工作流平台接口说明书V1..doc

工作流平台接口说明书 v1.1SPDB - 1 - 上上 海海 浦浦 东东 发发 展展 银银 行行 工作流平台接口说明书工作流平台接口说明书 v1.1v1.1 工作流平台接口说明书 v1.1SPDB - 2 - 文档版本记录 版本号版本号编写日期编写日期更改内容更改内容 1.02004-12-29初始稿 1.12004-12-301增加“内部接口 输出接口查询工作流流程接口” 2增加“系统外部接口输出接口通知平台接口” 工作流平台接口说明书 v1.1SPDB - 3 - 目目 录录 1 1系统内部接口系统内部接口 - 3 - 1.1术语定义 - 3 - 1.2输入接口 - 3 - 1.2.1用户认证接口- 3 - 1.2.2用户信息同步接口- 4 - 1.2.3机构信息同步接口- 4 - 1.2.4同步确认接口- 4 - 1.2.5启动工作项接口- 5 - 1.2.6提交工作项接口- 5 - 1.2.7查询工作项列表接口- 5 - 1.3输出接口 - 5 - 1.3.1用户变更通知接口- 6 - 1.3.2执行应用程序接口- 6 - 1.3.3查询工作项详情接口- 6 - 1.3.4删除工作项接口- 7 - 2 2系统外部接口系统外部接口 - 7 - 2.1输入接口 - 7 - 2.1.1工作项状态查询接口- 7 - 3 3配置设计配置设计 - 8 - 3.1业务规则 - 8 - 3.1.1业务流程走向规则- 8 - 3.1.2优先级规则- 8 - 3.1.3工作项分配规则- 8 - 3.2参数文件 - 9 - 3.3用户配置 - 9 - 3.4出错意外处理机制 - 9 - 3.4.1接口出错处理- 9 - 输入接口- 9 - 输出接口- 9 - 工作流平台接口说明书 v1.1SPDB - 4 - 1 1系统内部接口系统内部接口 1.11.1术语定义术语定义 请求请求 XMLXML 是指在接口通讯时，发起方向接收方发送的请求数据，此数据格式为 Xml。 响应响应 XMLXML 是指在接口通讯时，接收方发送的响应数据，此数据格式为 Xml。 数据数据 XMLXML 指在请求或响应 Xml 中包含的数据信息。通常此数据信息是加密的，数据信息格式为 Xml 1.21.2输入接口输入接口 输入接口指实际交互中业务系统、影像系统主动发起，通用授权系统、工作流系统被 动提供服务的接口。主要的输入接口如下表所示： 接口名接口名发起方发起方接收方 用户认证业务系统、影像通用授权 用户信息同步影像通用授权 机构信息同步影像通用授权 同步确认影像通用授权 启动工作项业务系统、影像工作流服务 提交工作项业务系统、影像工作流服务 查询工作项列表影像工作流服务 .1用户认证接口用户认证接口 接口功能描述：接口功能描述： 工作流平台接口说明书 v1.1SPDB - 5 - 当其它系统接收到工作流的执行请求时，需要对请求的用户进行验证，确保用户已登 录过。 接口时序图：接口时序图： 接口规范：接口规范： 接口技术模式：接口技术模式： .2用户信息同步接口用户信息同步接口 接口功能描述：接口功能描述： 其它系统请求通用授权系统同步用户信息。 接口时序图：接口时序图： 接口规范：接口规范： 接口技术模式：接口技术模式： .3机构信息同步接口机构信息同步接口 接口功能描述：接口功能描述： 其它系统请求通用授权系统同步机构信息。 接口时序图：接口时序图： 接口规范：接口规范： 接口技术模式：接口技术模式： .4同步确认接口同步确认接口 接口功能描述：接口功能描述： 其它系统向通用授权系统发送用户相关信息已同步消息。 接口时序图：接口时序图： 接口规范：接口规范： 接口技术模式：接口技术模式： 工作流平台接口说明书 v1.1SPDB - 6 - .5启动工作项接口启动工作项接口 接口功能描述：接口功能描述： 其它系统要求工作流系统启动工作项。 接口时序图：接口时序图： 接口规范：接口规范： 接口技术模式：接口技术模式： .6提交工作项接口提交工作项接口 接口功能描述：接口功能描述： 其它系统向工作流系统提交工作项，请求下一步工作。有两种提交方式： （1）SOAP （2）HTTP POST 接口时序图：接口时序图： 接口规范：接口规范： 接口技术模式：接口技术模式： .7查询工作项列表接口查询工作项列表接口 接口功能描述：接口功能描述： 其它系统要求工作流系统查询工作项信息。 接口时序图：接口时序图： 接口规范：接口规范： 接口技术模式：接口技术模式： 1.31.3输出接口输出接口 输出接口指实际交互中通用授权系统、工作流系统主动发起，影像系统，业务系统被 工作流平台接口说明书 v1.1SPDB - 7 - 动提供服务或数据的接口。主要的输入接口如下表所示： 接口名接口名发起方发起方接收方接收方 用户信息变更通知通用授权影像 执行应用程序工作流服务影像，业务系统 查询工作项详情工作流服务影像，业务系统 删除工作项工作流服务影像，业务系统 .1用户变更通知接口用户变更通知接口 接口功能描述：接口功能描述： 工作流系统通知其它系统，用户信息已变更。 接口时序图：接口时序图： 接口规范：接口规范： 接口技术模式：接口技术模式： .2执行应用程序接口执行应用程序接口 接口功能描述：接口功能描述： 工作流系统调用其它应用程序，以进行具体的业务操作。 接口时序图：接口时序图： 接口规范：接口规范： 接口技术模式：接口技术模式： .3查询工作项详情接口查询工作项详情接口 接口功能描述：接口功能描述： 工作流系统调用其它应用程序，以进行具体的业务查询。 接口时序图：接口时序图： 接口规范：接口规范： 工作流平台接口说明书 v1.1SPDB - 8 - 接口技术模式：接口技术模式： .4删除工作项接口删除工作项接口 接口功能描述：接口功能描述： 工作流系统调用其它应用程序，以进行具体的业务删除。 接口时序图：接口时序图： 接口规范：接口规范： 接口技术模式：接口技术模式： .5查询工作流流程接口查询工作流流程接口 接口功能描述：接口功能描述： 工作流系统调用其它应用程序，查询工作流系统所调用过的流程信息。主要用于恢复 工作流信息。 接口时序图：接口时序图： 接口规范：接口规范： 接口技术模式：接口技术模式： 2 2系统外部接口系统外部接口 2.12.1输入接口输入接口 输入接口指实际交互中外部渠道系统主动发起，工作流系统被动提供服务的接口。主 要的输入接口如下表所示： 接口名接口名发起方发起方接收方接收方 工作项状态查询外部渠道系统工作流系统 工作流平台接口说明书 v1.1SPDB - 9 - .1工作项状态查询接口工作项状态查询接口 接口功能描述：接口功能描述： 外部渠道系统请求工作流系统查询工作项状态。 接口时序图：接口时序图： 接口规范：接口规范： 接口技术模式：接口技术模式： 2.22.2输出接口输出接口 输出接口指实际交互中工作流系统主动发起，外部系统被动提供服务或数据的接口。 主要的输出接口如下表所示： 接口名接口名发起方发起方接收方接收方 通知平台接口工作流服务通知平台通知平台 3 3配置设计配置设计 3.13.1业务规则业务规则 所有的业务规则定义在 Biztalk 业务规则编辑器中，以 XML 作为事实参数。 .1业务流程走向规则业务流程走向规则 XmlXml 事实参数事实参数 规则定义规则定义 规则结果体现规则结果体现 在设计流程时选择相应的规则，由此决定流程走向。 工作流平台接口说明书 v1.1SPDB - 10 - .2优先级规则优先级规则 XmlXml 事实参数事实参数 请参见业务流程走向规则 词汇定义词汇定义 规则定义规则定义 规则结果体现规则结果体现 规则结果表现为工作项的优先级值，设置在表 WorkflowInstance 的优先级字段中。 .3工作项分配规则工作项分配规则 XmlXml 事实参数事实参数 请参见业务流程走向规则 词汇定义词汇定义 请参见优先级规则 规则定义规则定义 规则结果体现规则结果体现 工作项分配时所用的业务级别。 3.23.2参数文件参数文件 3.33.3用户配置用户配置 3.43.4出错意外处理机制出错意外处理机制 .1接口出错处理接口出错处理 接口出错处理包