UCML工作流系统与现有应用系统集成要点

The best solution forhow to develop WEB application on .Net quickly and efficientlyUCML工作流系统与现有应用系统集成实现方案说明金富瑞（北京）科技有限公司Goldframe Technologies Co., Ltd.一 总体说明UCML.Net工作流系统是国内领先的工作流平台，涵盖了从流程开发、发布、管理配置到运行、监控的整个过程。UCML工作流系统主要包括可视化的流程设计环境、独立的工作流引擎服务、WEB客户端管理、可视化的流程监控、流程套路生产线几个部分，是.Net领域用户最多，覆盖面最广的工作流平台。一方面，UCML工作流系统与UCML平台其它部分（业务单元开发，Web报表）无缝集成，可以完成复杂的业务处理及流程流转；另一方面，UCML工作流系统与业务之间采用松耦合设计，不仅可以与UCML业务系统集成，还可以与其它现成的应用系统实现无缝集成。UCML工作流在与其它应用系统集成时，一般有两种方式：第一种：保留UCML现有的组织机构、用户及权限体系第二种：完全屏蔽UCML提供的组织机构、用户及权限体系，完全采用客户原有的组织机构权限体系。对于第一种方式，需要另外实现UCML系统与客户现有应用系统之间的数据同步，具体方法可采用程序同步方式，在这里就不详细介绍了。下面主要介绍一下采用第二种方式时的处理方法。二 UCML Workflow会话编程接口UCML Workflow 提供了WorkFlow.WorkFlowSession会话类来访问工作流引擎, WorkFlow.WorkFlowSession以.Net Remoting服务形式形式存在于工作流引擎的独立进程中，客户端可以创建WorkFlow.WorkFlowSession的Client端来来调用服务端的接口。 创建工作流会话对象WorkFlow.WorkFlowSession FlowSession = (WorkFlow.WorkFlowSession)Activator.GetObject(typeof(WorkFlow.WorkFlowSession), tcp:/+WorkFlow.UCMLInitEnv.WorkflowEngineAddr+:+WorkFlow.UCMLInitEnv.WorkflowEnginePort+/WorkFlowSession); 程序启动工作流程 public Guid CreateInstance(string FlowID,Object UserOID,Object PostnOID, Object DivisionOID,Object ORGOID, bool startNow) 通过调用CreateInstance函数，可以启动指定的工流程。 返回值：流程实例句柄。参数名称类型参数说明FlowIDstring要启动的流程编号 UserOIDObject起动流程的用户OID,实际类型为GUIDPostnOIDObject起动流程的员工OID,实际类型为GUIDDivisionOIDObject起动流程的员工所在部门的OID,实际类型为GUIDORGOIDObject起动流程的员工所在组织的OID,实际类型为GUIDstartNowBool=true 流程是马上启动； =false 流程暂不启动，要启动流程需调用StartInstance函数，这种情况一般用于在业务（如客户订单）提交成功后，先写入订单号到流程实例中，然后在启动流程。 向流程全局数据写入数据public void WriteFlowData(string FlowID, Object InstanceID, string FieldName,Object Value)参数名称类型参数说明FlowIDstring数据项所属的流程编号 InstanceIDObject流程的实例句柄,实际类型为GUIDFieldNamestring数据的属性名称ValueObject数据的属性的值 从流程全局数据读出数据public Object ReadFlowData(string FlowID, Guid InstanceID, string FieldName)返回值：读取数据属性的值参数名称类型参数说明FlowIDstring数据项所属的流程编号 InstanceIDObject流程的实例句柄,实际类型为GUIDFieldNamestring数据的属性名称 向流程局部数据写入数据public void WriteActivityData(string FlowID, Guid InstanceID,string ActivityID, string FieldName,Object Value)参数名称类型参数说明FlowIDstring数据项所属的流程编号 InstanceIDObject流程的实例句柄,实际类型为GUIDActivityIDstring活动节点的编号FieldNamestring数据的属性名称ValueObject数据的属性的值 从流程局部数据读出数据public Object ReadActivityData(string FlowID, Guid InstanceID,string ActivityID, string FieldName)返回值：读取数据属性的值参数名称类型参数说明FlowIDstring数据项所属的流程编号 InstanceIDObject流程的实例句柄,实际类型为GUIDActivityIDstring活动节点的编号FieldNamestring数据的属性名称 完成已分配的任务public string FinishTask(string strAssignTaskID)FinishTask代表设置已分配出去的任务已完成返回值：提示信息参数名称类型参数说明strAssignTaskIDstring分配任务的唯一标志号 设置任务结果及状态public void SetTaskResolution(Guid TaskID,TTaskResolution Resolution)设置任务执行结果,代表任务执行完毕参数名称类型参数说明TaskIDGuid任务的Key值 ResolutionTtaskResolution任务的状态UNRESOLVED,SUCCESS,FAIL,EXCEPTION 含义分别为未处理,成功,失败,异常 编写节点分支条件UCML Workflow用abstract public class Transition类来描述一个分支条件类属性名称类型可见度属性说明TransResultBooleanprotectedTransResult=true 则代表流程分支条成立TransResult=false 则代表流程分支条不成成立 FromActivityWorkFlowActivitypublic分支来源节点对象实例ToActivityWorkFlowActivitypublic分支目标节点对象实例FlowModelWorkFlowModel的子类public其实是流程模型的实例对象,通过它可以访问流程所有属性(或状态)数据方法名称类型可见度方法说明OutgoingCondition()boolpublicvirtual public bool OutgoingCondition()在UCML Workflow里,节点的一条流出分支是否成立完全取决于这个函数,编程人员员可以它的子类里编写它的具体实现代码,在编写代码时可以结合流程的状态数据。在这函数中一定要设置TransResult的值，也就是说如果TransResult=true 分支成，否则分支不成立，也就不走这条分支。IncomingConditionboolpublicvirtual public bool IncomingCondition()OutgoingCondition()这函数是在Transition的子类中已覆盖函数形式实现，在UCML环境里的流出条件编辑，就是实现此函数。如下图示： 9. 编程实现智能任务分配wm_assign()UCML Workflow提供回调函数，为开发者提供完成复杂分配的可能,详见回调函数接口 10. 终止流程方法名称类型可见度方法说明Abort ()voidpublicpublic void Abort(string FlowID, Guid InstanceID)终止某个流程实例 9. 挂起流程方法名称类型可见度方法说明Pause ()voidpublicpublic virtual void Pause()暂时挂起一个流程 10. 唤醒流程方法名称类型可见度方法说明Resume ()voidpublicpublic void Resume(string FlowID, Guid InstanceID)重新运转流程 11. 节点手动跳转方法名称类型可见度方法说明GotoActivity ()voidpublicpublic void GotoActivity(string FlowID, Guid InstanceID,string FromActivityID,string ToActivityID,string Performers)作用 : 流程跳转FlowID：流程IDInstanceID：流程实例句柄FromActivityID：来源活动名称ToActivityID：目标活动名称Performers：执行人的群组串. 回退任务/ / 回退任务/ / 任务IDpublic void Rollback(Guid TaskID) 回收任务/ / 收回任务/ / 任务ID 获取某个活动节点执行人/ / 获取某个活动节点执行人 / / 活动节点ID / public string GetActivityPerformer( string ActivityID) 获取当前节点即将流向的目标节点，如果是并发输出将会多个流向。用于在当前节点完成时，马上选择下一节点执行人 / / 获取当前节点即将流向的目标节点，如果是并发输出将会多个流向 / 用于在当前节点完成时，马上选择下一节点执行人 / / 流程ID / 实例ID / 活动ID / 返回要输出的节点ID数组 public string GetOutgoingActivitys(string FlowID, Guid InstanceID, string ActivityID) 获取节点状态 / / 获取节点状态 / / / / / public int GetActivityStatus(string FlowID, Object InstanceID, string ActivityID) 修改节点状态 / / 修改节点状态 / / / / / public void ChangeActivityStatus(string FlowID, Object InstanceID, string ActivityID, int ActivityStatus) 不结束当前节点，而激活下一节点/ / 不结束当前节点，而激活下一节点 / / 流程ID / 流程实例ID / 流转到活动ID / 来自活动ID / 流转到活动节点执行人 public void GotoActivityNotFinishTask(string FlowID, Guid InstanceID, string FromActivityID, string ToActivityID, string Performers) 完成已分配的任务,但不流转 / / 完成已分配的任务,但不流转 / / 工作流活动节点对象 / public string FinishTaskNotRun(WorkFlowActivity Activity) 加签或者转签/ / 加签或者转签/ / 流程ID/ 实例ID/ 任务ID/ 当前用户OID/ 执行人/ 按照顺序执行/ true：加签；false：转签/ / 消息类型/ 消息内容 public void AddSignPerformer(string FlowID, Guid InstanceID, Guid AssignTaskOID, Guid CurrentUserOID, string SignPerformers, bool fSignOneByeOne, bool InsertBefore, bool IsDeleteSigner, int MessageType,string MessageContent) 协办或会签/ / 协办或会签 / / 流程ID / 实例ID / 任务ID / 当前用户OID / 执行人 / 消息类型 / 消息内容 / 3：协办;1:会签 public void AssignSignPerformer(string FlowID, Guid InstanceID, Guid AssignTaskOID, Guid CurrentUserOID, string SignPerformers,int MessageType, string MessageContent,int TaskKind) 手工正常分配任务/ / 手工正常分配任务/ / / public void MansualAssignTask(string TaskTicketOID,string Performer) 分配参阅任务/ / 分配参阅任务/ / / public void MansualAssignReadTask(string TaskTicketOID,string Performer) 悔签任务，对在任务分配表AssignTask中acceptFlag置为1的标记设为4悔签/ / 悔签任务，对在任务分配表AssignTask中acceptFlag置为1的标记设为4悔签/ / public void RepentSignforTask(string assignTaskID) 任务跳回到执行人 / / 任务跳回到执行人 / / 流程ID / 流程实例句柄 / 节点ID public void TaskReturn(string FlowID, Guid InstanceID, string ActivityID) 获取某个已完成节点的执行人/ / 获取某个已完成节点的执行人 / / 流程ID / 流程实例句柄 / 节点ID / 返回执行人OID数组 public Guid GetExecuteUser(string FlowID, Guid InstanceID, string ActivityID) 唤醒已完成的任务/ / 唤醒已完成的任务 / / public void WakeFinishedAssignTask(string AssignTaskOID) 12. 任务超时处理及编程UCML Workflow 的是否超时由下图的完成期限和延长时间两个属性决定： 当完成期限不填内容时，代表这个活动节点产生的任务没有时间限制延长时间代表完成期限倒了之后，还可以再延长多少时间l 即将超时处理当完成期限到了之后，会回调wm_willtimeout函数，如果想在此时放个邮件通知或短信，就可在wm_willtimeout函数内调用。l 超时处理同样的当完成期限到了之后，如果有延长时间，而且延长时间也到了，会回调wm_deadline函数，如果想在此时放个邮件通知或者短信，就可在wm_deadline函数内调用。如下图示： 如果任务在截止期限和延长时间内都没有完成，此时任务做超时处理，流程是继续流转还是停止由截止期限到达时系统行为这个属性决定，如为SYNCHR(同步)，则流程停在这里，如果为ASYNCHR(异步) 则流程继续流转。三 UCML工作流开放性介绍UCML 引擎底层框架的基类源码不开放，包括引擎调度代码和流程类、活动类和分支类基类代码。而根据定义可以直接生成引擎源码都是开放的，可以在这些源码的框架扩展时刻(回调函数)之内注入C#代码来进行，如下面活动节点代码的时刻函数任务分配时刻函数override public void wm_assign(Object taskTicketID,Object UserList,ref Object AssignUserList,ref int TaskKindList,Boolean reassignFlag)任务分配后时刻函数override public void wm_afterAssignTask(Object assignTaskID,Object UserOID) base.wm_afterAssignTask(assignTaskID,UserOID);任务分配前时刻函数override public void wm_beforeAssignTask(SysDBModel.AssignTaskInfo AssignTaskInfo)任务完成时刻函数override public void wm_afterTaskFinish(Object taskTicketID,TTaskResolution TaskResolution)任务超时时刻函数override public void wm_deadline(Object taskTicketID)任务完成规则函数override public bool wm_finishTaskRule(SysDBModel.TaskTicketInfo taskTicketInfo) return false;任务创建函数override public void wm_createTask(SysDBModel.TaskTicketInfo taskTicketInfo)任务回滚前函数override public void wm_beforerollback(Object taskTicketID)任务回滚后函数override public void wm_afterrollback(Object taskTicketID)override public void wm_onactivate()override public void wm_willtimeout(SysDBModel.TaskTicketInfo taskTicketInfo)override public bool wm_activityInComeCondi() return false; 四 集成方案在采用客户已有的人员权限体系时，主要用到UCML工作流系统的可视化流程设计环境、工作流引擎服务、工作流标准表结构、流程API、可视化的流程监控（可选）等。在集成时可能需要修改客户已有的Web系统或表的结构，主要是修改以下地方：l 修改人员信息表l 引入流程接口（UCML工作流API）l 客户登陆会话的改变l 加入工作流引擎需要的初始化程序l 增加一个待办事宜模块l 引入平台中的可视化的流程监控模块（如果需要可视化流程监控那么就需要引入）在平台中主要有以下注意点：l 在平台中设计工作流模型l 添加流程状态数据l 在任务分配函数-wm_assign()中设置任务的执行人l 修改人工节点上的业务标识符为为自己的页面1、 l修改人员信息表需要在客户现有的用户表（存储登录帐号、密码表）中增加一个Guid类型的字段，这个字段的值唯一标记一个用户，不影响客户现有的应用体系，起到与UCML工作流衔接作用。这个字段的字段名命名规范为：客户表名+OID，即“客户表名OID”，字段类型为GUID类型，在MSSQL Server中是Uniqueidentifier，Oracle中为VARCHAR类型。在客户业务系统中客户的登录ID代表客户的身份，如果整合中客户表中有现存的数据需要手工给“客户表名OID”赋值；另外，在增加用户的程序中要同时给“客户表名OID”赋值。2、 l引入流程接口（UCML工作流API）l 在客户现有系统的工程文件中引入UCML工作流API，并引用一个专门为第三方业务开发包装的接口源程序WorkflowClient.cs。l 相关工作流API：DBLayer.dll，SysDBModel.dll，UCMLBase.dll，WorkFlow.dlll 把Workflowbin 目录下的UCMLConf.xml,DBLayer.xml文件拷贝到客户工程的bin目录下，注意：如果不是在客户工程的本机运行工作流引擎，则需要把UCMLConf.xml文件中引用工作流引擎地址的IP改为运行工作流引擎主机的IP地址。3、 l客户登陆会话的改变在用户登陆的程序中，在取得用户表中各项数据时，把用户表中新增的字段也读出来，并把该项也放入用户登陆会话中。4、 l加入工作流引擎需要的初始化程序在使用客户的应用程序中与工作流引擎打交道之前的任意时刻加入如下程序：UCMLCommon.UCMLInitEnv.fInServer=true;UCMLCommon.UCMLInitEnv.LoadEnvVariable();new DBLayer.LogicDBModel();UCMLCommon.UCMLLogicDBModelApp x = new UCMLCommon.UCMLLogicDBModelApp();x.PrepareModel();5、 l增加一个待办事宜模块待办事宜也叫待办任务。需要客户自己新增一个待办事宜模块，其数据来源是UCML提供的任务分配表AssignTask，开发者可根据记录（任务）的完成与否状态过滤数据到待办任务模块内。6、 l引入平台中的可视化的流程监控模块（如果需要可视化流程监控那么就需要引入）可视化流程监控的页面在平台中的业务模块是：BPO_FlowTrace可以将BPO_FlowTrace相关文件拷贝到项目下：BPO_FlowTrace.aspxBPO_FlowTrace.aspx.csBPO_FlowTrace.asmxBPO_FlowTrace.asmx.csBPO_FlowTrace.htc7、 l在平台中设计工作流模型在平台中设计工作流模型，可以参考“工作流设计手册”。8、 l添加流程状态数据UCML工作流引擎和业务之间是松耦合处理模式，工作流和业务之间是通过流程状态数据进行交互。流程状态数据是指工作流在运转过程中流程流转所需要的保存在流程实例中的数据，一般有三类业务数据要保存在流程中，一是业务单据的关键字段，用它可以决定一个任务对应的业务单据号，在UCML里一般把表单主键存到流程里；二是决定流程分支走向的数据，有可能是领导意见，也有可能是单据金额，这些数据是为了工作流引擎内部调用的；三是流程执行人信息。流程和业务之间的状态数据交互方法很简单，如下所示：写入流程状态数据：即把业务的数据写入到流程中去，调用的方法是WriteFlowData；读出流程状态数据：即把流程状态读出来赋给业务，调用的方法是ReadFlowData。写入流程状态数据一般在数据提交时进行，读出流程状态数据一般在初始化时进行，读时可以把流程状态数据赋给业务中的某个属性，以方便业务中调用。9、 在任务分配函数-wm_assign()中设置任务的执行人在工作流中任务分配的方式有几种：通过群组配置分配任务回调函数分配任务手工执行执行人由于组织机构等均不采用平台自带的组织框架，所以无法采用“通过群组配置分配任务”的方式，只能采用“回调函数分配任务”或10、 自己实现执行人群组解析接口，可以继续使用基于配置的任务分配基于流程模型的执行人配置可以避免在wm_assign里写程序做任务分配，但必须必需特定某个组织机构，在这个组织机构基础之上可以定义群组，来描述人员、部门和岗位集合，也可以定义相对执行人如申请人的部门主管、申请人公司总经理等，只要实现自己的群组解析接口，就可以自己的群组串配置UCML的工作流执行人的字段里，就可以实现基于配置的任务分配实现步骤如下：u 自定义类实现如下接口 public interface IGroupParser Object UserOIDList(string GroupStr, Object Starter, Object StartPostn, Object StartDivision, Object StartORG, Object Performer, Object PerformerPostn, Object PerformerDivision, Object PerformerORG); Object UserOIDList(string GroupStr); / / 根据组定义获取用户列表/ / 群组字符串/ 流程启动者GUID / 流程启动岗位GUID /