ksc_move_request_workflow

This special command causes a workflow event to occur on the specified request.

Table 3-3. ksc_move_request_workflow parameters

Parameter

Description

REQUEST_ID

The ID of the request to take action on. This is a required parameter, and should default to the token for the ID of the current request ("[REQ.REQUEST_ID]").

FROM_WORKFLOW_STEP_SEQ

The sequence number of the step to take action on. This is a required parameter, and should default to the token for the active step of the current request ("[WFS.STEP_NO]").

EVENT_NAME

The type of workflow event to start.This is a required parameter. The following events are supported (same as the workflow transition database open interface):

  • INSTANCE_SET_CREATE. For request submission.

  • APPROVAL_VOTE. For decision step. If this event is specified, then the RESULT_VISIBLE_VALUE parameter should also be specified to indicate which of the step's outcomes to choose.

  • APPROVAL_DELEGATE. For decision step being delegated. If this event is specified, then the DELEGATE_TO_USERNAME parameter should also be provided.

  • EXECUTION_EXECUTE. For execution step.

  • EXECUTION_SCHEDULE. For execution step being scheduled. If this event is specified, then the SCHEDULE_DATE parameter must be provided.

  • BYPASS_EXECUTION. For execution step being bypassed. If this event is specified, then the RESULT_VISIBLE_VALUE parameter should also be specified to indicate which result value to override the execution step with.

  • RESULT_OVERRIDE. For an active step being overridden. If this event is specified, then the RESULT_VISIBLE_VALUE parameter must be specified to indicate which of the step's outcomes to choose.

  • INSTANCE_SET_CANCEL. For cancelling the request.

  • FORCE_TRANSITION. For forcing a transition from the step specified in FROM_WORKFLOW_STEP_SEQ to an arbitrary destination step, which may not have a valid transition in the workflow configuration. If this event is specified, then you must specify the RESULT_VISIBLE_VALUE and TO_WORKFLOW_STEP_SEQ parameters, to indicate the result value shown for the source step, and which step should be the destination of the forced transition.

RESULT_VISIBLE_VALUE

The visible value of the desired result value for the workflow action, if applicable. This is the value the user would choose in the user interface while taking action on a workflow, and should default to NULL. Most of the events require the result visible value to be specified (see the EVENT_NAME for specifics).

SCHEDULE_DATE

The date to schedule an execution event. This should default to NULL. Only used with EXECUTION_SCHEDULE events, otherwise it is ignored.

DELEGATE_TO_USER_ID

The ID of the user to whom the current user's approval vote should be delegated. This should default to NULL. Only used with APPROVAL_DELEGATE events, otherwise it is ignored.

TO_WORKFLOW_STEP_SEQ

The sequence number of the desired step to transition to. This should default to NULL. Only used with FORCE_TRANSITION events, otherwise it is ignored.