About the Integration Monitoring API for Strategic Sourcing

The data integration options available in SAP Ariba allows customers to import or export master and transaction data, to and from their ERP system. Data can be imported or exported by running individual or batch data import or export tasks from the user interface, or by scheduling the import or export using the SAP Ariba integration toolkit (ITK). This feature allows customers to configure an application or tool to call the Integration monitoring API URL, which will return the status of a particular integration event (a data import or export task). This is useful for customers to automate their batch import or export jobs to or from their SAP Ariba cloud solution. The API returns status information for both integration events run using the SAP Ariba integration toolkit as well as file-channel data import or export tasks run from the user interface.

The data import or export jobs can be run in frequent intervals or a particular job might take longer to process than expected due to other application issues. It was possible to start a job while a previous instance of the same job was still running, causing a data transfer failure. Now, using the Integration monitoring API, customers can monitor the status of imported and exported integration events. The API returns the current running status of the specified event, or, if the event is not currently running, it returns details of the last run status of the specific event. If the integration event was last run from the user interface, its status is returned. Integration monitoring API v2 has additional response fields to get detailed status information, such as percentage of completion of the file being processed, percentage of completion of files in a ZIP file, list of files processed, and list of files remaining, among others. It also returns the data source for error messages, which helps in identifying the source of the errors.

Your administrator must set the parameter Enable version 2 of the Integration monitoring APIs (Application.Base.EnableIntegrationEventMonitoringAPI) to turn on Integration monitoring API v2. For more information about the parameter, see Enable version 2 of the Integration monitoring APIs in Intelligent Configuration Manager Parameters Reference.

The Integration monitoring API is applicable to:

  • SAP, PeopleSoft, and generic ERP systems

  • Individual import and export file channel integration events

  • Batch import integration events

  • Transaction and master data

Accessing the API

This API can be accessed on the SAP Ariba Developer Portal from the Strategic Sourcing tab by selecting the following option:

  • Integration monitoring API for Strategic Sourcing

For more information on using the developer portal to develop client applications, see Help for the SAP Ariba Developer Portal.

Using the Integration Monitoring APIs in Multi-ERP Configurations

If an integration event runs on the parent site, querying the event status on the parent site shows details of that event.

A background replicator normally runs to push data down from the parent to child sites. The Integration monitoring APIs cannot retrieve the event status for data that is replicated to child sites. However, if the event runs on the child site, the Integration monitoring APIs can report on the progress of the event, as this event was run directly on the child site.