Enable Flow Service (Magic xpi 3.x)
The Enable Flow service 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 xpi Monitor Navigation Pane or you can use the Enable Flow service to automatically determine when flows are run. This service 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 service or through the Monitor. When you enable a disabled flow, the flow's triggers are also enabled and polling triggers begin polling.
|
|
To add the Enable Flow service to a flow:
-
Find the services icons in the Components pane at the left of the screen. You can display only the services by selecting Services from the drop-down list at the top of the Components pane.
-
Drag the Enable Flow service to your flow.
-
In the Enable Flow dialog box, enter the information as described in the table below:
|
|
Name
|
Type a name that describes the service in the flow
|
Description
|
Type a description of the service in your flow (optional)
|
Processing mode
|
Select whether the step should be executed linear, parallel or stand-alone. This is only available if the Enable Flow service is not the first step in the flow.
|
Wait for completion
|
Select whether the step should be run in Wait for Completion mode. The options are Yes or No.
Note:
|
Wait for completion is only available when the Enable Flow service is a Linear step and if it is not the first step in the flow.
|
|
|
Save Point
|
Select Yes to indicate that the step is a Save Point in your flow. This is available only if the flow's Recovery Policy is set to Save Point.
|
Magic xpi Server
|
Select the Magic xpi Server where the Enable Flow service is executed.
Click to the right of the Magic xpi Server field to open the Server List. Select a server from the list and then click Select.
|
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).
|
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. The flow is displayed next to the button. 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 and close the Enable Flow dialog box. The Enable Flow service is displayed in the flow.