SAP Ariba

This page covers the setup of Integration & Exception Monitoring with SAP Cloud ALM for the following SAP Ariba Products:

  • SAP Ariba Sourcing
  • SAP Ariba Procurement
  • SAP Ariba Network
  • SAP Ariba Cloud Integration Gateway (CIG)

Available Monitoring Content

CategoryTypeDescriptionSupported Processes
SAP Ariba Cloud Integration Gateway TransactionsMessagesMessages send via SAP Ariba Cloud Integration Gateway
  • Integration
SAP Ariba Network MessagesMessagesMessages send via SAP Ariba Network
  • Setting Up Automation of Order-to-Invoice with Ariba Network (4A1)
  • Setting Up Automation of Source-to-Pay with Ariba Network (42K)
SAP Ariba Procurement Integration MessagesMessagesMessages send from and to SAP Ariba Procurement
  • Setting Up Guided Buying Capability with SAP Ariba Buying (2NV)
  • Setting Up Guided Buying for Central Procurement with SAP Ariba Buying (3EN)
SAP Ariba Sourcing Integration MessagesMessagesMessages send from and to SAP Ariba Sourcing
  • Setting Up Contract Management with SAP Ariba Contracts (4AZ)
  • Setting Up Contract for Central Procurement with SAP Ariba Contracts (4B0)
  • Setting Up Sourcing with SAP Ariba Sourcing (4BL)
  • Setting Up Central Procurement with SAP Ariba Sourcing (4QN)

Setup Video

The following video demonstrates the setup steps to set up Integration & Exception Monitoring for SAP Ariba.

A textual step by step description for all setup steps is provided in the sections below the videos.

 

Set Up Integration & Exception Monitoring for SAP Ariba

  • Prerequisites for this video:
    • You need a user with access to SAP Ariba Connect (https://support.ariba.com)

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 messages information.

Please note that currently only SAP Ariba Support can assign the correct API to your client application. Therefore you must open a ticket with SAP Ariba Support to get the correct API assigned. 

Most customers will already have at least one person in their organization that has access to the SAP Ariba API portal. If you do not know who this person is, you can ask your Designated Support Contact to open a service request with SAP Ariba support to obtain this information. 

To find you DSC please follow the FAQ How can I see my company's Basic users and Designated Support Contacts (DSCs)?

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 below)
  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. Copy the value for the field "Application Key" (e.g. GuOBus1Z7xABCeQRQS7lZDfUjDNMbiHy) 
  7. Open a ticket with SAP Ariba support:
    1. Request API access for the application with the application key <your application key> for the API "Integration Event Monitoring Query API for Procurement"
    2. Provide SAP Ariba support with a list of the SAP Ariba products (Procurement, Sourcing, Ariba Network) and realms for which you want to use this API application.
    • You can use the same application for multiple realms, e.g. for mycompany and mycompany-T
    • 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 below)
  8. Wait for SAP Ariba support to assign the requested API to your client application. 

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 CIG.

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.

For this reason it is necessary that non-US customers 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 their region (see table below), this client application will be used to collect events for SAP Ariba Sourcing and SAP Ariba Procurement

You can use the same ticket with SAP Ariba Support to get the 'Integration Event Monitoring Query API for Procurement' API assigned to both client applications.

After the API is assigned, you must perform the steps described below to link the API Client Id to the AN-ID for SAP Ariba Network. 

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 below and add it to the file. 

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 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

You can use the same application for all SAP Ariba products that are in the same realm, e.g. SAP Ariba Sourcing and SAP Ariba Procurement. If you have SAP Ariba Network you can use the same application if it has the same AN-ID (which you find next to the realm name on the application details in the SAP Ariba API Portal).

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/

Setup Steps in SAP Cloud ALM

Create Cloud Service for SAP Ariba Cloud Integration Gateway

Currently SAP Ariba Cloud Integration Gateway cannot be collected automatically from the System Landscape Information Service (SLIS). Hence if you use SAP Ariba CIG you have to create the cloud service manually in the Landscape Management Service.

The other three SAP Ariba products will be discovered automatically from SLIS. You can use one of those services to find the Root URL that you need to use for the SAP Ariba CIG service.

  1. Open Landscape Management application from the launchpad
  2. Click the Add button to create a new service
    1. Name: Enter a name for the service
    2. Tenant ID: Enter the AN-ID or the realm
    3. Cloud Service Type: Select 'SAP Ariba Cloud Integration Gateway'
    4. Tenant Type: Select the appropriate type from the list
    5. Root URL: Enter SAP Ariba API URL
    6. External ID: Enter the AN-ID (you find the AN-ID next to the realm name in the application in the SAP Ariba API portal)
  3. Save you service

Create HTTP End-Point

You have to create one end-point for each of the SAP Ariba products in your SAP Cloud ALM. The end-point creation is similar for each of the products, so you have to go through the following steps four times. 

  1. Open the Landscape Management application from the launchpad
  2. Select your SAP Ariba service
  3. Press the > button at the end of the line
  4. On the tab "Endpoints" press the Add button to create a new end-point
  5. Enter a description
  6. Choose the use-case "Integration Monitoring"
  7. Root URL: Enter the SAP Ariba API URL 
  8. Choose OAuth authentication enter the OAuth credentials retrieved from the SAP Ariba API Portal:
    • Client ID: OAuth client ID
    • Client Secret: OAuth secret
    • Token Service URL: Extend your SAP Ariba OAuth URL with '/v2/oauth/token'
    • API Key: Enter the Application key

Connection Error with Cloud ALM 2011

Please note that with SAP Cloud ALM Release 2011 there might be an error if you perform a connection test. This doesn't influence the Interface Monitoring data collection and this error can be ignored.

Error message when clicking 'Ping Connection'

  • [401] Connection to <Ariba endpoint> cannot be established. Ensure that the URL and the login credentials, which are maintained for the endpoint, are correct.

When clicking 'Check Connection' during the end-point creation you will see the following error message

  • Connection to <Ariba endpoint> cannot be established - [Failed to obtain OAuth access token]. Ensure that the URL and the login credentials, which are maintained for the endpoint, are correct. - return code 401

Activate Monitoring (Standard)

In SAP Cloud ALM you can easily activate the standard monitoring content without any additional setup effort. 

  1. Open the Integration & Exception Monitoring application from the launchpad
  2. Open the scope selection via the target icon in the upper right corner
  3. Change the drop-down for Display Service to "All"
  4. Select your cloud service in the scope
  5. Click the rack-wheel icon in the upper right corner to access the configuration
  6. Expand the Configuration panel
  7. Change the toggle button next to the cloud service from OFF to ON

Adjust Monitoring and Alerting (Expert)

You can change which parts of the standard content are activated for each cloud service, activate and deactivate alerts or create own alerts with specific filters. 

  1. In the configuration panel, click on the name of the cloud service
  2. The "Configuration of Services" screen opens
  3. In the "Configuration for Services" screen, click the > button at the end of the line for the cloud service you want to change

Adjust Monitoring Categories

  1. Use the toggle button in the column Active to turn a monitoring category ON or OFF

Adjust Alerting

  1. Use the toggle button in the column Active to turn a standard alert ON or OFF
  2. Press the > button at the end of the line to access the detail setup for an existing alert or use the + button to create a new alert
  3. Adjust the display name if desired
  4. Expand the Filter Configuration tray
  5. Enter a filter name
  6. Select the filter category
  7. Maintain the available filter fields (see details below)

Available Alerts

  • Erroneous SAP Ariba Cloud Integration Gateway Transaction Detected (Single): Creates an alert for each failed message in SAP Ariba CIG
  • Erroneous SAP Ariba Cloud Integration Gateway Transaction Detected (Grouped): Creates an alert if one or more failed messages on SAP Ariba CIG were detected since the last data collection

Available Filter Parameters

The following filter parameters filter the collected messages. To find the correct values choose a message for which you would want to create an alert in the monitoring and drill-down to the message details. The filter values can be found on the Status Details card or on the Application Data card.

  • Message Older Than N Minutes: Default value = 10
  • Application Name: See Application Data card, e.g. Ariba:CIG
  • Component Name: See Application Data card, e.g. Ariba:CIG:P2P
  • Direction: INBOUND or OUTBOUND
  • Document Type: See Application Data card, e.g. QueryStockRequest
  • Receiver ID: See Application Data card
  • Receiver Name: See Application Data card
  • Sender ID: See Application Data card
  • Sender Name: See Application Data card
  • Status: Status as per the Status Details card, e.g. FAILURE
  • Status Group: Status group as per the Status Details card, e.g. ERROR
  • Status Text: Status text as per the Status Details card

Available Alerts

  • Erroneous SAP Ariba Network Message Detected: Creates an alert for each failed message in SAP Ariba Network
  • Erroneous SAP Ariba Network Messages Detected: Creates an alert if one or more failed messages on SAP Ariba Network were detected since the last data collection

Available Filter Parameters

The following filter parameters filter the collected messages. To find the correct values choose a message for which you would want to create an alert in the monitoring and drill-down to the message details. The filter values can be found on the Status Details card or on the Application Data card.

  • Message Older Than N Minutes: Default value = 10
  • Component Name: See Application Data card
  • Direction: INBOUND or OUTBOUND
  • Document Type: See Application Data card
  • Event Name: See Application Data card
  • Receiver Name: See Application Data card
  • Receiver Network ID: See Application Data card
  • Sender Name: See Application Data card
  • Sender Network ID: See Application Data card
  • Status: Status from the Status Details card
  • Status Group: Status Group from the Status Details card
  • Status Detail: Status Text from the Status Details card

Available Alerts

  • Erroneous SAP Ariba Procurement  Integration Message Detected: Creates an alert for each failed message in SAP Ariba Procurement
  • Erroneous SAP Ariba Procurement  Integration Messages Detected: Creates an alert if one or more failed messages on SAP Ariba Procurement were detected since the last data collection

Available Filter Parameters

The following filter parameters filter the collected messages. To find the correct values choose a message for which you would want to create an alert in the monitoring and drill-down to the message details. The filter values can be found on the Status Details card or on the Application Data card.

  • Message Older Than N Minutes: Default value = 10
  • Component Name: See Application Data card
  • Direction: INBOUND or OUTBOUND
  • Event Name: See Application Data card
  • Status: Status from the Status Details card
  • Status Group: Status Group from the Status Details card
  • Status Detail: Status Text from the Status Details card

Available Alerts

  • Erroneous SAP Ariba Sourcing Integration Message Detected: Creates an alert for each failed message in SAP Ariba Sourcing
  • Erroneous SAP Ariba Sourcing Integration Messages Detected: Creates an alert if one or more failed messages on SAP Ariba Sourcing were detected since the last data collection

Available Filter Parameters

The following filter parameters filter the collected messages. To find the correct values choose a message for which you would want to create an alert in the monitoring and drill-down to the message details. The filter values can be found on the Status Details card or on the Application Data card.

  • Message Older Than N Minutes: Default value = 10
  • Company Code Id: See Application Data card
  • Component Name: See Application Data card
  • Direction: INBOUND or OUTBOUND
  • Event Name: See Application Data card
  • Integration Channel: See Application Data card
  • Purchase Group Id: See Application Data card
  • Purchase Organization Id: See Application Data card
  • Realm: See Application Data card
  • Status: Status from the Status Details card
  • Status Group: Status Group from the Status Details card
  • Status Detail: Status Text from the Status Details card
  • System Id: See Application Data card

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)