SAP Ariba

This page describes the monitoring setup for SAP Ariba solutions with SAP Focused Run 3.0 FP 02 or newer.

Since SAP Focused Run 3.0 FP 02 the data is collected using a new monitoring API in SAP Ariba, which allows the collection of messages and exceptions from the SAP Ariba Integration Monitoring Central Store.

Please select the documentation appropriate for your SAP Focused Run release from the table below. 

SAP Focused Run ReleaseMonitoring Setup Documentation
SAP Focused Run 3.0 FP 02Stay on this page
SAP Focused Run 3.0 FP 01 and lowerSAP Ariba - up to SAP Focused Run 3.0 FP01

Technical Prerequisites

To collect messages from the SAP Ariba Integration Monitoring Central Store you need at least:

  • SAP Focused Run 3.0 Feature Pack 02

Setup Steps in SAP Ariba

Create Client Application in SAP Ariba API Portal

To be able to collect messages from SAP Ariba you need to be on-boarded to the SAP Ariba API portal. In this portal a client application will be created which then allows you to collect information on SAP Ariba messages.

Most customers will already have at least one person in their organization that has access to the SAP Ariba API portal. 

If no-one in your company has access, or your company does not yet have an organization in the SAP Ariba API portal, please follow the FAQ How do I create a new organization in API Developer Portal?

Once you have access to the SAP Ariba API portal please proceed is described here:

  1. Log on to the SAP Ariba API portal (you find the correct URL for your data center in the table of section "Important URLs")
  2. In the navigation pane on the left side navigate to 'Manage'
  3. Click the "+" button on top of the application list
  4. Enter an application name and a description
  5. Click the "Submit" button
  6. Click on "Actions" > "Request API Access"
  7. Select the API Integration Event Monitoring Query API for Procurement this API will be used for all SAP Ariba applications.
  8. Check the box in front of the SAP Ariba applications (Procurement, Sourcing and/or Ariba Network) that you want to assign to this client application
    1. Select all realms that you want to assign from the respective drop-down box
    2. You can use the same application for multiple realms, e.g. for mycompany and mycompany-T, and multiple applications
      • The realm is part of the URL you use to access SAP Ariba:
        • SAP Ariba Buyer Example: https://s1.ariba.com/Buyer/Main/ad/loginPage/...&realm=mycompany
        • SAP Ariba Sourcing Example: https://mycompany.sourcing.ariba.com/
      • If you only use SAP Ariba Network you won't have a realm name to provide, instead you must link the API client ID to the AN-ID after the API is assigned (see documentation in section "Link API Client ID to AN-ID (SAP Ariba Network only)")
  9. Click the "Submit" button.
  10. Ariba will approve the API access request for your client application within 24h.
  11. Continue with the steps under "Create OAuth Secret for Client Application" after the API access request is approved.

Create OAuth Secret for Client Application

After the API access for the application is provided go back to the SAP Ariba API Portal and generate an OAuth secret for your application.

  1. Log on to the SAP Ariba API portal with a user that has the Organization Admin role
  2. Click "Manage" in the left-hand menu 
  3. Find your application for Integration Monitoring under "My Applications" and select it
  4. The application should now only have the step "Your admin needs to generate the OAuth Secret for your application" open
  5. Click on "Actions" > "Generate OAuth Secret". Please note that generating a new OAuth secret invalidates any old OAuth secrets!
  6. Click Submit
  7. Download the file in the next step. It contains the Application Key, the OAuth Client Id, and the OAuth Secret.
  8. Find your SAP Ariba API URL and the SAP Ariba OAuth URL in the table in section "Important URLs" and add it to the file. 

Attention: Non-US Customers using SAP Ariba Network or SAP Ariba CIG

The following only applies to non-US customers using SAP Ariba Network or SAP Ariba Cloud Integration Gateway.

Unlike SAP Ariba Sourcing and SAP Ariba Procurement, SAP Ariba Network and SAP Ariba CIG are always hosted in US-based data centers. Hence, events in this applications are sent to the Integration Monitoring event database located in the US data center. 

The Integration Monitoring event database can only be accessed by a client application created in the SAP Ariba Developer Portal for its region.

To check in which region your SAP Ariba Sourcing and SAP Ariba Procurement tenants are hosted please perform the following steps:

  1. Log on to SAP Cloud ALM
  2. Open Administration > Landscape Management
  3. Find you SAP Ariba Sourcing or Procurement cloud service
  4. Click on the service name
  5. Go to the tab "Properties"
  6. Find the value for "Data Center Location"

Only if your SAP Ariba Sourcing or your SAP Ariba Procurement tenant are hosted in a non-US data center, you have to create two client applications.

  • One client application has to be created in the US SAP Ariba Developer Portal (https://developer.ariba.com/api/), this client application will be used to collect events from SAP Ariba Network and SAP Ariba CIG 
  • The second client application has to be created in the SAP Ariba Developer Portal for your region (see table in section 'Important URLs'), this client application will be used to collect events for SAP Ariba Sourcing and SAP Ariba Procurement

Please perform the steps described in the sections above for both client applications.

Important URLs

The following table contains the data centers with the respective SAP Ariba API URL and SAP Ariba OAuth URL:

Data CenterSAP Ariba API Portal URLSAP Ariba API URLSAP Ariba OAuth URL
US PRODhttps://developer.ariba.com/api/https://openapi.ariba.com/https://api.ariba.com/
EU PRODhttps://eu.developer.ariba.com/api/https://eu.openapi.ariba.com/https://api-eu.ariba.com/
RU PRODhttps://ru.developer.ariba.com/api/https://ru.openapi.ariba.com/https://api-ru.ariba.com/
CN PRODhttps://developer.ariba.cn/api/https://openapi.ariba.cn/https://api.ariba.cn/
UAE PRODhttps://mn1.developer.ariba.com/api/https://mn1.openapi.ariba.com/https://api.mn1.ariba.com/
KSA PRODhttps://mn2.developer.ariba.com/api/https://mn2.openapi.ariba.com/https://api.mn2.ariba.com/
AU PRODhttps://developer.au.cloud.ariba.com/api/https://openapi.au.cloud.ariba.com/https://api.au.cloud.ariba.com/

Link API Client ID to AN-ID (SAP Ariba Network only)

The following steps only apply to the following customers:

  • Customers who are using an SAP Ariba Network only scenario, like e.g. "Setting Up Automation of Source-to-Pay with Ariba Network (42K)" and do neither use SAP Ariba Sourcing nor SAP Ariba Procurement.
  • Non-US customers for which SAP Ariba Sourcing and SAP Ariba Procurement are located in a non-US data center and that use SAP Ariba Network located in a US data center

Those customers will not have a realm to assign to the client application for SAP Ariba Network. Instead they have to link the API Client ID (Oauth Client Id) to the AN-ID in SAP Ariba Network.

To do this:

  1. Log on to the SAP Ariba Developer portal after SAP Ariba Support added the requested API to your client application
  2. Copy the value in the field "Oauth Client Id"
  3. Log on to SAP Ariba Network
  4. Click on you user name in the upper right corner and navigate to "Manage Profile"
  5. Click on the option "Open API Client ID Config"
  6. Click the "Add" button
  7. Enter the Oauth Client Id you copied earlier
  8. Save you changes.

After finishing all steps you should have the following information available for the next steps in SAP Cloud ALM:

  • SAP Ariba API URL
  • SAP Ariba OAuth URL
  • OAuth client ID
  • OAuth secret
  • Application key

Configure Cloud Service

For SAP Ariba you can choose between the following products. Please choose the product that matches the cloud service you want to connect. 

  • SAP Ariba Cloud Integration Gateway
  • SAP Ariba Network
  • SAP Ariba Procurement
  • SAP Ariba Sourcing

Input Values for SAP Ariba

  • Tenant:
    • For SAP Ariba Procurement, SAP Ariba Sourcing and SAP Ariba CIG: Enter the realm
    • For SAP Ariba Network: Enter the AN-ID
  • Open API Root URL: Enter your SAP Ariba API URL
  • Description: (optional)

Input Values for SAP Ariba

  • Type: OAUTH
  • OAuth URL: Enter your SAP Ariba OAuth URL
  • Application key: Enter your Application Key
  • Client ID: Enter the OAuth client ID
  • Client secret: Enter the OAuth secret

Advanced Integration Monitoring Setup

Available Monitoring Categories 

For the different SAP Ariba products different monitoring categories are available:

  • SAP Ariba CIG Message: Collects messages from SAP Ariba Cloud Integration Gateway
  • SAP Ariba Network Message: Collects messages from SAP Ariba Network
  • SAP Ariba Procurement Message: Collects messages from SAP Ariba Procurement
  • SAP Ariba Sourcing Message: Collects messages from SAP Ariba Sourcing

Available Filter Options 

SAP Ariba CIG Message

  • Component Name: Select a value from the input help
  • Status: The message status
  • Status Group: Select a value from the input help

SAP Ariba Network Message

  • Component Name: Select a value from the input help
  • Status: The message status
  • Status Group: Select a value from the input help

SAP Ariba Procurement Message

  • Component Name: Select a value from the input help
  • Status: The message status
  • Status Group: Select a value from the input help

SAP Ariba Sourcing Message

  • Status: The message status
  • Status Group: Select a value from the input help

Available Metrics 

For the different SAP Ariba categories the following metrics are collected:

SAP Ariba CIG Message

  • Erroneous Messages detected: Creates an alert if a message in error state is detected
    Metric parameters:
    • STATUS_GROUP (not changeable) = ERROR
    • OLDER_THAN_MINUTES = Only consider messages older than [minutes]
  • SAP Ariba CIG Message issues for longer than N minutes: Creates an alert if a message is in a certain state for longer than N minutes.
    Metric parameters:
    • OLDER_THAN_MINUTES = Only consider PI Messages older than [minutes]

SAP Ariba Network Message

  • Erroneous Messages detected: Creates an alert if a message in error state is detected
    Metric parameters:
    • STATUS_GROUP (not changeable) = ERROR
    • OLDER_THAN_MINUTES = Only consider messages older than [minutes]
  • SAP Ariba Network Message issues for longer than N minutes: Creates an alert if a message is in a certain state for longer than N minutes.
    Metric parameters:
    • OLDER_THAN_MINUTES = Only consider PI Messages older than [minutes]

SAP Ariba Procurement Message

  • Erroneous Messages detected: Creates an alert if a message in error state is detected
    Metric parameters:
    • STATUS_GROUP (not changeable) = ERROR
    • OLDER_THAN_MINUTES = Only consider messages older than [minutes]
  • SAP Ariba Network Message issues for longer than N minutes: Creates an alert if a message is in a certain state for longer than N minutes.
    Metric parameters:
    • OLDER_THAN_MINUTES = Only consider PI Messages older than [minutes]

SAP Ariba Sourcing Message

  • Erroneous Messages detected: Creates an alert if a message in error state is detected
    Metric parameters:
    • STATUS_GROUP (not changeable) = ERROR
    • OLDER_THAN_MINUTES = Only consider messages older than [minutes]
  • SAP Ariba Network Message issues for longer than N minutes: Creates an alert if a message is in a certain state for longer than N minutes.
    Metric parameters:
    • OLDER_THAN_MINUTES = Only consider PI Messages older than [minutes]

Further Information

Supported Events

ProductProcessEvents
SAP Ariba Sourcing / SAP Ariba ContractsSetting Up Contract Management with SAP Ariba Contracts (4AZ)
  • PurchaseContractRequestExport [Outbound]
  • PurchaseContractStatusUpdateRequestImport [Inbound]
SAP Ariba Sourcing / SAP Ariba ContractsSetting Up Contract for Central Procurement with SAP Ariba Contracts (4B0)
  • PurchaseContractRequestExport [Outbound]
  • PurchaseContractStatusUpdateRequestImport [Inbound]
SAP Ariba Sourcing / SAP Ariba ContractsSetting Up Sourcing with SAP Ariba Sourcing (4BL)
  • S4HANARequestForQuotation [Inbound]
  • RFQConfirmationS4Request [Outbound]
  • SupplierQuotationS4RequestAsync  [Outbound]
  • S4HanaQuotationConfirmation [Inbound]
SAP Ariba Sourcing / SAP Ariba ContractsSetting Up Central Procurement with SAP Ariba Sourcing (4QN)
  • S4HANARequestForQuotation [Inbound]
  • RFQConfirmationS4Request [Outbound]
  • SupplierQuotationS4RequestAsync  [Outbound]
  • S4HanaQuotationConfirmation [Inbound]
SAP Ariba Procurement / SAP Ariba Guided BuyingSetting Up Guided Buying Capability with SAP Ariba Buying (2NV)
  • RequisitionSubmit [Outbound]
  • RequisitionFinalApproval [Outbound]
  • RequisitionLineAddAttachment [Outbound]
  • RequisitionLineRemoveAttachment [Outbound]
  • RequisitionDelete [Outbound]
  • PurchaseOrderStatusNotificationMsgS4Hana [Inbound]
  • PurchaseRequisitionReplicationNotificationS4Hana [Inbound]
SAP Ariba Procurement / SAP Ariba Guided BuyingSetting Up Guided Buying for Central Procurement with SAP Ariba Buying (3EN)
  • RequisitionSubmit [Outbound]
  • RequisitionFinalApproval [Outbound]
  • RequisitionLineAddAttachment [Outbound]
  • RequisitionLineRemoveAttachment [Outbound]
  • RequisitionDelete [Outbound]
  • PurchaseOrderStatusNotificationMsgS4Hana [Inbound]
  • PurchaseRequisitionReplicationNotificationS4Hana [Inbound]
Ariba Network

Setting Up Automation of Order-to-Invoice with Ariba Network (4A1)

Setting Up Automation of Source-to-Pay with Ariba Network (42K)

  • ProcessOrderRequest
  • ProcessShipNoticeRequest
  • ProcessConfirmationRequest
  • ProcessReceiptRequest
  • ProcessInvoiceDetailRequest
  • ProcessStatusUpdateRequest
  • ProcessPaymentProposalRequest
  • ProcessServiceEntrySheet
  • ProcessStatusUpdateRequest
  • ProcessQuoteRequest (AN Discovery)
  • ProcessQuoteMessageOrder (AN Discovery)
SAP Ariba Cloud Integration GatewayIntegration
  • Status log for transmitted documents (document types see supported processes for SAP Ariba products)