Flow Properties

View and edit the properties for a Flow directly from the Flow canvas.

Prerequisites

• Create a Flow in your tenant and open it in the Flow canvas. Refer to The Flow canvas.

Opening the Flow properties form

• Select Properties from the right-hand menu on the Flow canvas.

Overview

The Flow Properties page allows you to access and edit the properties for a Flow.

The following basic Flow properties are available for editing:

• Name: Edit the name for the Flow.

• Comments: Use this optional field to insert information about the Flow that other users can then view. These comments are not visible in the Flow to runtime users.

note

The system does not save changes on this page automatically. Click Save to save your changes to the Flow and close the Flow Properties form.

Authentication

You can configure Flow authentication using an Identity Provider (IdP) or a Connector (Legacy).

• Authentication provided by Identity Provider: Select the Identity Provider to be used for authentication.

  • Allowed Users - Specify the individual users (by username or email) who are authorized to run this Flow. Enter user identifiers directly or click the Variable picker icon and select a Value to manage users dynamically across environments (for example, restricting access to specific developers in 'Dev' versus users in 'Prod'). This allows the authorized user list to update automatically based on the Environment Variable settings.
  • Allowed Groups - Specify the user groups (as defined in your Identity Provider) that are authorized to run this Flow. Enter group names directly or click the Variable picker icon and select a Value to manage groups dynamically across environments. This enables you to use a single Flow definition while applying different security rules per environment (for example, allowing a "Testers" group in the Test environment but only a "Managers" group in the Production environment).

• Authentication provided by connector:: Edit the authentication connector used with the Flow and the access type for the Flow. Select the authentication connector you wish to use, or select the 'No Authentication Connector' option if you do not wish to use an authentication connector with the Flow.

  If you select an authentication connector, you must then specify the access type for the connector from the Access drop-down menu that appears:

  • Anyone can run this Flow: Select this option to build a public Flow. Anyone with the Flow URL can run a public Flow. You can run the app yourself, or share the link with others.

  • Any user that can login with the selected identity connector can run this Flow: Users of the Flow will need to authenticate themselves before they can run the app, using the authentication connector selected earlier.

  • Create restrictions for specific users and groups of users: Restrict access to specific users or groups for the entire Flow. For example, only a user that logs in with user@boomi.com will be able to access the Flow. Anyone else, even if they can authenticate correctly with the selected connector, will be unable to access the Flow. If you select this option you must add the users/groups that you wish to restrict access to in the Groups and/or Users section.

  note

  When defining access for a Flow, you can also use a swimlane, by selecting the Swimlane step in the canvas to build a Flow that passes control between users with different privileges. For example, there may be an ’employee’ swimlane and a ‘manager’ swimlane for a Flow app that approves expenses submissions. Refer to Swimlane steps.

• Groups/Users: If you have selected an authentication connector to use with the Flow and the Create restrictions for specific users and groups of users option, these sections become available. Use them to add the users/groups that you wish to restrict access to.

  To add groups:

  1. Click in the Search to add groups field in the Groups section and begin entering the name of any groups that you wish to add.

  2. The search automatically returns any groups matching your search term. Select the checkbox for each group that you wish to add and click Add Selected. To add users:

  3. Click in the Search to add users field in the Users section and begin entering the name of any users that you wish to add.

  4. The search automatically returns any users matching your search term. Select the checkbox for each user that you wish to add and click Add Selected. Click the Delete icon in the Actions column to remove a group or user.

  note

  The search returns a maximum of 10 groups or users at a time. If your search term matches more than 10 groups or users, a message tells you to refine your search.

Navigation

The Navigation section allows you to specify navigation settings for the Flow.

• Enable historical breadcrumb navigation: This checkbox allows you to enable historical navigation in the Flow:

  • Select the checkbox to enable historical navigation. If you enable historical navigation, the Flow inserts breadcrumb-style navigation links, letting users quickly navigate back through their Flow page history to previously visited pages. You must also select the Navigation | Allow the user to move to any Step location in the Flow checkbox to enable historical breadcrumb navigation. Refer to Historical navigation.

  • De-select the checkbox (default) to disable historical navigation.

• Allow the user to move to any Step location in the Flow: This checkbox allows you to specify user navigation behaviour for the Flow:

  • Select the checkbox to enable a user to navigate to any step location when using the Flow. For example, if you add a navigation menu to the Flow that allows a user to freely jump around between pages. You must also select this checkbox if you enable historical breadcrumb navigation.

  • De-select the checkbox (default) to specify that the user can only navigate the Flow via the set paths configured in the Flow. For example, a user can only access a page once the Flow triggers it — they cannot jump to the page regardless of their location in the Flow.

State

The State section allows you to specify state expiration and deletion times. Refer to Flow States.

• Number of days before the in-flight States should be deleted: This setting allows you to specify in days how long the Flow will hold its 'status' before it expires.

  • By default, Flow never deletes 'in-flight' states. For example, if the Flow is running and the current step still has outcomes, Flow holds the data indefinitely.

• Number of days of inactivity before the in-flight States should be deleted: This setting allows you to specify in days how long the Flow state can remain inactive before it expires. For example, you may wish a Flow state to expire after x days of state inactivity.

  • The default setting for newly created flows is 30 days.

  • Set this value between 1-180 days; 180 days is the maximum.

  • Once a state ‘expires’ due to this setting, any user who tries to join or progress through the Flow will not be able to interact with the Flow. Instead, they will receive a message informing them that “The state with ID 12345 has now expired”.

Translation notes

The Translation notes section allows you to provide optional context for third-party translators when exporting the Flow to XLIFF.

• Enter details such as tone, formality, and any other context that may be helpful to the translator (for example: "Formality: Use the formal case. Tone: Welcoming but respectful. Context: A shop storefront."). The exported XLIFF file includes this note at the Flow level, helping translators produce more accurate and tone consistent translations.

Snapshots

The Snapshots section allows you to activate a previously built snapshot of the Flow.

A snapshot is a version of a Flow that Flow creates every time you run or publish it. Activating a snapshot only changes the version of the Flow that users view when they run the Flow without a specific version id; it does not affect the build version.

• Click Activate Flow Snapshot in the Actions column to activate a snapshot.