流程引擎API調(diào)用說明

1、慧 正 工 作 流 引 擎 A P I 說 明（試用版）北京慧正通軟科技有限公司2012 年 5 月目錄總體1. 業(yè)務(wù)操作說明業(yè)務(wù)操作說明功能方法參數(shù)說明1.XMLWork xWork = newXMLWork(String userid,String username,String deptname)必要參數(shù)：Userid: 用戶 Id UserName:用戶名稱 DeptName：部門名稱int init = ( ” ,flowID, ” );根據(jù)流程定義 Id ，啟動流程 實(shí)例必要參數(shù) :flowID: 流程定義 Id2.XMLWork xWork = newXMLWork(String

2、 userid,String username,String deptname)設(shè)置 XMLWork的基本屬性 必要參數(shù) :Userid: 用戶 Id UserName:用戶名稱 DeptName：部門名稱int init = ( workid , ” , ” );根據(jù)流程實(shí)例 Id ，打開流程 實(shí)例必要參數(shù) :workid ：流程實(shí)例 Id2. 流程參數(shù)說明具體可參考流程參數(shù)總體說明參數(shù)名含義格式要求必須賦值flowIdentifier流程數(shù)據(jù)源標(biāo) 識或者配置 ,具體參考dataIdentifier業(yè)務(wù)數(shù)據(jù)源標(biāo) 識UserID操作人用戶IdUserName操作人用戶名 稱DeptName操作

3、人部門名 稱WorkID流程實(shí)例 idNodeID流程實(shí)例當(dāng)前節(jié)點(diǎn) IdNodeName流程實(shí)例當(dāng)前節(jié)點(diǎn)名稱TrackID路徑 Id果提交到下一點(diǎn) , 只有一個 節(jié)點(diǎn)時，請不要賦值，置為 空；2. 當(dāng)下一節(jié)點(diǎn)有多個節(jié)點(diǎn)， 根據(jù)路由條件無法確定時，可以指定其中一個或者多 個來確定流程走向。 傳入格式： ( 必須從返回格 式中獲取傳入數(shù)據(jù) ) rId1nId1|rId2nId2&rId 3nId3 路由 ID節(jié)點(diǎn) ID 。3. 如果從當(dāng)前節(jié)點(diǎn)( A)到 目標(biāo)節(jié)點(diǎn) (C) 之間有其他節(jié) 點(diǎn)(B) 被跳過時格式為：路 由 B節(jié)點(diǎn) B| 路由 C節(jié)點(diǎn) C 4. 多個節(jié)點(diǎn)被選擇時，使 用&連接msgSen

4、dFlag發(fā)送消息方式ToDo|Mail|Msg|Note|RTF|Other|如果在中配 置 ReChgMsgFl ag 節(jié) 點(diǎn) 為 true 時 需 要傳入發(fā)送 消息的方式ActionName操作類型Save 等，具體參考總體中的 流程執(zhí)行操作allowUnitNext合并節(jié)點(diǎn)，是 否允許執(zhí)行提 交操作1：允許，其他不允許合并節(jié)點(diǎn)時為必填項cancelFlag撤銷時的標(biāo)1=刪除,2=回收站只有執(zhí)行撤志,默認(rèn)刪除銷操作時為 必填項urlapp待辦鏈接地址如果為空則默認(rèn)使用流程框架頁面打開Comments意見內(nèi)容selectFlag當(dāng)前節(jié)點(diǎn)如果 替換處理人和 轉(zhuǎn)辦時 , 是否 允許選擇多人1:

5、 允許，其他不允許執(zhí)行替換和 轉(zhuǎn)辦時為必 填項submitflag操作提交狀態(tài)(1) 提交操作時的含義 : 1=獲取下一節(jié)點(diǎn)信息， 返回 是否選擇節(jié)點(diǎn)， 是否需要選 擇人員，用于跟前臺交互， 0=執(zhí)行提交到下一節(jié)點(diǎn)辦 理人，如果處理中遇到節(jié)點(diǎn) 不明確或者辦理人不明確 時，跟 1 效果一樣。當(dāng)需要 跟前臺操作人進(jìn)行交互， 比 如獲取是否需要選擇節(jié)點(diǎn) 或者選擇辦理人， 是否需要 操作人進(jìn)行確認(rèn)等， 建議使 用 1 ，處理速度會快一點(diǎn)。(2) 跳轉(zhuǎn)操作時的含義： 1=獲取可以跳轉(zhuǎn)的節(jié)點(diǎn)列 表， 0= 執(zhí)行跳轉(zhuǎn)到指定節(jié)點(diǎn)。(3) 退回操作時的含義： 1=獲取可以退回的節(jié)點(diǎn)列 表，0=執(zhí)行退回到指定節(jié)點(diǎn)

6、 操作。(4) 啟動子流程時的含義： 如果系統(tǒng)提供了啟動子流 程 的 ID ( 參 數(shù) selectFlowID )，則忽略此 參數(shù)，不提供 selectFlowID 參數(shù)時，如果當(dāng)前人沒有啟 動過子流程時忽略此參數(shù)， 直接根據(jù)定義判斷是否有 多個子流程定義， 如果只有 一個子流程定義， 則直接啟 動，否則返回；如果當(dāng)前人 已經(jīng)啟動過子流程， 1=獲取 已經(jīng)啟動的子流程列表， 并 返回，0=根據(jù)定義判斷是否 有多個子流程定義， 如果只 有一個子流程定義， 則直接 啟動，否則返回。(5) 催辦操作時的含義： 1=催辦次數(shù)如果已經(jīng)達(dá)到 上限則停止， 0=催辦次數(shù)已 經(jīng)達(dá)到上限也繼續(xù)催辦curNod

7、eAuthorSendFlag當(dāng)前節(jié)點(diǎn)的作 者消息發(fā)送方 式, 用于執(zhí)行 會簽, 加簽, 替 換, 轉(zhuǎn)辦格式同 msgSendFlagcurNodeReaderSendFlag當(dāng)前節(jié)點(diǎn)的讀 者消息發(fā)送方 式, 用于執(zhí)行 閱知操作時顯 示在前臺供操 作者選擇selectFlowID啟動子流程的Id啟動子流程 時為必填項FormAction流程提交操作的 URLtmpAuthor選擇人員時 , 臨時獲取選擇 范圍格式同 SelectAuthorpreFlag如果有選擇節(jié) 點(diǎn)頁面 , 在確 認(rèn)頁面上出現(xiàn) 上一步按鈕1: 顯示，其他不出現(xiàn)ActionClass執(zhí)行業(yè)務(wù)的 action 名稱默認(rèn)tmpS

8、aveInfo臨時信息記錄( 目前用于存儲當(dāng)前人填寫 的意見信息 ）3. 流程執(zhí)行操作說明流程執(zhí)行操作1.（具 體點(diǎn) 擊上 面鏈 接）引入的包： .XMLWork從 request 中獲 取的相關(guān)參數(shù) 參考流程參數(shù) 總體說明 , 以及 要執(zhí)行下面具 體操作的說明(1)傳入 request 對象, 調(diào)用 doAction XMLApp app = new XMLApp(); LinkedHashMap backMap = (request);（具體點(diǎn)擊上LinkedHashMap hashMap = new LinkedHashMap();2.在自定義的類中執(zhí)行組織流程操作 需要的參數(shù) 具體根據(jù)

9、流程 參數(shù)總體說明 以及對應(yīng)的操 作設(shè)置相關(guān)參面鏈接）int result = doAction(null,hashMap);數(shù)，放入到hashMap中。4. 流程實(shí)例流轉(zhuǎn)操作操作名稱英文標(biāo)識說明提交Submit提交到下一節(jié)點(diǎn)退回reject退回到某個節(jié)點(diǎn)拿回getback拿回已提交的流程閱知addreader發(fā)送待閱撤銷cancel撤銷流程跳轉(zhuǎn)goto跳轉(zhuǎn)到某個節(jié)點(diǎn)會簽huiqian發(fā)送給相關(guān)人員會簽加簽jiaqian發(fā)送給相關(guān)人員加簽轉(zhuǎn)辦move轉(zhuǎn)交給其他人辦理暫停pause暫停流程已閱readed閱讀待閱的信息催辦remsg催辦流程實(shí)例替換辦理人replace替換流程的辦理人暫存save

10、暫存流程實(shí)例終止流程stopflow終止流程實(shí)例啟動子流程subflow啟動子流程啟動實(shí)例1. 啟動流程實(shí)例整體說明引入.XMLWork類：執(zhí)行 方法初始化 XMLWor，k 設(shè)置 相關(guān)屬性1. XMLWork xWork = new XMLWork(userid,username,deptname);啟動具體的流程實(shí)例 （ 返回值說明見下面 ）init = ( ” ,flowID, ” );2. 啟動流程實(shí)例參數(shù)說明參數(shù)名含義要求userid啟動實(shí)例的操作人 的用戶 Id不能為空username啟動實(shí)例的操作人 的用戶名稱可以為空deptname啟動實(shí)例的操作人 的部門名稱可以為空flowI

11、D流程定義 Id不能為空3. 啟動流程初始化 XMLWork 額外屬性說明初始化 XMLWor，k 設(shè)置相關(guān)屬性（根據(jù)業(yè)務(wù)，如有需要，可以設(shè)置以下內(nèi)容）()設(shè)置流程數(shù)據(jù)所使 用的數(shù)據(jù)源標(biāo)識符。中設(shè)置的默認(rèn)數(shù)據(jù)源和中的設(shè)置不 一致時，設(shè)置為空和設(shè)置成 null （或 者不設(shè)置）是有區(qū)別的，設(shè)置為空時， 系統(tǒng)使用中設(shè)置的默認(rèn)數(shù)據(jù)源， 設(shè)置 成 null （或者不設(shè)置）時，使用的 是中的設(shè)置。 數(shù)據(jù)源無效時， 系統(tǒng)默 認(rèn)使用中設(shè)置的默認(rèn)數(shù)據(jù)源。如果 flowIdentifier 跟 dataIdentifier 一樣可以直接使用 （“”） 對兩個變 量同時賦值xWork .setDataIde nt

12、ifier()設(shè)置業(yè)務(wù)數(shù)據(jù)所使 用的數(shù)據(jù)源標(biāo)識符。xWork .setUserAuthType()如果需要設(shè)置外部 辦理人獲取方式。4. 啟動流程實(shí)例返回值 init 說明返回值含義init=初始化成功。init =當(dāng)前人員無權(quán)啟動流程init =鎖定當(dāng)前實(shí)例失敗，啟動流程時不影響，可以等 同成功init =其他原因失敗從 (); 可以獲取錯誤信息啟動流程實(shí)例成功后，可以從 xWork 對象中獲取相關(guān)的信息，具體參考5. 啟動實(shí)例代碼樣例/* 啟動流程實(shí)例操作，從前臺獲取參數(shù)，獲取流程定義 Id 等信息， 具體可參考 */程定義 Id, 必須有此值 String flowID = (flowi

13、d); 部權(quán)限設(shè)置分類 ,XMLWork 額外屬性，可以不用設(shè)置 String userAuthType = (userAuthType);得數(shù)據(jù)源 ,XMLWork 額外屬性，可以不用設(shè)置String dbIdentifier = (dbIdentifier); 前用戶信息 , 根據(jù)應(yīng)用系統(tǒng)的區(qū)別，靈活獲取。下面是產(chǎn)品中的自帶的用戶獲取方式String userid = (session);始化 XMLWork 屬性XMLWork xWork =new XMLWork(userid,username,deptname);動流程實(shí)例 , 第一個參數(shù)是流程實(shí)例 Id ，第二個參數(shù)是流程定義 Id

14、 ，第三個參數(shù)是業(yè)務(wù)數(shù)據(jù) Id ， 如果三個都有值，獲取流程數(shù)據(jù)的優(yōu)先順序：workID flowID dataIDint init = ( “” ,flowID, ” ); 動流程實(shí)例成功后，對業(yè)務(wù)數(shù)據(jù)的處理 etCurForm(dataid);for(int i=0;i;i+) String formid = formi.getID();etFormtype().equals(HTML) etFormtype().equals(JSP) etDataID()etID(); etTableID(); oString(); oString(); oString(); oString(); oS

15、tring();else6.MLWork執(zhí)初始化 XMLWor，k 設(shè)置 相關(guān)屬性1. XMLWork xWork = new行XMLWork(userid,username,deptname);打開具體的流程實(shí)例init = (workid, ”, ”);方法（ 返回值說明見下面 ）7. 打開流程實(shí)例參數(shù)說明參數(shù)名含義要求userid啟動實(shí)例的操作人 的用戶 Id不能為空username啟動實(shí)例的操作人 的用戶名稱可以為空deptname啟動實(shí)例的操作人 的部門名稱可以為空workid流程實(shí)例 Id不能為空8. 打開流程初始化 XMLWork 額外屬性說明初始化 XMLWor，k 設(shè)置相關(guān)屬

16、性（根據(jù)業(yè)務(wù)，如有需要，可以設(shè)置以下內(nèi)容）()設(shè)置流程數(shù)據(jù)所使 用的數(shù)據(jù)源標(biāo)識符。（1） 中設(shè)置的默認(rèn)數(shù)據(jù)源和中的設(shè)置 不一致時，設(shè)置為空和設(shè)置成 null （或者不設(shè)置） 是有區(qū)別的， 設(shè)置為空時，系統(tǒng)使用中設(shè)置的()設(shè)置業(yè)務(wù)數(shù)據(jù)所使 用的數(shù)據(jù)源標(biāo)識符。默認(rèn)數(shù)據(jù)源，設(shè)置成 null (或者 不設(shè)置)時，使用的是中的設(shè)置。 數(shù)據(jù)源無效時，系統(tǒng)默認(rèn)使用中 設(shè)置的默認(rèn)數(shù)據(jù)源。(2) 如 果 flowIdentifier 跟 dataIdentifier 一樣可以直接 使用( “”) 對兩個變量同時賦值()設(shè)置指定路徑 Id打開流程實(shí)例時可以設(shè)置此值(1) 如果當(dāng)前人在多個分支節(jié)點(diǎn)都具 有權(quán)限, 還

17、需要指定路徑 ID(2) 如果不指定 , 系統(tǒng)會自動獲取所 有分支, 返回前臺供選擇9. 打開流程實(shí)例返回值 init 說明返回值含義init=選擇需要打開的節(jié)點(diǎn)String allnodes = ();String nodes = (|); 選擇后的結(jié)果賦值給 ( “”);return;init =打開實(shí)例成功init =當(dāng)前人員無權(quán)查看此流程實(shí)例init =當(dāng)前人只能以只讀權(quán)限打開 (此時不能執(zhí)行任何 操作)init =當(dāng)前實(shí)例被其他人鎖定(此時不能執(zhí)行任何操 作)init =鎖定當(dāng)前實(shí)例失敗， 此時其他人仍然可以打開實(shí) 例進(jìn)行操作，可能會出現(xiàn)數(shù)據(jù)沖突問題，建議退 出重新打開init =其

18、他原因失敗從 (); 可以獲取錯誤信息打開流程實(shí)例成功后，可以從 xWork 對象中獲取相關(guān)的信息，具體參考10. 打開實(shí)例代碼樣例/* 打開流程實(shí)例操作，從前臺獲取參數(shù)，獲取流程實(shí)例 Id 等信息， 具體可參考 */ 程實(shí)例 Id, 必須有此值 String workid = (workid);部權(quán)限設(shè)置分類 ,XMLWork 額外屬性，可以不用設(shè)置String userAuthType = (userAuthType); 得數(shù)據(jù)源 ,XMLWork 額外屬性，可以不用設(shè)置 String dbIdentifier = (dbIdentifier);設(shè)置指定路徑 Id ， XMLWork 額外

19、屬性，如果沒有分支，可以不用設(shè)置String openTrackID = (openTrackID );前用戶信息 , 根據(jù)應(yīng)用系統(tǒng)的區(qū)別，靈活獲取。下面是產(chǎn)品中的自帶的用戶獲取方式 String userid = (session); 始化 XMLWork 屬性XMLWork xWork = new XMLWork(userid,username,deptname); setOpenTrackID(openTrackID);開流程實(shí)例int init = (workid,” , ” );開流程實(shí)例成功后，對業(yè)務(wù)數(shù)據(jù)的處理 etCurForm(dataid);for(int i=0;i1 ”u

20、bstring(nodesi.indexOf()+1) ubstring(0,nodesi.indexOf();elseE.F.G.要把 selectAuthor 變量賦值，此值是閱知人員 Idif(cp = I.J.要將(“ActionName”, ”cancel ”);if(cp = K.L.要把 selectAuthor 變量賦值，此值是會簽人員 Idif(cp1” ubstring(nodesi.indexOf()+1);ubstring(0,nodesi.indexOf();else0” sgFlagCN();String msgFlag = ():String other= (ms

21、gFlag):M.N.要把 selectAuthor 變量賦值，此值是會簽人員 Id if(cp = O.P.要把 selectAuthor 變量賦值，此值是加簽人員 Id if(cp = Q.R.T.U.V.W.X.要將催辦的內(nèi)容 Comments賦值 , 放到 dataHashMap 的 Comments 對應(yīng)的值 if(cp = Y.Z.AA.BB.CC.DD.EE.FF.要將 selectFlowID 選擇的子流程放入到 dataHashMap中. if(cp = plit(|);for ( int i=0,n=;in;i+)if (listi.length()=0) continue

22、 ubstring(0,listi.indexOf();ubstring(listi.indexOf()+1);If(“1 ”)plit(|);for ( int i=0,n = ;in;i+)int pos= flowlisti.indexOf( = );ubstring(0,pos);ubstring(pos+1);ode_Parallel ：多人處理StaticVar .Node_Order ：多人順序StaticVar .Node Everyone ：多人單一簽核()獲取當(dāng)前節(jié)點(diǎn)的辦理方式()獲取當(dāng)前節(jié)點(diǎn)事件列表()獲取當(dāng)前節(jié)點(diǎn)當(dāng)前人所具有的表單信息 (包含表單域和操作信息 )獲取當(dāng)前

23、節(jié)點(diǎn)當(dāng)前人所具有的表單信息 (包含表單域和操作信息 ) 在已有數(shù)據(jù) 上啟動流程時，增加查找主表單，并判斷是否有 dataid ，如果沒有則使用參數(shù) 賦值()獲取當(dāng)前節(jié)點(diǎn) ID()獲取當(dāng)前節(jié)點(diǎn)名稱()獲取當(dāng)前節(jié)點(diǎn)的讀者消息發(fā)送方式()獲取當(dāng)前節(jié)點(diǎn)所有未辦理人員列表中文名稱，多個值用“ |”分隔。獲取當(dāng)前節(jié)點(diǎn)所有未辦理人員列表中文名稱，使用指定分隔符()獲取當(dāng)前節(jié)點(diǎn)所有未辦理人員列表 ID，多個值用“ |”分隔。()獲取當(dāng)前節(jié)點(diǎn)的可能路由條件()獲取當(dāng)前執(zhí)行人 ID()獲取當(dāng)前執(zhí)行人的中文名稱() 業(yè)務(wù)數(shù)據(jù)源名稱(int i)獲取當(dāng)前表單域信息，用于表單引擎解析獲取當(dāng)前表單域信息，用于表單引擎解析

24、() 獲取流程 ID()獲取流程的數(shù)據(jù)源() 獲取流程名稱int() 獲取當(dāng)前分支的流程狀態(tài) 返回值： StaticVar .FlowStatus Start：開始StaticVar .FlowStatus_Normal ：正常StaticVar .FlowStatus_HuiQian ：會簽StaticVar .FlowStatus_Reject ：退回StaticVar .FlowStatus_Getback ：拿回StaticVar .FlowStatus_End ：正常結(jié)束StaticVar .FlowStatus_ErrorEnd ：異常結(jié)束StaticVar .FlowStatus

25、_Pause ：暫停StaticVar .FlowStatus_Cancel ：撤銷StaticVar .FlowStatus Delete ：刪除()獲取當(dāng)前分支的流程狀態(tài)名稱必須在打開實(shí)例后才能獲取到值獲取表單按鈕數(shù)組根據(jù)指定表單按鈕生成的 html 內(nèi)容()獲取辦理記錄 XML 片段 ,由應(yīng)用在前臺進(jìn)行顯示格式轉(zhuǎn)換根據(jù) formID 獲取其他屬性 ,一般是獲取 TableID 和 DataID 參數(shù)：formID ：表單 Idtype ： TableID: 庫表 ID，業(yè)務(wù)數(shù)據(jù) DataID:int()獲取實(shí)例化 XMLWork 對象的結(jié)果()獲取當(dāng)前鎖定人中文名稱() 獲取當(dāng)前鎖定人

26、ID()獲取流程圖對應(yīng)的 XML 數(shù)據(jù)，用于流程圖顯示獲取繼承文檔所在的庫表和數(shù)據(jù) id ()獲取上一節(jié)點(diǎn)辦理人獲取上一節(jié)點(diǎn)辦理人，使用指定分隔符()獲取上一節(jié)點(diǎn)辦理人 id()獲取上一節(jié)點(diǎn)名稱(int pos)獲取給下一節(jié)點(diǎn)讀者發(fā)送消息的方式(int pos)獲取給下一節(jié)點(diǎn)辦理人發(fā)送消息的方式int()獲取選擇人員方式 ,單選還是多選(當(dāng)前節(jié)點(diǎn))獲取靜態(tài)表單內(nèi)容()獲取系統(tǒng)按鈕數(shù)組()根據(jù)對應(yīng)系統(tǒng)按鈕生成的 hmtl 內(nèi)容int() 獲取當(dāng)前人的類型 (為拿回時 ,需要區(qū)分是否為起草人 ) StaticVar .User_MainDo ：主辦人 StaticVar .User_SecondD

27、o ：協(xié)辦辦理人 StaticVar .User_Manager ：管理員 StaticVar .User_SecondDone ：協(xié)辦已辦理人 StaticVar .User_CurDone ：當(dāng)前節(jié)點(diǎn)辦理人 StaticVar .User_PreDone ：上一節(jié)點(diǎn)辦理人 StaticVar .User_Creator ：流程創(chuàng)建者 ,流程起草人 StaticVar .User_Done ：已辦理人 StaticVar .User_Huiqian ：會簽提出人 StaticVar .User_Reader ：流程讀者 , 節(jié)點(diǎn)讀者 ,閱知人 StaticVar .User_CReader

28、：讀者 ,由其他權(quán)限降級或者不參與讀者權(quán)限 (比如轉(zhuǎn) 辦人)StaticVar .User_NoRole ：無權(quán)限()用于前臺顯示當(dāng)前用戶類型()獲取實(shí)例 IDboolean()判斷是否為當(dāng)前操作人鎖定下面的方法用于執(zhí)行操作，需要跟前臺交互時，獲取對應(yīng)信息進(jìn)行下一步處理boolean()判斷下一節(jié)點(diǎn)是否跟當(dāng)前節(jié)點(diǎn)相同，相同為 false ，不同為 true 。()獲取給下一節(jié)點(diǎn)作者發(fā)送消息的方式。多值時用“ |”隔開。()獲取當(dāng)前節(jié)點(diǎn)辦理人的消息發(fā)送方式。多值時用“ |”隔開。()返回從定義列表中選擇人員 ,，用于前臺從流程節(jié)點(diǎn)定義中選擇人員。多值時用 “|”隔開。IntgetMaySelectNodeNumber()返回可以選擇的節(jié)點(diǎn)數(shù)量 (包含已經(jīng)選擇的節(jié)點(diǎn) )Name ()獲取下一辦理人中文名稱 ,用于前臺顯示，讓操作人最后確認(rèn)。Name (int pos)獲取下一辦理人中文名稱 ,用于前臺顯示，讓操作人最后確認(rèn)。Name 獲取下一辦理人中文名稱 ,用于前臺顯示 , 使用指定分隔符