Error Inbox

Error Inbox

Overview

An Error Message Log is a record that captures details of all errors that occur within a system, application, or integration process. It helps you and administrators to track, review, and troubleshoot issues by storing information such as:
  1. Timestamp – when the error occurred
  2. Error Code/ID – unique identifier for the error
  3. Error Message – description of the issue
  4. Source/Module – the system component where the error originated
  5. User/Session Details – context of who or what triggered the error

Error Message Log

  1. Go to the Monitoring menu.
  2. Click on the Error Inbox tab.
  3. Upon clicking the Error Inbox, you will see the list of error messages.

Action Area

The action area of the screen provides the following icons:
    1. Search: The search icon allows you to find any message by its name.
    2. Refresh: The refresh icon updates the message list shown on the screen.
    3. Filter: The filter provides many options to find your desired message.
    4. Help: The help icon takes you to a dedicated screen with helpful support content. 

Filter

  1. The action area provides a filter action. When you click the filter icon, the filter opens in the content context area.
  2. The filter includes the following fields:
    1. Message ID:
      1. A message ID field allows you to search the message by its message ID.
      2. Enter the message ID manually in the field, and hit the Show Result button. 
    2. Component ID:
      1. A Component ID field enables you to search for messages by their component ID.
      2. Enter the component ID manually in the field and click the Show Result button. 
    3. Entity Type:
      1. A drop-down allows you to search the message by entity type.
      2. Select the entity type from the drop-down and hit the Show Result button.
    4. Status:
      1. This drop-down field allows you to search the message by message status.
      2. Select the message status from the drop-down and hit the Show Result button.
    5. Object:
      1. This drop-down field allows you to search the message by its object.
      2. A list of all OE objects will be listed in the drop-down.
      3. Select the object from the drop-down and hit the Show Result button.
    6. Speaking Key:
      1. This is a text box field where you can enter the speaking key.
      2. Enter the speaking Key manually in the field and click the Show Result button. 
    7. System Key:
      1. This is a text box field where you can enter the system key.
      2. Enter the system key manually in the field and click the Show Result button. 
    8. Direction:
      1. This field lets you filter messages by direction.
      2. Select 'Inbound' or 'Outbound' from the drop-down menu to view the messages you desire.
    9. Message from & Message to:
      1. These fields let you filter the message for a specific date range and time.
      2. A calendar pop-up will open when you click the calendar icon in the field.
      3. Select the date, month, year, hours, minutes, and AM/PM from the calendar to select the start. Once you have selected all the values, click anywhere outside the pop-up to close.
      4. Similarly, click the calendar icon in the message in the field and select the end date and time. 
    10. System in Network:
      1. This drop-down field allows you to search the message to determine whether the system is connected to the project network or not.
      2. Yes and No option is provided in the drop-down.
      3. Select the option from the drop-down and hit the Show Result button.
  3. Show Results: After clicking the "Show Results" button, the configured filter will be applied, and the results will be displayed on the screen.
  4. Reset: Clicking the Reset button will remove all filter settings and reset them to the default.
  5. An 'X' icon allows you to close the filter tab.

Retry

  1. A Retry icon will become visible when you hover your mouse over any of the error message bands.
  2. By clicking the icon, you can attempt to process the failed message again.
  3. A toaster message will then confirm that the message is being sent for processing. After the message is processed, the screen will refresh to display the updated message list. 

Open Flow Debugger

  1. A flow debugger is an interactive tool designed to assist you in debugging when encountering errors. A distinct Flow Debugger icon will become visible when you hover your mouse over any of the message bands.
  2. Hover over the message and click on the Open Flow Debugger icon.

  1. Clicking on this icon will open the flow debugger screen, which provides a comprehensive interface for analyzing the error messages associated with the specific band you are investigating.
  2. Within this screen, users can delve into detailed diagnostics, view the flow of operations leading to the error, and access troubleshooting tips to help resolve the issues effectively. This functionality enhances the overall user experience by facilitating easier identification and correction of problems.
  3. Refer to the Flow Debugger article for more information.


Review Error Message

  1. Upon clicking any of the error messages, the details of the message will open on the Details tab. By default, the Details tab will open.
  2. The error messages will provide the following tabs:
    1. Details
    2. Message
    3. Data Flow  
  3. The header of the screen will be displayed in red color with the parked icon and will have the following information:
    1. System Name:
      1. The system for which the message is seen is displayed in the header.
    2. Object Name:
      1. The object for which the message is seen is also displayed in the header.
      2. You can hover over the object name and select it to copy. The object name will be copied to the clipboard.
    3. Date and time:
      1. The date and time of the message will also be shown on the header. 

Error - Details Screen

  1. By default, the screen will open with the Details tab. 
  2. The details shown on the screen are for viewing only (Read-Only). The Details tab will display the following information:
  3. Message Details:
    1. This section provides information on the message and its description. 

  1. Below the message, action items are provided. This action item will be provided based on the message.
  2. To trigger the action, an action button is provided.
  3. Click on the action item button. Upon clicking the button, the corresponding action will be initiated. For some of the actions, you may be directed to another screen to configure some settings.

  1. This section presents the technical details of the message.
  2. An accordion is provided in the section. Upon clicking the accordion, the section will be expanded.
  3. The expanded section will provide details, including the message ID, transaction ID, and other pertinent information. This information is organized in a key-value format. For instance, 'Message ID' is the key, while '000000000000000' represents its corresponding value.
  4. When you hover over the message ID and transaction ID, the key will be highlighted, and a Copy Message ID and Copy Transaction ID tooltip will appear.
  5. To copy the message ID or transaction ID, click on the key. The key will be copied to the clipboard.

Error - Message Screen

  1. Click on the Message tab to transition from the Details/Data Flow tabs to the Message tab. The interface will then present the corresponding message on the screen.
  2. By default, the message is displayed in tree view mode.

Tree View

  1. By default, the tree view with the Control tab will be open, displaying the message details.
  2. Within the tree view, you can switch between the Control and Data views to see the message. The Control view displays the details of the message headers, while the Data view displays the details of the message elements. 

  1. A toolbar allows you to configure the font size to adjust the message readability. 

  1. A search feature is also available to find any elements within the message.
  2. As you begin typing in the search field, results are displayed instantly.
  3. If more than one search result is found, a navigation icon allows you to navigate through the searched results.
  4. To close the search, click on the 'X' icon.

  1. At the bottom of the screen, the message's location and target are shown.
  2. Location indicates the processing queue name, queue ID, target queue and stream name. 
  3. Please note that this information is for read-only use.

  1. When you switch to Data view, the message details will be shown on the screen.
  2. A Show Field Details section is provided on the right side of the message.

  1. The section displays details of the message node. When you click on any part of the message, the section opens automatically, showing information about that element.  
  2. The section appears with the details when you select any node in the message, displaying information such as name, type, format, and more.

  1. By default, the details of the selected parameter will be shown. 
  2. The section will display the name, type, format, default value, and other parameter details. 
  3. The information provided in this section is read-only for one purpose only.

  1. Click on the Issues tab to view the issue details.
  1. Once you click on the Issue tab, the issue in the messages will be displayed.
  2. The issue will be listed as a band. 
  3. Click on the issue band. Upon clicking the issue band, the message will scroll and display the parameter where the error is. By using this information, you can rectify the error in the message. 

Code View

  1. To switch from tree view to code view, click on the Code View.
  2. The code view displays the message in various formats, including XML, JSON, etc. 

  1. Within the code view, you can switch between the Control and Data views to see the message. The Control view displays the details of the message headers, while the Data view displays the details of the message elements. 

  1. A toolbar allows you to configure the various options to adjust the message readability:
    1. Font Size:
      1. This will enable you to increase the font size of the message for clear visibility. 
      2. Select the appropriate font size from the drop-down.
    2. Tab Size:
      1. This allows you to adjust the tab size in the message.
      2. Select the appropriate tab size from the drop-down.
    3. Word Wrap:
      1. This option allows you to use word wrap functionality for the displayed code.
      2. Please note that it is available in code view mode.

  1. A search feature is also available to find any elements within the message.
  2. As you begin typing in the search field, results are displayed instantly.
  3. If more than one search result is found, a navigation icon allows you to navigate through the searched results.
  4. To close the search, click on the 'X' icon.

  1. At the bottom of the screen, the message's location and target are shown.
  2. Location indicates the processing queue name, queue ID, target queue, and stream name. 
  3. Please note that this information is for read-only use.

Error - Data Flow Screen

  1. Click on the Data Flow tab to switch from the Details tab to the Data Flow tab. The interface will display a flow diagram in the tree view illustrating the process. 
  2. Each node in the tree provides an accordion, which allows you to expand or collapse the node.
  3. The flow starts with the object node of the system through which data flows.  
  4. The diagram visually represents the data flow involving various objects between interconnected systems. This flow highlights the exchange of data objects and organized collections of related information that mirror various business processes. These data objects can encompass a variety of attributes, including but not limited to sales orders, invoices, products, customer details, supplier information, and purchase orders. 
  5. At the end of the node, a message status icon will be displayed, such as success, error, or pause. 
  6. An Open Debugger button is provided in the action area of the screen.
  7. Click on the button to open the debugger of the selected message.




    • Related Articles

    • Debugging the Error Message

      Overview The Flow Debugger in OneEnterprise is an integral feature of Flow Designer, facilitating testing and troubleshooting of flows before deployment. This functionality allows you to execute a flow sequentially, enabling a comprehensive ...

    • Message Log

      Overview A log message is a comprehensive and structured record that captures crucial information or communication related to the operation of a program or system. These messages are generated during software execution, documenting various aspects ...