Recording Integration History for Oracle Integration Cloud Integrations

Configure Oracle Integration Cloud integrations that invoke Oracle Fusion Cloud Enterprise Data Management REST APIs to record integration runs and associated operations in Cloud EDM integration history.

An OIC integration can use Cloud EDM integration history to provide a consolidated record of the Cloud EDM and external operations performed during an integration run. The integration uses an integrationHistoryId to associate these operations with the integration run in Cloud EDM.

To record this information, configure the OIC integration to create and maintain an integration history record in Cloud EDM, associate supported Cloud EDM operations with that history, and optionally record significant operations performed outside of Cloud EDM. The following sections describe the integration history model and recommended configuration practices.

Note:

The configuration described in this topic is performed in OIC. For detailed information about creating and configuring integrations in OIC, see Using Integrations in Oracle Integration 3.

Understanding Integration History Records

Cloud EDM integration history uses different types of history records to represent the overall integration run and the operations performed during that run. The following table describes the types of history records used by Oracle Integration Cloud integrations in Cloud EDM.

Table -61 Integration Record Types

Record Type	What it Represents	How it is Managed
Integration history record	The overall Oracle Integration Cloud integration run that is associated with Cloud EDM operations.	The integration that manages the end-to-end run creates or uses the effective integrationHistoryId, records the final outcome, and clears the scheduled value after all history processing is complete.
Cloud EDM task history record	A Cloud EDM operation, such as an import, export, extract, load, or other operation that Cloud EDM records as a task.	Cloud EDM creates and maintains task history for the operation. Pass integrationHistoryId only when the applicable Cloud EDM REST request schema supports that field.
Custom task history record	A significant operation performed outside of Cloud EDM, such as source retrieval, file validation, database loading, an external API call, or target delivery.	Create the record immediately before the operation begins. Update the same record on its success and failure paths.

Use Custom task history records only for integration steps that happen outside of Cloud EDM. Do not create a Custom task history record for Cloud EDM operations that already record their own history.

Recording Integration History

Configure the OIC integration to create and maintain Cloud EDM integration history throughout the integration run. The following steps describe the recommended sequence for managing integration history.

1. In OIC, define an optional String schedule parameter named integrationHistoryId for the integration. The integrationHistoryId is a correlation value that associates an integration run with its related history records.

2. Create a Cloud EDM integration history record and retain the returned integrationHistoryId for the duration of the integration run.

   See Create Integration History in REST API for Oracle Fusion Cloud Enterprise Data Management

3. When the integration invokes a Cloud EDM REST API operation that supports integrationHistoryId, pass the integration history ID in the request. This associates the Cloud EDM operation with the integration run.

   In REST API for Oracle Fusion Cloud Enterprise Data Management, see:

   • Import Operations:
     • Import a Dimension by Name
     • Import a Dimension from a File
     • Import a Dimension via a Connection
   • Export Operations:
     • Export a Dimension by Name
     • Export a Dimension to Connection
     • Export a Dimension to a File
     • Incremental Export for a Dimension
   • Export Mapping Operations:
     • Export a Dimension Mapping by Name
     • Export a Dimension Mapping to a Connection
     • Export a Dimension Mapping to a File
   • Extract Operations:
     • Extract a Dimension Viewpoint
     • Run an Extract Package
   • Load Operations:
     • Load a Viewpoint from a File
     • Load a Dimension Viewpoint

4. Optional: For significant operations that occur outside of Cloud EDM, create and update custom task history records using the Cloud EDM integration task history APIs. Provide the integrationHistoryId when creating a custom integration task.

   In REST API for Oracle Fusion Cloud Enterprise Data Management, see:

   • Create Integration Task History
   • Update Integration Task History

5. When processing completes, update any required custom task history records with their final status. Then update the integration history with the final status and messages. Set the status to COMPLETED when processing succeeds or ERROR when an unrecovered error occurs.

   See Update an OIC Integration History Record in REST API for Oracle Fusion Cloud Enterprise Data Management.

6. In OIC, configure an Assign action to reset the integrationHistoryId parameter to blank after updating the integration history. This prevents a subsequent integration run from reusing the history ID from a previous run.

   See Create and Update Parameters in Schedule Integrations in Using Integrations in Oracle Integration 3.

For more information, see OIC Integrations in REST API for Oracle Fusion Cloud Enterprise Data Management.