Create a flow
To create a flow, select the New flow button in the Bottom toolbar of the Flow overview section to open the Flow editor.
The Flow editor has two sections:
-
The Flow roadmap: The section on the left defines the roadmap of the flow and has the following subsections:
- Trigger: To select and configure the trigger of the flow.
- Add filter: Dynamic section, which you can optionally define, that allows you to stop a flow depending on the output of the previous step of the action associated to it. This way the flow will react to more specific events.
- Add condition: Dynamic section, which you can optionally define, that allows you to conditionally skip the action it is associated with.
- Action: To define what actions will follow a triggered event. The flow must contain at least one action.
- Overview: Summary of the state of the flow. See Overview section for more details.
-
The Dynamic section: The section on the right side dynamically changes depending on what you choose on the left, allowing you to enter values relevant only to the currently chosen element.
Name your flow
To save your flow you must first name it. To name your flow:
- Go to the top of the Flow roadmap section.
- Select the Pencil icon.
- Enter the name of your flow following the flow naming convention.
Flow naming convention
You must follow the naming convention for the flows created in the Preview and Production environments as shown in the example below:
[Owner]-[ShortName]-[FlowName]-[FlowType]-[Version]
- Owner: For example, U4, if the flow was created by Unit4.
- ShortName: Short name of the tenant ID given in the Portal.
- FlowName: Short name of the Trigger. For example, SE - Scheduler Event, MH - Message Hub Event, WH - Webhook.
- FlowType: Type of the flow. For example, employee, if the flow uses the Employee object in the ERP public API.
- Version: Current version of the flow.
Example
U4-EUN-PLW-PREV-MH-EMPLOYEE-01.001
Note: You can only save a flow if the name, trigger and all actions are properly defined.
Trigger configuration
The trigger defines what will start your flow. To create a new flow:
-
Select the Trigger node in the Flow roadmap and the Dynamic section will show you all the triggers that you can add.
-
Select the type of Trigger and then configure it by entering the relevant properties. These are dynamic and will differ according to the type of trigger you configure.
When all the required information is provided the Trigger node is marked with a green checkmark in the Flow roadmap.
Action configuration
To add actions to your flow, you must:
-
Open the list of available actions in the Dynamic section of the editor. To open it, you must:
- Select the action placeholder from the Flow roadmap for the first action.
- Select the Add new action button from the Flow roadmap for further actions.
-
Select an action.
- Fill in al the required fields of the Action configuration section to set up the action.
Note: All flows must have at least one action.
Templating in actions
To use other actions outputs as inputs, you can:
- Use the Plus (+) button to display the Suggestions drop-down and select the desired data.
- Enter the data manually:
{{Step0.SomeData}}
.
Note: When the focus is lost from the input, these input data fields are rendered as chips.
Overview section
This section allows you to see:
- A summary of everything you have configured during the flow creation process.
- Configure an enable or disable some features.
The Overview section shows:
- Flow name: The name of the flow.
- Enable/disable flow toggle: Turn on and off the enable or disable the flow. When blue the flow is enabled and when grey disabled.
- Tenant ID: The tenant hosting the flow.
- Flow ID: Unique ID number generated by Extension Kit when a flow is saved to identify the flow.
- Summary: A summary of your flow that lists all the actions included in the flow.
- Extra data: This section appears after you have created a flow with a Webhook trigger (it is not immediate):
- Address: URL to trigger the flow.
- Meta data address: Properties of the trigger definition.
- Trigger ID: Unique ID number generated by Extension Kit to identify the trigger.
- Created by: The developer who created the flow.
- Latest changes: Date and developer to implement the last changes to the flow.
- Tags: Enter up to five tags to label your flow. Only owner and contributor roles can update tags:
- Enter your text and press tab to create the different tabs.
- Each tag must contain only lowercase letters, numbers, dashes or underscores. White spaces are not accepted.
- Maximum 15 characters.
- Tags will be displayed in the flow card.
- Select the Cross icon button to remove a tag.
-
Configuration settings for:
- Templating V2: Turn on to allow templating V2.
- Sensitive: Turn on to disable input and output data storage in the flow history.
- Static IP: Turn on to enable the use of static IP in the actions that allow it. Available only when activated as a feature by Unit4.
- Automatic steps renumbering: Turn on to automatically renumber steps when these are added moved or removed from the flow.
-
Preview features: This section shows features that are not yet in production.
- Optimize flow memory: Turn on to apply optimizations to Liquid templating to improve memory consumption. Caution it might case braking changes. See optimize flow memory for more details.
Exit flow creation
If you decide to leave the creation process, select the Cancel button and a confirmation window appears prompting you to leave the process.