流程表单回调方法
平台提供流程表单操作流程回调方法汇总:以下回调均可通过返回false来取消代码的的继续执行,比如:beforeSaveOrUpdateWorkflow(){return false;} // 不会继续执行提交到工作流表单的代码。
1、保存或修改流程实例数据
/**
* 保存或修改流程实例数据之前调用
* @param workflowRequest json: 流程表单请求数据
* @param formData json: 表单数据
* @return [Boolean] 如果是返回false,则不会继续执行请求
*/
function beforeSaveOrUpdateWorkflow(workflowRequest, formData){ }
/**
* 保存或修改流程实例数据成功调用
* @param response json: 请求返回数据
* @return [Boolean] 如果是返回false,则不会继续执行后续操作
*/
function saveOrUpdateWorkflowSuccess(response){ }
/**
* 保存或修改流程实例数据失败调用
* @param xhr json:
* @param response json: 请求返回数据
* @return [Boolean] 如果是返回false,则不会继续执行后续操作
*/
function saveOrUpdateWorkflowFail(xhr, response){ }
2、获取下一步骤发送的待选步骤和用户信息列表
/**
* 获取下一步骤发送的待选步骤和用户信息列表之前调用
* @param procId string: 流程实例ID
* @param taskId int: 流程实例步骤ID
* @param formData json: 表单数据
* @return [Boolean] 如果是返回false,则不会继续执行请求
*/
function beforeQueryWorkflowNextSteps(procId, taskId, formData){ }
/**
* 获取下一步骤发送的待选步骤和用户信息列表成功调用
* @param response json: 请求返回数据
* @return [Boolean] 如果是返回false,则不会继续执行后续操作
*/
function queryWorkflowNextStepsSuccess(response){ }
/**
* 获取下一步骤发送的待选步骤和用户信息列表失败调用
* @param response json: 请求返回数据
* @return [Boolean] 如果是返回false,则不会继续执行后续操作
*/
function queryWorkflowNextStepsFail(xhr, response){ }
3、运行流程实例
/**
* 运行流程实例之前调用
* @param workflowRequest json: 流程表单请求数据
* @param formData json: 表单数据
* @param choices array[json]: 流程选择步骤数据
* @return [Boolean] 如果是返回false,则不会继续执行请求
*/
function beforeRunWorkflow(workflowRequest, formData, choices){ }
/**
* 运行流程实例成功调用
* @param response json: 请求返回数据
* @return [Boolean] 如果是返回false,则不会继续执行后续操作
*/
function runWorkflowSuccess(response){ }
/**
* 运行流程实例失败调用
* @param response json: 请求返回数据
* @return [Boolean] 如果是返回false,则不会继续执行后续操作
*/
function runWorkflowFail(xhr, response){ }
4、根据流程实例ID删除流程实例
/**
* 根据流程实例ID删除流程实例之前调用
* @param procId string: 流程实例ID
* @return [Boolean] 如果是返回false,则不会继续执行请求
*/
function beforeDeleteWorkflow(procId){ }
/**
* 根据流程实例ID删除流程实例成功调用
* @param response json: 请求返回数据
* @return [Boolean] 如果是返回false,则不会继续执行后续操作
*/
function deleteWorkflowSuccess(response){ }
/**
* 根据流程实例ID删除流程实例失败调用
* @param response json: 请求返回数据
* @return [Boolean] 如果是返回false,则不会继续执行后续操作
*/
function deleteWorkflowFail(xhr, response){ }
5、传阅流程实例
/**
* 传阅流程实例之前调用
* @param procId string: 流程实例ID
* @param taskId int: 流程实例步骤ID
* @param users array[json]: 传阅用户列表
* @return [Boolean] 如果是返回false,则不会继续执行请求
*/
function beforeCirculateWorkflow(procId, taskId, users){ }
/**
* 传阅流程实例成功调用
* @param response json: 请求返回数据
* @return [Boolean] 如果是返回false,则不会继续执行后续操作
*/
function circulateWorkflowSuccess(response){ }
/**
* 传阅流程实例失败调用
* @param response json: 请求返回数据
* @return [Boolean] 如果是返回false,则不会继续执行后续操作
*/
function circulateWorkflowFail(xhr, response){ }
6、撤回流程实例工作项
/**
* 撤回流程实例工作项之前调用
* @param procId string: 流程实例ID
* @param taskId int: 流程实例步骤ID
* @return [Boolean] 如果是返回false,则不会继续执行请求
*/
function beforeRollbackWorkflow(procId, taskId){ }
/**
* 撤回流程实例工作项成功调用
* @param response json: 请求返回数据
* @return [Boolean] 如果是返回false,则不会继续执行后续操作
*/
function rollbackWorkflowSuccess(response){ }
/**
* 撤回流程实例工作项失败调用
* @param response json: 请求返回数据
* @return [Boolean] 如果是返回false,则不会继续执行后续操作
*/
function rollbackWorkflowFail(xhr, response){ }
7、退回上一步流程实例工作项
/**
* 退回上一步流程实例工作项之前调用
* @param procId string: 流程实例ID
* @param taskId int: 流程实例步骤ID
* @param opinionContent string: 意见内容
* @param opinionArea string: 意见区域
* @return [Boolean] 如果是返回false,则不会继续执行请求
*/
function beforePushbackWorkflow(procId, taskId, opinionContent, opinionArea){ }
/**
* 退回上一步流程实例工作项成功调用
* @param response json: 请求返回数据
* @return [Boolean] 如果是返回false,则不会继续执行后续操作
*/
function pushbackWorkflowSuccess(response){ }
/**
* 退回上一步流程实例工作项失败调用
* @param response json: 请求返回数据
* @return [Boolean] 如果是返回false,则不会继续执行后续操作
*/
function pushbackWorkflowFail(xhr, response){ }
8、退回第一步流程实例工作项
/**
* 退回第一步流程实例工作项之前调用
* @param procId string: 流程实例ID
* @param taskId int: 流程实例步骤ID
* @param opinionContent string: 意见内容
* @param opinionArea string: 意见区域
* @return [Boolean] 如果是返回false,则不会继续执行请求
*/
function beforePushbackToRootWorkflow(procId, taskId, opinionContent, opinionArea){ }
/**
* 退回第一步流程实例工作项成功调用
* @param response json: 请求返回数据
* @return [Boolean] 如果是返回false,则不会继续执行后续操作
*/
function pushbackToRootWorkflowSuccess(response){ }
/**
* 退回第一步流程实例工作项失败调用
* @param response json: 请求返回数据
* @return [Boolean] 如果是返回false,则不会继续执行后续操作
*/
function pushbackToRootWorkflowFail(xhr, response){ }