Skip to main content

Rygen Help Center

Errors

Errors in X1 are any unexpected events that occur during the processing of a message. These can include things like network errors, parsing errors, or errors that occur in custom scripts.

When an error occurs during a message's processing, X1 handles the message either with a default error process or by a custom process that users can configure.

Error handling method

Description

Default

When an error occurs, X1 does the following steps by default:

  1. Logs the error in the application logs.

  2. Saves an X1 error that contains all the information about the error and the context in which it occurred.

  3. Terminates the message flow that the error occurred in and sets the flow status to FAULTED.

  4. Sends an error email notification to the configured error email address if email alerts are turned on.

Custom

You can create custom error handlers to handle errors that occur in a message flow. These error handlers are used in place of the default error-handling process.

Custom error handlers can be either of the following:

  • Single error translator script - Translates the original document and/or error into a suitable response document. See Create an Error translator for more information.

  • Error router - Enables users to script routing rules and flows of components that further process the error. See Create an Error router for more information.

The Errors page is where you can view and resolve errors.

  1. On the Errors page, view the list of errors.

See the "Error Page Tabs Field Descriptions" below for more information about each Error Page tab field.

Error Page Tabs Field Descriptions

Field

Description

Queue tab

Displays all unresolved errors.

History tab

Displays all resolved errors. The error history is read-only and cannot be modified.

Sender

Displays on both tabs.

The trading partner that sent the message that caused the error.

Receiver

Displays on both tabs.

The trading partner that was the intended recipient of the message that caused the error.

Correlation ID

Displays on both tabs.

The correlation ID of the message flow that the error occurred in.

Document Type

Displays on both tabs.

The type of the document that was being processed when the error occurred. See Document Types for more information.

Timestamp

Displays on both tabs.

The time that the error occurred.

Note

In General Settings, you can configure X1 to send an error alert via email for each error. An error alert email contains the error details.

Search for an error
  1. On the Errors page (on either tab), you can search for a specific error using the default search fields.

    errors_search.png
  2. Select the Start Date and End Date ranges.

Note

You can select add_icon.png to add a new filter criterion for sorting the Errors table.

  1. In the Errors table, next to an error, select show_error.png. The Error box displays with the error text for you to view.

  1. In the Errors table, next to an error, select folder_icon2.png.

    Note

    If there are any documents or files available to download, select Download.

    The files are saved in your default location for file downloads.

  1. In the Errors table, next to an error, select resolve_icon2.png. The Resolve Error dialog box displays.

  2. Enter an error resolution reason and select Resolve. The resolution is saved with the error.

Note

To resolve all the errors at the same time, on the Queue tab, select Resolve All.