Working with error definition and messages

This topic describes the configuration of the AutoPilot-OA-Errors module, the error definitions, error categories, and the workflows:

AutoPilot-OA-Errors module configuration

Error definitions are stored in the AutoPilot-OA-Errors module. Error definitions are split into many categories based on target applications the workflow interacts with. Error definitions define the way error messages will be displayed. For example, all generic error messages encountered for BMC Remedy AR System will have a prefix ARS, and are appended with an error code 100.

The following table lists the error categories and error definitions for the Service Desk Automation Run Book:

Error category	Error definitions
Remedy	Specifies all generic BMC Remedy AR System errors `<errors> <!-- All generic Remedy errors are recorded here - like unable to connect, etc. A prefix ARS is used. Errors common to all remedy applications (incident, change, etc.) can be recorded here as well. --> <error> <code>ARS-100</code> <summary>Unknown error</summary> <details>Uknown error</details> <resolution>Please contact BAO administrator</resolution> </error> </errors>`
Incident	Specifies the errors encountered in the Incident Management module `<errors> <error> <code>INC-200</code> <summary>Unknown error</summary> <details>Uknown error</details> <resolution>Please contact BAO administrator</resolution> </error> </errors>`
Change	Specifies the errors encountered in the Change Management module `<errors> <error> <code>CHG-300</code> <summary>Unknown error</summary> <details>Uknown error</details> <resolution>Please contact BAO administrator</resolution> </error> </errors>`
Task	Specifies the errors encountered in the Task Management module `<errors> <error> <code>TSK-300</code> <summary>Unknown error</summary> <details>Uknown error</details> <resolution>Please contact BAO administrator</resolution> </error> </errors>`
WorkOrder	Specifies the errors encountered in the Work Order Management module `<errors> <error> <code>WO-400</code> <summary>Unknown error</summary> <details>Uknown error</details> <resolution>Please contact BAO administrator</resolution> </error> </errors>`
SRM	Specifies the errors encountered in the Service Request Management application `<errors> <error> <code>SRM-500</code> <summary>Unknown error</summary> <details>Uknown error</details> <resolution>Please contact BAO administrator</resolution> </error> </errors>`
Fulfillment	Specifies the errors encountered in the Microsoft Active Directory or Microsoft Exchange applications `<errors> <!-- MSAD means active directory and MSEXCHG means MS Exchange --> <error> <code>MSAD-600</code> <summary>Unknown error</summary> <details>Uknown error</details> <resolution>Please contact BAO administrator</resolution> </error> <error> <code>MSEXCHG-600</code> <summary>Unknown error</summary> <details>Uknown error</details> <resolution>Please contact BAO administrator</resolution> </error> </errors>`
General	Specifies all generic errors encountered in BMC Atrium Orchestrator `<errors> <!-- All BAO related errors are recorded here --> <error> <code>GEN-1000</code> <summary>Unknown error</summary> <details>Uknown error</details> <resolution>Please contact BAO administrator</resolution> </error> </errors>`

AutoPilot-OA-Errors module utility workflows

The AutoPilot-OA-Errors module contains the following utility workflows.

Get Category List

The Get Category List utility workflow retrieves the list of error definition categories. You do not require to specify any input for running this workflow (Is this correct?).

Sample error definition

 <Categories>
  <Remedy />
  <Incident />
  <Change />
  <Task />
  <WorkOrder />
  <SRM />
  <Fulfillment />
  <General />
</Categories>

Get Error by Code

The Get Error by Code workflow retrieves the error definition based on the specified error code.

The following table lists the input element for the Get Errors by Code workflow.

Input Description

error code

Specify the error code based on which you want to retrieve the error definition

For example, 100.

Note: If an error code is not found, the following error message is displayed:

Error definition with code: '10' not found!

Sample error definition by code

 <error>
  <code>ARS-100</code>
  <summary>Unknown error</summary>
  <details>Uknown error</details>
  <resolution>Please contact BAO administrator</resolution>
</error>

Get Errors by Category

The Get Errors by Category workflow retrieves the error definition based on the specified name of the category.

The following table lists the input element for the Get Errors by Category workflow.