Stop
The Stop function is used to conditionally skip assignment statements, the execution phase, or
both, for a workflow, node, or task. The execution phase or assignment statements are skipped when the
conditions attribute for the Stop function is true.
You can use this function to skip assignment statements that have an executionPoint
attribute of onEntry or onExit. The assignment statements that are defined after the Stop function are the
statements that might be skipped when the conditions attribute for the Stop function is true.
Which assignment statements, or whether the execution phase is skipped, is controlled by a constant value that
you specify in the value attribute of the Stop function.
The constants in the following list control what is skipped when the Stop condition is true. Specify only
one of the following constants in the
value attribute of the Stop function.- GOTO_EXECUTION
- This option skips the rest of the onEntry assignment statements and resumes with the execution phase. For a table task, the execution phase is the table lookup. For a node, it’s the operation that is specific to the node. This option is ignored when the Stop function is defined with the onExit assignment statements.
- GOTO_ONEXIT
- This option skips the rest of the onEntry assignment statements and the execution phase. It resumes with the onExit assignment statements. This option is ignored when the Stop function is defined with the onExit assignment statements.
- GOTO_END
- This option skips the rest of the onEntry assignment statements, the execution phase, and the onExit assignment statements. It is the same as returning immediately. This option is not ignored when the Stop function is defined with the onExit assignment statements.
- No value provided
- This option is the same as specifying GOTO_END.
The Stop function can be used to optionally set the results flag for the workflow, node, or task. The
values to use in the
value attribute of the Stop function are shown in the following list.
You can use only one of these constants in the value attribute.- RETURN_SUCCESS
- Sets the results flag to SUCCESS.
- RETURN_FAILURE
- Sets the results flag to FAILURE.
- No value provided
- Doesn't change the results flag value that was set by the workflow, node, or task. The trace entry that is logged for this option is return_as_is.
Return type
The function return type is: BOOLEAN
Function parameters
| Parameter order | Input variable type | Parameter data type | Required parameter | Description |
|---|---|---|---|---|
| 1 | Constant | FIXED | No | A constant that indicates what the Stop function skips or indicates how it returns the results flag. |
| 2 | Constant | FIXED | No | A constant that indicates what the Stop function skips or indicates how it returns the results flag. This constant can't be from the same list as the constant you use in parameter 1. |
The order that the two parameters are passed to the Stop function doesn't matter. However, both parameters
can't be from the same list of constants that are available for the
value attribute. For
example, both parameters can't be a constant that indicates what the Stop function skips. The following
example shows two valid ways to specify GOTO_END and RETURN_FAILURE
as the parameters for the Stop
function.<assignment field="" type="Stop" value="'GOTO_END','RETURN_FAILURE'" conditions="ibmEntryDate IS notCurrent"/>
<assignment field="" type="Stop" value="'RETURN_FAILURE','GOTO_END'" conditions="ibmEntryDate IS notCurrent"/>The following condition settings do not apply to the Stop function.
- empty
- current
- notCurrent
- sourceCurrent