Skip to main content
Version: Current

Error Handler

Overview​

The Error Handler node becomes available in the Process Data Explorer when configuring activities within a Custom Error Handler.

It provides access to detailed information about the activity that generated the error, allowing workflows to inspect failures, generate notifications, perform recovery actions, or create audit records.

The Error Handler node is available only within a Custom Error Handler execution path.


Activity Error​

The Error Handler node contains a single object named Activity Error.

Error Handler
└── Activity Error
├── Source
├── Exception
├── Context
└── Inputs

The object is populated automatically when the Custom Error Handler begins execution.


Source​

Provides information about the activity that generated the error.

PropertyDescription
Activity IDWorkflow activity identifier.
Activity Instance IDRuntime activity instance identifier.
Activity TypeActivity type.
Activity NameInternal activity name.
Activity Display NameDisplay name shown in the Designer.
Node IDCanvas node identifier.

Exception​

Provides details about the exception.

PropertyDescription
MessageError message.
TypeException type.
Stack TraceStack trace, when available.
SourceComponent that generated the exception.

Context​

Provides execution context for the failure.

PropertyDescription
Occurred AtTimestamp of the failure.
Workflow IDWorkflow identifier.
Workflow Instance IDWorkflow execution identifier.
Automation IDAutomation execution identifier.

Inputs​

Provides the input values supplied to the activity when the error occurred.

Unlike the other sections of Activity Error, the structure of Inputs depends on the activity that failed.

For example:

Activity Error
└── Inputs
├── File Path
├── Connection
└── Timeout

Using Error Handler Data​

Error Handler data can be used to:

  • Send detailed failure notifications.
  • Record audit information.
  • Create incidents.
  • Perform recovery logic.
  • Diagnose execution failures.

Because Error Handler data is available through the Process Data Explorer, it can be bound directly to activity properties, expressions, and conditions.


Runtime Behavior​

The Error Handler node exists only while executing a Custom Error Handler.

It is not available during normal workflow execution.

The Activity Error object is populated automatically by the workflow engine when an activity failure redirects execution to the Custom Error Handler.