常用的流程引擎API开发调用接口大全-工作流引擎设计

第1章:            程序调用开发接口

1.1:  接口说明

l  所谓的驰骋工作流引擎的接口,在BP.WF.Dev2Interface.*上面的静态方法,前台页面通过这些静态方法通过页面于操作者提供交互数据功能交互。

l  Port_* 开头的方法都是组织结构相关的操作,比如:登录、登出、发送消息。

l  DB_*的都是提供数据列表的接口,比如:发起列表、待办列表、在途列表、完成列表等。

l  驰骋BPM的发起、待办、在途菜单功能都是通过这个静态方法提供的BP.WF.Dev2Interface.DB_*接口生成的列表。

l  驰骋的工作处理器创建工作ID、发送、退回、移交、删除、加签、会签等操作也是调用BP.WF.Dev2Interface.Node_*通过流程接口对流程的操作比如:流程的删除、回滚、撤销、冻结、取消冻结等流程的操作都是操作的BP.WF.Dev2Interface.Flow_*开发接口。

l  WorkOpt_* 开头的方法,都是工作流引擎部件的代码,比如在退回窗口上,获取可以退回的节点列表,设置指定的节点处理人。

l  我们在流程属性里有一个接口,请参考如下图:

 

1.2:  菜单接口

获取数据是如何根据您自己的需要,通过CCBPM的接口获取想要的数据。

比如:发起流程,待办工作,在途工作。

类名:BP.WF. Dev2Interface.DT_*  在当前的静态方法中一般的返回的都是datatable数据集合类型,可以将它转化为json以方便前台生成列表。

 

发起列表:BP.WF. Dev2Interface.DB_GenerCanStartFlowsOfDataTable

发起列表是当前登录人员,或者指定人员可以发起的流程列表,返回的数据源包含 No,Name两个列,分别是流程模版编号,流程模版名称,可以连接到工作处理器 MyFlow.htm?FK_Flow=001 上让用户可以直接发起流程。

系统提供的功能页面:请参考/WF/Start.htm

 

待办列表:BP.WF. Dev2Interface.DB_ GenerEmpWorksOfDataTable

就是当前操作员的待办,需要他解决的问题,待办列表返回的是WorkID流程实例ID,Title流程实例标题,FK_Flow流程模版编号,FlowName流程模版名称等列,更多的信息请参考(Select * from WF_EmpWorks的视图)。开发者可以根据这个数据源生成待办数据列表,连接到MyFlow.htm,比如MyFlow.htm?WorkID=10112&FK_Flow=002&FK_Node=203

系统提供的功能页面:请参考/WF/Todolist.htm

 

在途列表: BP.WF. Dev2Interface.DB_ GenerRuningOfDataTable

顾名思义在途就是未完成的工作,并且我参与了,比如,我发起流程,他就是我的在途,我审批过的流程。对于在途流程的集合返回的列有,WorkID, Title 等。连接到工作查看器上比如,/WF/WFRpt.htm?WorkID=111&FK_Flow=001,在在途上可以执行,撤销或者催办操作。

系统提供的功能页面:请参考/WF/Runing.htm

 

其他高级方法,并不常用,开发说明都在代码里面,请参考/WF/的前台页面相关操作。

1.3:  流程接口

流程接口是指对流程实例操作的接口,比如流程的催办、回滚、删除、冻结等操作。

流程的接口是以Flow_开头的接口,本操作手册不能及时与代码同步,最新的接口需要参考代码。

 

方法

方法名

参数

备注

Flow_DoFlowOver

流程完成

workID


Flow_DoPress

催办

workID


Flow_DoRebackWorkFlow

回滚

workID


Flow_DoDeleteFlowByFlag

逻辑删除

workID


Flow_DoUnDeleteFlowByFlag

撤销逻辑删除

workID


Flow_DoFix

冻结

workID


Flow_DoUnFix

撤销冻结

workID


Flow_DoDeleteFlowByReal

彻底的删除

workID


Flow_DoDeleteDraft

删除草稿

workID


Flow_DoUnSend

撤销发送

workID


Flow_IsCanDoCurrentWork

判断是否可以处理当前工作

workID


Flow_IsCanDeleteFlowInstance

判断是否有删除流程实例的权限

workID


Flow_IsCanStartThisFlow

判断是否可以发起流程

workID


Flow_SetFlowTitle

设置流程标题

workID


Flow_SetSDTOfFlow

设置流程应完成日期

workID


Flow_ReSend

重新发送

workID


Flow_DoComeBackWorkFlow

把流程从非正常运行状态恢复到正常运行状态.

workID

比如现在的流程的状态是,删除,挂起,现在恢复成正常运行。

 

1.4:  节点接口

 

节点接口是指对流程实例操作的接口,比如创建workid,执行发送,退回,移交,会签等操作。

接口是以Node_开头的接口,本操作手册不能及时与代码同步,最新的接口需要参考代码。

 

方法

方法名

参数

备注

Node_CreateBlankWork

创建workid



Node_SendWork

执行发送



Node_ReturnWork

执行退回



Node_SetWorkRead

设置工作已读



Node_SetWorkUnRead

设置工作未读



Node_Shift

移交



Node_ShiftUn

撤销移交



Node_Allot

工作分配



Node_AddTodolist

增加一个操作员



Node_AddNextStepAccepters

增加指定步骤的操作员



Node_CC

抄送



Node_CC_DoDel

删除抄送



Node_CC_SetRead

设置读取



Node_SetDraft

设置为草稿



Node_SetDraft2Todolist

把草稿转为待办



Node_HungUpWork

挂起



Node_UnHungUpWork

撤销挂起



 

 

 

1.5:  组织结构接口

 

组织结构接口是指对组织结构操作的接口,登录、登出发送消息等操作。

接口是以Port_开头,本操作手册不能及时与代码同步,最新的接口需要参考代码。

 

方法

方法名

参数

备注

Port_Login

登录



Port_SigOut

退出登录



Port_SendMsg

发送消息



 


评论区

北流家园网

2019-10-20 19:47

太复杂了,不想用