Error Causes

Description

A workflow exception can include many common errors, which may or may not impact its overall execution/completion. For example, an error may occur if a workflow tries to execute a task that is currently disabled or communicate with an agent that is currently off-line. You may want the workflow to bypass common errors that are irrelevant or insignificant to the workflows overall execution / completion. The Error Causes properties solves this issue by allowing you to dictate which exceptions the workflow should pay attention to and which ones to ignore. The default behavior is to monitor for all exceptions; however, the properties can be set in order for the workflow to bypass certain errors or only react to specific errors.

With regards to workflow items assigned to an agent group, Error Causes can dictate whether that item should throw an error depending on the numerical ratio or percentage of agents in the group that caused an error.

To access the Error Causes properties, select Options on the Server Management Console's navigation bar, and then select Default Properties > Workflow Items > Error Causes.

You can also access these properties in the Workflow Designer by right-clicking a task, and then selecting Workflow Item Properties > Error Causes.

Related Topics

Parameters

Property	Description
Task / Process / Sub-Workflow	Controls whether the server should allow the following event types to lead to an error as they relate to task, process. and sub-workflow items. Available options are: Disabled - If enabled (default), tasks, processes or sub-workflows that are determined to be in a disabled state during execution (as specified in the object's Details properties) will return an error causing the instructions specified in the On Error properties to be performed. If disabled, the error is ignored, and object execution is treated as a success, allowing the workflow to advance. Unbuilt - If enabled (default), tasks, processes or sub-workflows that are unbuilt (that is, workflows that contain no repository objects, tasks that contain no steps or processes that contain no commands) will return an error causing the instructions specified in the On Error properties to be performed. If disabled, the error is ignored and object execution is treated as a success, allowing the workflow to advance. Runtime Failure- If enabled (default), tasks, processes or sub-workflows that fail with an error during runtime will return an error causing the instructions specified in the On Error properties to be performed. If disabled, runtime errors are ignored and object execution is treated as a success allowing the workflow to advance.      Stop - If enabled, tasks, processes or sub-workflows that are manually stopped during execution will return an error causing the instructions specified in the On Error properties to be performed. If disabled (default), manually stopped tasks, processes or sub-workflows will not return an error and execution is treated as a success allowing the workflow to advance.    Time exclusion - If enabled (default), tasks, processes or sub-workflows that are excluded from running at the current date, time or time interval (as specified in the object's Exclusion properties) will return an error causing the instructions specified in the On Error properties to be performed. If disabled, the error is ignored and object execution is treated as a success, allowing the workflow to advance.
Condition	Controls whether the server should allow the following event types to lead to an error as they relate to conditions. Note that this applies only to conditions used in the middle of a workflow as a wait or conditional object. They do not apply to conditions that are used as a triggering object in the beginning of a workflow. The available options are: Disabled - If enabled (default), conditions that are determined to be disabled during execution (as specified in the object's Details properties) will return an error causing the instructions specified in the On Error properties to be performed. If disabled, the error is ignored and execution is treated as a success, allowing the workflow to advance.      Unbuilt - If enabled (default), conditions that are unbuilt (that is, contain no properties) will return an error causing the instructions specified in the On Error properties to be performed. If disabled, the error is ignored and execution is treated as a success, allowing the workflow to advance.      Negative evaluation- If enabled (default), conditions that evaluate to a negative value (that is, FALSE) will return an error causing the instructions specified in the On Error properties to be performed. If disabled, the error is ignored and execution is treated as a success, allowing the workflow to advance. For example, a File System condition is set to immediately evaluate whether a specific file exists. If the file does not exist, the condition returns FALSE, hence, a negative evaluation. Stop - If enabled, conditions that are stopped during execution will raise an error causing the instructions specified in the On Error properties to be performed. If disabled (default), manually stopped conditions will not raise an error and item execution is treated as a success, allowing the workflow to advance.      Timeout - If enabled (default), conditions that time out during execution will raise an error causing the instructions specified in the On Error properties to be performed. If disabled, conditions that time out will not raise an error and execution is treated as a success, allowing the workflow to advance. Time exclusion - If enabled (default), conditions that are excluded from executing at the current date, time or time interval (as specified in the object's Exclusion properties) will return an error causing the instructions specified in the On Error properties to be performed. If disabled, the error is ignored and execution is treated as a success, allowing the workflow to advance.
Agent	Controls whether the server should allow the following event types to lead to an error as they relate to task and process agents. The available options are: Disabled -  If enabled (default), task or process agents that are found to be in a disabled state during execution (as specified in the object's Details properties) will return an error causing the instructions specified in the On Error properties to be performed. If disabled, the error is ignored and object execution on the given agent is treated as a success, allowing the workflow to advance. Unavailable - If enabled (default), task or process agents that are unavailable (that is, off-line) during execution will raise an error causing the instructions specified in the On Error properties to be performed. If disabled, the error is ignored and object execution on the given agent is treated as a success, allowing the workflow to advance. Staging - If enabled (default), task or process agents that contain conditions or tasks that are unqualified to execute due to their stage level will return an error causing the instructions specified in the On Error properties to be performed. If disabled, the error is ignored and execution is treated as a success, allowing the workflow to advance. Incompatible - If enabled (default), task or process agents that contain incompatible objects (that is, process object set to execute on a task agent or task object set to execute on a process agent) will raise an error causing the instructions specified in the On Error properties to be performed. If disabled, the error is ignored and item execution on the agent is treated as a success, allowing the workflow to advance. Time exclusion - If enabled (default), task or process agents that are excluded from executing at the current date, time or time interval (as specified in the object's Exclusion properties) will return an error causing the instructions specified in the On Error properties to be performed. If disabled, the error is ignored and object execution on the given agent is treated as a success, allowing the workflow to advance.
Agent Group	Controls whether the server should allow the following event types to lead to an error as they relate to agent groups. The available options are: Disabled - If enabled (default), agent groups that are marked disabled during execution (as specified in the object's Details properties) will raise an error causing the instructions specified in the On Error properties to be performed. If disabled, the error is ignored and execution on the given agent group is treated as a success, allowing the workflow to advance. Empty - If enabled (default), agent groups that contain no individual agents during execution will return an error causing the instructions specified in the On Error properties to be carried out. If disabled, the error is ignored and execution on the given agent group is treated as a success, allowing the workflow to advance. Subset errors - If enabled (default), error event types related to agent subsets should be handled. If disabled, subset agent errors are ignored and execution on the given agent group is treated as a success, allowing the workflow to advance. The available options are: Any errors – An error occurring on any agent contained in a group during execution will return an error causing the instructions specified in the On Error properties to be performed. If greater or equal to X number of  errors – If the total number of errors caused by all agents in a group is greater or equal to the value entered, an error will be returned causing the instructions specified in the On Error properties to be performed. For example, an agent group contains 5 agents. If the value entered is 3, an error caused by three of the five agents will return an error. However, if only two of the five agents caused an error, no error is returned. If greater or equal to X percent of errors - If the total number of errors caused by all agents in a group is greater or equal to the percentage value entered, an error will be returned causing the instructions specified in the On Error properties to be performed. For example, an agent group contains 5 agents. If the value entered is 60%, an error caused by three of the five agents will return an error. However, if only two of the five agents cause an error, this option is ignored.
Agent Group Subset	Controls whether the server should allow the following event types to lead to an error as they relate to individual agents contained in a group: The available options are: Disabled -  If enabled (default), any agent in a group determined to be disabled during execution will return an error causing the instructions specified in the On Error properties to be performed. If disabled, the error is ignored and execution is treated as a success, allowing the workflow to advance. Unavailable - If enabled (default), any agent in a group determined to be unavailable (that is, off line) during execution will return an error causing the instructions specified in the On Error properties to be performed. If disabled, the error is ignored and execution is treated as a success, allowing the workflow to advance.  Staging - If enabled, agents within a group that contain conditions or tasks that are unable to execute due to their staging level will raise a workflow error causing the instructions specified in the On Error properties to be performed. If disabled, the error is ignored and execution is treated as a success, allowing the workflow to advance. Incompatible - If enabled (default), agents in a group that contain incompatible objects (that is, process object set to execute on a task agent) will raise an error causing the instructions specified in the On Error properties to be performed. If disabled, the error is ignored and execution is treated as a success, allowing the workflow to advance. Time exclusion - If enabled (default), agents in a group that are excluded from executing at the current date, time or time interval (as specified in the object's Exclusion properties) will return an error causing the instructions specified in the On Error properties to be performed. If disabled, the error is ignored and execution is treated as a success, allowing the workflow to advance.