com.actionsoft.sdk.local.api

接口 ProcessDataLoaderAPI

public interface ProcessDataLoaderAPI

指定处理时间，迁移外部流程实例控制接口。该API适用于迁移外部历史流程数据，也适合基于规则的数据事件进行模拟执行，如监控分析外部流程的执行绩效。不支持自动化执行的系统任务、系统类节点及由网关自动化触发的时间指定。

方法概要

限定符和类型	方法和说明
ProcessExecuteQuery	completeTask(java.lang.String taskInstId, java.util.Map<java.lang.String,java.lang.Object> vars, java.lang.String uid, boolean isBranch, java.sql.Timestamp endTime) 提交流程变量数据，完成任务，任务类型可以是普通人工任务、服务任务、子流程任务及 加签这类的特殊任务。
ProcessExecuteQuery	completeTask(java.lang.String taskInstId, java.util.Map<java.lang.String,java.lang.Object> vars, java.lang.String uid, java.sql.Timestamp endTime) 提交流程变量数据，完成任务，任务类型可以是普通人工任务、服务任务、子流程任务及 加签这类的特殊任务。
TaskInstance	createCallActivityTaskInstance(ProcessInstance processInst, TaskInstance parentTaskInstModel, java.lang.String targetActivityDefId, java.lang.String title, java.sql.Timestamp beginTime) 一个特定创建日期的调用外部子流程任务实例，同时启动相关子流程。
TaskInstance	createCallActivityTaskInstanceByBusinessKey(java.lang.String processBusinessKey, java.lang.String parentTaskInstId, java.lang.String targetActivityDefId, java.lang.String title, java.sql.Timestamp beginTime) 一个特定创建日期的调用外部子流程任务实例，同时启动相关子流程。
TaskInstance	createCallActivityTaskInstanceById(java.lang.String processInstId, java.lang.String parentTaskInstId, java.lang.String targetActivityDefId, java.lang.String title, java.sql.Timestamp beginTime) 一个特定创建日期的调用外部子流程任务实例，同时启动相关子流程。
ProcessInstance	createProcessInstance(java.lang.String processDefId, java.lang.String processBusinessKey, java.lang.String uid, java.lang.String createUserDeptId, java.lang.String createUserRoleId, java.lang.String title, java.sql.Timestamp createTime, java.util.Map<java.lang.String,java.lang.Object> vars) 一个特定创建日期的流程实例，支持短流程或人工+系统混编的流程。
ProcessInstance	createShortProcessInstance(java.lang.String processDefId, java.lang.String processBusinessKey, java.lang.String title, java.sql.Timestamp createTime, java.util.Map<java.lang.String,java.lang.Object> vars) 一个特定创建日期的流程实例，适用于系统集成类的短流程启动。
ProcessInstance	createSubProcessInstance(java.lang.String processBusinessKey, java.lang.String createUser, java.lang.String title, java.lang.String callActivityTaskInstId, java.sql.Timestamp createTime, java.util.Map<java.lang.String,java.lang.Object> vars) 一个特定创建日期的常规子流程实例，支持短流程或人工+系统混编的流程。
ProcessInstance	createSubProcessInstance(java.lang.String createUser, java.lang.String title, java.lang.String callActivityTaskInstId, java.sql.Timestamp createTime, java.util.Map<java.lang.String,java.lang.Object> vars) 一个特定创建日期的常规子流程实例，支持短流程或人工+系统混编的流程。
java.util.List<TaskInstance>	createUserTaskInstance(ProcessInstance processInst, TaskInstance parentTaskInstModel, UserContext userContext, java.lang.String targetActivityDefId, java.lang.String participant, java.lang.String title, int priority, java.sql.Timestamp beginTime) 一个特定创建日期的人工任务实例。
java.util.List<TaskInstance>	createUserTaskInstanceByBusinessKey(java.lang.String processBusinessKey, java.lang.String parentTaskInstId, java.lang.String uid, java.lang.String targetActivityDefId, java.lang.String participant, java.lang.String title, int priority, java.sql.Timestamp beginTime) 一个特定创建日期的人工任务实例。
java.util.List<TaskInstance>	createUserTaskInstanceById(java.lang.String processInstId, java.lang.String parentTaskInstId, java.lang.String uid, java.lang.String targetActivityDefId, java.lang.String participant, java.lang.String title, int priority, java.sql.Timestamp beginTime) 一个特定创建日期的人工任务实例。
java.io.File	exp(java.lang.String processInstId, java.util.Map<java.lang.String,java.util.List<?>> attrs, boolean expBOData, java.io.File expTmpDir) 导出流程数据zip文件包
void	imp(java.lang.String processInstId, java.io.File jar, java.io.File impTmpDir, boolean clear) 导入实例ID为processInstId的流程数据包到
void	imp(java.lang.String processInstId, java.io.File jar, java.io.File impTmpDir, boolean clear, boolean replace, UserContext userContext)
ProcessExecuteQuery	start(ProcessInstance processInst, java.sql.Timestamp startTime) 启动流程， 使用第1个NoneStartEvent来启动该流程。
ProcessExecuteQuery	startByBusinessKey(java.lang.String processBusinessKey, java.sql.Timestamp startTime) 通过processBusinessKey启动流程， 使用第1个NoneStartEvent来启动该流程。
ProcessExecuteQuery	startById(java.lang.String processInstId, java.sql.Timestamp startTime) 通过id启动流程， 使用第1个NoneStartEvent来启动该流程。
void	terminateByBusinessKey(java.lang.String processBusinessKey, java.lang.String uid, java.sql.Timestamp terminateTime) 通过processBusinessKey终止一个流程实例。
void	terminateById(java.lang.String processInstId, java.lang.String uid, java.sql.Timestamp terminateTime) 通过id终止一个流程实例。

方法详细资料

imp

void imp(java.lang.String processInstId,
         java.io.File jar,
         java.io.File impTmpDir,
         boolean clear)
  throws java.io.IOException

导入实例ID为processInstId的流程数据包到

参数:

processInstId - 对应的流程实例

jar - 数据包

impTmpDir - jar包临时解压目录

clear - 是否删除jar和解压文件

抛出:

java.io.IOException

imp

void imp(java.lang.String processInstId,
         java.io.File jar,
         java.io.File impTmpDir,
         boolean clear,
         boolean replace,
         UserContext userContext)
  throws java.io.IOException

参数:

processInstId -

jar -

impTmpDir -

clear -

replace - 创建、更新日期为安装日期，创建、更新人为当前安装人

抛出:

java.io.IOException

exp

java.io.File exp(java.lang.String processInstId,
                 java.util.Map<java.lang.String,java.util.List<?>> attrs,
                 boolean expBOData,
                 java.io.File expTmpDir)
          throws java.io.IOException

导出流程数据zip文件包

参数:

processInstId - 流程实例

attrs - 其它数据

expBOData - 是否导出BO数据

expTmpDir - 导出临时目录，zip文件包所在目录

返回:

抛出:

java.io.IOException

createShortProcessInstance

ProcessInstance createShortProcessInstance(java.lang.String processDefId,
                                           java.lang.String processBusinessKey,
                                           java.lang.String title,
                                           java.sql.Timestamp createTime,
                                           java.util.Map<java.lang.String,java.lang.Object> vars)
                                    throws AWSAPIException,
                                           BPMNError

一个特定创建日期的流程实例，适用于系统集成类的短流程启动。短流程是指没有人工节点(UserTask)的系统流程，可能在瞬间执行完毕。

该方法主要用于集成外部表单或为外部系统提供流程API服务，processBusinessKey在工作流引擎实例表中必须是全局不重复的值， 比如一个CRM系统的订单编号 （如该业务键将执行多个不同的BPM流程，如订单的审批流程、订单的发货流程，则该业务键应该是个组合值，例如2012003 -APPROVAL、 2012003-SHIPMENT）。使用processBusinessKey可避免外部系统建立与BPMS的实例对照字段

参数:

processDefId - 流程定义ID,如果是versionId则根据版本状态使用"RUN"版本

processBusinessKey - 外部业务系统数据主键标识值或一个组合值，在工作流引擎实例表中全局不能重复，可以为null

title - 便于系统维护人员识别的实例短标题名，可以为null

createTime - 创建时间

vars - 流程变量值，可以为null

返回:

创建的流程实例对象

抛出:

AWSAPIException - 系统异常

BPMNError - 业务异常

createProcessInstance

ProcessInstance createProcessInstance(java.lang.String processDefId,
                                      java.lang.String processBusinessKey,
                                      java.lang.String uid,
                                      java.lang.String createUserDeptId,
                                      java.lang.String createUserRoleId,
                                      java.lang.String title,
                                      java.sql.Timestamp createTime,
                                      java.util.Map<java.lang.String,java.lang.Object> vars)
                               throws AWSAPIException,
                                      BPMNError

一个特定创建日期的流程实例，支持短流程或人工+系统混编的流程。该方法支持了createUserDeptId参数， 如果流程启动者可能含有ORG兼任的身份，该参数用来获得启动者的启动身份。

该方法主要用于集成外部表单或为外部系统提供流程API服务，processBusinessKey在工作流引擎实例表中必须是全局不重复的值， 比如一个CRM系统的订单编号 （如该业务键将执行多个不同的BPM流程，如订单的审批流程、订单的发货流程，则该业务键应该是个组合值，例如2012003 -APPROVAL、 2012003-SHIPMENT）。使用processBusinessKey可避免外部系统建立与BPMS的实例对照字段。

参数:

processDefId - 流程定义ID,如果是versionId则根据版本状态使用"RUN"版本

processBusinessKey - 外部业务系统数据主键标识值或一个组合值，在工作流引擎实例表中全局不能重复，可以为null

uid - 创建人，一个合法的AWS账户名

createUserDeptId - 启动者所在的部门ID（这个参数用于使用兼任身份启动流程，可以为null）

createUserRoleId - 启动者的角色ID（这个参数用于使用兼任身份启动流程，可以为null）

title - 流程标题，给定一个方便用户识别的扼要信息，长度建议在64位内

createTime - 创建时间

vars - 流程变量值，可以为null

返回:

创建的流程实例对象

抛出:

AWSAPIException - 系统异常

BPMNError - 业务异常

createSubProcessInstance

ProcessInstance createSubProcessInstance(java.lang.String createUser,
                                         java.lang.String title,
                                         java.lang.String callActivityTaskInstId,
                                         java.sql.Timestamp createTime,
                                         java.util.Map<java.lang.String,java.lang.Object> vars)

一个特定创建日期的常规子流程实例，支持短流程或人工+系统混编的流程。

参数:

createUser - 创建人，一个合法的AWS账户名

title - 流程标题，给定一个方便用户识别的扼要信息，长度建议在64位内

callActivityTaskInstId -

createTime - 创建时间

vars - 流程变量值，可以为null

返回:

createSubProcessInstance

ProcessInstance createSubProcessInstance(java.lang.String processBusinessKey,
                                         java.lang.String createUser,
                                         java.lang.String title,
                                         java.lang.String callActivityTaskInstId,
                                         java.sql.Timestamp createTime,
                                         java.util.Map<java.lang.String,java.lang.Object> vars)

一个特定创建日期的常规子流程实例，支持短流程或人工+系统混编的流程。

参数:

processBusinessKey - 外部业务系统数据主键标识值或一个组合值，在工作流引擎实例表中全局不能重复，可以为null

createUser - 创建人，一个合法的AWS账户名

title - 流程标题，给定一个方便用户识别的扼要信息，长度建议在64位内

callActivityTaskInstId -

createTime - 创建时间

vars - 流程变量值，可以为null

返回:

start

ProcessExecuteQuery start(ProcessInstance processInst,
                          java.sql.Timestamp startTime)
                   throws AWSAPIException,
                          BPMNError

启动流程， 使用第1个NoneStartEvent来启动该流程。

参数:

processInst - 流程实例结构对象

startTime - 启动时间

返回:

由ProcessExecuteQuery包装的引擎执行结果

抛出:

AWSAPIException - 系统异常

BPMNError - 业务异常

startByBusinessKey

ProcessExecuteQuery startByBusinessKey(java.lang.String processBusinessKey,
                                       java.sql.Timestamp startTime)
                                throws AWSAPIException,
                                       BPMNError

通过processBusinessKey启动流程， 使用第1个NoneStartEvent来启动该流程。

参数:

processBusinessKey - 外部业务系统数据主键标识值或一个组合值，在工作流引擎实例表中全局不能重复

startTime - 启动时间

返回:

由ProcessExecuteQuery包装的引擎执行结果

抛出:

AWSAPIException - 系统异常

BPMNError - 业务异常

startById

ProcessExecuteQuery startById(java.lang.String processInstId,
                              java.sql.Timestamp startTime)
                       throws AWSAPIException,
                              BPMNError

通过id启动流程， 使用第1个NoneStartEvent来启动该流程。

参数:

processInstId - 流程实例ID

startTime - 启动时间

返回:

由ProcessExecuteQuery包装的引擎执行结果

抛出:

AWSAPIException - 系统异常

BPMNError - 业务异常

terminateById

void terminateById(java.lang.String processInstId,
                   java.lang.String uid,
                   java.sql.Timestamp terminateTime)
            throws AWSAPIException,
                   BPMNError

通过id终止一个流程实例。不按照预先的流程路径自然完成流程的执行，强行终止流程各分支活动的任务（及子流程活动） 和活动令牌，然后执行close操作 。 若此时有任务未处理完，将终止的任务转换到 H表，其controlstate状态被标记为terminate。

参数:

processInstId - 流程实例ID

uid - 终止人，可以为null

terminateTime - 终止时间

抛出:

AWSAPIException - 系统异常

BPMNError - 业务异常

terminateByBusinessKey

void terminateByBusinessKey(java.lang.String processBusinessKey,
                            java.lang.String uid,
                            java.sql.Timestamp terminateTime)
                     throws AWSAPIException,
                            BPMNError

通过processBusinessKey终止一个流程实例。不按照预先的流程路径自然完成流程的执行，强行终止流程各分支活动的任务（及子流程活动 ） 和活动令牌，然后执行close操作 。 若此时有任务未处理完，将终止的任务转换到 H表，其controlstate状态被标记为terminate。

参数:

processBusinessKey - 外部业务系统数据主键标识值或一个组合值，在工作流引擎实例表中全局不能重复

uid - 终止人，可以为null

terminateTime - 终止时间

抛出:

AWSAPIException - 系统异常

BPMNError - 业务异常

createUserTaskInstance

java.util.List<TaskInstance> createUserTaskInstance(ProcessInstance processInst,
                                                    TaskInstance parentTaskInstModel,
                                                    UserContext userContext,
                                                    java.lang.String targetActivityDefId,
                                                    java.lang.String participant,
                                                    java.lang.String title,
                                                    int priority,
                                                    java.sql.Timestamp beginTime)
                                             throws AWSAPIException,
                                                    BPMNError

一个特定创建日期的人工任务实例。

参数:

processInst - 流程实例对象

parentTaskInstModel - 要产生任务的当前人工任务实例对象，如果是流程启动时第1个产生的任务允许为null

userContext - 操作者对象

targetActivityDefId - 目标节点定义Id(UserTask)

participant - 参与者,一个或多个AWS账户（多个用空格隔开）

title - 任务标题

priority - 优先级。0=低；1=无；2=中；3=高

beginTime - 指定创建日期

返回:

TaskInstance集合，每个参与者对应List结果的一个任务实例

抛出:

AWSAPIException - 系统异常

BPMNError - 业务异常

另请参阅:

TaskRuntimeConst

createUserTaskInstanceByBusinessKey

java.util.List<TaskInstance> createUserTaskInstanceByBusinessKey(java.lang.String processBusinessKey,
                                                                 java.lang.String parentTaskInstId,
                                                                 java.lang.String uid,
                                                                 java.lang.String targetActivityDefId,
                                                                 java.lang.String participant,
                                                                 java.lang.String title,
                                                                 int priority,
                                                                 java.sql.Timestamp beginTime)
                                                          throws AWSAPIException,
                                                                 BPMNError

一个特定创建日期的人工任务实例。

参数:

processBusinessKey - 外部业务系统数据主键标识值或一个组合值，在工作流引擎实例表中全局不能重复

parentTaskInstId - 要产生任务的当前人工任务实例对象，如果是流程启动时第1个产生的任务允许为null

uid - 操作者,一个合法的AWS账户名

targetActivityDefId - 目标节点定义Id(UserTask)

participant - 参与者,一个或多个AWS账户（多个用空格隔开）

title - 任务标题

priority - 优先级 。0=低；1=无；2=中；3=高

beginTime - 指定创建日期

返回:

TaskInstance集合，每个参与者对应List结果的一个任务实例

抛出:

AWSAPIException - 系统异常

BPMNError - 业务异常

另请参阅:

TaskRuntimeConst

createUserTaskInstanceById

java.util.List<TaskInstance> createUserTaskInstanceById(java.lang.String processInstId,
                                                        java.lang.String parentTaskInstId,
                                                        java.lang.String uid,
                                                        java.lang.String targetActivityDefId,
                                                        java.lang.String participant,
                                                        java.lang.String title,
                                                        int priority,
                                                        java.sql.Timestamp beginTime)
                                                 throws AWSAPIException,
                                                        BPMNError

一个特定创建日期的人工任务实例。

参数:

processInstId - 流程实例Id

parentTaskInstId - 要产生任务的当前人工任务实例对象，如果是流程启动时第1个产生的任务允许为null

uid - 操作者,一个合法的AWS账户名

targetActivityDefId - 目标节点定义Id(UserTask)

participant - 参与者,一个或多个AWS账户（多个用空格隔开）

title - 任务标题

priority - 优先级 。0=低；1=无；2=中；3=高

beginTime - 指定创建日期

返回:

TaskInstance集合，每个参与者对应List结果的一个任务实例

抛出:

AWSAPIException - 系统异常

BPMNError - 业务异常

另请参阅:

TaskRuntimeConst

createCallActivityTaskInstance

TaskInstance createCallActivityTaskInstance(ProcessInstance processInst,
                                            TaskInstance parentTaskInstModel,
                                            java.lang.String targetActivityDefId,
                                            java.lang.String title,
                                            java.sql.Timestamp beginTime)
                                     throws AWSAPIException,
                                            BPMNError

一个特定创建日期的调用外部子流程任务实例，同时启动相关子流程。CallActivity任务本身不支持异步参数，由子流程配置决定， 如果外部子流程全部为异步设置， 那么该任务等同异步 。创建CallActivity任务不需要制定owner和target，如果依赖执行的是人工类子流程， 这两个参数根据子流程的配置参数和事件代码决定

参数:

processInst - 流程实例对象

parentTaskInstModel - 父任务实例对象，如果是流程启动时第1个产生的任务允许为null

targetActivityDefId - 节点定义ID(CallActivity)

title - 任务标题（仅用于运维），允许为null

beginTime - 指定创建日期

抛出:

AWSAPIException - 系统异常

BPMNError - 业务异常

createCallActivityTaskInstanceById

TaskInstance createCallActivityTaskInstanceById(java.lang.String processInstId,
                                                java.lang.String parentTaskInstId,
                                                java.lang.String targetActivityDefId,
                                                java.lang.String title,
                                                java.sql.Timestamp beginTime)
                                         throws AWSAPIException,
                                                BPMNError

一个特定创建日期的调用外部子流程任务实例，同时启动相关子流程。CallActivity任务本身不支持异步参数，由子流程配置决定， 如果外部子流程全部为异步设置， 那么该任务等同异步 。创建CallActivity任务不需要制定owner和target，如果依赖执行的是人工类子流程， 这两个参数根据子流程的配置参数和事件代码决定。

参数:

processInstId - 流程实例Id

parentTaskInstId - 父任务实例Id，如果是流程启动时第1个产生的任务允许为null

targetActivityDefId - 节点定义ID(CallActivity)

title - 任务标题（仅用于运维），允许为null

beginTime - 指定创建日期

返回:

创建的CallActivity任务实例

抛出:

AWSAPIException - 系统异常

BPMNError - 业务异常

createCallActivityTaskInstanceByBusinessKey

TaskInstance createCallActivityTaskInstanceByBusinessKey(java.lang.String processBusinessKey,
                                                         java.lang.String parentTaskInstId,
                                                         java.lang.String targetActivityDefId,
                                                         java.lang.String title,
                                                         java.sql.Timestamp beginTime)
                                                  throws AWSAPIException,
                                                         BPMNError

一个特定创建日期的调用外部子流程任务实例，同时启动相关子流程。CallActivity任务本身不支持异步参数，由子流程配置决定， 如果外部子流程全部为异步设置， 那么该任务等同异步 。创建CallActivity任务不需要制定owner和target，如果依赖执行的是人工类子流程， 这两个参数根据子流程的配置参数和事件代码决定。

参数:

processBusinessKey - 外部业务系统数据主键标识值或一个组合值，在工作流引擎实例表中全局不能重复

parentTaskInstId - 父任务实例Id，如果是流程启动时第1个产生的任务允许为null

targetActivityDefId - 节点定义ID(CallActivity)

title - 任务标题（仅用于运维），允许为null

beginTime - 指定创建日期

返回:

创建的CallActivity任务实例

抛出:

AWSAPIException - 系统异常

BPMNError - 业务异常

completeTask

ProcessExecuteQuery completeTask(java.lang.String taskInstId,
                                 java.util.Map<java.lang.String,java.lang.Object> vars,
                                 java.lang.String uid,
                                 java.sql.Timestamp endTime)
                          throws AWSAPIException,
                                 BPMNError

提交流程变量数据，完成任务，任务类型可以是普通人工任务、服务任务、子流程任务及 加签这类的特殊任务。如果评估可以达成向后推进的条件，自动向下推进。

参数:

taskInstId - 任务实例Id

vars - 流程变量值，可以为null

uid - 操作者,一个合法的AWS账户名

endTime - 结束时间

返回:

由ProcessExecuteQuery包装的引擎执行结果

抛出:

AWSAPIException - 系统异常

BPMNError - 业务异常

completeTask

ProcessExecuteQuery completeTask(java.lang.String taskInstId,
                                 java.util.Map<java.lang.String,java.lang.Object> vars,
                                 java.lang.String uid,
                                 boolean isBranch,
                                 java.sql.Timestamp endTime)
                          throws AWSAPIException,
                                 BPMNError

提交流程变量数据，完成任务，任务类型可以是普通人工任务、服务任务、子流程任务及 加签这类的特殊任务。如果评估可以达成向后推进的条件，isBraching决定是否向下推进。

参数:

taskInstId - 任务实例Id

vars - 流程变量值，可以为null

uid - 操作者,一个合法的AWS账户名

isBranch - 如果评估可以达成向后推进的条件，是否继续自动向下执行。如果开发者不希望干扰后继的路线的执行， 应提供true值。该选项对传阅、加签等非常规任务无效

endTime - 结束时间

返回:

由ProcessExecuteQuery包装的引擎执行结果

抛出:

AWSAPIException - 系统异常

BPMNError - 业务异常