CCBPM系统集成(一)——接口说明

CCBPM驰骋工作流引擎提供了大量的数据接口，并为每一个接口方法进行了详细说明。

接口文件存在位置：ccflow\Components\BP.WF\Dev2Interface.cs。

接口功能一览表

一、保存

    功能说明：此接口有多个，可根据业务需求选择对应的接口

    方法名称：Node_SaveWork

    参数说明：

                string FK_Flow:流程编号，必须                                                                      
                string FK_Node:节点编号，必须
                Int64 WorkID:工作ID，必须
                Hashtable htWork:要保存的主表数据，可为空
                DataSet dsDtls:要保存到子表的数据，可为空

 

二、发送

        功能说明：此接口有多个，可根据业务需求选择对应的接口

        方法名称：Node_SendWork

        参数说明：

                string FK_Flow:流程编号，必须                                                                                                               
                Int64 WorkID:工作ID，必须
                Hashtable htWork:要保存的主表数据，可为空
                DataSet dsDtls:要保存到子表的数据，可为空
                int toNodeID:下一步（接收）的节点ID，可为空，为空时，根据方向条件，自动寻找下一步的接收节点
                string nextWorkers:接收人（发送给谁），可多人(zhangsan,lisi,wangwu)，可为空，为空时根据接收人规则自动查找接收人

三、退回

        功能说明：流程退回至选择的任一节点

        方法名称： Node_ReturnWork

        参数说明：

                string FK_Flow:流程编号，必须
                Int64 WorkID:工作ID，必须
                Int64 FID:主流程ID，用于分合流，必须。非子线程时，默认为0。
                int currentNodeID:当前节点ID，必须
                int returnToNodeID:要退回到的节点ID，必须
                string returnToEmp:退回给哪个人，必须
                string msg:退回原因，可为空
                bool isBackToThisNode:是否原路返回，可为空。为空时，按照退回规则执行。

 

四、生成WorkID

       功能说明：生成流程唯一识别符，整数形式递增。

                如果要创建一个子流程，需要传入相关的父流程的参数，

                即parnetWorkID,parentFID,parentFlowNo,parentNodeID，这4个参数是必须要有的。

        方法名称：Node_CreateBlankWork

        参数说明：

                string FK_Flow:流程编号，必须
                Hashtable ht:要保存的主表数据，可为空
                DataSet workDtls:要保存到子表的数据，可为空
                string starter:流程发起人，可以为空
                string title:流程标题，可为空。为空时，按照标题生成规则创建。如果没有设置规则，会显示默认标题。
                Int64 parnetWorkID:父流程工作ID（WorkID），用于生成一个子流程的WorkID。可为空，为空时默认为0，表示没有父流程。
                Int64 parentFID:父流程的主流程ID，用于分合流子线程发起子流程时。可为空，为空时默认为0，表示不是分合流的子线程。
                string parentFlowNo:父流程编号，用于生成一个子流程的WorkID。可为空，为空时表示，没有父流程。
                int parentNodeID:发起子流程的父流程的节点编号。可为空，默认为0.
                string parentEmp:发起子流程的发起人，可为空。
                int jumpToNode:要跳转到的节点，默认为0.可为空
                string jumpToEmp:要跳转到节点的接收人，默认为空，可为空。

五、创建WorkID时，并在开始节点生成一个工作待办

        功能说明：如果要创建一个子流程，需要传入相关的父流程的参数，

                        即parnetWorkID,parentFID,parentFlowNo,parentNodeID，这4个参数是必须要有的。

        方法名称：Node 1c140 _CreateStartNodeWork

        参数说明：

                string FK_Flow:流程编号，必须
                Hashtable ht:要保存的主表数据，可为空
                DataSet workDtls:要保存到子表的数据，可为空
                string starter:流程发起人，可以为空
                string title:流程标题，可为空。为空时，按照标题生成规则创建。如果没有设置规则，会显示默认标题。
                Int64 parnetWorkID:父流程工作ID（WorkID），用于生成一个子流程的WorkID。可为空，为空时默认为0，表示没有父流程。
                string parentFlowNo:父流程编号，用于生成一个子流程的WorkID。可为空，为空时表示，没有父流程。
                int parentNDFrom:发起子流程的父流程的节点编号。可为空，默认为0.

六、彻底删除

        功能说明：彻底删除流程信息，管关联的所有表数据被清空

        方法名称：Flow_DoDeleteFlowByReal

        参数说明：string flowNo:流程编号，必须

                    Int64 WorkID:工作ID，必须
                    bool isDelSubFlow:是否删除子流程，默认false

 

七、删除已完成的数据

        方法名称：Flow_DoDeleteWorkFlowAlreadyComplete

        参数说明：

               string flowNo:流程编号，必须
               Int64 WorkID:工作ID，必须
               bool isDelSubFlow:是否删除子流程，默认false
               string note:删除原因，必须

八、删除并写入日志

           方法名称：Flow_DoDeleteFlowByWriteLog

            参数说明：

                string flowNo:流程编号，必须
               Int64 WorkID:工作ID，必须
               string deleteNote:删除原因
               bool isDelSubFlow:是否删除子流程，默认false

九、逻辑删除

        功能说明：并不是真正的删除数据，只是将当前的流程状态（WFState），改为：已删除

        方法名称：Flow_DoDeleteFlowByFlag

        参数说明：

                string flowNo:流程编号，必须
                Int64 WorkID:工作ID，必须
                string msg:删除原因
                bool isDelSubFlow:是否删除子流程，默认false

十、撤销删除

        功能说明：只能撤销逻辑删除的流程。彻底删除流程、和已经删除的已完成的流程，无法撤销。

        方法名称：Flow_DoUnDeleteFlowByFlag

        参数说明：

                 string flowNo:流程编号，必须
                Int64 WorkID:工作ID，必须
                string msg:撤销原因

十一、撤销发送    

        方法名称：Flow_DoUnSend 
        参数说明：
                   string flowNo:流程编号，必须    
                Int64 WorkID:工作ID，必须    
                int unSendToNode:撤销到哪个节点，可为空    

十二、流程结束    

        方法名称：Flow_DoFlowOver  
        参数说明：
                 string flowNo:流程编号，必须    此接口一般多用于，满足流程结束条件时调用。
                Int64 WorkID:工作ID，必须    
                string msg:结束原因    

十三、强制结束流程    

        方法名称：Flow_DoFlowOverByCoercion
        参数说明：
                string flowNo:流程编号，必须    
                int nodeid:当前节点，必须    
                Int64 WorkID:工作ID，必须    
                Int64 FID:主流程ID，用于分合流，必须。非子线程时，默认为0。    
                string msg:结束原因    

十四、获取要到达的节点

        方法名称：Node_GetNextStepNode    
        参数说明：
                string flowNo:流程编号，必须    
                Int64 WorkID:工作ID，必须    

十五、检查某人是否可以发起流程

        方法名称：Flow_IsCanStartThisFlow    
        参数说明：
                string flowNo:流程编号，必须    
                string userNo:人员编号,必须    

十六、检查某人是否有权限处理当前工作

        方法名称：Flow_IsCanDoCurrentWork    
        参数说明：
                string FK_Flow:流程编号，必须    
                int nodeid:当前节点，必须    
                Int64 WorkID:工作ID，必须    
                string userNo:人员编号,必须    

十七、催办   

        方法名称：Flow_DoPress    
        参数说明：
                Int64 WorkID:工作ID，必须    
                string msg:催办消息，必须    
                bool isPressSubFlow:是否催办子流程,必须    

十八、设置流程标题   

        方法名称： Flow_SetFlowTitle    
        参数说明：
                string flowNo:流程编号，必须    
                Int64 WorkID:工作ID，必须    
                string title:流程标题，必须    

十九、抄送   

        方法名称： Node_CC_WriteTo_Cclist    
        参数说明：
                int nodeid:当前节点，必须    人员、部门、岗位、权限组，虽然都可以为空，但是必须4选1.
                Int64 WorkID:工作ID，必须    
                string title:流程标题，必须    
                string doc:抄送内容，必须    
                string toEmps:抄送给谁，可为空，可多人（zhangsan,lisi,wangwu）    
                string toDepts:抄送给部门,可为空，可多个部门(001,002,003)    
                string toStations:抄送给岗位，可为空，可多个岗位(1001,1002,1003)    
                string toGroup:抄送给权限组，可为空，可多个权限组（101，102，103）    

二十、获取待办列表

        方法名称：DB_GenerEmpWorksOfDataTable    
        参数说明：
                string userNo:人员编号,可为空    
                string FK_Flow:流程编号，可为空。为空时，查询所有流程    

二十一、获取已完成列表   

        方法名称：DB_FlowComplete       

二十二、获取全部抄送列表

        方法名称： DB_CCList    
        参数说明： string FK_Emp:人员编号,必须    

二十三 、 获取未读的抄送   

        方法名称：DB_CCList_UnRead    
        参数说明：string FK_Emp:人员编号,必须    

二十四、获取已读的抄送   

         方法名称：DB_CCList_Read 
        参数说明：string FK_Emp:人员编号,必须    

二十五、获取在途(未完成)列表   

        方法名称： DB_GenerRuning    
        参数说明：
                string userNo:人员编号，可为空    
                string FK_Flow:流程编号，可为空。为空时，查询所有流程    
                bool isMyStarter:是否只查询我发起的   

 

 

 

 

转载于:https://my.oschina.net/ccbpm/blog/1920965

• 点赞
• 收藏
• 分享
• 文章举报

chengping8138 发布了0 篇原创文章 · 获赞 3 · 访问量 197 私信 关注