常用的流程引擎API開發調用接口大全-工作流引擎設計

  1. 程序調用開發接口

  2. 接口說明

  1. 所謂的馳騁工作流引擎的接口,在BP.WF.Dev2Interface.*上面的靜態方法,前臺頁面通過這些靜態方法通過頁面於操作者提供交互數據功能交互。
  2. Port_* 開頭的方法都是組織結構相關的操作,比如:登錄、登出、發送消息。
  3. DB_*的都是提供數據列表的接口,比如:發起列表、待辦列表、在途列表、完成列表等。
  4. 馳騁BPM的發起、待辦、在途菜單功能都是通過這個靜態方法提供的BP.WF.Dev2Interface.DB_*接口生成的列表。
  5. 馳騁的工作處理器創建工作ID、發送、退回、移交、刪除、加簽、會籤等操作也是調用BP.WF.Dev2Interface.Node_*通過流程接口對流程的操作比如:流程的刪除、回滾、撤銷、凍結、取消凍結等流程的操作都是操作的BP.WF.Dev2Interface.Flow_*開發接口。
  6. 以WorkOpt_* 開頭的方法,都是工作流引擎部件的代碼,比如在退回窗口上,獲取可以退回的節點列表,設置指定的節點處理人。
  7. 我們在流程屬性裏有一個接口,請參考如下圖:

 

  1. 菜單接口

獲取數據是如何根據您自己的需要,通過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. 流程接口

流程接口是指對流程實例操作的接口,比如流程的催辦、回滾、刪除、凍結等操作。

流程的接口是以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. 節點接口

 

節點接口是指對流程實例操作的接口,比如創建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. 組織結構接口

 

組織結構接口是指對組織結構操作的接口,登錄、登出發送消息等操作。

接口是以Port_開頭,本操作手冊不能及時與代碼同步,最新的接口需要參考代碼。

 

方法

方法名

參數

備註

Port_Login

登錄

 

 

Port_SigOut

退出登錄

 

 

Port_SendMsg

發送消息

 

 

 

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章