驰骋工作流引擎SDKCCFlow6.docx

1、驰骋工作流引擎SDKCCFlow6【命名空间：BP.WF】CCFlow6 - SDK模式开发手册类名：Dev2Interface此接口为程序员二次开发使用,在阅读代码前请注意如下事项.1, CCFlow的对外的接口都是以静态方法来实现的.2, 以 DB_ 开头的是需要返回结果集合的接口.3, 以 Flow_ 是流程接口.4, 以 Node_ 是节点接口。5, 以 Port_ 是组织架构接口.6, 以 DTS_是调度 7, 接口的文件是: BP.WF.Dev2Interface如果您已经习惯msdn格式的接口阅读格式请参考http:/bbs.ccflow.org/showtopic-1357.a

2、spx序号方法名功能描述参数返回值1DTS_AutoStarterFlow自动执行开始节点数据说明:根据自动执行的流程设置，自动启动发起的流程。比如：您根据ccflow的自动启动流程的设置，自动启动该流程，不使用ccflow的提供的服务程序，您需要按如下步骤去做。1,写一个自动调度的程序。2，根据自己的时间需要调用这个接口。参数名类型说明默认值flBP.WF.Flow流程实体,您可以newFlow(flowNo);来传入.无2DB_GenerTrack获取流程事例的运行轨迹数据.说明：使用这些数据可以生成流程的操作日志.参数名类型说明默认值fk_flowSystem.String流程编号wor

3、kidSystem.Int64工作ID0fidSystem.Int64流程ID0从临时表与轨迹表获取流程轨迹数据.3DB_CCList获取指定人员的抄送列表说明:可以根据这个列表生成指定用户的抄送数据.参数名类型说明默认值fk_empSystem.String人员编号返回该人员的所有抄送列表,结构同表WF_CCList.4DB_CCList_UnRead获取指定人员的抄送列表(未读)参数名类型说明默认值fk_empSystem.String人员编号返回该人员的未读的抄送列表5DB_CCList_Read获取指定人员的抄送列表(已读)参数名类型说明默认值fk_empSystem.String人员

4、编号返回该人员的已读的抄送列表6DB_CCList_Delete获取指定人员的抄送列表(已删除)参数名类型说明默认值fk_empSystem.String人员编号返回该人员的已删除的抄送列表7DB_GenerCanStartFlowsOfEntities获取当前操作员可以发起的流程集合说明:利用此接口可以生成用户的发起的流程列表.BP.WF.Flows对象集合.如何使用该方法形成发起工作列表,请参考:WFUCStart.ascx.8DB_GenerCanStartFlowsOfEntities获取指定人员能够发起流程的集合.说明:利用此接口可以生成用户的发起的流程列表.参数名类型说明默认值us

5、erNoSystem.String操作员编号BP.WF.Flows可发起的流程对象集合,如何使用该方法形成发起工作列表,请参考:WFUCStart.ascx9DB_GenerCanStartFlowsOfDataTable获取指定人员能够发起流程的集合说明:利用此接口可以生成用户的发起的流程列表.参数名类型说明默认值userNoSystem.String操作员编号Datatable类型的数据集合,数据结构与表WF_Flow大致相同.如何使用该方法形成发起工作列表,请参考:WFUCStart.ascx10DB_GenerHLSubFlowDtl_TB获取(同表单)合流点上的子线程说明:如果您要想

6、在合流点看到所有的子线程运行的状态.参数名类型说明默认值nodeIDOfHLSystem.Int32合流点ID0workidSystem.Int64工作ID0与表WF_GenerWorkerList结构类同的datatable.11DB_GenerHLSubFlowDtl_YB获取(异表单)合流点上的子线程参数名类型说明默认值nodeIDOfHLSystem.Int32合流点ID0workidSystem.Int64工作ID0与表WF_GenerWorkerList结构类同的datatable.12DB_GenerDraftDataTable获取当前操作员的指定流程的流程草稿数据参数名类型说明

7、默认值fk_flowSystem.String流程编号返回草稿数据集合,列信息.OID=工作ID,Title=标题,RDT=记录日期,FK_Flow=流程编号,FID=流程ID,FK_Node=节点ID13DB_GenerEmpWorksOfDataTable根据状态获取当前操作员的待办工作参数名类型说明默认值wfStateBP.WF.WFState流程状态fk_flowSystem.String流程编号表结构与视图WF_EmpWorks一致14DB_GenerEmpWorksOfDataTable获取当前操作人员的待办信息数据内容请参考图:WF_EmpWorks返回从视图WF_EmpWork

8、s查询出来的数据.15DB_GenerHungUpList获得所有的流程挂起工作列表返回从视图WF_EmpWorks查询出来的数据.16DB_GenerHungUpList获得指定流程挂起工作列表参数名类型说明默认值fk_flowSystem.String流程编号,如果编号为空则返回所有的流程挂起工作列表.返回从视图WF_EmpWorks查询出来的数据.17DB_GenerDeleteWorkList获得逻辑删除的流程返回从视图WF_EmpWorks查询出来的数据.18DB_GenerDeleteWorkList获得逻辑删除的流程:根据流程编号参数名类型说明默认值userNoSystem.St

9、ring操作员编号fk_flowSystem.String流程编号(可以为空)WF_GenerWorkFlow数据结构的集合19DB_NDxxRpt根据流程状态获取指定流程数据参数名类型说明默认值fk_flowSystem.String流程编号staBP.WF.WFState流程状态数据表OID,Title,RDT,FID20DB_GenerWillReturnNodes获取当前节点可以退回的节点参数名类型说明默认值fk_nodeSystem.Int32节点ID0workidSystem.Int64工作ID0fidSystem.Int64FID0No节点编号,Name节点名称,Rec记录人,R

10、ecName记录人名称21DB_GenerRuning获取未完成的流程(也称为在途流程:我参与的但是此流程未完成)参数名类型说明默认值fk_flowSystem.String流程编号返回从数据视图WF_GenerWorkflow查询出来的数据.22DB_GenerRuning获取未完成的流程(也称为在途流程:我参与的但是此流程未完成)返回从数据视图WF_GenerWorkflow查询出来的数据.23Port_Login用户登陆,此方法是在开发者校验好用户名与密码后执行参数名类型说明默认值userNoSystem.String用户名SIDSystem.String安全ID,请参考流程设计器操作手

11、册无24Port_Login用户登陆,此方法是在开发者校验好用户名与密码后执行参数名类型说明默认值userNoSystem.String用户名无25Port_SigOut注销当前登录无26Port_SendMail发送邮件与消息参数名类型说明默认值userNoSystem.String信息接收人msgTitleSystem.String标题msgDocSystem.String内容无27Port_SendSMS发送SMS参数名类型说明默认值userNoSystem.String信息接收人msgTitleSystem.String标题msgDocSystem.String内容无28Flow_Ge

12、nerWorkID产生一个新的工作ID参数名类型说明默认值flowNoSystem.String流程编号返回当前操作员创建的工作ID29Flow_GenerWork产生一个新的工作参数名类型说明默认值flowNoSystem.String流程编号返回当前操作员创建的工作30Flow_IsCanStartThisFlow检查指定的人员是否可以发起改流程参数名类型说明默认值flowNoSystem.String流程编号fk_empSystem.String操作员编号false不能启动该流程31Flow_DoComeBackWrokFlow恢复流程,在一件工作完成后，要恢复上来这条流程并把待办工作放

13、在最后一个的结束的节点上。参数名类型说明默认值flowNoSystem.String流程编号workIDSystem.Int64工作ID0msgSystem.String原因执行信息32Flow_DoDeleteFlowByReal执行删除流程:彻底的删除流程.清除的内容如下:1,流程引擎中的数据.2,节点数据,NDxxRpt数据.3,轨迹表数据.参数名类型说明默认值flowNoSystem.String流程编号workIDSystem.Int64工作ID0isDelSubFlowSystem.Boolean是否要删除它的子流程执行信息33Flow_DoDeleteFlowByFlag执行逻辑

14、删除流程:此流程并非真正的删除仅做了流程删除标记比如:逻辑删除工单.参数名类型说明默认值flowNoSystem.String流程编号workIDSystem.Int64工作ID0msgSystem.String逻辑删除的原因isDelSubFlowSystem.Boolean逻辑删除的原因执行信息,执行不成功抛出异常.34Flow_DoUnDeleteFlowByFlag撤销删除流程说明:如果一个流程处于逻辑删除状态,要回复正常运行状态,就执行此接口.参数名类型说明默认值flowNoSystem.String流程编号workIDSystem.Int64工作流程ID0msgSystem.Str

15、ing撤销删除的原因执行消息,如果撤销不成功则抛出异常.35Flow_DoUnSend执行-撤销发送说明:如果流程转入了下一个节点,就会执行失败,就会抛出异常.参数名类型说明默认值flowNoSystem.String流程编号workIDSystem.Int64工作ID0返回成功执行信息36Flow_DoFlowOver执行流程结束说明:正常的流程结束.参数名类型说明默认值flowNoSystem.String流程编号workIDSystem.Int64工作ID0msgSystem.String流程结束原因返回成功执行信息37Flow_DoFlowOverByCoercion执行流程结束:强制

16、的流程结束.参数名类型说明默认值flowNoSystem.String流程编号workIDSystem.Int64工作ID0msgSystem.String强制流程结束的原因执行强制结束流程38Flow_GetCurrentNode获取指定的workid在运行到的节点编号参数名类型说明默认值workIDSystem.Int64需要找到的workid0返回节点编号.如果没有找到，就会抛出异常.39Flow_GetCurrentWork获取指定节点的Work参数名类型说明默认值nodeIDSystem.Int32节点ID0workIDSystem.Int64工作ID0当前工作40Flow_GetC

17、urrentWork获取当前工作节点的Work参数名类型说明默认值workIDSystem.Int64工作ID0当前工作节点的Work41Flow_GetWorkerList指定workid当前节点由哪些人可以执行.参数名类型说明默认值workIDSystem.Int64需要找到的workid0返回当前处理人员列表,数据结构与WF_GenerWorkerList一致.42Flow_CheckIsCanDoCurrentWork检查当前人员是否有权限处理当前的工作.参数名类型说明默认值workIDSystem.Int64工作ID0userNoSystem.String要判断的操作人员返回指定的人

18、员是否有操作当前工作的权限43Flow_CheckIsCanViewCurrentWork检查当前人员是否有查看指定流程的权限参数名类型说明默认值workIDSystem.Int64工作ID0userNoSystem.String用户编号返回是否可以查看44Flow_NewStartWork创建一个工作参数名类型说明默认值flowNoSystem.String流程编号要创建的工作，此工作已经具备了WorkID。45Flow_DoPress执行工作催办参数名类型说明默认值workIDSystem.Int64工作ID0msgSystem.String催办消息isPressSubFlowSystem

19、.Boolean是否催办子流程？返回执行结果46Node_StartWork发起新工作参数名类型说明默认值flowNoSystem.String流程编号htSystem.Collections.Hashtable节点表单:主表数据以KeyValue方式传递(可以为空)workDtlsSystem.Data.DataSet节点表单:从表数据，从表名称与从表单的从表编号要对应(可以为空)fk_NodeSheetfJumpToSystem.Int32发起后要跳转到的节点(可以为空)0nextWorkerSystem.String发起后要跳转到的节点并指定的工作人员(可以为空)执行信息47Node_C

20、reateBlankWork创建一个空白的工作参数名类型说明默认值flowNoSystem.String流程编号htSystem.Collections.Hashtable主表信息，可以为空workDtlsSystem.Data.DataSet从表信息，可以为空nextWorkerSystem.String工作的处理人无48Node_SendWork执行工作发送参数名类型说明默认值fk_flowSystem.String流程编号workIDSystem.Int64工作ID0返回发送结果49Node_SendWork执行工作发送参数名类型说明默认值fk_flowSystem.String工作编号

21、workIDSystem.Int64工作ID0htSystem.Collections.Hashtable节点表单数据返回发送结果50Node_SendWork执行工作发送参数名类型说明默认值fk_flowSystem.String工作编号workIDSystem.Int64工作ID0htSystem.Collections.Hashtable节点表单数据dsDtlSystem.Data.DataSet节点表单从表数据返回发送结果51Node_SendWork发送工作参数名类型说明默认值nodeIDSystem.String节点编号workIDSystem.Int64工作ID0返回执行信息52

22、Node_SendWork发送工作参数名类型说明默认值fk_flowSystem.String流程编号workIDSystem.Int64工作ID0htWorkSystem.Collections.Hashtable节点表单数据(Hashtable中的key与节点表单的字段名相同,value就是字段值)执行信息53Node_SendWork发送工作参数名类型说明默认值fk_flowSystem.String流程编号workIDSystem.Int64工作ID0htWorkSystem.Collections.Hashtable节点表单数据(Hashtable中的key与节点表单的字段名相同,v

23、alue就是字段值)workDtlsSystem.Data.DataSet节点表单明从表数据(dataset可以包含多个table，每个table的名称与从表名称相同，列名与从表的字段相同,OID,RefPK列需要为空或者null)执行信息54Node_CC执行抄送参数名类型说明默认值empNoSystem.String抄送人员编号empNameSystem.String抄送人员人员名称fk_nodeSystem.Int32节点编号0workidSystem.Int64工作ID0fidSystem.Int64FID0无55Node_CC执行抄送参数名类型说明默认值empNoSystem.Str

24、ing抄送人员编号empNameSystem.String抄送人员人员名称fk_nodeSystem.Int32节点编号0workidSystem.Int64工作ID0fidSystem.Int64FID0msgTitleSystem.String标题msgDocSystem.String内容无56Node_SaveWork保存参数名类型说明默认值nodeIDSystem.String节点IDworkIDSystem.Int64工作ID0返回保存的信息57Node_SaveWork保存参数名类型说明默认值fk_flowSystem.String流程编号workIDSystem.Int64wor

25、kid0wkSystem.Collections.Hashtable节点表单参数58Node_SaveWork保存参数名类型说明默认值nodeIDSystem.String节点IDworkIDSystem.Int64工作ID0htWorkSystem.Collections.Hashtable工作数据返回执行信息59Node_SaveFlowSheet保存流程表单参数名类型说明默认值fk_mapdataSystem.String流程表单IDworkIDSystem.Int64工作ID0htDataSystem.Collections.Hashtable流程表单数据KeyValue格式存放.返回执行信息60Node_SaveFlowSheet保存流