Schedule Flow Utility (Magic xpi 4.13)
The Schedule Flow utility lets you create schedules for flow invocation. You use this utility to start a flow after specific actions in another flow, however the flow will not be called until its scheduled time. If the flow that contains the Schedule Flow utility does not run, the Magic xpi Server does not execute the schedule. This utility is used as a step in a flow. You can also set conditions to the step or to the flow's scheduled time and date so that the schedule is executed only if the conditions are met.
At deployment, the Magic xpi Server uses the Schedule information to invoke flows at the required time periods.
To add the Schedule Flow utility to a flow:
-
Drag the Schedule 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.
|
|
This is available only if the Schedule 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.
|
|
This is available only when the Schedule 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.
|
|
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 Schedule Flow utility and select Configuration from the context menu to open the Schedule Flow Configuration dialog box. This dialog box has the following fields:
|
|
|
|
Flow ID
|
The ID of the flow to be scheduled. Click the button to open the Flow List. Select the flow to be scheduled and then click Select.
|
|
Date
|
Indicate the date the flow is to begin in dd/MM/yyyy format
You can click  next to the Date field to open the Expression Editor and create an expression or condition to define the date to call the specified flow. You can use this when you want to change the schedule according to specific events that occur in the current flow or project. Enter an expression or use a variable to dynamically define the date to call the flow.
|
|
Time
|
Indicate the Time that the flow is to begin in hh:mm:ss format.
You can click next to the Time field to open the Expression Editor and create an expression or condition to define the time to call the specified flow. You can use this when you want to change the schedule according to specific events that occur in the current flow or project. Enter an expression or use a variable to dynamically define the time to call the flow.
|
-
Click OK to close the Schedule Flow Configuration dialog box. The Schedule Flow utility is displayed in the flow.
