4、工作项管理

更新时间： 2024-09-12

类名

H3.DataModel.IWorkItemManager

接口清单

序号	接口名称	说明
1	AddWorkItems	添加一组工作项
2	CancelWorkItem	取消一个工作项
3	GetWorkItem	根据ID获取一个工作项
4	GetWorkItems	根据参与者和节点名称获取工作项
5	ForwardWorkItem	转交一个工作项
6	FinishWorkItem	完成一个工作项
7	FinishCirculateByIds	将指定的传阅工作项标为已阅
8	Urge	催办

基本用法

上述清单中的接口均归属在this.Engine.WorkItemManager下，如要获取一个工作项，可使用如下代码形式：

H3.Workflow.WorkItem.WorkItem workItem = this.Engine.WorkItemManager.GetWorkItem("XXX");

其他接口使用方式与此类似。

接口说明

1. AddWorkItems(WorkItem[] workItems, bool isChildInstance = false)

1.1. 说明

添加一组工作项，这样可以保证事务化，以防有的工作项刚刚添加就被完成了。添加一个工作项的时候，需要在这里设置他的被添加时间，而不能以创建的时间为准，因为创建的时间可能来自于其他服务器或者客户端，这就有可能涉及时区的问题，如果以外部的时间为准就无法统一了。

1.2. 参数

参数名	说明
workItems	新建的工作项数组，细节详见`H3.Workflow.WorkItem.WorkItem`
isChildInstance	是否子流程，默认为`false`

1.3. 返回值

类型	说明
string[]	添加的工作项ID

2. CancelWorkItem(string workItemId)

2.1. 说明

取消一个工作项，相应的征询意见的工作项也会被取消。

2.2. 参数

参数名	说明
workItemId	工作项ID

2.3. 返回值

类型	说明
H3.ErrorCode	错误代码

3. GetWorkItem(string workItemId)

3.1. 说明

根据ID获取一个工作项。

3.2. 参数

参数名	说明
workItemId	工作项ID

3.3. 返回值

类型	说明
H3.Workflow.WorkItem.WorkItem	工作项

4. GetWorkItems(string schemaCode, string[] participants, string[] activityNames)

4.1. 说明

根据参与者和节点名称获取工作项。

4.2. 参数

参数名	说明
schemaCode	表单编码
participants	参与者
activityNames	节点名称

4.3. 返回值

类型	说明
H3.Workflow.WorkItem.WorkItem[]	工作项

5. ForwardWorkItem(string workItemId, string participant, string comment, string commentId = "", bool isNewComment = false, bool notify = true)

5.1. 说明

转交一个工作项。转交一个工作项给某人，不能创建新工作项，否则引用这些工作项的地方无法取消这个工作项,如果暂存后再转发，审批意见需要覆盖。

5.2. 参数

参数名	说明
workItemId	工作项ID
participant	接收人
comment	转交意见
commentId	转交意见ID,可不传
isNewComment	是否是新的转交意见，默认为`false`
notify	是否发送工作通知，默认为`true`

5.3. 返回值

类型	说明
H3.ErrorCode	错误代码

6. FinishWorkItem(string userId, string workItemId, AccessMethod finishAccessMethod, H3.Data.BoolValue approval, string comment, string actionName, ActionEventType actionEventType, bool isChildInstance = true)

6.1. 说明

完成一个工作项。

6.2. 参数

参数名	说明
userId	提交人员
workItemId	工作项ID
finishAccessMethod	提交人员的接入方式，详见`H3.Workflow.WorkItem.AccessMethod`
approval	审批结果
comment	审批意见
actionName	操作名称
actionEventType	操作的事件类型，详见`H3.Workflow.WorkItem.ActionEventType`
isChildInstance	是否子流程

6.3. 返回值

类型	说明
H3.ErrorCode	错误代码

7. FinishCirculateByIds(string userId, string[] workItemIds, AccessMethod finishAccessPoint, string comment, string actionName)

7.1. 说明

将指定的传阅工作项标为已阅。

7.2. 参数

参数名	说明
userId	用户ID
workItemIds	工作项ID
finishAccessPoint	提交人员的接入方式，详见`H3.Workflow.WorkItem.AccessMethod`
comment	评论
actionName	操作名称

7.3. 返回值

类型	说明
H3.ErrorCode	错误代码

8. Urge(string userId, string instanceId, string content)

8.1. 说明

催办。

8.2. 参数

参数名	说明
userId	催办人ID
instanceId	催办的流程实例ID
content	催办的内容

8.3. 返回值

类型	说明
无	无

4、工作项管理更新时间： 2024-09-12 类名H3.DataModel.IWorkItemManager接口清单序号接口名称说明1AddWorkItems添加一组工作项2CancelWorkItem取消一个工作项3GetWorkItem根据ID获取一个工作项4GetWorkItems根据参与者和节点名称获取工作项5ForwardWorkItem转交一个工作项6FinishWorkItem完成一个工作项7FinishCirculateByIds将指定的传阅工作项标为已阅8Urge催办基本用法上述清单中的接口均归属在this.Engine.WorkItemManager下，如要获取一个工作项，可使用如下代码形式：H3.Workflow.WorkItem.WorkItem workItem = this.Engine.WorkItemManager.GetWorkItem("XXX");其他接口使用方式与此类似。接口说明1. AddWorkItems(WorkItem[] workItems, bool isChildInstance = false)1.1. 说明添加一组工作项，这样可以保证事务化，以防有的工作项刚刚添加就被完成了。添加一个工作项的时候，需要在这里设置他的被添加时间，而不能以创建的时间为准，因为创建的时间可能来自于其他服务器或者客户端，这就有可能涉及时区的问题，如果以外部的时间为准就无法统一了。1.2. 参数参数名说明workItems新建的工作项数组，细节详见H3.Workflow.WorkItem.WorkItemisChildInstance是否子流程，默认为false1.3. 返回值类型说明string[]添加的工作项ID2. CancelWorkItem(string workItemId)2.1. 说明取消一个工作项，相应的征询意见的工作项也会被取消。2.2. 参数参数名说明workItemId工作项ID2.3. 返回值类型说明H3.ErrorCode错误代码3. GetWorkItem(string workItemId)3.1. 说明根据ID获取一个工作项。3.2. 参数参数名说明workItemId工作项ID3.3. 返回值类型说明H3.Workflow.WorkItem.WorkItem工作项4. GetWorkItems(string schemaCode, string[] participants, string[] activityNames)4.1. 说明根据参与者和节点名称获取工作项。4.2. 参数参数名说明schemaCode表单编码participants参与者activityNames节点名称4.3. 返回值类型说明H3.Workflow.WorkItem.WorkItem[]工作项5. ForwardWorkItem(string workItemId, string participant, string comment, string commentId = "", bool isNewComment = false, bool notify = true)5.1. 说明转交一个工作项。转交一个工作项给某人，不能创建新工作项，否则引用这些工作项的地方无法取消这个工作项,如果暂存后再转发，审批意见需要覆盖。5.2. 参数参数名说明workItemId工作项IDparticipant接收人comment转交意见commentId转交意见ID,可不传isNewComment是否是新的转交意见，默认为falsenotify是否发送工作通知，默认为true5.3. 返回值类型说明H3.ErrorCode错误代码6. FinishWorkItem(string userId, string workItemId, AccessMethod finishAccessMethod, H3.Data.BoolValue approval, string comment, string actionName, ActionEventType actionEventType, bool isChildInstance = true)6.1. 说明完成一个工作项。6.2. 参数参数名说明userId提交人员workItemId工作项IDfinishAccessMethod提交人员的接入方式，详见H3.Workflow.WorkItem.AccessMethodapproval审批结果comment审批意见actionName操作名称actionEventType操作的事件类型，详见H3.Workflow.WorkItem.ActionEventTypeisChildInstance是否子流程6.3. 返回值类型说明H3.ErrorCode错误代码7. FinishCirculateByIds(string userId, string[] workItemIds, AccessMethod finishAccessPoint, string comment, string actionName)7.1. 说明将指定的传阅工作项标为已阅。7.2. 参数参数名说明userId用户IDworkItemIds工作项IDfinishAccessPoint提交人员的接入方式，详见H3.Workflow.WorkItem.AccessMethodcomment评论actionName操作名称7.3. 返回值类型说明H3.ErrorCode错误代码8. Urge(string userId, string instanceId, string content)8.1. 说明催办。8.2. 参数参数名说明userId催办人IDinstanceId催办的流程实例IDcontent催办的内容8.3. 返回值类型说明无无

类名