› System data › Error codes › Manage error codes

Manage error codes

You can define and maintain text error codes and assign localizable values to these text codes on the Error codes page.

To open the Error codes page, navigate to System data > Error codes.

Any error codes added to DocAI Studio are visible in Advanced Studio, and vice versa.

Create error codes

Procedure
  1. On the Error codes page, select New.

    The New error code dialog box is displayed.

  2. Enter a Name for the error code.
    By default, the name of the error code becomes the ID of the error code; however, you can change the ID if needed.
  3. Enter a Description for the error code.
  4. Enter a default (or base) Error message for the error code. When localizations are not specified, this message is used for that text code.
  5. Select Save.

Modify error codes

Procedure
  1. On the Error codes page, select the error code to modify.

    Alternatively, to display a specific error code, enter the name of the error code in the Search field and select .

    The Edit error code dialog box is displayed.

  2. Make changes as needed, such as updating the description or error message.
  3. Select Save.

Delete error codes

You can only delete an error code if it is not in use; otherwise, an unexpected behavior may occur.

Procedure
  1. On the Error codes page, on the context menu of the error code to delete, select Delete.
  2. When prompted, select Yes to confirm.

    On confirmation, the error code is deleted.