Break error handler
The Break error handler removes the erroring bundle from the flow. stores the error message, mappings and the remaining flow as an incomplete executions. Depending on the Break error handler settings, retries the incomplete runs automatically or stores them until you resolve them yourself.
Automatic retry is most effective for temporary errors or errors where another attempt might be successful.
automatically retries the most frequent temporary errors, the ConnectionError and RateLimitError, by default already. You don't need the Break error handler to automatically retry these types of errors.
To automatically retry the ConnectionError and RateLimitError, you only need to enable incomplete executions in scenario settings.
You can read more about automatic retry in the article about incomplete executions.
processes the rest of the bundles in the flow.
To use the Break error handler in your , you have to enable incomplete executions in settings.
For example: This demo contains five modules. The is useful for tests and showing the effect of an error handler:
- JSON - Parse JSON provides test data in the form of an array of three record IDs.
- Iterator splits the array into individual bundles.
- Data store - Update a record: Updates the data in the data store.
Data store - Update a record: This module updates the data again. This time the module works differently. In the module mapping, there is a mapping that intentionally creates an error:
The mapping inserts a null value into the required Key field, which always creates the BundleValidationError.
- Slack - Send a message: Sends a message to a private testing channel.
This is how the example looks:
When we run the example , we would get the BundleValidationError:
If we added the Break error handler to the Update a record module, the Break error handler would remove the bundle from the flow. The bundle that caused the error doesn't continue through the rest of the . Instead, creates an incomplete execution to store the error type, mappings, and the remaining flow.
would then process the remaining bundles in the flow.
For more information about error handling strategies check the overview of error handling.
With the Break error handler, you can store the remaining flow in the incomplete executions when an error happens. also stores the error message, mappings, and data.
You can finish the run in the incomplete executions tab manually or can finish the run automatically.
For example, the following outputs an error in the Data Store app module:
To store the as an incomplete execution, follow the steps:
- Right-click the module that is causing the error. In the menu, select Add error handler.
- Select the Break error handler.
- Optional: In the error handler settings, select if you want to automatically finish the incomplete executions. For automatic completions, you can set the number of attempts and the time delay between them.
- Confirm the Break handler settings with the OK button.
- Enable storing of incomplete executions in settings.
- Save your .
You added the Break error handler to your . When an error occurs in the Data store module, creates an incomplete execution. The incomplete execution contains the error message, mappings and data.
If you use the automatic completion, attempts to finish the automatically.