Manage Business Identifiers for Tracking Fields in Messages

You can view the status of business identifiers included in integrations on the Tracking page.

You can also view the message payload of an instance you are tracking.

Topics:

See Assign Business Identifiers for Tracking Fields in Messages.

Track Business Identifiers in Integrations During Runtime

You can track fields in messages on which you have defined business identifiers on the Track Instances page during runtime. These fields are only available for tracking on the Track Instances page if you defined a primary business identifier in the Business Identifiers for Tracking dialog during design time.

To track business identifiers in integrations during runtime:
  1. In the left navigation pane, click Home > Monitoring > Integrations > Tracking.
  2. From the Filter icon link, select the time window, instance ID, status, integration, request ID, recovery job ID, or asserter instance for which to search for business identifiers in messages.
    Filters for Time Window, Status, Integration, Request ID, Recovery Job ID, and Asserter Instance

    You can also click Date Range to specify a custom time range with which to filter the search for instances with the From and To buttons at the bottom. This enables you to select a time range as small as a minute and track only those instances processed within that specified time range. The specified time range is preserved by default and applied to the data being displayed when you navigate from one monitoring page to another (for example, when you move from the Track Instances page to the Monitor Integrations or Errors page).

    Note:

    The time range specified must be within the retention period. Data beyond the retention period is not retained. If the selected time range is beyond the retention period, only available data is displayed.
    Results are displayed for any integration on which a primary business identifier is set, including the business identifier and value, the instance identifier of the integration, and the state of the integration (for example, completed, failed, or aborted). You can show the name and value of tracking variables.

    For aborted instances, the running time does not point to the actual time the aborted (faulted) instance was running. Instead, it consists of the total time span between when the instance began and when the instance was manually aborted.


    Description of track_instances1.png follows
    Description of the illustration track_instances1.png

  3. Use the Search field to search for values across both primary identifiers and secondary identifiers.
    1. To search for primary and secondary identifier values, enter a value, and click Search. For example, assume the primary value is James. In the search results, any instances that have a primary value of James are returned. Any instances with a secondary value that includes James (for example, Mark.James@asc.com) are also returned.
    2. To search only on primary business identifier values, enter the value as primary: value or Primary: value in the Search field

      Search field value of primary:James. The Search button is to the right.

    Note:

    • If you enter a primary business identifier in the Search field, but do not click the Search button, then select a value from the time period dropdown list, note that the instances are filtered considering the string entered in the Search field, even though the Search button was not clicked. This is the expected behavior and is true for other landing pages in Oracle Integration.

    • The search facility on the Track Instances page is case sensitive.

  4. Click Abort icon at the end of the row of a specific instance to abort it. This option is only available under the following scenarios:
    • In-progress instances of asynchronous integrations (both scheduled and nonscheduled).
    • Waiting and paused instances of scheduled integrations. Attempting to abort other types of instances results in an error message being displayed.
  5. Click Details icon at the end of the row of a specific instance to view the message flow. The activity stream shows details about the movement of the message through the integration, including where any failures occurred. For orchestrated integrations, the message flow through each action (for example, any defined switch action branches) is also shown. The date and time according to your user preferences are displayed.
    Description of activity_stream.png follows
    Description of the illustration activity_stream.png

  6. Perform the following tasks in the Activity Stream section.
    Click ... To ...
    Download link

    The first two options do not include the payloads of activities.

    • Download JSON: Download the activity stream data in JSON format.
    • Download CSV: Download the activity stream data in CSV format.
    • Download Logs: Download the instance activity stream logs. This log file includes the payload of activities.
    Expand icon Display the activity stream on a full page. This link works as a toggle to expand and collapse the activity stream.
    Close link Close the activity stream.
  7. Click Message to view the payload details for the action.
  8. Click Actions menu, then select an action to perform.
    Click ... To ...
    Expand Display the message on a full page. This link works as a toggle to expand and collapse the message.
    Show Line Numbers Number each line in the message.
    Copy to Clipboard Copy the message to the clipboard.
    Download Payload Download a text file of the payload.
    Close Close the message.
  9. If your integration includes any looping actions (such as for-each, while, and others), expand Iteration to view flow execution inside the loop (available if you enabled tracing to include the payload when you activated your integration).
    This image shows a While loop with an Iteration section that has been expanded to show the tasks that are executed as part of that loop.

  10. If the activity stream contains errors, click Error to show the error message.
    The time and message of the activity stream are displayed. In the upper right, Ascending is selected. The message includes clickable Error links.

  11. Click Actions menu, then select an action to perform.
    Click ... To ...
    Expand Display the message on a full page. This link works as a toggle to expand and collapse the message.
    Show Line Numbers Number each line in the message.
    Copy to Clipboard Copy the message to the clipboard.
    Download Payload Download a text file of the payload.
    Close Close the message.
  12. Return to the Track Instances page and click the business identifier to access a graphical display of the integration instance.
    Business identifier to click

    This page provides information about the business identifiers and values defined for the integration, the instance identifier of the integration, any error message, the activity stream, a button for discarding an error, and other information. The entire message flow is tracked through the integration. Successful message flows are indicated by green arrows. Any message flow errors that occur are identified by red arrows. For looping elements (such as for-each, while, and others), successful instances do not capture the flow inside the iterations. The loop-internal actions and colored lines are shown only if a failure occurs.
The functionality available on this page is based on your type of integration style.

View the Runtime Instance Flow of an Orchestrated Integration

You can view a graphical display of the runtime instance flow of an orchestrated integration. The graphical display is shown when you click the business identifier for the instance on the Track Instances page.

Once on the page that shows the graphical display of the runtime instance, you can perform the following tasks:
  1. From the hamburger menu menu in the upper right corner, select View Activity Stream to view the message flow. The activity stream shows details about the movement of the message through the integration, including where any failures occurred. For orchestrated integrations, the message flow through each action (for example, any defined switch action branches) is also shown. The date and time according to your user preferences are displayed.
    Perform similar activity stream tasks as described in Track Business Identifiers in Integrations During Runtime.
    • Successful instance:
      The activity stream of a successful instance. The stream drawer is displayed on the right. Each step in the integration flow is indicated by a green dot. The Message link is clicked to show more specific message details.

    • Failed instance:
      The activity stream of a failed instance. The stream drawer is displayed on the right. Each step in the integration flow that is successful is indicated by a green dot. Steps that are unsuccessful are indicated by a red dot. The Error link is clicked to show more specific message details.

  2. Click Close when complete.

View the Runtime Instance Flow for a Basic Routing Integration

You can view a graphical display of the runtime instance flow of a basic routing integration. The graphical display is shown when you click the business identifier for the instance on the Track Instances page.

Once on the page that shows the graphical display of the runtime instance, you can perform the following tasks:
  1. From the hamburger menu menu, select View Audit Trail to view the message flow. The audit trail shows details about the movement of the message through the integration, including where any failures occurred.
    The Audit Trail dialog with columns for Time and Activity. A Close button is in the lower right corner. A help icon is in the upper right corner.

  2. Select View Activity Stream to view the high level activity stream. If you enabled tracing to include the payload when you activated your integration, more specific payload details are provided.
    The activity stream is shown in ascending order. The Record count list is shown in the upper right corner. The Close button is in the lower right corner.

  3. Select Download Activity Stream to download a ZIP file of the activity stream.
  4. Click Close when complete.