Error Handler

The Error Handler component enables Workflow Designers to detect and handle workflow execution failures. It captures runtime errors and redirects failed executions to a predefined error handling path for recovery actions, such as logging errors or sending notifications. It acts as the Catch block for one or more workflow actions.


Figure: Error Handler

Key Features

• Monitor one or more workflow steps for execution failures.

• Automatically detect and capture runtime errors within monitored workflow actions.

• Route failed executions to a dedicated Error Found path.

• Continue normal workflow processing through the Success path when no errors occur.

• Trigger notifications to designated administrators when failures are detected.

• Dynamically display the number of monitored workflow steps within the Error Handler container.

• Enforce workflow design validations to ensure consistent error-handling behavior.

How It Works

Notes

• The Error Handler follows a Try-Catch execution model. You can configure multiple workflow actions within the Try section. If any action in the Try section encounters an error during execution, the workflow transfers control to the Catch section of the Error Handler, where the error handling logic is executed.
  

• When multiple Error Handlers are configured, they execute according to the workflow connection sequence. The Error Handler whose incoming connection is not linked to any preceding node is treated as the starting point of execution.

Error Handler Structure

The Error Handler component contains:

• Input Node – Receives workflow execution from the preceding step.

• Success Output – Used when all monitored steps execute successfully.

• Error Found Output – Used when a monitored step encounters an execution error.

The component supports multiple workflow actions within its container and displays the total number of monitored steps.

Benefits

• Improves workflow resiliency by handling failures gracefully.

• Reduces troubleshooting time through immediate error notifications.

• Prevents workflow interruptions from going unnoticed.

• Centralizes error management within workflow designs.

• Simplifies monitoring of integration and automation failures.

Example

An organization uses a workflow to create a user account, assign licenses, and update an external identity provider. If the identity provider update fails because the external service is unavailable, the Error Handler captures the failure and routes execution to the Error Found path. A notification is automatically sent to the Integration Administrator, allowing the issue to be investigated without impacting other workflow processes.

Configure Error Handler

To configure error handler, perform the following steps:

1. From the Workflow canvas, drag and drop the Error Handler component in the Workflow canvas.
   The Error Handler component in the Workflow Canvas is displayed.
   
   
   Figure: Error Handler
   

2. Drag and drop multiple workflow components within its container and configure it based on the requirements.

   
   Figure: Error Handler component
   

   Note

   A Error Handler container supports multiple applications or workflow actions, enabling users to group and execute multiple sequential tasks within the same block instead of creating separate blocks for each action.

3. Double-click the Custom Code and Notification to configure the control nodes.
   For more information, refer Custom Code and Notification to configure it.
   

4. Configure the required workflow configuration. Click Save and later click Run to execute the flow.
   

   • The workflow follows the Success path when all monitored actions complete successfully.

   • If an action fails, execution is redirected to the Error Found path.

   • Use the Error Found path to trigger notifications or remediation actions.

5. On successfully execution the workflow displays Workflow Execution details.
   
   

   Figure: Workflow Execution

Error View

The Error Handler displays the details of any failed workflow step, enabling administrators to identify the cause of the failure and take corrective action.

To view the failed error details, perform the following steps:

1. Navigate to Run History > click View corresponding to the Workflow.
   The Workflow Error Log page is displayed.
   
   Figure: Workflow Error Log
   

2. Click failed Custom Code and view the error details in the Node Details section.
   
   Figure: Node Details
   
   The error displays detailed information about the workflow failure, including the error type, execution details, and the exception message to assist with troubleshooting.