Enable Flow Utility (Magic xpi 4.5)
The Enable Flow utility lets you determine whether a flow should run at any point in a project. You can disable or enable a flow manually when the project is deployed thorough the Magic Monitor, or you can use the Enable Flow utility to automatically determine when flows are run. This utility lets you create an expression to change the flow mode according to your definition. The flow mode determines whether the flow is enabled or disabled.
An example would be when you want a flow to run only if a specific item does not exist in a company's inventory. In this case, you can define a flow variable that is updated each time that the inventory for that item changes. You write an expression that states that the flow will run when the variable's value indicates that the item is no longer in the company inventory. The expression's value must be numeric, where 0 (or less than 0) indicates that the flow is disabled, and 1 (or greater than 1) indicates that the flow is enabled.
|
Note:
|
You can enable a disabled flow either using this utility or through the Monitor. When you enable a disabled flow, the polling triggers begin polling.
|
To add the Enable Flow utility to a flow:
-
Drag the Enable 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 Enable 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 Enable 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 Enable Flow utility and select Configuration from the context menu to open the Enable Flow Configuration dialog box. This dialog box has the following fields:
|
|
|
|
Flow ID
|
The ID of the flow to enable/disable. Click to open the Flow List. Select the flow to be enable/disable and then click Select. To delete the flow that is selected, click Reset.
|
|
Flow Mode
|
Select whether to enable or disable the flow. The drop-down list has three options:
-
-
0 or < 0 = disable
-
1 or > 1 = enable
You can also click  to open the Expression Editor to create the expression.
|
-
Click OK to close the Enable Flow Configuration dialog box. The Enable Flow utility is displayed in the flow.
