Build a Flow
A Flow is a reusable building block that can contain miniApps, Conditions, Transfers, and even other Flows grouped according to the predefined logic same as a Dialog Application. As a Dialog Application scenario grows and has more building blocks, it is recommended to organize parts of it logically grouped and saved, or to have it prepared to use while building a different Dialog Application. These cases can be covered with the Flow building block.
Flows can be reused in multiple Dialog Applications, if these Dialog Applications belong to the same group.
Flows can be used to create complicated flow logic condensed in a building block that can be reused in a Dialog Application or used throughout different Dialog Applications and save time.
To build a Flow, follow the steps below:
Navigate to the Flows panel on the left and click the + Add button.
2. Fill in the fields in the modal window and click Save when finished:
Enter a Flow Name. For example, Authenticate, for a Flow that is used to authenticate callers.
Enter the Input Fields to assign a value containing data that will be passed to a caller to the Flow.
Output Fields: assign the value that is returned as the caller’s answer.
Select a Group from the available list. The Flow will be available to the group members.
Switch the Report Flow toggle button and select the reporting type (Self Service or Authentication) in order to tag the Flow in relation to what will be visible in the Analytics dashboard for various business reasons.
3. Once created, the Flow is listed in the Flows panel.
4. Click the Flow, so it will be opened in a separate tab for a further configuration.
5. Select a miniApp from the miniApps list and drag and drop it into the canvas. Note that now you are working inside the Flow.
6. Click the Settings button in the right upper corner of the miniApp to configure it.
7. 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.
8. Select or create a second miniApp just like you did in the Getting Started section. Note that now you work inside the Flow.
9. Connect two miniApps by dragging a line between them.
10. Click the Settings icon in the right upper corner of the second miniApp to configure it.
11. Click the + Add Input Field first and then proceed to filling in the fields like you for any other miniApp, 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 Flow can be used in multiple cases in the Dialog Application and provide the preconfigured data it already contains, so it is not required to configure it from the beginning.
It is possible to easily and 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 right upper corner and click Edit.
2. In the newly-opened form, edit the Input and Output fields.
The values of 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 the preconfigured Flow outputs. However, if the output value is not provided, the Flow will still continue.
To configure optional output fields, proceed as follows:
Navigate to the left sidebar with Flows, click the Options button in the right upper corner, click Edit and add multiple output fields.
2. 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 a 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 right upper corner of the Flow and click Delete.
It is not possible to delete a Flow if it’s already placed on canvas and is used as part of a Dialog Application. Remove a Flow from canvas to delete it.