Learn about flow settings

Flow settings control the behavioral aspects of an entire flow. You access flow settings using the Settings icon.

Note: Flow settings are specific to the current flow version. Settings common to all versions of the flow, such as the flow name may only be accessed from the flows page.

These settings appear for drafts and versions of flows:

• Short description: Use to indicate significant changes in a flow version and to facilitate change identification at a glance. This setting appears only when multiple versions of a flow exist

• Notes: Contain detailed information on changes or list specific instructions on running the flow. Notes are visible only in Flow Studio.

• Flow runtime version: Specifies the minimum flow runtime version required to run the flow. This setting impacts which versions of modules may be included and the flow runtimes selected for remote debug sessions. All new flows receive the latest flow runtime version by default.

  Note: If there are no flow runtimes upgraded to a matching flow runtime version within your environment, you will see no flow runtimes available to deploy and debug your flow when you start a remote session.

  If you have modules in your flow that are not incompatible with a selected flow runtime version you will encounter validation errors indicated by module status notifications.

• Choose Halt on error to stop the flow when an error is encountered either from a module or the flow itself. If disabled the flow will run unless severity leads the flow to crash, at which point it will restart automatically.
  For flow runtimes 2.6 or later you can use the Halt on error setting available on each module to stop on individual module errors, and disable at the flow level to allow restart for flow errors.

• Choose Disable Queues to stop message queuing for modules and halt generation of new messages until the current message has been processed and delivered to the next module. This can be useful to create back pressure when debugging flows with high message rates and a mix of fast and slow modules.

  For example, when iterating over an array and processing messages with modules and an external connector, enabling queues will cause all messages in the array to be queued in the modules before the external connector module, which typically process messages more slowly. This may lead to difficulty following the exact sequence of processing through the modules in debug situations. With queues disabled, only one message at a time will be processed through all modules and to the external connector.

  Note: When flow-level queues are disabled, queue settings on modules including Retry and Persistence are superseded and disabled. Note that queues can also be disabled on individual modules.

• Choose Update Modules to keep modules within the flow updated to the latest version, thereby keeping the flow current.