Build Flow
A Flow is a reusable building block that can contain miniApps, Conditions, Transfers, and other Flows grouped by predefined logic, similar to a Dialog Application. As a Dialog Application grows and adds building blocks, organize and save its parts for reuse or prepare them for use in other Dialog Applications. Use the Flow building block for these cases.
Flows can be reused in multiple Dialog Applications if these Dialog Applications belong to the same group.
Flows encapsulate complex logic into reusable building blocks that you can use within a Dialog Application or across multiple Dialog Applications, saving time.
To build a Flow, follow the steps below:
-
Navigate to the Flows section in the left panel and click the + Add button.
-
Fill in the fields in the modal window and click Save:
-
Enter a Flow Name, e.g., Authenticate for a Flow that authenticates callers.
-
Enter the Input Fields that supply data passed to the caller of the Flow.
-
Output Fields: assign values returned as the caller’s answer.
-
Select a Group from the list; the Flow will be available to its members.
-
Toggle on the Report Flow button and select the reporting type (Self Service or Authentication) to tag the Flow for the Analytics dashboard.
-
Once created, the Flow is listed in the Flows panel.
-
Double-click the Flow for it to open it in a separate tab, and configure it further.
-
Select a miniApp from the miniApps list and drag and drop it into the canvas. Note that you are working inside the Flow.
-
Click the Settings button in the upper-right corner of the miniApp to configure it.
-
Fill in the fields in the settings window and click Save.
-
Input Fields: assign an external value to the Flow.
-
Output Fields: assign the value that is returned as the caller’s answer.
-
Select or create a second miniApp. Note that you work inside the Flow.
-
Connect two miniApps by dragging a node between them.
-
Click the Settings icon in the upper-right corner of the second miniApp to configure it.
-
Click the + Add Input Field first and then proceed to fill in the fields like you would for any other miniApp, and click Save when finished.
This Flow contains two configured miniApps that are connected logically by passing values to one another, representing a completed piece of a Dialog Application. Since the Flow is a reusable building block, this particular one can be used in multiple cases in the Dialog Application and provides the preconfigured data it already contains, so it is not required to configure it again.
Edit Flow
It is possible to quickly edit a Flow's Input and Output. To do that, follow the steps below.
-
Navigate to the left sidebar with Flows, click the Options button in the upper-right corner, and click Edit.
-
In the newly-opened form, edit the Input and Output fields.
The values of the Input and Output fields will be available in other building blocks of the Dialog Application.
Optional output fields
It is possible to add optional output fields to the Flow. These optional output fields can be selected from the list of preconfigured Flow outputs. However, if the output value is not provided, the Flow will continue regardless.
To configure optional output fields, proceed as follows:
-
Navigate to the Flows section in the left sidebar, click the Options button in the right upper corner, click Edit, and add multiple output fields.
-
Place the Flow onto the canvas, click the Settings button in the right upper corner, and click the toggle button to select optional output fields. Note that you should have at least one non-optional output.
Delete Flow
To permanently delete a Flow, do the following:
Select a Flow from the list on the left and click the Options menu icon in the upper-right corner of the Flow and click Delete.
You cannot delete a Flow while it remains on the canvas and is used in a Dialog Application. Remove the Flow from the canvas before deleting it.