Flow Modules

Flows are made by building a sequence of Modules. A Module performs a specific action and is shown as a box in the Flow Editor.

To add a module to a flow, click a '+' icon at the desired point on the flow canvas and select the Add Module option. Then select one of the available modules from the sidebar :-

  • Response module - Use to return a response to the end-user they are in a structured conversation

  • Gather module - Use to capture information from the end-user

  • Integration module - Will trigger an Integration to an outside service

  • Set Variables module - Use to change the value of unnassigned variables

  • Jump To module - Use to jump the conversation to another Module or Condition within the same Flow, or to the start of another external Flow.

  • Component module - Will jump the conversation to a Component. You can create new Components from this module type, or from the Flow page.

  • UiPath Subscribe module - Use to subscribe to UiPath events. Only available when full UiPath features are requested.

You can save your Flow by clicking Save Standard Flow in the sidebar. Do this at regular intervals to ensure you don't lose your work.

Response module

Sends a response to the end-user. For instance, you may want to start your Flow with an introductory message to inform the end-user that they're in a structured conversation, what's going to happen, and how to break out of it if necessary (using the @exit_flow entity's values - see Entity Text Values).

  1. Choose the Response module in the sidebar.

  2. Enter in the sidebar -

    • Module Name
      Name the module. All module names must be unique within the Flow.

    • Response
      Text (can include entities and variables).

  3. Click Create Module in the sidebar.

    The new Response module will be shown on the Flow canvas.

Gather module

Ask for information and store it in an Entity or a Variable. Set prompt, success, and failure responses.

  1. Choose the Gather module in the sidebar.

  2. Enter in the sidebar -

    • Module Name
      Name the module. All module names must be unique within the Flow.

    • Entity/Variable
      The entity or variable that will store the gathered response.
      Choose an existing entity or variable, or create a new one.

    • Prompt
      Text prompting the end-user to provide some information.

    • Success Response
      Response to be given to the end-user following a valid input. Validation is handled by the entity or entity-assigned variable, if any.

    • Fail Response
      Response to be given to the end-user following an invalid input. Validation is handled by the entity or entity-assigned variable, if any.

    You can add the following Advanced Options for each prompt, success, or fail response -

    • Video
    • Metadata

    These work in the same way as the Video and Metadata Add-Ons on Intents.
    The Metadata add-on can also be used to create Quick Reply buttons in a Gather module.

  3. Click Create Module in the sidebar

    The new Gather module will be shown on the Flow canvas.

Integration module

Initiates an Integration, that will call an external service such as a third-party API. An existing Integration Request is required, although you can navigate to the Integrations page from the module's sidebar.

  1. Choose the Integration module in the sidebar.

  2. Enter in the sidebar -

    • Module Name
      Name the module. All module names must be unique within the Flow.

    • Base URL
      The integration Base URL for the Request that you want to trigger.

    • Request
      The integration Request that you want to trigger.

      When a Request is selected, more sections are revealed with fields relevant to that Request (see below).

Request Configuration section

Specify entities or variables or free text to populate the Integration's request parameters (that will be passed to the API called).
The number of fields here will match the number of request parameters in the selected Request.

  1. Enter in the sidebar -

    • Entity/Variable/Free Text
      The entity, variable or free text that you want passed to the corresponding request definition. The field will have a tool tip (created within the Request) that should explain the request definition's purpose.

      Start typing in the Search or Create field to either -

      • Select an existing entity or variable

      • Create a new entity or unassigned variable
        If you create an entity from here, it will have no values. Once you've finished building your Flow, you will need to add Text Values or Pattern Values to it.
        If you create a variable from here, it will be unassigned. Once you've finished building your Flow, you may need to Assign the Variable to an Entity.

      • Add a free text value

    Repeat for all request parameters.

Set Variables section

Specify the variables that will be populated with data passed back from the Request via its response definitions.
The number of fields here will match the number of response definitions in the selected Request.

  1. Enter in the sidebar -

    • Variable
      The variable that you want populated with the data from the corresponding response definition. The field's tool tip should explain the response definition's purpose.

      Start typing in the Search or Create field to either -

      • Select an existing variable

      • Create a new variable (If you create a variable from here, it will be unassigned. Once you've finished building your Flow, you may need to Assign the Variable to an Entity).

    Repeat for all response definitions.

Configure Response section

Link the Integration's response definitions to the variables you will use to communicate any outcomes in the flow.

  1. Enter in the sidebar -

    • Return Response checkbox
      Check if the response returned from the integration is to be displayed to the end-user
      Uncheck to disable the Response fields & skip any response displayed to the end-user
      Defaults to checked

    • Success Response
      The response given to the end-user following a successful response from the integration

    • Fail Response
      The response given to the end-user following a failed response from the integration

    You can return the contents of variables and entities in these responses, by naming them (including their prefixes) e.g. $example_variable or @example_entity, in the text.

    You can add the following Advanced Options for each prompt, success, or fail response -

    • Metadata

    These work in the same way as the Metadata Add-Ons on Intents.

  2. Click Create Module in the sidebar.

    The new Integration module will be shown on the Flow canvas.

Set Variables module

Sets the value of one or more unnassigned variables.

  1. Choose the Set Variables module in the sidebar.

  2. Enter in the sidebar -

    • Module Name
      Name the module. All module names must be unique within the Flow.

    • Variable To Set
      The unnassigned variable that you want set.

      Start typing in the Search or Create field to either -

      • Select an existing unassigned variable

      • Create a new unassigned variable

    • Set To Value
      The entity, variable or free text that you want to set the unnassigned variable to.

      Start typing in the Search or Create field to either -

      • Add a free text value

      • Select an existing entity or variable

      • Create a new entity or unassigned variable
        If you create an entity from here, it will have no values. Once you've finished building your Flow, you will need to add Text Values or Pattern Values to it.
        If you create a variable from here, it will be unassigned. Once you've finished building your Flow, you may need to Assign the Variable to an Entity.

      Repeat to set as many variables as needed.

  3. Click Create Module in the sidebar.

    The new Set Variables module will be shown on the Flow canvas.

Jump To module

Jumps the conversaton to a different module or condition within the same Flow, or externally to the start of a different Flow. Commonly used alongside Conditions e.g. to skip to different part of the Flow depending on the end-user's input etc.

Jumping to another Flow means the conversation will not return to its previous origin unless via other Jump To modules
Returning the conversation (once finished) to the Flow it was called from can be achieved by jumping to an external Component - see Component module below

  1. Choose the Jump To module in the sidebar.

  2. Enter in the sidebar -

    • Module Name
      Name the module. All module names must be unique within the Flow.

    • Jump Type
      From the drop-down menu, choose to jump the conversation internally or externally.

      Select either -

      • Flow
        to jump to another Flow

      • Module/Condition
        to jump to a module or condition within the same Flow

    • Jump to
      Depends on the Jump Type previously selected.

      • For Flow, start typing in the Search or Create field to either -

        • Select an existing Flow

        • Create a new Flow

      • For Module/Condition, select from the dropdown list an existing module or condition within the same Flow

  3. Click Create Module in the sidebar.

    The new Jump To module will be shown on the Flow canvas.

Component module

Jumps the conversaton to the start of a Component.

When the conversation has reached the end of Component, it will be returned to the Flow (or Component) it was called from, continuing with the module directly below the Component module it was called from.

  1. Choose the Component module in the sidebar.

  2. Enter in the sidebar -

    • Module Name
      Name the module. All module names must be unique within the Flow.

    • Component
      Choose to jump the conversation internally or externally. Start typing in the Search or Create field to either -

      • Select an existing Component

      • Create a new Component

  3. Click Create Module in the sidebar.

    The new Component module will be shown on the Flow canvas.

UiPath Subscribe module

The UiPath Subscribe module allows you to subscribe to, and receive responses from, UiPath events. Currently, it is only available on request.

See Getting Started with UiPath if you would like access to our full features that integrate with UiPath.

See how to apply the Subscribe Module within Flow for more details.

Still need help? Get in touch!
Last updated on 3rd Apr 2020