Managing Error Definitions
Modifying an Error Definition
Double-click an error entry in the Service Error List to open the error definition:
The error definition opens in a pop-up window. The two upper boxes contain information on the error:
Error Definition: Contains meta information about the error such as the service that raised the error, error category, code and type.
Information About Error: Contains description message that came with the first occurrence, provides a field for remarks, and the current entry state of the error. Every error definition is created in state "New". It is considered good practice to change the entry state to "Checked" when you configured the definition to your needs.
You can define the specific error handling in the box labelled Error Notification:
Setting | Possible Options |
|---|---|
Notification |
|
Recipients TO | Enter the email addresses of the notification recipients in this field. Separate multiple addresses with semicolons. |
Recipients CC | If required, you can define additional email recipients in this field. Recipients CC is an optional field. |
Description for required action | Enter meaningful text that explains to the recipients of the notification what to do if this error occurs. |
Subject | In this field you can enter a subject for the email notification. |
If Email is set to true, the integration component automatically sends a notification mail to the configured recipients:
Deleting Error Definitions
In the far right column of the error list you can select entries by a checkbox. Clicking the Delete Selection button will delete all selected entries:
Make sure that you do not delete the template entry. The template entry is is used for the default settings for new entries.
In case you accidentally deleted the existing template, see Managing Error Definitions > Creating an Error Definition.
You will have to confirm the deletion in a separate pop-up:
Bulk Change of Error Definitions
Click the Add/Remove Recipients button to bulk add or remove one recipient (email address) for all error entries:
In the pop-up window, enter the email address you want to use. Then select the action to apply: Add or Remove and the field to apply the action to: TO or CC:
Creating an Error Definition
In most cases, DevOps will wait until a new error appears in the list of service errors and then change its error definition. However, it is also possible to create a new error definition if an error has not yet occurred.
In some use cases, it is useful to create a new error definition from scratch, e.g.
to create a new Template in case you accidentally deleted the existing one.
to create a Match Template that matches specific parts of the error signature, e.g. the service's name only.
to create an error definition for an error that has not yet occurred but is already known to the service modeler.
In the navigation bar of the xUML service monitor you can find the button New Error Definition for this purpose:
The error definition opens in a pop-up window. Unlike the error definition of an already existing error, the pop-up is now empty and can be filled according to your wishes.
The fields for Service Name, Error Category, Error Code and Error Type each contain an asterisk (*) that serves as a placeholder for all possible contents.
For the master template (entry state "Template"), in case you accidentally deleted it, leave all definition fields as asterisk(*).
For a matching template (entry state "Match Template"), define the parts of the error that you want to match, and leave the rest as asterisk. E.g. if you want to create a match template for a service, so that each new exception thrown by a specific service is notified according to this specific template, enter the service's name only.
For an error definition (entry state "New" or "Checked"), fill out all four fields according to the error signature (ask the modeler what to enter here).
