《工作流引擎API说明》由会员分享，可在线阅读，更多相关《工作流引擎API说明（50页珍藏版）》请在金锄头文库上搜索。
1、慧正工作流引擎API说明V6.0（试用版）北京慧正通软科技有限公司2012年5月目录一、总体41.业务操作说明42.流程参数说明43.流程执行操作说明84.流程实例流转操作9二、启动实例91.启动流程实例整体说明92.启动流程实例参数说明103.启动流程初始化XMLWork额外属性说明104.启动流程实例返回值init说明105.启动实例代码样例11三、打开实例121.打开流程实例整体说明122.打开流程实例参数说明133.打开流程初始化XMLWork额外属性说明134.打开流程实例返回值init说明145.打开实例代码样例14四、执行操作161.采用系统提供的默认类处理162.自行编写处理类
2、17五、流程实例具体功能操作191.提交19A.提交流程实例参数说明19B.提交流程实例返回值cp说明19C.提交流程实例代码样例202.退回23A.退回流程实例参数说明23B.退回流程实例返回值cp说明23C.退回代码样例243.拿回24A.拿回流程实例参数说明24B.拿回流程实例返回值cp说明25C.拿回代码样例254.阅知25A.流程实例阅知参数说明25B.流程实例阅知返回值cp说明26C.流程实例阅知代码样例265.撤销26A.撤销流程实例参数说明26B.撤销流程实例返回值cp说明26C.撤销流程实例代码样例276.跳转27A.流程实例跳转参数说明27B.流程实例跳转返回值cp说明27
3、C.流程实例跳转代码样例287.会签29A.流程实例会签参数说明29B.流程实例会签返回值cp说明29C.流程实例会签代码样例308.加签30A.流程实例加签参数说明30B.流程实例加签返回值cp说明30C.流程实例加签代码样例319.转办31A.转办流程实例参数说明31B.转办流程实例返回值cp说明31C.转办流程实例代码样例3210.暂停32A.暂停流程实例参数说明32B.暂停流程实例返回值cp说明32C.暂停流程实例代码样例3311.已阅33A.流程实例已阅参数说明33B.流程实例已阅返回值cp说明33C.流程实例已阅代码样例3312.催办34A.催办流程实例参数说明34B.催办流程实例
4、返回值cp说明34C.催办流程实例代码样例3413.替换办理人35A.流程实例替换办理人参数说明35B.流程实例替换办理人返回值cp说明35C.流程实例替换办理人代码样例3514.暂存36A.暂存流程实例参数说明36B.暂存流程实例返回值cp说明36C.暂存代码样例3615.终止流程36A.终止流程实例参数说明36B.终止流程实例返回值cp说明37C.终止流程代码样例3716.启动子流程37A.启动子流程实例参数说明37B.启动子流程实例返回值cp说明37C.启动子流程代码样例38附录：XMLWork方法摘要40一、 总体1. 业务操作说明业务操作说明功能方法参数说明1.启动实例1.1 XML
5、Work xWork = new XMLWork(String userid,String username,String deptname)设置XMLWork的基本属性必要参数：Userid:用户IdUserName:用户名称DeptName：部门名称1.2 int init = xWork.openWorkFlow(”,flowID,”);根据流程定义Id，启动流程实例必要参数:flowID:流程定义Id2.打开实例2.1 XMLWork xWork = new XMLWork(String userid,String username,String deptname)设置XMLWork的
6、基本属性必要参数:Userid:用户IdUserName:用户名称DeptName：部门名称2.2 int init = xWork.openWorkFlow(workid,”,”);根据流程实例Id，打开流程实例必要参数:workid：流程实例Id2. 流程参数说明具体可参考/horizon/workflow/include2/xmlwork.index.hidden.jsp流程参数总体说明参数名含义格式要求必须赋值flowIdentifier流程数据源标识configuration.xml或者workflow.xml配置,具体参考启动流程初始化XMLWork额外属性说明dataIdenti
7、fier业务数据源标识UserID操作人用户IdUserName操作人用户名称DeptName操作人部门名称WorkID流程实例idNodeID流程实例当前节点IdNodeName流程实例当前节点名称TrackID路径Id/如果当前人在多个分支节点都具有权限,还需要指定路径ID/如果不指定,系统会自动获取所有分支,返回前台供选择actionFlag操作权限设置1:允许操作selectAuthor办理人员的Id单个节点(或者不需要传入节点)时为user1|user2或者node=user1|user2多个节点时node1=user1|user2&node2=user3流程节点的办理人无值时为必填
8、项selectAuthorCN办理人员的中文名称secondAuthor选择的协办人员格式同selectAuthornextNodeID下一个节点Id1.如果提交到下一点,只有一个节点时，请不要赋值，置为空；2.当下一节点有多个节点，根据路由条件无法确定时，可以指定其中一个或者多个来确定流程走向。传入格式：(必须从返回格式中获取传入数据)rId1nId1|rId2nId2&rId3nId3路由ID节点ID。3. 如果从当前节点（A）到目标节点(C)之间有其他节点(B)被跳过时格式为：路由B节点B|路由C节点C 4. 多个节点被选择时，使用&连接msgSendFlag发送消息方式ToDo|Mai
9、l|Msg|Note|RTF|Other|如果在workflow.xml中配置ReChgMsgFlag节点为true时需要传入发送消息的方式ActionName操作类型Save等，具体参考总体中的流程执行操作allowUnitNext合并节点，是否允许执行提交操作1：允许，其他不允许合并节点时为必填项cancelFlag撤销时的标志,默认删除1=删除,2=回收站只有执行撤销操作时为必填项urlapp待办链接地址如果为空则默认使用流程框架页面打开Comments意见内容selectFlag当前节点如果替换处理人和转办时,是否允许选择多人1:允许，其他不允许执行替换和转办时为必填项submitfl
10、ag操作提交状态(1)提交操作时的含义:1=获取下一节点信息，返回是否选择节点，是否需要选择人员，用于跟前台交互，0=执行提交到下一节点办理人，如果处理中遇到节点不明确或者办理人不明确时，跟1效果一样。当需要跟前台操作人进行交互，比如获取是否需要选择节点或者选择办理人，是否需要操作人进行确认等，建议使用1，处理速度会快一点。(2)跳转操作时的含义：1=获取可以跳转的节点列表，0=执行跳转到指定节点。(3)退回操作时的含义：1=获取可以退回的节点列表，0=执行退回到指定节点操作。(4)启动子流程时的含义：如果系统提供了启动子流程的ID（参数selectFlowID），则忽略此参数，不提供sele
11、ctFlowID参数时，如果当前人没有启动过子流程时忽略此参数，直接根据定义判断是否有多个子流程定义，如果只有一个子流程定义，则直接启动，否则返回；如果当前人已经启动过子流程，1=获取已经启动的子流程列表，并返回，0=根据定义判断是否有多个子流程定义，如果只有一个子流程定义，则直接启动，否则返回。(5)催办操作时的含义：1=催办次数如果已经达到上限则停止，0=催办次数已经达到上限也继续催办curNodeAuthorSendFlag当前节点的作者消息发送方式,用于执行会签,加签,替换,转办格式同msgSendFlagcurNodeReaderSendFlag当前节点的读者消息发送方式,用于执行阅
12、知操作时显示在前台供操作者选择selectFlowID启动子流程的Id启动子流程时为必填项FormAction流程提交操作的URLtmpAuthor选择人员时,临时获取选择范围格式同SelectAuthorpreFlag如果有选择节点页面,在确认页面上出现上一步按钮1:显示，其他不出现ActionClass执行业务的action名称默认com.horizon.workflow.flowengine.impl.entity.XMLApptmpSaveInfo临时信息记录(目前用于存储当前人填写的意见信息)3. 流程执行操作说明流程执行操作1.系统默认处理过程（具体点击上面链接）引入的包：com.
13、horizon.workflow.flowengine.impl.entity.XMLAppcom.horizon.workflow.flowengine.pub.XMLWork从request中获取的相关参数参考流程参数总体说明,以及要执行下面具体操作的说明（1）传入request对象,调用doActionXMLApp app = new XMLApp();LinkedHashMap backMap = app.doAction(request);/返回结果int cp = Integer.parseInt(String)backMap.get(iResult);/获取提交后的流程信息XMLWork xWork = (XMLWork)backMap.get(xWork);（2）把参数放入的LinkedHashMap，调用doActionLinkedHashMap dataHashMap = new LinkedHashMap();XMLApp app = new XMLApp();LinkedHashMap backMap = app.doAction(dataHashMap);/返回结果int cp = Integer.parseInt(String)backMap.get(iResult);/
