On Error

Description

On Error works hand-in-hand with Error Causes. These properties allow you to globally dictate how a workflow should react in the event that one of its items causes an error as specified in the Error Causes properties as well as modify the way the errors are logged. With this functionality, you can configure workflows to continue or halt execution upon error. You can configure multi-branch workflows to stop execution on only the branch that caused the error, allowing all other branches to proceed or stop execution of all other branches except the one that caused the error. Also, you can determine whether the execution should be logged as “failed” or “successful” in the event that one of its items causes an error.

On Error properties can be set via Server Management Console by selecting Options from the Navigation bar and navigating to Default Properties -> Default Workflow Item Properties -> On Error. They can also be set for individual objects contained in a workflow via Workflow Designer by right-clicking the object and selecting Workflow Item Properties -> Error Causes.

NOTE: By default, these properties are inherited by all workflow items on the system unless they are overwritten via the individual agent, workflow or task level. For more details regarding inheritance hierarchies, see Property Inheritance.

 

Related Topics

Parameters

Property

Description

On Workflow Item Error

Controls how a workflow should progress in the event that one of its items causes an error. The available options are:

  • Continue (default) - The workflow will continue its normal course in the event that one of its items causes an error as specified in the Error Causes properties. This tells AutoMate to essentially ignore the error and resume execution. It is very important to remember that this option does not in any way "fix" the error. It simply instructs the workflow to continue as if no error occurred.

  • Stop current branch – In the event of a workflow item error, the branch stemming the item that caused the error will stop immediately. However, other active branches that exist in the same workflow (if any) will continue their course. If only a single branch exists, workflow behavior becomes equivalent to the Stop Workflow option, whereas, execution stops immediately at the item that caused the error.

  • Stop other branches - In the event of a workflow item error, the branch containing the specific item that caused the error will proceed. However, other active branches contained in the same workflow (if any) will stop. If only a single branch exists, this option’s behavior becomes  equivalent to the Continue option, whereas, the workflow continues its normal course upon error.

  • Stop workflow - Workflow execution stops immediately at the item that caused the error. All branches are stopped.

Fail Workflow

If enabled, workflow execution will be logged as "failed" in the event that one of its items causes an error. If disabled (default), execution is logged as “successful.” This does not affect the workflows progress as specified in the On Workflow Item Error properties. For example, if this option is enabled and the On Workflow Item Error parameter is set to Continue, execution of this workflow will be logged as “failed”, although the workflow will still continue its normal course.