Track Integration Instances

You can filter and track the status of integration instances on the Instances page through business identifiers. You can also view the message payload of an instance you are tracking.

Topics:

You assign business identifiers during integration design time. At least one business identifier is required. See Assign Business Identifiers for Tracking Fields in Messages.

Filter the Display of Integration Instances

You can filter the display of integration instances on the Instances page during runtime.

In the navigation pane, click Observability, then Instances.
Click Filter to filter the display of instances by the following:
- Last updated or creation time
- Time window
- Instance ID
- Status
- Project name
- Integration name
  Begin typing an integration name. Do not use copy and paste. The filter is refreshed to display fields for the defined secondary business identifiers.
  
  You can now begin typing the values of the business identifiers to narrow down the search. This input follows the same rules (for example, for exact matches and phrase matches) as described in Search for Primary and Secondary Business Identifier Values.
- Integration style (all, application, schedule, or event)
- Event name
- Instances published and/or subscribed to that event name
- Parent instance ID
- Recovery job ID
- Integration that invoked the instance
- Instance state (all, retained, purged, replayed, or replayable).
You can enter variable values with special characters or variable values of multiple words with white space in double quotes in the Search field (for example, &filename or "file tracking").
Click Date Range to specify a custom time range with which to filter the search for instances with the From and To buttons. 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 Instances page to the Monitor Integrations page 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.

Search for Business Identifier Values

You can search for primary and secondary business identifier values on the Instances page during runtime. You can perform simple searches, phrase match searches, and exact match searches. This section provides examples of performing each search type.

In the navigation pane, click Observability, then Instances.
Use the Search field to search for values across both primary and secondary business identifiers.
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 canceled instances, the running time does not point to the actual time the canceled (faulted) instance was running. Instead, it consists of the total time span between when the instance began and when the instance was manually canceled.
The Search field provides many capabilities:
Note:
- Partial word searches are not supported. For example, assume one business identifier value is New York and another is New Orleans and both belong to different instance IDs. If you enter New as your search criterion, both instances are displayed because New and York are considered separate words. White space is considered a word separator.
- Underscores are not considered word separators. For example if the values are New_York and New_Orleans, and you enter New as the search criterion, neither instance is displayed because New_York is considered a complete word and partial word matches/searches are not supported. This is the case only with underscores. All other special characters (for example, periods, commas, and others) are considered word separators.

Search for Primary and Secondary Business Identifier Values

Enter a value, and press Enter. 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.
Search only for primary business identifier values by entering the value as primary: value or Primary: value in the Search field.
Note:
- If you enter a primary business identifier in the Search field, but do not press Enter, then select a value from the time period drop-down list, note that the instances are filtered considering the string entered in the Search field, even though Enter was not pressed. This is the expected behavior and is true for other landing pages in Oracle Integration.
- The search facility on the Instances page is case sensitive.

Perform a Simple Search

Enter a value in the Search field, and press Enter. For example:
```
125-78-2345
```
This returns all instances that include part of that business identifier value.
Enter a value with white space in the Search field, and press Enter. For example:
```
125-78-2345 York
```
Note that each individual part of the value is treated as a separate value (125, 78, 2345, and York are all considered separate). Any business identifier value found containing at least one of these values is returned. A simple search is similar to a web browser search.

Perform a Phrase Match Search

You can perform a phrase match search by enclosing your value in double quotes. Phrase matches are useful when you need to search for primary and secondary business identifier values containing special characters and white spaces.

Enter a value in the Search field, and press Enter. For example:
```
"125-78-2345 York"
```
Note that exact values are returned. Without the double quotes, each individual part would be considered a separate searchable value: 125, 78, 2345, and York.

Note that exact phrase match searches can also return the exact match, plus any additional values at the beginning or end of the enclosed value. Consider the following example.
Enter a value in the Search field, and press Enter. For example:
```
"125-78-2345 Delhi"
```
This returns any value that matches, plus any additional values. In this case, both 125-78-2345 Delhi and 125-78-2345 Delhi India are returned.

Perform an Exact Match Search

You can return an exact match search by enclosing the business identifier value in brackets ([ and ]). This search returns only exact match values.

Enter a value in brackets in the Search field, and press Enter. For example:
```
[125-78-2345 Delhi]
```
View the results. Only exact matches are returned.

Track the Status of Integration Instances

You can track fields in messages on which you have defined business identifiers on the Instances page during runtime. These fields are available for tracking on the Instances page because you defined at least one business identifier in the Business Identifiers panel during design time.

In the navigation pane, click Observability, then Instances.
Perform the following tasks:

You can also view the activity stream, business identifiers and values, and message payload in failed instances. See Manage Errors.

View the Slowest Running Activities in an Integration Instance

To diagnose performance issues, you can view the activities in the activity stream by their elapsed time. This ability ensures that the most time-consuming activities show first in the list and the best performing activities appear at the bottom. This functionality provides you with an immediate performance view and eliminates the time-consuming task of clicking each individual message or a large number of iterations in a looping action to identify time-consuming activities.

Understand the following behavior:

The duration is not shown for all activities. The duration for an activity is the time from the beginning to the end of activity execution. Not all activities have both times (for example, a trigger or a throw action) because both are not applicable.
The duration may not be available even for activities that have both times (such as a map action). This is because availability of these times depends on the integration tracing level. For example, an invoke action always appears, but other actions appear only when the instance is executed with the tracing level set to debug.
Only the top 10 slowest activities are shown in the table. Your integration may have many more actions.
You can view the overall time a looping action (for example, a while action or a for-each action) took to execute all its iterations. You can also expand the looping action to view the following:
- If your looping action had less than 10 iterations, all iterations and their times to execute are shown.
- If your looping action has more than 10 iterations, only the ten slowest iterations and their times to execute are shown.

Go to the row of the integration instance to view. The Duration column shows the time that an instance took to execute.
Click View Details .
The activity stream is displayed.
Click View slowest activities .
The total duration of the instance is displayed at the top. The activities that took the longest amount of time to execute are displayed in a table. The final column shows the percentage of time each activity took to execute based on the total duration of the instance. For this example, getWeatherInfo included a looping action that iterated 13 times.
Expand the looping action (getWeatherInfo) to view the iterations. For this example, the looping action was executed 13 times. The 10 slowest-running iterations are shown.
Use this functionality to identify and debug slow running activities.
Click View slowest activities again to return to the activity stream. This link enables you to toggle back and forth.

Discard an Instance on the Instances Page

Hover over the row of the instance to discard, then select Abort .
This option is only visible under the following scenarios:
- In-progress instances of asynchronous integrations (both scheduled and nonscheduled).
- Waiting and paused instances of schedule integrations. Attempting to discard other types of instances results in an error message being displayed.

View the Status of Future Schedule Integrations

Schedule integrations that have not yet run are displayed as Queued on the Instances page. The Duration column shows the label Scheduled on and the time at which the queued integration is scheduled to run (for this example, in four minutes).

The Primary Identifier, Instance Id, Status, Business Identifiers, and Duration columns are shown.

Hover over the queued integration in the Duration column to display the full date and time at which the queued integration is scheduled to run.
Click View Details or click the business identifier in the Primary Identifier column of a queued integration. The Activity Stream panel opens in either place and shows the time at which the queued integration is scheduled to run.

View the Activity Stream on the Instances Page

Hover over an instance, then select View Details to view the activity stream of the instance.
The activity stream shows details about the movement of the message through the integration, including where any failures occurred. The message flow through each action is also shown.
Expand the invoke connection.
Key child milestones of the parent invoke connection are displayed.

The date and time according to your user preferences are displayed. If your instance contains logic actions (for example, a while action or a for-each action with multiple iterations), each iteration is shown in the activity stream and can be expanded to show specific details about the message flow.
Click Download at the top of the activity stream to download the activity stream logs for the entire instance.
Click View Payload to view the payload for that part of the integration flow.

Perform tasks within the payload.

Element	Description
Summary	Click to view a summary of payload details.
Details	Click to view more specific payload details.
Download Payload	Click to download this part of the payload to your desktop.
Copy Payload	Click to copy this part of the payload for pasting into a document.
Toggle Line Numbers	Click to show or hide line numbers in the payload.

View the Child Instances of a Parent Instance

If your instance invokes child instances (for example, an integration action in your flow is invoking child integrations), you can view those instances on the Instances page.

Hover over a row and select View Child Instances.

You can also view invocations of child instances (local invokes) in the activity stream.

View the Activity Stream of a Child Integration Separately from the Parent Integration

You can view a child integration being invoked by a parent integration in a separate activity stream. You can also view the separate activity streams for one integration that invokes another integration, which then invokes a child integration. Each activity stream is connected by a button that provides easy access.

See Invoke a Child Integration from a Parent Integration.

Hover over the instance of a parent integration that invokes a child integration.
Click View Details .
The activity stream is displayed.
Expand the invoke connection.
The View child instance details link is displayed. This is where the instance of the child integration is invoked.
Click View child instance details to access the instance of the activity stream for the child integration. Note that Integration: Child and the integration version number are also displayed after the instance ID at the top.
Click to return to the instance of the activity stream for the parent integration.
Return to the Instances page and hover over the instance of an integration that invokes another integration, which then invokes a child integration.
Click View Details .
Expand the invoke connection.
Click View child instance details to access the instance of the activity stream for the integration being invoked.

Note that the parent name and the integration version number are displayed at the top.
Expand the invoke connection.
Click View child instance details to access the instance of the activity stream for the child integration being invoked.
Note that the child name and the integration version number are displayed at the top.
Click twice to return to the instance of the activity stream for the top level integration.

View the Display of HTTP Headers Separate from the Payload

HTTP headers associated with a payload are displayed separately from the payload for ease of viewing in the activity stream.

Click View Details .

If HTTP headers are associated with the payload, two tabs are displayed: Payload and Headers.
Click Headers to view details about the HTTP headers associated with the payload.

View File Metadata for Large Payloads in the Activity Stream

You can view file metadata for large payloads in the activity stream.

For example, if an integration performing inbound polling sends a CXML payload in GZIP format, the payload is shown in readable format in the activity stream. The payload size and media type are also shown.

Track the Integration Flow on the Instance Details Page

The Instance Details page provides a graphical view of the instance flow and access to the activity stream.

View the Instance Elements and Activity Stream on the Instance Details Page

Click a specific business identifier of an integration instance in the Primary Identifier column.

The integration flow of the instance and Activity Stream panel are displayed.
Click Download at the top of the activity stream to download the activity stream logs for the entire instance.
Click View Payload to view the payload for that part of the integration flow.

Perform tasks within the payload.

Element	Description
Summary	Click to view a summary of payload details.
Details	Click to view more specific payload details.
Download Payload	Click to download the payload to your desktop.
Copy Payload	Click to copy the payload for pasting into a document.
Toggle Line Numbers	Click to show or hide line numbers in the payload.

Click Activity Stream to close the activity stream.

View the Results of Iterations of Logic Actions on the Instance Details Page

You can view the results of iterations of logic actions (such as a for-each, switch, while, and others) in the activity stream on the Instance Details page.

Click a specific business identifier of an integration instance in the Primary Identifier column.
Go to the logic action in the integration (for this example, a for-each action is shown).
You can move to another iteration of the loop in either of two ways.
1. Click > to access a view of the next iteration in the loop. For this example, there are five iterations in this for-each action.
  
  or
1. Hover over and click the iteration box of a logic action in the integration.
2. Enter a specific value and click OK (for example, 5). This method is useful when the logic action has iterated many times.
  The activity stream shows the specified iteration of the logic action.

Access Information Through Inline Menus on the Instance Details Page

The inline menus of the triggers, invokes, and actions in the integration flow provide access to additional information.

Click a specific business identifier of an integration instance in the Primary Identifier column.

Select from a set of options. The options that appear are based on the element you selected.

Option	Description
For trigger or invoke connections, click Actions , then View Connection.	Displays configuration details for the connection: Selected roles for the connection (trigger, invoke, or trigger and invoke) Identifier value and date last updated Integrations using the connection (click to view the list) Connection and security properties defined on the Connections page Status of agent group association Configuration progress (the connection properties and security policy must be completely configured and tested to be listed as 100%) The Actions menu in the upper right corner enables you to edit or delete the connection (if not currently used in an activated instance).
For trigger, action, and invoke connections, click Actions , then View.	Displays the following details: For schedules, shows the configured scheduled parameters. For triggers and invokes, the Adapter Endpoint Configuration Wizard is invoked to show the configuration settings. For maps, the mapper is invoked to show the mappings. For other actions, the specific configurations are shown.
For logic actions (such as a scope, for-each, while, wait, and switch), click Actions , then Expand.	Displays each action and invoke within the logic action.
For logic actions (such as a scope, for-each, while, wait, and switch), click Actions , then Collapse.	Displays the collapsed logic action.
For parent integrations that call child integrations, click Actions , then View Child Instances.	Displays the child integration called by the parent. See Invoke a Child Integration from a Parent Integration.

Determine Why an Integration Instance Stopped Running

When a scheduled or asynchronous integration instance stops running, the reason for the termination appears in the activity stream.

The following sections describe the message displayed in the activity stream based on the type of instance termination.

Someone Stopped an Asynchronous Integration Instance

In the navigation pane, click Observability, then Instances.
Hover over the row of the active integration instance to terminate, and select Abort .
Click Confirm when prompted.
Click View Details .
The Activity Stream panel opens. A red icon and the reason for the termination are displayed.
```
Instance aborted by username
```

Someone Deactivated an Asynchronous Integration While Instances Were Running

In the navigation pane, click Design, then Integrations.
Hover over the row of the integration instance to deactivate, and select .
In the navigation pane, click Observability, then Instances.
Click View Details .
The Activity Stream panel opens. A red icon and the reason for the termination are displayed.
```
Instance aborted due to deactivation of integration by username
```

Someone Stopped a Running Schedule of an Integration

The scheduled run is either currently running successfully or has exceeded six hours in duration (now considered an out-of-bounds run).

In the navigation pane, click Observability, then Instances.
Hover over the row of the active, schedule integration instance to terminate, and select Abort .
Click Confirm when prompted.
Click View Details .
The Activity Stream panel opens. A red icon and the reason for the termination are displayed.
```
Instance aborted as schedule was stopped by username
```

Oracle Integration Terminated an Asynchronous or Schedule Instance That Exceeded the Processing Deadline

In the navigation pane, click Observability, then Instances.
In the Duration column, find the integration that has exceeded the processing deadline (for example, an integration's duration reached eight hours and two minutes).
Click View Details .
The Activity Stream panel opens and displays the following details for the instance terminated internally by Oracle Integration.
```
Instance aborted as it has reached maximum duration allow for a flow
```

Oracle Integration Terminated a Stuck Scheduled Instance

This rare scenario is for scheduler recovery jobs and only applies when a schedule instance is not terminated internally by Oracle Integration.

In the navigation pane, click Observability, then Instances.
In the Duration column, find the integration that has exceeded the processing deadline.
Click View Details .
The Activity Stream panel opens and displays the following details for schedule instances.
```
Instance aborted as it has reached maximum duration allow for a scheduled flow
```

Replay Integration Instances

You can replay REST Adapter-triggered and AS2 Adapter-triggered integration instances that you configured as replayable during integration activation. This feature enables you to quickly retest your integration without the need to re-enter the data used to initially trigger the integration.

Capabilities and Restrictions

You can only replay instances in which you explicitly select Allow to run again in the Activate integration panel.
You can only replay instances in which the trigger adapter connection is a REST Adapter or AS2 Adapter.
You can only replay instances with structured payload content. You cannot replay instances with unstructured payload content.
You can replay instances regardless of their state (for example, you can replay successful, faulted, and aborted instances).
You can replay instances outside and inside of projects.
You cannot replay instances where the connectivity agent is used.
You can only replay a single instance at a time.
There must be an active integration with the same major version as the replayed instance.
A parent instance can have many child-replayed instances.
A replayed instance has a single parent instance.
You can replay both asynchronous and synchronous instances.
Payload data for replayed instances is captured for 32 days (for the Production and Audit tracing levels).

Understand the Differences Between Replaying and Recovering Instances

Instance replay and instance recovery (performed with the Resubmit option on the Errors page) are not the same. Understand the differences to determine which feature is best for your scenario. Instance recovery includes the following restrictions.

You can only recover a faulted instance that is identified as recoverable.
You cannot recover synchronous instances.
You cannot recover scheduled integration instances with scheduled parameters.
Recovery only updates the existing instance. No new instance is created.
Recovery is independent of adapter type or payload content.
Recovery only restarts from the last dehydration point in an instance (for example, a wait action), whereas replay starts completely from the beginning of the instance.

Replay an Integration Instance

This section describes how to replay an integration instance on the Instances page outside of a project. You can also replay an integration instance inside a project. See Activate or Deactivate an Integration in a Project and Track Instances in a Project.

In the navigation pane, click Design, then Integrations.
Hover over the integration to activate, then click Activate .
Select the level of tracing appropriate to your integration. This level describes the amount of data to capture in the activity stream. See Activate an Integration.
In the Configure runtime options section, select Allow to run again, then click Activate. This selection enables you to replay an instance of an integration during runtime on the Instances page. This selection is only available with specific types of integrations. See Capabilities and Restrictions.
Run the integration. For REST Adapter trigger connection-based integrations, you can use the Configure and run page. See Test Integrations from Outside the Integration Canvas.
The Activity Stream panel opens.
Go to the Instances page in either of two ways:
1. On the Configure and run page, close the activity stream and click Track instances.
2. In the navigation pane, click Observability, then Instances.
Hover over the row of the instance to replay, and click Run again .
The Run again panel opens.
Select the tracing level to use for this instance replay. The level you select is unique to this replay only and does not impact the tracing level you set when activating the integration.
Click Run again.
When you replay an instance, a new instance ID is created and an icon is added to identify this as a replayed instance. For this example, the replayed instance and the original instance immediately below are shown. You can continue to replay the original instance or the replayed instance.

Note:
The Display instances option of the Filter enables you to filter on replayed or replayable instances.
Click View details to view the activity stream.
Click Actions and note the selections for both the original and replayed instances.
- The original instance lets you view the replayed child instance.
- The replayed instance lets you view the replayed parent instance and the replayed child instances.
You can replay the original instance again or replay the previously-replayed instance again.

If you no longer want the integration to be replayable, you can change the configuration.
In the navigation pane, click Design, then Integrations.
Hover over the row of the integration to configure, and select Actions , then Configure activation.
In the Configure runtime options section, deselect Allow to run again, then click Save. You do not need to deactivate the integration. The change is applied to the active integration.
Run your integration again and go to the Instances page to review the results.
Hover over the row for that instance and note that there is no Run again icon for replaying this specific instance.

Note:
The instances that you created previously when the integration was replayable still show the Run again icon. However, if you attempt to replay these instances, you receive an error. This is because the integration is no longer replayable.

You can also reprocess (replay) B2B for Oracle Integration instances. See B2B Tracking in Using B2B for Oracle Integration 3.