Break Iteration v1.0.0 Help ​

Terminates the current iteration loop and jumps to a specified Start Iteration Step within the Flow.

How can I use the Step? ​

The Break Iteration Step is designed to give you more control over your iteration loops. It allows you to exit a loop prematurely based on certain conditions, making your Flows more dynamic and efficient. This is particularly useful when you don't need to process every item in a loop.

How does the Step work? ​

The Step halts an ongoing iteration and redirects the Flow to the selected Start Iteration Step. It sets the isIterationBroken flag to true in the Merge field of the specified Start Iteration Step, indicating that the iteration has been broken.

Prerequisites ​

To use the Step, make sure to meet the following requirements:

  • Basic knowledge of JavaScript/JSON.
  • A Start Iteration Step must be present and correctly configured in the Flow.

Table of Contents ​

Iteration settings ​

  • For Iteration destination, select the Start Iteration Step inside the current iteration level. This parameter is required.

Merge field settings ​

The Step has no Merge field. It adds the isIterationBroken property to the Merge field of Start Iteration Step with the value true to indicate that the iteration has been broken.

To learn more about Merge fields, their types, and how to work with them, follow this link

Error handling ​

By default, the Step handles errors using a separate exit. So if any error occurs during the Step execution, the Flow proceeds down the error exit.

The Step throws errors for specific conditions:

  • If the iteration destination Step is not selected.
  • If the selected destination Step is missing in the Flow.

For more information on error handling, follow this link.

Reporting ​

The Step automatically generates Reporting events, allowing you to track its performance and user interactions.

To learn more about Reporting events, follow this link.

Service dependencies ​

  • studio v3.71.0
  • bot deployer v2.22.4
  • library v2.18.4

Release notes ​

v1.0.0 ​

  • Initial release