Try/Catch shape

The try/catch shape will be available following our next release, scheduled for 16th October 2024.

Introduction

Using the try/catch shape, you can build your own path to handle process flow sync exceptions elegantly.

Place a try/catch shape before key steps in your flow, then configure its settings to determine behaviour when exceptions are found. Once this is done, the shape is added to the canvas with two routes - one for try and one for catch:

For the try route, build your flow in the usual way to achieve the required result. For the catch route, define a flow that should be followed for exceptions. For example, you might add exceptions to a cache (so they can be processed subsequently) and then notify specified contacts that exceptions have occurred.

The notify shape can be very powerful when used with the try/catch shape. Keep in mind that you can include meta, flow, and payload variables to define notification messages. For example:

When the process flow runs, data flows down the try route and ideally completes without any exceptions. However, if an exception is found, the associated payload is removed and sent along the catch route. These payloads can be found on the failed payloads tab in run logs - for example:

Need to know

• You can add one try/catch shape per process flow

Adding & configuring a try/catch shape

To add and configure a new try/catch shape, follow the steps below.

Step 1 In your process flow, add the ry/catch shape in the usual way:

You can add one try/catch shape per process flow. It's up to you where you place this in your flow, but it's generally a good idea to add it at the very start to ensure that all steps are checked.

Step 2 Access settings for the newly placed shape:

Step 3 Choose the action to take if an exception is encountered:

Available options are summarised below:

Action	Flow behaviour
Succeed as partial success	The flow completes and, where possible, data is synced. Failed payloads for exceptions are removed and are available from run logs. The flow is logged with a status of partial success.
Fail flow	The flow completes and, where possible, data is synced. Failed payloads for exceptions are removed and are available from run logs. The flow is logged with a status of failure.
Fail flow & retry	Use this option with care. When the process flow is retried, all data is processed again. If you have any doubt as to whether duplicate records will be handled correctly, we advise using a different action and manage exceptions separately (for example, add exceptions to a cache and process from there). The flow completes and, where possible, data is synced. Failed payloads for exceptions are removed and are available from run logs. The flow is logged with a status of retried. The flow is retried with ALL data. Important! A retry will only happen if the process flow is enabled and deployed. The flow is retried ONCE only.

Step 4 Save settings to return to the canvas and build your try and catch routes as required.

Related pages

• Run logs - failed payloads

• Notify shape