Error Catalog

Error messages and their associated numbers can be referenced in the Rules Palette through the Error Catalog.  You can add new error messages and edit existing messages.  

 

The Error Catalog is located in the Admin Explorer tab in the Administration folder.  Since error messages are put into XML via their error number, the Error Catalog is a nice reference tool that lets you look up messages to find the associated error number.  

 

Error Editor in Admin Explorer

 

Steps to Add a New Error Message

  1. Navigate to the Admin Explorer and open the Administration folder.

  2. Scroll down and open the Error Catalog folder.

  3. Right-click on the Error catalog file and select Check-out.

  4. Select Add at the bottom of the screen.  A blank row highlighted in blue will be added.

  5. Enter the Error number.  This will be the reference used to call the error message.  

  6. Enter the Error message text.  This will be the message the user sees when this particular error occurs.

    1. A place holder will identify the variable name(s) that must be available in the entity where the message will reside.  The variable names are surrounded by square brackets ([]).  If a square bracket is used as part of the message it must be immediately preceded by a backslash (\[ and \]).  Where this combination of characters is found, the bracket will be part of the message while the backslash will not (a form of encoding).  

    2. The variables may contain numeric, date or text data.  The palette can retrieve the data type of the variable from the entity in which the error message is being added.  If the variable(s) do not exist, the message can only be added without the place holder(s) or cancelled.  Later when the variable(s) has been added to the entity, the message may be edited with place holders.

  1. Enter the Error fix tip.  This will be the tip the user is given to help fix the error.

  2. Right-click on the error catalog file and check it back in.

 

Note:  If you try to check in the Error Catalog when you have empty rows, you will receive a validation error message.  Delete all empty rows before checking-in your catalog file.

 

If you need to delete one of the error messages, click the Delete box to the right of the error message you want to delete.  Then check-in the Error Catalog.xml file to save your changes to the database.