SZDBZ 17.10-2008 深圳市电子政务应用服务规范 第10部分：业务流程服务接口规范

L77深圳市电子政务应用服务规范第10部分：业务流程服务接口规范深圳市质量技术监督局发布I I 2规范性引用文件 13术语和定义 14状态定义 4.1流程定义状态 2 2 5.1流程服务总体概述 35.2流程模型服务 45.3流程实例服务 65.4应用调用服务 145.5流程互操作服务 5.6流程管理服务 185.7异常约定 20参考文献 22ⅡSZDB/Z17-2008《电子政务应用服务规范》目前分为10个部分：——第1部分《总则》——第2部分《应用系统分类及代码规范》——第3部分《应用系统描述规范》——第4部分《组织身份模型数据规范》——第5部分《应用服务运行管理框架规范》——第6部分《组织身份服务接口规范》——第7部分《访问控制服务接口规范》——第8部分《单点登录服务接口规范》—第9部分《电子表单服务接口规范》——第10部分《业务流程服务接口规范》本部分为SZDB/Z17-2008的第10部分。术规范的编写原则对本部分内容进行扩充。本技术规范文件由深圳市信息化领导小组办公室、深圳市福田区信息中心提出。本技术规范文件由深圳市信息化领导小组办公室归口。有限公司共同起草。本技术规范文件主要起草人：贾兴东、陈朝祥、张雁、高新辉、王克照、石礼洪、杨海波、王姝、张焕焕、刘用军、梁文龙等。本技术规范文件为首次发布。深圳市电子政务应用服务规范第10部分：业务流程服务接口本部分定义了业务流程服务的基本概念，规定了流程定义、流程实例和活动实例的基本状态，规范操作服务接口、流程管理服务接口五部分内容，为应用系统提供统一的流程服务。本部分主要用于深圳市各级党政机关的信息系统规划与建设，以及电子政务成商、软件开发商和监理单位进行信息化规划、建设。适用于规划与开发业务用业务流程进行任务的手工和自动办理，实现应用系统和业务流程之间的互相下列文件中的条款通过本部分的引用而成为本部分的条款。凡是注日期的引用文件，其随后所有的修改单(不包括勘误的内容)或修订版均不适用于本部分，然而，鼓励根据本部分达成协议的各方研究是否可使用这些文件的最新版本。凡是不注日期的引用文件，其最新版本适用于本部分。GB/T19487-2004电子政务业务流程设计方法通用规范SZDB/Z17.1-2008电子政务应用服务规范第1部分：总则SZDB/Z17.7-2008电子政务应用服务规范第7部分：访问控制服务接口规范为方便查询、显示以及权限管理，对具有相同或相似业务功能的流程定节点对应一个流程定义，资源节点可以递归包含，形成树状结构。对资源节点的操作请参照本规范第7部分中“4.2.2资源管理”。流程定义版本(version):用来区分同一个流程定义在不同时间内的不同状态，保存在流程服务器上定，版本号是一个0或正整数，从0开始，以递增1为一个新版本号。流程定义(ProcessDefinition):是实现一个业务流转过程的自动化处理模型，包括活动及活动之间关系的网、过程和单独活动(参与者、应用)开始和结束的约定，如发文流程。流程实例(ProcessInstacnce):一个流程定义过程单次执行的表示，如一份具体的发文。活动实例(ActivityInstance):一个流程定义中活动单次执行的表示。它属于一个流程实例，在某个时刻，一个流程实例可同时有若干个ActivityInstance,但一个ActivityInstance只能与一个ProcessInstance相关。工作项(WorkItem):活动实例对应的工作列表中的项。一个活动实例中有一个以上的工作项用户。流程实例数据(InstanceVariable):2包含单个流程实例中的所有流程相关数据的集合，如表单数据、意见、正文、附件、签名等。4状态定义4.1流程定义状态1.Edit:编辑状态，不能创建、运行流程实例，已有的流程实例可以被查询。2.Debug:调试状态，可以创建、运行流程实例，流程实例可以被查询。但在调试状态，创建和运行的流程实例均带有debug标记，便于以后清除。3.Running:正常执行状态，可以创建、运行流程实例，流程实例可以被查询。4.Suspended:挂起状态，不能再创建新的流程实例，已有的流程实例可以继续执行。5.Freeze:冻结状态，不能创建新的流程实例，已有的流程实例也不能继续执行。6.Hide:隐藏状态，不能创建新的流程实例，已有的流程实例不能继续执行，而且隐藏状态下所有的流程实例均不能被查询和显示。流程实例查询查询√√√√√√√√√√√√√√√√√√1.open-流程实例是可以执行的2.open.running-流程实例正在执行3.open.notRunning-流程实例暂时不能执行4.open.notRunning.notStarted-流程实例已经创建，但还没有启动5.open.notRunning.suspended-流程实例处于挂起状态6.closed-流程实例正常执行完毕7.closed.aborted-流程实例被用户选择跳过8.closed.terminated-流程实例被用户选择终止9.pleted-流程实例正常执行完毕如图1所示。35业务流程服务流程服务器流程客户端调用应用管理监控如图2所示，业务流程服务的核心组件是流程服务器，流程服务器可以提供五类服务：流程模型服务、流程实例服务、应用调用服务、流程互操作服务和流程管理服务。流程模型服务：是对流程模型的管理服务。流程模型提供对业务流程的形式工具输入或输出定义好的流程模型，以及图形化展示。流程实例服务：是操作并控制流程实例、活动实例运行和状态的服务。本类4的实例数据。各应用系统主要使用的是本类服务，包括执行流程的客户端。统间的调用，可在流程服务的各环节调用其他应用程序，实现业务流程贯通。取流程运行的日志信息，导出或迁移流程定义等。是对流程模型的管理服务。流程模型提供对业务流程的形式化描述，通定义好的流程模型，以及图形化展示。包括部署、删除、更新、查找、获取流程定义、控制流程定义版本、获取和改ProcessDefinitionService.deployProcessDefi服务说明参数名称参数说明String类型，流程定义所属的资源节点UID。NoSuchElementExceptProcessDefinitionExc如果部署失败，则抛出此异常。返回ProcessDefinition对象，是经过流程服务器处理的ProcessDefinition对象，具有uid和版本号。备注ProcessDefinitionService.updateProcessDefi服务说明参数名称参数说明义对象需要有类型，流程定义版本，从0开始，如果版本为-1,则更新最高版本的流程定义。NoSuchElementExcept如果流程定义或相应版本不存在，则抛出此异常。ProcessDefinitionExc如果更新失败，则抛出此异常。返回ProcessDefinition对象，是经过流程服务器处理的ProcessDefinition对象，具有uid和版本号。备注服务名称ProcessDefinitionService.服务名称ProcessDefinitionService.deleteProcessDefinition5服务说明删除指定版本的流程定义。参数名称参数说明String类型，流程定义唯一标识。NoSuchElementExcept如果流程定义不存在，则抛出此异常。ProcessDefinitionExc如果删除失败，则抛出此异常。无备注ProcessDefinitionService.getProcessDefinitio服务说明获取指定流程定义的状态信息。参数名称参数说明String类型，流程定义唯一标识。int类型，指定流程定义的版本号，从0开始。NoSuchElementExceptString类型，返回指定流程定义的状态值，参见“4.1流程定义状态”。备注ProcessDefinitionService.changeProcessDefinitio服务说明改变指定流程定义的状态。参数名称参数说明String类型，流程定义唯一标识。int类型，流程定义的版本号，从0开始。String类型，新状态，参见“4.1流程定义状态”。NoSuchElementExcept此异常。无备注ProcessDefinitionService.searchProcessDefin服务说明根据指定的范围、状态、筛选条件，获取流程定义列表。参数名称参数说明流程定义资源节点的UID,用流程定义资源根节点的String类型，流程定义状态值。Null表示所有状态。6String类型，查询条件，不包含where字符串。查询条件的格式应符合ANSISQL92中件的要求。NoSuchElementExcept如果查询条件错误，或执行查询错误，则抛出此异常返回ProcessDefinition对象数组。备注ProcessDefinitionService.getProcessDefi服务说明根据流程定义的UID,获取最新版本的流程定义。参数说明String类型，流程定义唯一标识。NoSuchElementExcept如果指定流程定义对象不存在，或版本不存在，则抛出此异常。返回ProcessDefinition对象。备注ProcessDefinitionService.getProcessDefinitionOneV服务说明参数名称参数说明String类型，流程定义唯一标识。int类型，流程定义的版本号，从0开始。NoSuchElementExcept此异常。返回ProcessDefinition对象。备注ProcessDefinitionService.getProcessDefinitionAl1V服务说明根据流程定义的UID,获取流程定义的所有版本。参数名称参数说明String类型，流程定义唯一标识。NoSuchElementExcept如果指定流程定义对象不存在，则抛出此异常。返回ProcessDefinitions对象数组。备注应用系统主要使用的是本类服务，包括执行流程的客户端。包括创建并启动流程实例、删除流程实例、获取及改变流程实例的状态、获取状态、获取工作项列表、改变工作项状态、重新分配工作项等。7ProcessInstanceService.getProcessIn服务说明根据指定的流程实例的UID,获取流程实例对象。参数名称参数说明String类型，指定流程实例唯一标识。NoSuchElementExcept如果没有对应的流程定义，则抛出此异常。返回ProcessInstance对象。备注ProcessInstanceService.createProcessIn服务说明最高版本的流程定义实例。参数名称参数说明String类型，指定流程定义唯一标识。int类型，指定流程定义的版本号，从0开始，如果为-1表示自动选择处于可运行状态的最高版本。如果创建流程实例失败，则抛出此异常NoSuchElementExcept如果没有对应的流程定义，则抛出此异常。返回已创建的ProcessInstance对象。备注ProcessInstanceService.createProcessIn服务说明创建指定流程定义的流程实例，并指定新建流程实例的起始节点。参数名称参数说明String类型，指定流程定义唯一标识。String类型，流程定义活动节点唯一标识。如果创建流程实例失败，则抛出此异常NoSuchElementExcept如果没有对应的流程定义，则抛出此异常。返回已创建的ProcessInstance对象。备注ProcessInstanceService.createSubProcessIn服务说明参数名称参数说明String类型，指定主流程实例唯一标识。String类型，指定要创建的流程定义唯一标识。Int类型，指定子流程定义的版本号8如果创建流程实例失败，则抛出此异常NoSuchElementExcept返回已创建的ProcessInstance对象。备注例的状态。ProcessInstanceService.deleteProcessIn服务说明删除指定的流程实例，如果存在子流程，则同时删除关联的子流程。参数名称参数说明String类型，指定要删除流程实例唯一标识。如果创建流程实例失败，则抛出此异常NoSuchElementExcept无备注ProcessInstanceService.getProcessInstanc服务说明参数名称参数说明String类型，指定当前流程实例唯一标识。NoSuchElementExcept如果根据参数获得对象为空，则抛出此异常。备注ProcessInstanceService.changeProcessInstanc服务说明根据指定的流程实例唯一标识，改变流程实例状态。参数名称参数说明String类型，指定要改变状态的流程实例唯一标识。如果流程实例变更状态失败，则抛出此异常NoSuchElementExcept如果根据参数获得对象为空，则抛出此异常。无备注ProcessInstanceService.changeProcessInstanceV服务说明改变指定流程实例所依赖的流程定义版本号属性。参数名称参数说明String类型，指定要修改流程实例唯一标识。9int类型，用于变更的流程定义版本号。如果改变流程实例失败，则抛出此异常NoSuchElementExcept如果根据参数获得对象为空，则抛出此异常。无备注ProcessInstanceService.searchProcessIns服务说明参数名称参数说明String数组类型，要查找的流程定义唯String类型，查询条件，不包含where字符串。查询条件的格式应符合ANSISQL92中NoSuchElementExcept如果流程实例查找过程失败，则抛出此异常如果查找条件错误引起查找失败，则抛出此异常备注ProcessInstanceService.getActivityIn服务说明根据活动实例唯一标识，获得指定的活动实例对象。参数名称参数说明String类型，指定的活动实例唯一标识。NoSuchElementExcept如果根据参数获得对象为空，则抛出此异常。返回ActivityInstance对象。备注ProcessInstanceService.getNextActi服务说明获得指定活动的所有直接后续活动。参数名称参数说明String类型，指定的活动实例唯一标识。NoSuchElementExcept如果根据参数获得对象为空，则抛出此异常。返回所有后续活动的唯一标识数组。备注ProcessInstanceService.getPreviousActi服务说明获得指定活动的所有前驱活动。参数名称参数说明String类型，指定的活动实例唯一标识。NoSuchElementExcept如果根据参数获得对象为空，则抛出此异常。返回所有前驱活动的唯一标识数组。备注ProcessInstanceService.getActivityIns服务说明获得指定流程实例不同状态下的活动实例。参数名称参数说明String类型，指定流程实例唯一标识。String数组，活动实例状态。Null表示NoSuchElementExcept返回ActivityInstance对象数组。备注ProcessInstanceService.getSubProcessIns服务说明获得流程实例所包含的子流程实例。参数名称参数说明String类型，指定的流程实例唯一标识。NoSuchElementExcept返回ProcessInstance对象数组。备注ProcessInstanceService.getParentProcessIn服务说明获得流程实例的父流程实例。参数说明String类型，指定的流程实例唯一标识。NoSuchElementExcept返回ProcessInstance对象。备注ProcessInstanceService.getActivityInstanc服务说明获取指定活动实例的状态。参数名称参数说明String类型，指定当前活动实例唯一标识。NoSuchElementExcept备注ProcessInstanceService.changeActivityInstanc服务说明参数说明String类型，要改变的状态流程实例唯一标识。如果流程实例变更状态失败，则抛出此异常NoSuchElementExcept无备注ProcessInstanceService.rollbackToAc服务说明动实例已经处于运行状态，则不能被回收；如果是回退，则退回到上一前驱活动。参数名称参数说明String类型，要回退的活动实例唯一标识。rollbackToActivityDString类型，要回退到的活动唯一标识。如果活动实例回退失败，则抛出此异常。NoSuchElementExcept如果根据参数获得对象为空，则抛出此异常。无备注ProcessInstanceService.getWo服务说明获取流程工作列表，能够分页显示。参数名称参数说明String数组，要查找的流程定义唯一标识范围。NullString数组，参与者列表。Null表示所String类型，查询条件，不包含where字符串。查询条件的格式应符合ANSISQL92中int类型，每页显示的数目。int类型，显示第几页。NoSuchElementExcept如果查找条件错误引起查找失败，则抛出此异常备注ProcessInstanceService.updateWo服务说明参数名称参数说明WorkItem对象，用于更新的工作项对象。NoSuchElementExcept如果根据参数获得对象为空，则抛出此异常。无备注工作项的状态，例如：待阅：此工作项还没有查看。已阅：此工作项已经由收件人打开查看，但还没有开始办理。暂存：此工作项已经由收件人查看并修改、保存，尚未办理完。结束：此工作项已经办理完成。ProcessInstanceService.finishWo服务说明结束指定的工作项。参数名称参数说明String数组，要结束的工作项唯一标识数组。String类型，工作项当前办理人唯一标识。String类型，工作项代理办理人唯一标识。如果结束工作项失败，则抛出此异常。NoSuchElementExcept如果根据参数获得对象为空，则抛出此异常。无备注如果代理人员不为空，则工作项标记为由代理人结束ProcessInstanceService.getInstanceVa服务说明获取指定流程实例的实例数据。参数说明String类型，流程实例唯一标识。NoSuchElementExcept返回InstanceVariable对象。备注ProcessInstanceService.setInstanceVa服务说明设置指定流程实例的实例数据。参数名称参数说明String类型，流程实例唯一标识。NoSuchElementExcept无备注ProcessInstanceService.assignParti服务说明为指定流程实例的活动指派参与者。参数名称参数说明String类型，流程实例唯一标识。String类型，活动定义唯一标识。如果指派参与者失败，则抛出此异常。NoSuchElementExcept如果根据参数获得对象为空，则抛出此异常。无备注参与者的工作项是自动产生的，不需要用API创建。ProcessInstanceServi服务说明运行指定的活动实例。参数名称参数说明String类型，要运行的活动实例唯一标识。如果活动实例运行失败，则抛出此异常。NoSuchElementExcept如果根据参数获得对象为空，则抛出此异常。无备注ProcessInstanceServi服务说明以指定路径运行活动实例。参数名称参数说明String类型，要运行的活动实例唯一标识。String类型，活动实例运行的路径名称。如果活动实例运行失败，则抛出此异常。NoSuchElementExcept如果根据参数获得对象为空，则抛出此异常。无备注ProcessInstanceService.st服务说明启动流程实例。参数名称参数说明String类型，要启动的流程实例唯一标识。如果活动实例启动失败，则抛出此异常。NoSuchElementExcept无备注ProcessInstanceService.fi服务说明正常结束流程实例。如果结束的是子流程，就返回主流程。参数名称参数说明String类型，要结束的流程实例唯一标识。如果活动实例结束失败，则抛出此异常。NoSuchElementExcept如果根据参数获得对象为空，则抛出此异常。无备注5.4应用调用服务是调用其他应用程序实现任务自动化的服务。本类服务来实现流程服务和各应用系统间的调用，可在流程服务的各环节调用其他应用程序，实现业务流程贯通。应用调用服务通常用来调用其他应用程序执行特定的任务，如调用PDF生成程序生成PDF文档、调用打印服务器打印文档。调用打印服务器打印文档。应用调用服务应用程序应用程序应用图3应用调用示意图应用调用服务通过“应用代理”组件来完成调用。应用调用服务必须提供“双向”服务，既可以从流程服务调用应用程序，也可以从应用程序调用流程服务。应用调用服务同时提供更新数据的功能，包括应用程序更新流程服务数据以及流程服务更新应用程序数据。AppInvocationService.invokeAppS服务说明给流程服务器。本调用方式为同步调用，即流程服务器的线程将阻塞，等待返回结果。参数名称参数说明String类型，流程实例唯一标识String类型，工作项唯一标识int类型，应用程序执行的基本方式：1、后台执行，缺省的方式。2、前台执行。3、批量执行。NoSuchElementExceptAppInvocationExcept如果调用失败，无法返回对象，则抛出此异常返回RelevantData对象，包含应用程序返回给流程服务器备注AppInvocationService.invokeAppAs服务说明的相关参数信息传递给应用程序。果。参数名称参数说明String类型，“应用代理”组件名称。String类型，要执行的应用程序名称。String类型，流程实例唯一标识String类型，工作项唯一标识int类型，应用程序执行的基本方式：4、后台执行，缺省的方式。5、前台执行。1.批量执行。NoSuchElementExcept如果根据参数获得对象为空，则抛出此异常。AppInvocationExcept如果调用失败，无法返回对象，则抛出此异常无备注AppInvocationService.getAsyncInvo服务说明检查异步调用应用程序的情况，如果执行完成，返回异步调用的结果。参数名称参数说明String类型，“应用代理”组件名称。String类型，要执行的应用程序名称。String类型，流程实例唯一标识String类型，工作项唯一标识NoSuchElementExceptAppInvocationExcept如果返回对象为空或调用错误，则抛出此异常返回RelevantData对象，包含应用程序返回给流程服务器备注AppInvocationService.requestAppSt服务说明参数名称参数说明String类型，“应用代理”组件名称。String类型，要执行的应用程序名称。String类型，流程实例唯一标识String类型，工作项唯一标识NoSuchElementExcept如果根据参数获得对象为空，则抛出此异常。备注AppInvocationService.terminate服务说明参数名称参数说明String类型，流程实例唯一标识String类型，工作项唯一标识NoSuchElementExceptAppInvocationExcept如果强制停止应用程序时发生错误，则抛出此异常无备注是流程服务之间相互通讯和调用的服务。本类服务实现流程服务器之间的协同工作。服务说明参数名称参数说明NoSuchElementExcept如果在请求服务的过程中发生异常，则抛出此异常。备注服务说明塞执行直到匹配的消息的到达。参数名称参数说明boolean类型，是否创建实例，true或String类型，调用的名称。String类型，执行的调用操作。String类型，指向第三方服务的标示。String类型，调用执行的WSDL接口。NoSuchElementExcept如果根据参数获得对象为空，则抛出此异常。如果在请求服务的过程中发生异常，则抛出此异常。返回xml字符串。备注服务说明发送消息给第三方服务来应答通过receive活动所接收到的消息。re服务的组合对应WSDLportType上定义的请求-响应操作。参数名称参数说明String类型，调用的名称。String类型，执行的调用操作。String类型，指向第三方服务的标示。String类型，调用执行的WSDL接口。NoSuchElementExcept如果根据参数获得对象为空，则抛出此异常。如果在请求服务的过程中发生异常，则抛出此异常。返回xml字符串。备注服务说明用新的数据来更新变量的值。参数名称参数说明String类型，赋值的来源。String类型，赋值的目标。String类型，赋值的变量。Stirng类型，赋值的变量值。NoSuchElementExcept如果根据参数获得对象为空，则抛出此异常。如果在请求服务的过程中发生异常，则抛出此异常。无备注5.6流程管理服务是对流程服务器进行监控、管理的服务。本类服务可以启动、停止流程服务器，获取流程运行的日志信息，导出或迁移流程定义等。ManagementService.startProcessSer服务说明量，设置流程执行的环境。参数名称参数说明NoSuchElementExcept无备注ManagementService.stopProcessSer服务说明象池，销毁流程实例和流程定义对象，回收资源。参数名称参数说明NoSuchElementExcept如果根据参数获得对象为空，则抛出此异常。如果停止流程服务器失败，则抛出此异常。无备注Management