Call Client Flow
The Call Client Flow construct is used to invoke and execute Client Flow within an event, function or another client flow logic. This construct enables modularization and promotes code reusability, allowing for structured and organized logic.
Steps to Add a Call Client Flow Construct in a Logic Flow
- Drag and Drop: In the designer canvas of a logic flow, drag and drop the Call Client Flow construct into the flow.
- Configure Properties: Double-click the construct to configure its properties as required and then click save.
Properties
| Property | Description | Comments |
|---|---|---|
| Label | Labels help developers quickly understand each step in the logic flow without examining the details of the construct. | It is recommended to provide a simple precise label that improves the logic flow readability. |
| Client Flow* | The name of the Client Flow to be executed, selected from a drop-down list. | |
| Input Parameters | The required parameters to pass into the Client Flow using the Expression Builder. | Ensure that all input parameters are assigned with a value. |
| Execution Mode* | Defines how the Client Flow executes: | Sequential – Executes in order and waits for completion. Async – Executes independently without waiting for completion. |
| Activity Handle* | Unique identifier required for Asynchronous execution. | Visible only if Execution Mode is set to async. This will be awaited when required. Activity Handle is used to track and manage asynchronous activities. Since asynchronous operations do not return responses immediately, the Activity Handle acts as a reference to monitor the execution and retrieve results when available. |
| Output Mapping* | The output mapping type is selected and mapped to the return type of the selected Client Flow. | All existing parameters in the current flow are loaded if they match with the data type of the selected Client Flow output parameter. |
| Comment | Specify whether to comment this construct or not. Either Yes or No. | If marked as Yes, the construct is treated as a commented expression and ignored in code generation. |
| Description | Provides details about the Call Client Flow purpose and behaviour. | Helps in understanding Call Client Flow construct significance. |
Note: Properties marked with an asterisk (*) are mandatory for configuring the Call Client Flow construct.
Upon successfully adding the Call Client Flow construct, a confirmation message is displayed.
Sample example for the selected Client flow.
- Async Operation is true – Executive Mode is Visible
- If we select Async – Activity Handle is visible
- If we select Sequential -- Output Mapping is Visible
- Async Operation is false – Output Mapping is Visible
Output Mapping params are loaded based on the flow type.
| Flow Name | OutputMapping Params |
|---|---|
| Clientflow | Input Parameters, Output Parameter, and Variables |
| Event/Function | Models, Appcontext, and Variables |
| Subscriptions | Models, Appcontext, and Variables |
| Component Event | Models, Appcontext, and Variables |
| Component Subscriptions | Models, Appcontext, and Variables |
| Appcomponent | Variables and Appcontext |
| SocketIOEvents – Receive Events | Output Parameter and Variables |
| SocketIOEvents – Send Events | Input Parameters and Variables |
| WebsocketEvents - OnClose | Variables |
| WebsocketEvents - OnError | Variables |
| WebsocketEvents - OnMessage | Output Parameter and Variables |
| WebsocketEvents - OnOpen | Variables |
| WebsocketEvents – Send Events | Input Parameters and Variables |