Invoke Flow Utility (Magic xpi 4.7)
The Invoke Flow utility invokes a flow using the flow ID. The flow is executed on the relevant Magic xpi Server and based on the first flow component’s invocation properties.
To add the Invoke Flow utility to a flow:
-
Drag the Invoke 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 Invoke 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 Invoke 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 Invoke Flow utility and select Configuration from the context menu to open the Invoke Flow Configuration dialog box. This dialog box has the following fields:
|
|
|
|
Invoke by Expression
|
This field enables you to invoke a flow dynamically according to expressions that are evaluated at runtime. Select one of the following from the drop-down list:
|
|
To invoke a flow dynamically, you need to supply both the business process ID and the flow ID. You can use the GetBPID and GetFlowID functions to locate the business process ID and the flow ID.
|
|
|
Flow ID
|
The flow to be invoked. This field can be used in two different ways.
-
If you set the Invoke by Expression field (above) to No, click to open the Flow List. Select the flow to be invoked and then click Select. The selected flow is displayed next to the button.
-
If you set the Invoke by Expression field (above) to Yes, click  to open the Expression Editor. You can use the Expression Editor to enter an expression that represents the flow ID that you want to invoke.
|
|
Arguments
|
Click to open the Invoke Arguments dialog box. Here you can define the following parameters:
-
Destination Variable: Click to select a target flow variable.
-
In/Out: Select In, Out or In/Out.
-
Source Variable: Click to select a source variable. This is available only when you select Out or In/Out.
-
Source Variable EXP: Enter a value using the Expression Editor. This is available only when you select In.
|
|
BP ID
|
The business process to be invoked. Click to open the Expression Editor. You can use the Expression Editor to enter an expression that represents the business ID that you want to invoke.
This field is available only if you select Yes in the Invoke by Expression field (above).
|
-
Click OK to close the Invoke Flow Configuration dialog box. The Invoke Flow utility is displayed in the flow.
|
|
You can move directly to the flow that you that you want to invoke, as defined in the Invoke Flow utility. To do this, right-click on the Invoke Flow utility icon in the flow, and select Move To Flow from the context menu. The Magic xpi Studio will then display the invoked flow and set it to Active.
At the same time, the Move Back button  is enabled in the Magic xpi Studio toolbar. To return to the invoking flow, click this button.
|
