e-cology工作流接口技术方案说明书.doc

工作流接口技术方案说明书e-cology工作流接口技术方案说明书SUBMITED BY WEAVER文档版本历史变更序号日期版本文件变更申请编号变更说明修改人12007年4月27日V1.0无新文件衡晓辉22007年6月20日V1.1无张小丰目 录一、前言41.1编写目的41.2名词定义4二、需求概述52.1客户需求52.2数据输入需求分析62.3数据输出需求分析7三、技术方案83.1技术实现83.2接口应用范围83.3 交换数据范围83.4 附件传递8四、接口设计94.1流程创建接口94.2流程修改接口134.3流程操作接口134.4流程写接口134.5流程列表读接口134.6流程数据读接口17五、接口应用设计225.1工作流节点、出口附加操作改进225.2流程监控改进22一、前言1.1编写目的为实现e-cology系统工作流模块的标准输入输出接口，特编写本文档，定义以下内容：1、 概要分析e-cology工作流接口需求；2、 定义e-cology工作流输入输出接口的技术实现方案；3、 定义e-cology工作流输入输出接口的功能范围；4、 定义e-cology工作流输入输出接口在e-cology系统内的功能应用；本文档用于针对系统集成需求，对客户及第三方软件供应商的技术方案描述。工作流接口内容定义，请参见e-cology工作流接口详细设计说明书。工作流接口使用说明，请参见e-cology工作流接口使用白皮书。1.2名词定义1、e-cology系统：指提供本工作流接口，用于与其他系统数据交接的e-cology系统。2、外部系统：指调用或实现e-cology工作流输入输出接口，与e-cology系统进行数据交接的其他系统。3、workflow指工作流，也称流程，包括表单（或单据）定义、节点定义、节点路径定义等，比如流程管理员设置的请假申请工作流。4、request指某一工作流的实例，也称请求，即具体的某一表单（或单据），比如某用户创建的一张请假申请单。二、需求概述概要分析e-cology工作流接口需求。2.1客户需求1、外部系统在e-cology系统中触发一个新的流程,不回写值；2、外部系统在e-cology系统中触发一个新的流程,并在某个节点上进行回写；3、e-cology系统中创建一个流程，在某节点触发外部系统，外部系统处理后返回OA系统继续流转(其中包括跟随外部系统处理阶段直接影响流程流转)；4、e-cology系统中创建一个流程在某个节点对外部系统进行回写；5、外部系统获取e-cology系统中的一些数据.(例如: 流转日志)；2.2数据输入需求分析外部系统通过工作流接口，向e-cology系统输入数据。创建新的工作流或修改、操作已有流程数据。2.2.1 通过接口创建流程指外部系统通过调用e-cology流程创建接口，在e-cology系统内触发具体的流程。新建表单数据由外部系统通过接口传入。e-cology流程创建接口返回流程创建结果，外部系统可保留requestid，用以之后其他接口的调用。2.2.2 通过接口修改表单数据指外部系统通过调用e-cology流程修改接口，修改e-cology系统内具体流程的表单数据。修改表单数据由外部系统通过接口传入。2.2.3 通过接口操作流程指外部系统通过调用e-cology流程操作接口，对e-cology系统内具体流程做提交或退回操作。操作类型及签字意见由外部系统通过接口传入。e-cology流程操作接口返回流程操作结果。2.3数据输出需求分析e-cology系统通过工作流输出接口，实现对外部系统的数据输出；或外部系统通过e-cology工作流数据输出接口，读取e-cology流程数据，实现流程数据输出。2.3.1 流程数据自动输出指通过e-cology系统在流程流转过程中，对工作流输出接口的调用，实现实时、自动对外部系统的数据输出。输出的流程数据，在外部系统内所做的操作内容，由对方系统对工作流输出接口的实现内容决定。可以在e-cology工作流节点、出口附加操作上，设置对工作流数据输出接口的调用，以实现流程流转过程中，与外部系统数据交换的无缝链接。2.3.2 在e-cology系统选择输出范围手动输出指通过e-cology系统在相应功能中，对工作流输出接口的调用，实现可选择流程范围、手动对外部系统的数据输出。输出的流程数据，在外部系统内所做的操作内容，由对方系统对工作流输出接口的实现内容决定。可以在e-cology流程监控功能上，添加对工作流数据输出接口的调用，以实现选择流程范围，手动与外部系统进行数据交换。2.3.2 在外部系统选择输出范围手动输出指外部系统在相应功能中，通过对e-cology流程列表数据读接口的调用，获取并选择流程范围，或通过其他方式得到流程id，再通过e-cology流程数据读接口，获取到具体流程的数据，从而实现e-cology工作流数据输出。输出后的流程数据处理，由外部系统自行实现。三、技术方案定义e-cology工作流接口的技术实现。3.1技术实现e-cology工作流接口被部署为web service，数据流被封装为soap消息以xml格式通过http协议在企业内外部网络中传递，不受平台和开发语言的限制，掌握高级编程语言的开发人员可以方便地生成本地代理程序远程调用ecology工作流接口而不用关心数据序列化和反序列化的细节，最大程度地降低了复杂性。3.2接口应用范围本文档定义的工作流接口，即可用于与其他异构系统数据交换，也可用于与其他e-cology系统的数据交换。当外部系统为其他e-cology系统时，即形成了多套e-cology系统的分布式部署，通过工作流输入输出接口，实现多套e-cology系统间的数据流转。3.3 交换数据范围通过本工作流输入输出接口传递的交接数据，全部为文本型数据。e-cology系统与外部系统中的id/名称数据，在通过本接口交接时，均以名称文本的形式传递，不考虑跨系统通过id转换为名称的问题。3.4 附件传递从外部系统获取附件至e-cology系统，需要得到外部系统发送文件的url地址，e-cology系统通过url直接获取文件数据。从e-cology系统传送附件至外部系统，需要传递e-cology系统发送文件的url地址，外部系统通过url直接获取文件数据。四、接口设计定义e-cology工作流输入输出接口的功能范围。4.1流程创建接口 由e-cology系统实现，被外部系统调用，用以外部系统触发e-cology系统内的流程创建。4.1.1 类图weaver.soa.workflow.request:工作流接口命名空间（namespace or package）RequestService:工作流接口。提供了创建工作流数据的方法createRequest(requestInfo),该方法返回创建完成的表单或单据的id。RequestInfo：表单(或单据)信息，包括创建人id、工作流id、主表字段信息（Property对象数组）、明细表信息（DetailTableInfo对象）和流转日志信息（RequestLog对象）。Property：主表字段信息,包含了字段名和字段值。DetailTableInfo：明细表信息,它包含了一个DetailTable对象列表，列表里的每个元素代表一张明细表。DetailTable：明细表数据，它由Row对象数组构成，数组里的每个元素代表明细表中的一行数据。Row：行数据。它由Cell数组构成，数组里的每个元素代表某一行中的一个单元格数据。Cell：单元格数据，包含了字段名和字段值。RequestLog：流转日志信息。它由Log对象数组构成，数组中的每个元素代表一次提交记录。（注：流程创建接口不需要设置RequestLog信息）Log：提交记录。包含操作人、操作时间、意见等信息。4.1.2 顺序图client proxy:通过开发工具(java,c#，delphi等)生成的本地代理类。开发人员通过调用本地代理类的createRequest方法，由代理类负责把调用转化为soap request message来实现对ecology RequestService的远程调用，对开发者而言就像在本地直接调用RequestService一样。Web service engine: ecology web服务引擎，处理代理类发送的请求并转化为对RequestService的调用4.2流程修改接口由e-cology系统实现，被外部系统调用，用以外部系统修改e-cology系统内的流程表单数据。4.2.1 类图未实现，待补充。4.2.2 顺序图未实现，待补充。4.3流程操作接口由e-cology系统实现，被外部系统调用，用以实现外部系统对e-cology系统内的流程操作。4.3.1 类图未实现，待补充。4.3.2 顺序图未实现，待补充。4.4流程写接口由e-cology系统定义并调用，由外部系统开发实现，用以实现e-cology系统对外部系统的数据操作。4.4.1 类图未实现，待补充。4.4.2 顺序图未实现，待补充。4.5流程列表读接口由e-cology系统实现，被外部系统调用，用于外部系统获取e-cology系统内相应条件的流程列表。4.5.1 类图weaver.soa.workflow.request:工作流接口命名空间（namespace or package）RequestBaseService:工作流接口。提供了获取流程列表的方法,这些方法返回表单（或单据）数组。方法说明： getALLRequest:获取所有的表单（单据）列表 getRequestByWorkflowId:获取指定工作流的表单（或单据） getRequestByWorkflowIdandDate:获取指定日期后某工作流的表单（或单据） getRequestByDate: 获取指定日期后的表单（或单据） getAllEndRequest:获取所有已归档的表单（或单据） getEndRequestByWorkflowId: 获取指定工作流的已归档表单（或单据） getEndRequestByWorkflowIddandDate: 获取指定日期后某工作流的已归档表单（或单据） getEndRequestByDate: 获取指定日期后的已归档表单（或单据） getRequestByCreatorId: 获取指定用户创建的表单（或单据） getRequestByCreatorIdandDate: 获取指定日期后某用户创建的表单（或单据） getPendingRequestByUserId:获取指定用户待办的表单（或单据）RequestBase:表单（或单据）基本信息。4.5.2 顺序图client proxy:通过开发工具(java,c#，delphi等)生成的本地代理类。开发人员通过调用本地代理类的getALLRequest、getRequestByWorkflowId、getRequestByWorkflowIdandDate等方法，由代理类负责把调用转化为soap request message来实现对ecology RequestBaseService的远程调用，对开发者而言就像在本地直接调用requestBaseService一样。Web service engine: ecology web服务引擎，处理代理类发送的请求并转化为对RequestBaseService的调用4.6流程数据读接口由e-cology系统实现，被外部系统调用，用于外部系统获取e-cology系统内相应流程的流程数据。4.6.1 类图说明：上图描述了“流程数据读接口”的实现类及关联关系。weaver.soa.workflow.request:工作流接口命名空间（namespace or package）RequestService:工作流接口。提供了获取工作流数据的方法getRequest,该方法返回RequestInfo对象。RequestInfo：表单(或单据)信息，包括主表字段信息（Property对象数组）、明细表信息（DetailTableInfo对象）和流转日志信息（RequestLog对象）。Property：主表字段信息,包含了字段名和字段值。DetailTableInfo：明细表信息,它包含了一个DetailTable对象列表，列表里的每个元素代表一张明细表。DetailTable：明细表数据，它由Row对象数组构成，数组里的每个元素代表明细表中的一行数据。Row：行数据。它由Cell数组构成，数组里的每个元素代表某一行中的一个单元格数据。Cell：单元格数据，包含了字段名和字段值。RequestLog：流转日志信息。它由Log对象数组构成，数组中的每个元素代表一次提交记录。Log：提交记录。包含操作人、操作时间、意见等信息。4.6.2 顺序图说明：上图描述了外部系统对“流程数据读接口”的调用过程。client proxy:通过开发工具(java,c#，delphi等)生成的本地代理类。开发人员通过调用本地代理类的getRequest方法，由代理类负责把调用转化为soap request message来实现对ecology RequestService的远程调用，对开发者而言就像在本地直接调用RequestService一样。Web service engine: ecology web服务引擎，处理代理类发送的请求并转化为对RequestService的调用五、接口应用设计定义e-cology工作流输入输出接口在e-co