驰骋工作流引擎SDKCCFlow6.docx

资源描述

驰骋工作流引擎SDKCCFlow6.docx

《驰骋工作流引擎SDKCCFlow6.docx》由会员分享，可在线阅读，更多相关《驰骋工作流引擎SDKCCFlow6.docx（64页珍藏版）》请在冰豆网上搜索。

驰骋工作流引擎SDKCCFlow6.docx

驰骋工作流引擎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.aspx

序号

方法名

功能描述

参数

返回值

DTS_AutoStarterFlow

自动执行开始节点数据说明:

根据自动执行的流程设置，自动启动发起的流程。

比如：

您根据ccflow的自动启动流程的设置，自动启动该流程，不使用ccflow的提供的服务程序，您需要按如下步骤去做。

1,写一个自动调度的程序。

2，根据自己的时间需要调用这个接口。

参数名

类型

说明

默认值

BP.WF.Flow

流程实体,您可以newFlow（flowNo）;来传入.

无

DB_GenerTrack

获取流程事例的运行轨迹数据.说明：

使用这些数据可以生成流程的操作日志.

参数名

类型

说明

默认值

fk_flow

System.String

流程编号

workid

System.Int64

工作ID

fid

System.Int64

流程ID

从临时表与轨迹表获取流程轨迹数据.

DB_CCList

获取指定人员的抄送列表说明:

可以根据这个列表生成指定用户的抄送数据.

参数名

类型

说明

默认值

fk_emp

System.String

人员编号

返回该人员的所有抄送列表,结构同表WF_CCList.

DB_CCList_UnRead

获取指定人员的抄送列表（未读）

参数名

类型

说明

默认值

fk_emp

System.String

人员编号

返回该人员的未读的抄送列表

DB_CCList_Read

获取指定人员的抄送列表（已读）

参数名

类型

说明

默认值

fk_emp

System.String

人员编号

返回该人员的已读的抄送列表

DB_CCList_Delete

获取指定人员的抄送列表（已删除）

参数名

类型

说明

默认值

fk_emp

System.String

人员编号

返回该人员的已删除的抄送列表

DB_GenerCanStartFlowsOfEntities

获取当前操作员可以发起的流程集合说明:

利用此接口可以生成用户的发起的流程列表.

BP.WF.Flows对象集合.如何使用该方法形成发起工作列表,请参考:

\WF\UC\Start.ascx.

DB_GenerCanStartFlowsOfEntities

获取指定人员能够发起流程的集合.说明:

利用此接口可以生成用户的发起的流程列表.

参数名

类型

说明

默认值

userNo

System.String

操作员编号

BP.WF.Flows可发起的流程对象集合,如何使用该方法形成发起工作列表,请参考:

\WF\UC\Start.ascx

DB_GenerCanStartFlowsOfDataTable

获取指定人员能够发起流程的集合说明:

利用此接口可以生成用户的发起的流程列表.

参数名

类型

说明

默认值

userNo

System.String

操作员编号

Datatable类型的数据集合,数据结构与表WF_Flow大致相同.如何使用该方法形成发起工作列表,请参考:

\WF\UC\Start.ascx

DB_GenerHLSubFlowDtl_TB

获取（同表单）合流点上的子线程说明:

如果您要想在合流点看到所有的子线程运行的状态.

参数名

类型

说明

默认值

nodeIDOfHL

System.Int32

合流点ID

workid

System.Int64

工作ID

与表WF_GenerWorkerList结构类同的datatable.

DB_GenerHLSubFlowDtl_YB

获取（异表单）合流点上的子线程

参数名

类型

说明

默认值

nodeIDOfHL

System.Int32

合流点ID

workid

System.Int64

工作ID

与表WF_GenerWorkerList结构类同的datatable.

DB_GenerDraftDataTable

获取当前操作员的指定流程的流程草稿数据

参数名

类型

说明

默认值

fk_flow

System.String

流程编号

返回草稿数据集合,列信息.OID=工作ID,Title=标题,RDT=记录日期,FK_Flow=流程编号,FID=流程ID,FK_Node=节点ID

DB_GenerEmpWorksOfDataTable

根据状态获取当前操作员的待办工作

参数名

类型

说明

默认值

wfState

BP.WF.WFState

流程状态

fk_flow

System.String

流程编号

表结构与视图WF_EmpWorks一致

DB_GenerEmpWorksOfDataTable

获取当前操作人员的待办信息数据内容请参考图:

WF_EmpWorks

返回从视图WF_EmpWorks查询出来的数据.

DB_GenerHungUpList

获得所有的流程挂起工作列表

返回从视图WF_EmpWorks查询出来的数据.

DB_GenerHungUpList

获得指定流程挂起工作列表

参数名

类型

说明

默认值

fk_flow

System.String

流程编号,如果编号为空则返回所有的流程挂起工作列表.

返回从视图WF_EmpWorks查询出来的数据.

DB_GenerDeleteWorkList

获得逻辑删除的流程

返回从视图WF_EmpWorks查询出来的数据.

DB_GenerDeleteWorkList

获得逻辑删除的流程:

根据流程编号

参数名

类型

说明

默认值

userNo

System.String

操作员编号

fk_flow

System.String

流程编号（可以为空）

WF_GenerWorkFlow数据结构的集合

DB_NDxxRpt

根据流程状态获取指定流程数据

参数名

类型

说明

默认值

fk_flow

System.String

流程编号

sta

BP.WF.WFState

流程状态

数据表OID,Title,RDT,FID

DB_GenerWillReturnNodes

获取当前节点可以退回的节点

参数名

类型

说明

默认值

fk_node

System.Int32

节点ID

workid

System.Int64

工作ID

fid

System.Int64

FID

No节点编号,Name节点名称,Rec记录人,RecName记录人名称

DB_GenerRuning

获取未完成的流程（也称为在途流程:

我参与的但是此流程未完成）

参数名

类型

说明

默认值

fk_flow

System.String

流程编号

返回从数据视图WF_GenerWorkflow查询出来的数据.

DB_GenerRuning

获取未完成的流程（也称为在途流程:

我参与的但是此流程未完成）

返回从数据视图WF_GenerWorkflow查询出来的数据.

Port_Login

用户登陆,此方法是在开发者校验好用户名与密码后执行

参数名

类型

说明

默认值

userNo

System.String

用户名

SID

System.String

安全ID,请参考流程设计器操作手册

无

Port_Login

用户登陆,此方法是在开发者校验好用户名与密码后执行

参数名

类型

说明

默认值

userNo

System.String

用户名

无

Port_SigOut

注销当前登录

无

Port_SendMail

发送邮件与消息

参数名

类型

说明

默认值

userNo

System.String

信息接收人

msgTitle

System.String

标题

msgDoc

System.String

内容

无

Port_SendSMS

发送SMS

参数名

类型

说明

默认值

userNo

System.String

信息接收人

msgTitle

System.String

标题

msgDoc

System.String

内容

无

Flow_GenerWorkID

产生一个新的工作ID

参数名

类型

说明

默认值

flowNo

System.String

流程编号

返回当前操作员创建的工作ID

Flow_GenerWork

产生一个新的工作

参数名

类型

说明

默认值

flowNo

System.String

流程编号

返回当前操作员创建的工作

Flow_IsCanStartThisFlow

检查指定的人员是否可以发起改流程

参数名

类型

说明

默认值

flowNo

System.String

流程编号

fk_emp

System.String

操作员编号

false不能启动该流程

Flow_DoComeBackWrokFlow

恢复流程,在一件工作完成后，要恢复上来这条流程并把待办工作放在最后一个的结束的节点上。

参数名

类型

说明

默认值

flowNo

System.String

流程编号

workID

System.Int64

工作ID

msg

System.String

原因

执行信息

Flow_DoDeleteFlowByReal

执行删除流程:

彻底的删除流程.清除的内容如下:

1,流程引擎中的数据.2,节点数据,NDxxRpt数据.3,轨迹表数据.

参数名

类型

说明

默认值

flowNo

System.String

流程编号

workID

System.Int64

工作ID

isDelSubFlow

System.Boolean

是否要删除它的子流程

执行信息

Flow_DoDeleteFlowByFlag

执行逻辑删除流程:

此流程并非真正的删除仅做了流程删除标记比如:

逻辑删除工单.

参数名

类型

说明

默认值

flowNo

System.String

流程编号

workID

System.Int64

工作ID

msg

System.String

逻辑删除的原因

isDelSubFlow

System.Boolean

逻辑删除的原因

执行信息,执行不成功抛出异常.

Flow_DoUnDeleteFlowByFlag

撤销删除流程说明:

如果一个流程处于逻辑删除状态,要回复正常运行状态,就执行此接口.

参数名

类型

说明

默认值

flowNo

System.String

流程编号

workID

System.Int64

工作流程ID

msg

System.String

撤销删除的原因

执行消息,如果撤销不成功则抛出异常.

Flow_DoUnSend

执行-撤销发送说明:

如果流程转入了下一个节点,就会执行失败,就会抛出异常.

参数名

类型

说明

默认值

flowNo

System.String

流程编号

workID

System.Int64

工作ID

返回成功执行信息

Flow_DoFlowOver

执行流程结束说明:

正常的流程结束.

参数名

类型

说明

默认值

flowNo

System.String

流程编号

workID

System.Int64

工作ID

msg

System.String

流程结束原因

返回成功执行信息

Flow_DoFlowOverByCoercion

执行流程结束:

强制的流程结束.

参数名

类型

说明

默认值

flowNo

System.String

流程编号

workID

System.Int64

工作ID

msg

System.String

强制流程结束的原因

执行强制结束流程

Flow_GetCurrentNode

获取指定的workid在运行到的节点编号

参数名

类型

说明

默认值

workID

System.Int64

需要找到的workid

返回节点编号.如果没有找到，就会抛出异常.

Flow_GetCurrentWork

获取指定节点的Work

参数名

类型

说明

默认值

nodeID

System.Int32

节点ID

workID

System.Int64

工作ID

当前工作

Flow_GetCurrentWork

获取当前工作节点的Work

参数名

类型

说明

默认值

workID

System.Int64

工作ID

当前工作节点的Work

Flow_GetWorkerList

指定workid当前节点由哪些人可以执行.

参数名

类型

说明

默认值

workID

System.Int64

需要找到的workid

返回当前处理人员列表,数据结构与WF_GenerWorkerList一致.

Flow_CheckIsCanDoCurrentWork

检查当前人员是否有权限处理当前的工作.

参数名

类型

说明

默认值

workID

System.Int64

工作ID

userNo

System.String

要判断的操作人员

返回指定的人员是否有操作当前工作的权限

Flow_CheckIsCanViewCurrentWork

检查当前人员是否有查看指定流程的权限

参数名

类型

说明

默认值

workID

System.Int64

工作ID

userNo

System.String

用户编号

返回是否可以查看

Flow_NewStartWork

创建一个工作

参数名

类型

说明

默认值

flowNo

System.String

流程编号

要创建的工作，此工作已经具备了WorkID。

Flow_DoPress

执行工作催办

参数名

类型

说明

默认值

workID

System.Int64

工作ID

msg

System.String

催办消息

isPressSubFlow

System.Boolean

是否催办子流程？

返回执行结果

Node_StartWork

发起新工作

参数名

类型

说明

默认值

flowNo

System.String

流程编号

System.Collections.Hashtable

节点表单:

主表数据以KeyValue方式传递（可以为空）

workDtls

System.Data.DataSet

节点表单:

从表数据，从表名称与从表单的从表编号要对应（可以为空）

fk_NodeSheetfJumpTo

System.Int32

发起后要跳转到的节点（可以为空）

nextWorker

System.String

发起后要跳转到的节点并指定的工作人员（可以为空）

执行信息

Node_CreateBlankWork

创建一个空白的工作

参数名

类型

说明

默认值

flowNo

System.String

流程编号

System.Collections.Hashtable

主表信息，可以为空

workDtls

System.Data.DataSet

从表信息，可以为空

nextWorker

System.String

工作的处理人

无

Node_SendWork

执行工作发送

参数名

类型

说明

默认值

fk_flow

System.String

流程编号

workID

System.Int64

工作ID

返回发送结果

Node_SendWork

执行工作发送

参数名

类型

说明

默认值

fk_flow

System.String

工作编号

workID

System.Int64

工作ID

System.Collections.Hashtable

节点表单数据

返回发送结果

Node_SendWork

执行工作发送

参数名

类型

说明

默认值

fk_flow

System.String

工作编号

workID

System.Int64

工作ID

System.Collections.Hashtable

节点表单数据

dsDtl

System.Data.DataSet

节点表单从表数据

返回发送结果

Node_SendWork

发送工作

参数名

类型

说明

默认值

nodeID

System.String

节点编号

workID

System.Int64

工作ID

返回执行信息

Node_SendWork

发送工作

参数名

类型

说明

默认值

fk_flow

System.String

流程编号

workID

System.Int64

工作ID

htWork

System.Collections.Hashtable

节点表单数据（Hashtable中的key与节点表单的字段名相同,value就是字段值）

执行信息

Node_SendWork

发送工作

参数名

类型

说明

默认值

fk_flow

System.String

流程编号

workID

System.Int64

工作ID

htWork

System.Collections.Hashtable

节点表单数据（Hashtable中的key与节点表单的字段名相同,value就是字段值）

workDtls

System.Data.DataSet

节点表单明从表数据（dataset可以包含多个table，每个table的名称与从表名称相同，列名与从表的字段相同,OID,RefPK列需要为空或者null）

执行信息

Node_CC

执行抄送

参数名

类型

说明

默认值

empNo

System.String

抄送人员编号

empName

System.String

抄送人员人员名称

fk_node

System.Int32

节点编号

workid

System.Int64

工作ID

fid

System.Int64

FID

无

Node_CC

执行抄送

参数名

类型

说明

默认值

empNo

System.String

抄送人员编号

empName

System.String

抄送人员人员名称

fk_node

System.Int32

节点编号

workid

System.Int64

工作ID

fid

System.Int64

FID

msgTitle

System.String

标题

msgDoc

System.String

内容

无

Node_SaveWork

保存

参数名

类型

说明

默认值

nodeID

System.String

节点ID

workID

System.Int64

工作ID

返回保存的信息

Node_SaveWork

保存

参数名

类型

说明

默认值

fk_flow

System.String

流程编号

workID

System.Int64

workid

System.Collections.Hashtable

节点表单参数

Node_SaveWork

保存

参数名

类型

说明

默认值

nodeID

System.String

节点ID

workID

System.Int64

工作ID

htWork

System.Collections.Hashtable

工作数据

返回执行信息

Node_SaveFlowSheet

保存流程表单

参数名

类型

说明

默认值

fk_mapdata

System.String

流程表单ID

workID

System.Int64

工作ID

htData

System.Collections.Hashtable

流程表单数据KeyValue格式存放.

返回执行信息

Node_SaveFlowSheet

保存流

展开阅读全文