Abort Flow Utility (Magic xpi 4.5)
The Abort Flow utility lets you abort the flow execution on purpose, as part of the flow logic. You also have the option to restart the flow automatically after it is aborted by the Abort Flow utility.
To add the Abort Flow utility to a flow:
-
Drag the Abort Flow utility from the Toolbox pane to your flow.
-
In the Properties pane, enter the information as described in the table below:
|
|
|
|
General
|
|
Step Name
|
Type a name that describes the utility in the flow.
|
|
Description
|
Type a description of the utility in your flow (optional).
|
|
Step ID
|
A read-only field displaying the ID of the step in the flow.
|
|
Component ID
|
An internal identifier number generated automatically.
|
|
Component Type
|
A read-only field displaying the name of the step type.
|
|
Condition
|
Enter a condition to specify the flow's execution behavior. You can either click  to open the Expression Editor, or you can right-click on the component and select Condition from the context menu.
|
|
Processing mode
|
Select whether the step should be executed linear, parallel or stand-alone.
|
Note:
|
This is available only if the Abort Flow utility is not the first step in a flow.
|
|
|
Wait for completion
|
Select whether the step should be run in Wait for Completion mode. The options are Yes or No.
|
Note:
|
This is available only when the Abort Flow utility is a Linear step and if it is not the first step in the flow.
|
|
|
Advanced
|
|
Save point
|
Select Yes to indicate that the step is a Save Point in your flow.
|
Note:
|
This is available only if the flow's Recovery Policy is set to Save Point.
|
|
|
Call logic flow
|
You can use this option if you want to call generic logic after the execution of a specific step. Once this step has been executed, the flow logic that you defined in the flow properties is called before the Server continues to the following steps.
The options are Yes or No (default).
|
-
Double-click or right-click on the Abort Flow utility and select Configuration from the context menu to open the Abort Flow Configuration dialog box. This dialog box has the following fields:
|
|
|
|
Restart
|
Determines whether you want to restart the aborted flow. Select one of the following from the drop-down list:
|
|
Propagation Error
|
An applicative user error can be generated when the flow is aborted. The behavior is relevant only when another flow called the flow that caused the error.
Enter the (numeric) error code, or click  to open the Expression Editor.
If you do not define a user error, or the selected error does not exist, a general error message ("Flow was aborted") is issued.
|
-
Click OK to close the Abort Flow Configuration dialog box. The Abort Flow utility is displayed in the flow.
|
Note:
|
You can abort a flow if an error occurs, without specifying this policy for every component. To do this, add an Abort Flow utility to the end of the error flow. In the calling flow's Error Policies repository, set the error range to encompass all the General component error codes whose failure will trigger the error. This causes the flow to abort when there is an error in the flow.
|
