中国联通山西分公司系统设计书工作流引擎样本.doc

TW_OO_DESIGN_DOC_1210-01AConfidential(秘密)OA工作流引擎设计说明书Version 5.0Written By TalkWebTALKWEB湖南拓维信息系统股份 ， All Rights Reserved目录1引言41.1编写目标41.2缩略语41.3参考资料42软件结构42.1关键实现技术42.2引擎处理结构53引擎包含到数据名称规范53.1文件系统划分53.1.1文件区命名规范53.2数据库中表、字段命名规范84引擎异常处理机制84.1以前错误机制缺点84.2对错误机制改善方法95引擎服务类具体说明105.1类列表105.2引擎全部类关系结构图105.3类具体设计115.3.1功效类别层中类具体说明115.3.2步骤实例层中类具体说明165.3.3步骤逻辑处理层中类具体说明216具体类实现机制297数据库字典307.1ER图307.2数据字典301.主步骤实例表（T_WorkFlow_FlowMain）302.主步骤字段表(T_WorkFlow_MainField)313.主步骤附件列表(T_WorkFlow_MainAtt)324.步骤日志表(T_Flow_LogMsg)325.未结束步骤步骤日志信息表（T_Flow_LogStatus）326.未结束日志字段表(T_Flow_LogField)337.未结束日志附件列表(T_Flow_LogAtt)338.已结束步骤步骤日志信息表（T_Flow_EndLogStatus）349.已结束日志字段表(T_Flow_EndLogField)3410.已结束日志附件列表(T_Flow_EndLogAtt)3511.待办信息表（T_WorkFlow_Notify）3512.在办信息表（T_WorkFlow_ZaiBan）3513.用户公文邮件表（T_WorkFlow_UserMail）3614.公文邮件字段表(T_WorkFlow_MailField)3615.公文邮件附件列表(T_WorkFlow_MailAtt)3716.需要修改表、视图说明378附注388.1步骤状态类型388.2处理标识388.3消息格式说明388.4和文件传输服务接口418.5对传阅修改说明418.6和其它外挂功效接口411 引言1.1 编写目标 本文档是完全参考中国联通总企业办公自动化系统工作流模块具体设计说明结合山西联通MSS系统建设现在来编写，而且在原有4.0版本基础上对工作流引擎基础结构及基础实现做了较大改善，软件开发人员在此基础上编写程序代码。1.2 缩略语WFEWorkFlow Engine工作流引擎1.3 参考资料步骤定义设计书工作流处理系统设计说明书（v4.0)中国联通总部OA系统设计变更提议2 软件结构2.1 关键实现技术 采取.Net框架，用C#编写； SQL SERVER数据库存放数据； 文件系统存放步骤中所带工作附件（用到自定义文件传输服务）； 2.2 引擎处理结构说明：1. WEB上消息直接送到MSMQ Agent服务器上，由Agent上一个消息分发服务依据消息缓急程度，将消息送到工作流引擎服务器上，不一样队列中；（Agent服务器上分发服务另外设计开发）2. 引擎服务器上开设多个队列，针对每个MSMQ，引擎服务全部开了专门线程对应处理；3. 引擎服务在做处理时候，关键是和数据层文件服务器和数据库服务器交互；4. 引擎服务在程序出现异常时候也有对应异常处理机制（具体机制后面会有具体说明）3 引擎包含到数据名称规范3.1 文件系统划分文件系统分为五个区盘符:FileStoreTemp临时区盘符: FileStore OAMail公务邮件区盘符: FileStore backup备份区盘符: FileStore Doc文档归档区盘符: FileStore Mode模板区(存放Word模板)备注：以上命名必需和引擎服务配置文件保持一致3.1.1 文件区命名规范临时区、备份区、公文邮件区命名：企业命名以企业ID命名，部门以部门ID命名，时间以yyyyMM方法命名，步骤实例ID已经由工作引擎定义好了。附件命名以文件实际名称命名。备份区备份序号采取数字递增方法命名。文档归档区命名：采取企业ID,部门ID命名企业文件夹和部门文件夹，时间以yyyyMM方法命名，全部文件夹及文件不能采取汉字方法命名,附件命名采取Guid方法命名,扩展名称保持原有扩展名。 临时区UnicomgdTemp步骤实例ID时间(年月)部门ID企业ID文件实际名称+原扩展名 文档归档区UnicomgdDoc时间(年月)部门ID企业IDGUID+原扩展名步骤实例ID说明:步骤结束后附件将归档到此处 备份区Unicomgdbackup步骤实例ID时间(年月)部门ID企业ID步骤处理序号文件实际名称+原扩展名步骤处理序号= T + 递增数字=用户ID+yyyyMMddhhmmssmi说明:一个步骤实例每个走一个步骤就会在备份去存放一个备份，只到步骤实例结束后才由工作流引擎删除 公务邮件区UnicomgdOAMail企业名称ID步骤实例ID传 阅主抄送文件实际名称+原扩展名文件实际名称+原扩展名年月阅 办文件实际名称+原扩展名说明：公务邮件区为用户个人存放传阅文件、阅办文件和主送、抄送文件，在同一个步骤中，在传阅、阅办和主送、抄送时是多个人共享一份文件。3.2 数据库中表、字段命名规范1. 数据库表是以T_开头;2. 数据库视图是以V_开头;3. 数据库函数是以SF_开头;4. 数据库存放过程是以SP_开头;5. 每个表中字段，要以意思明确为标准；4 引擎异常处理机制4.1 以前错误机制缺点引擎对于犯错消息，重新处理时间间隔太短。而对数据库压力很大时，频繁数据库操作可能造成数据库死锁，超时等错误，对于这些错误系统自动恢复需要时间较长，二者矛盾造成了过多工作流请求出现回滚。4.2 对错误机制改善方法对于可能出现异常错误，我们采取多级错误队列处理方法，对于不一样错误队列分情况用不一样重试时间，确保每一个错误全部能够经过足够长时间进行尝试，从而尽可能避免因为数据库或其它系统资源繁忙造成引擎处理不过来而回滚。具体错误处理机制图以下： 说明：1. 消息首先被送到正常队列中，等候处理；2. 当正常处理失败时，先送入异常处理队列1中，等候5分钟后处理该消息；3. 当在异常处理队列1中处理失败时，先送入异常处理队列2中，等候10分钟后处理该消息；4. 当在异常处理队列2中处理失败时，先送入异常处理队列3中，等候15分钟后处理该消息；5. 处理时间间隔能够依据实际系统性能需要做对应调整；6. 错误队列也能够经过配置文件来配置；7. 对于数次处理也失败消息,保留到日志或数据库中,用另外监控程序做监控,等候修改后处理.5 引擎服务类具体说明5.1 类列表类名类说明WorkEnginerCls.cs工作流处理类（即单个线程），负责工作流处理SocketCls.cs文件处理类，负责向文件服务器发送指令，等候返回结果ConstCls.cs定义了整个工程全部需要用到常量和方法DBDealCls.cs数据库交互类，负责对数据库进行操作MSMQCls.cs负责对消息队列进行操作SmsCls.cs对短信处理类WorkFlowDefineCls.cs步骤实例基础信息定义类WorkFlowCntrCls.cs步骤实例基础信息控制类StatusCls.cs步骤中每个状态基础信息类DisposalCls.cs步骤中每个处理基础信息类UserCls.cs用户基础信息类5.2 引擎全部类关系结构图 DBDealCls.csConstCls.csMSMQCls.csSMSCls.csSocketCls.cs功效类别层WorkFlowDefineCls.csStatusCls.csDisposalCls.csUserCls.cs步骤实例层WorkEnginerCls.cs逻辑实现层层WorkFlowCntrCls.cs5.3 类具体设计5.3.1 功效类别层中类具体说明5.3.1.1 ConstCls类类名ConstCls 父类名责任描述 定义静态方法 定义全局常量（各个线程独自占有）协同类全局常量类型值UrlCompartchar#ConfigCompartchar=C_Userchar;cntFileCompartchar*C_Chr1char(char)1C_Chr2char(char)2C_Chr3char(char)3C_Chr4char(char)4C_Rep1string#$!%C_Rep2String#$%!C_Rep3String$#!%C_Rep4string!#$%cntFileEndstringncntFileQuitstringQUITcntMSMQstringprivate$cntCFilesstringCOPYcntDFilesstringMOVEcntMFilesstringMOVEC_PassDirstring传阅C_MotifDirstring主抄送C_TypeZhustring主办C_TypeXieString协办C_TypeYueString阅办C_CompartStringC_DubCompartStringC_UdeptString方法说明方法名1ResolveStr ()类型public static stringDescription字符串解析方法InputSrcStr，string型,需要解析字符串；Flag,char型，字符串分割符OutputStrArr 解析后产生字符串数组方法名2WriteLog ()类型public static voidDescription当操作失败时，写犯错日志Inputstring LogMsg, 犯错信息 string FilePath 日志文件所在路径Output5.3.1.2 SocketCls类类名FileCntrCls父类名责任描述 提供指示文件服务器操作附件方法协同类ConstCls CnnSocket方法说明方法名1DealFileSys ()类型Public boolDescription发送命令到文件服务器InputSocket Skt,连接服务器SOCKET，string CmdFile 要操作文件命令行Output成功则返回TRUE，不然返回FALSE方法名2SendFileMsg ()类型public stringDescription和文件服务器建立连接，而且将指定操作送到文件服务器上，并等候服务器操作后返回结果。Inputstring AllDealFileStr 全部要发送命令组成一个字符串格式是：命令1；命令2；。/nOutput成功则返回TRUE，不然返回FALSE5.3.1.3 DBDealCls类类名DBDealCls父类名责任描述 提供连接数据库方法 查询方法 事务实施方法 断开数据库方法协同类FileDealCls方法说明方法名1DBDealCls ()类型public voidDescription类结构函数，建立数据库连接，实例化文件类。调用到了Open_Cnn发生 错误时抛犯错误，让上一级处理Inputstring CnnStr 连接数据库字符串Output方法名2Open_Cnn ()类型public voidDescription建立数据库连接InputOutput方法名3Close_Cnn ()类型private voidDescription关闭数据库连接，释放连接实例InputOutput方法名4Query ()类型public DataTableDescription依据传入查询语句，得到一个统计集，并返回InputSqlStr, string型，查询语句Output类型 DataTable方法名5ExecuteTran ()类型public boolDescription有事务处理方法InputSqlArr 字符串数组(包含要操作全部SQL语句),OutputTRUE表示事务实施成功，FALSE表示实施失败方法名6ExecuteTran ()类型public boolDescription有事务处理方法InputSqlArr 字符串数组(包含要操作全部SQL语句), 包含文件系统操作类型和所包含附件OutputTRUE表示事务实施成功，FALSE表示实施失败方法名7RollBackFile ()类型public boolDescription到犯错时需要恢复文件系统机制InputArrayList AttachMentDeal 包含文件系统操作类型和所包含附件OutputTRUE表示实施成功，FALSE表示实施失败5.3.1.4 MSMQCls类类名MSMQCls父类名责任描述 创建消息队列方法 发送消息到队列方法 从指定队列中读取消息 删除指定名称消息队列方法协同类ConstCls方法说明方法名1CreateMSMQ ()类型public boolDescription在指定机器上创建指定名称消息队列InputMSMQPath string 消息队列名称OutputTRUE 表创建成功，FALSE 表创建失败方法名2SendMsg ()类型public boolDescription将指定消息发送到指定队列中InputMsmqPath string 消息队列路径，System.Messaging.Message ObjMsg 要发送消息对象OutputTRUE 表发送成功，FALSE 表发送失败方法名3OnReceiveCompleted ()类型public voidDescription事件绑定具体方法InputSource 触发事件源 ReceiveCompletedEventArgs asyncResult 异步OutputObject 返回读到消息方法名4DelMsmq ()类型public boolDescription删除指定消息队列InputMsmqPath string 消息队列路径OutputTRUE 表删除成功，FALSE 表删除失败5.3.2 步骤实例层中类具体说明5.3.2.1 WorkFlowDefineCls类 类名WorkFlowDefineCls父类名责任描述 步骤实例基础信息类协同类ConstCls属性类型说明FlowIDstring步骤实例IDTitleString步骤实例标题ActionString动作处理标识FlowTypeIDInt 步骤类型IDFlowTypeNameString 步骤类型名称CreatorUserCls 步骤创建者用户类CreateTimeString 步骤创建时间ParentWorkFlowWorkFlowCls父步骤类FormClassString HuanJiString 缓急程度MiJiString密集程度IS_PIGEONHOLEint是否归档标志ModifyFlagString对应SpecialID处理情况（False + chr(1) + False）表示会签情况BrachResultInt 合流标示（1：表示合流，0表示未合流）SpeciIDString分支标识（用户A + chr(1) + 用户B）FieldsString 步骤附件字段（字段名 + chr(1) + 字段值 + chr(2) + 字段名 + chr(1) + 字段值）AttachMentsString 步骤带附件名称和路径（附件名 + chr(1) + 附件路径 + chr(2) + 附件名 + chr(1) + 附件路径）MergeFieldString 合流时需要合并字段（字段名；字段；。字段名）PIGEONHOLEDeptNameString 该文要归入部门名称FileClassString 请看消息FileClass解释FileFlagInt 请看消息FileFlag解释CurStatusStatusCls步骤走到目前状态Company_IDint步骤所在企业ID5.3.2.2 WorkFlowCntrCls类类名WorkFlowCntrCls父类名责任描述 步骤实例基础信息类协同类ConstCls方法说明方法名1CommState类型private voidDescription处理一般状态方法(一般状态和开始进行一样处理)InputOutput方法名2EndState类型private voidDescription处理结束状态方法InputOutput方法名3ChildFlow类型private voidDescription处理子流动作InputOutput方法名4ChildFlow_Wait_SameTime类型private voidDescription处理等候、同时子流动作(传阅时候起作用)InputOutput方法名5ChildFlow_NotWait_SameTime类型private voidDescription处理不等候、同时子流动作(传阅)没有写日志InputOutput方法名6DivideFlow类型private voidDescription处理分流InputOutput方法名7MergeFlow类型private voidDescription处理合流InputOutput方法名8HurryAct类型private voidDescription处理催办动作InputOutput方法名9RenewAct类型private voidDescription处理一般状态方法(一般状态和开始进行一样处理)InputOutput方法名10ReteatAct类型private voidDescription处理撤回动作InputOutput方法名11DisposeAct类型private voidDescription处理作废动作InputOutput方法名12GetFlowLogMsg类型private voidDescription得到目前步骤得日志信息InputOutput方法名13类型private voidDescription处理作废动作InputOutput5.3.2.3 StatusCls类类名StatusCls父类名责任描述 步骤状态基础信息类协同类属性类型说明FlowIDstring步骤实例IDFlowTypeIDInt 步骤类型IDFlowTypeNameString 步骤类型名称StatusNameString状态名称StatusTypeNameString 状态类型名称StatusTypeIDint状态类型IDINTERFLOW_CUSTOM_RULEstring合流自定义规则INTERFIX_FIELDstring相关字段COM_EXTENDstringCom扩展CHILD_FLOW_TYPEstring子流（分流）类型CHILD_FLOW_HINTstring子流提醒CHILD_FLOWstring子流CHANGE_FLOW_NAMEstring转步骤步骤名CHANGE_FLOW_IDInt 转步骤步骤IDCHANGE_STATUS_NAMEstring转步骤状态名称CHANGE_STATUS_IDInt 转步骤状态IDAUTO_FIELD_LISTstring自动列表AUTO_CUSTOM_RULEstring自动自定义规则AUTO_FIELD_NAMEstring自动字段名称INTERFLOW_UNITE_LISTstring合流自定义规则OperationRole _IDInt 业务角色IDUSERROLE_IDInt 用户角色IDNextStatusHashTable由下一步状态作为元素组成HashTableFromDisposalDisposalCls本状态从哪个动作过来方法名1GetStatusMsg类型private voidDescription得到状态信息，对属性赋值InputString FlowID 步骤ID，string StatusID 状态IDOutput方法名2GetNextStatusMsg类型private HashTableDescription得到目前状态全部下一步状态信息,给属性赋值InputString FlowID 步骤ID，string StatusID 状态IDOutput由全部下一步状态信息组成HashTable5.3.2.4 DisposalCls类类名DisposalCls父类名责任描述 步骤处理基础信息类协同类ConstCls属性类型说明FlowIDstring步骤实例IDFlowTypeIDInt 步骤类型IDFlowTypeNameString 步骤类型名称DISPOSAL_IDInt处理过程IDDISPOSAL_HINTString 处理过程提醒DISPOSAL_NAMEString处理过程名称TRANSACT_STATUS_IDInt经办状态DEPT_LIMITInt同部门限制ROLE_LIMITInt同角色限制CUR_STATUS_IDInt目前步骤IDPRE_STATUS_IDint上步骤IDGROUP_LIMITInt同组限制方法名1GetDisponsalMsg类型private voidDescription得四处理步骤信息Inputint FlowTypeID 步骤类型ID，int PreStatus_ID,上一个状态ID，int CurStatus_ID 目前状态IDOutput5.3.2.5 UserCls类类名UserCls父类名责任描述 用户基础信息类协同类ConstCls属性类型说明UserIDstring用户IDDeptIDInt 用户所在部门IDDeptNameString 用户所在部门名称RoomIDInt 处室IDRoomNameString 处室名称UserNameString 用户汉字名CompanyIDInt 用户所在企业IDCompanyNameString用户所在企业名称OPERRoleIDString 用户所属角色IDOPERRoleNameString用户所属角色名称UserOrderbyInt用户排序字段RoomOrderByInt处室排序字段DeptOrderByInt部门排序字段CompanyOrderByInt企业排序字段方法名1GetUserMsg类型private voidDescription得到用户信息Inputstring UserID 用户ID,string CnnStr 数据库连接Output5.3.3 步骤逻辑处理层中类具体说明5.3.3.1 WorkEnginerCls类类名WorkEnginerCls父类名责任描述 连接数据库 扫描工作流引擎表（是一个视图） 对动作和状态做处理协同类使用FileDealCls对文件系统操作使用DBDealCls对数据库进行操作使用ConstCls调用系统常量方法说明方法名1WorkEnginerRun()类型public voidDescription工作流引擎工作方法，创建队列和线程，而且绑定关系，调用方法AssembleMethod处理取得消息，并做对应逻辑处理。InputOutput方法名2AssembleMethod ()类型public voidDescription将取得消息转变成为结构体，再实施具体处理方法InputOutput方法名3XMLToStruct ()类型private boolDescription分解得到消息，将消息中信息组合成ItemMsg类型数据InputMSXML2.DOMDocument ObjDom，由消息中正文所得到MSXML2.DOMDocument对象Output转变正确则返回TRUE，不然返回FALSE方法名DealWorkFlow ()类型public voidDescription对多种动作和状态处理InputOutput方法名AgainDealMethod ()类型public voidDescription处理因为连接失败而造成未处理情况。InputOutput方法名CorrectMethod ()类型public voidDescription创建纠错线程，关键是在做纠错处理时使用InputOutput方法名FileSrvDealMethod ()类型private voidDescription关键用于处理在没有连接文件服务成功时放入队列消息InputOutput方法名4CommState()类型private voidDescription对一般、开始状态和跳转动作进行处理若犯错，写犯错信息，错误步骤等候下一次处理（最多处理3次）InputItemMsg TmpRsd,要处理结构体，int LogFlag,日志处理标志位(0:开始时候，1:非开始时候,2:结束）FrmWorkEnginer WinEnginer(在应用程序中用到，服务中没有)Output方法名5EndState ()类型private voidDescription对结束进行处理，调用了DecomposeFields(),GetFileName(),MergeUrl(),GetNewAttachment(),BeginState(),GetLogSql(),MoveLog(),DeleteAllTable()CanZhuChaosong(),GetZhuChaoUrl(),DealZhuChaoSong(),EnginerDB.ExecuteTran()若犯错，写犯错信息，错误步骤等候下一次处理（最多处理3次）InputItemMsg TmpRsd,要处理结构体，FrmWorkEnginer WinEnginer(在应用程序中用到，服务中没有)Output方法名6HurryAct ()类型private voidDescription对催办进行处理，调用了DealUserMail(),EnginerDB.ExecuteTran()若犯错，写犯错信息，错误步骤等候下一次处理（最多处理3次）InputItemMsg TmpRsd,要处理结构体，FrmWorkEnginer WinEnginer(在应用程序中用到，服务中没有)Output方法名7RenewAct ()类型private voidDescription对重发进行处理，调用了ConstCls.ResolveStr(),EnginerDB.ExecuteTran()若犯错，写犯错信息，错误步骤等候下一次处理（最多处理3次）InputItemMsg TmpRsd,要处理结构体，FrmWorkEnginer WinEnginer(在应用程序中用到，服务中没有)Output方法名8DisposeAct ()类型private voidDescription对作废进行处理，调用了MoveLog(),DeleteAllTable(),DealUserMail(),DelMergeUrl(),EnginerDB.ExecuteTran()若犯错，写犯错信息，错误步骤等候下一次处理（最多处理3次）InputItemMsg TmpRsd,要处理结构体，FrmWorkEnginer WinEnginer(在应用程序中用到，服务中没有)Output方法名10ReteatAct ()类型private voidDescription对撤回进行处理，调用了EnginerDB.Query(),DecomposeFields(),DealNotify(),EnginerDB.ExecuteTran()若犯错，写犯错信息，错误步骤等候下一次处理（最多处理3次）InputItemMsg TmpRsd,要处理结构体，FrmWorkEnginer WinEnginer(在应用程序中用到，服务中没有)Output方法名11ChildFlow ()类型private voidDescription对子流进行处理，调用了ChildFlow_Wait_SameTime (),ChildFlow_NotWait_SameTime (),ChildFlow_NotWait_Order (),ChildFlowEnd ()若犯错，写犯错信息，错误步骤等候下一次处理（最多处理3次）InputItemMsg TmpRsd,要处理结构体，FrmWorkEnginer WinEnginer(在应用程序中用到，服务中没有)Output方法名12ChildFlow_Wait_SameTime()类型private voidDescription对结束进行处理，调用了GetRealPath (),GetFileName(),MergeUrl(),GetNewAttachment(),DealerToSql (),DealZaiBan (),DealFlowMain (),GetLogSql(),EnginerDB.ExecuteTran ()若犯错，写犯错信息，错误步骤等候下一次处理（最多处理3次）InputItemMsg TmpRsd,要处理结构体，FrmWorkEnginer WinEnginer(在应用程序中用到，服务中没有)Output方法名13ChildFlow_NotWait_SameTime ()类型private voidDescription对结束进行处理，调用了GetRealPath(),GetFileName(),MergeUrl(),GetNewAttachment(),DealUserMail(),GetLogSql(),DealZaiBan (),DealFlowMain (),EnginerDB.ExecuteTran()若犯错，写犯错信息，错误步骤等候下一次处理（最多