SAP Ariba

Support of Ariba Network in SAP Solution Manager

The Ariba Security team has decided to deprecate the Ariba Transaction Monitoring API (TM API) as of November 2022, since it can't support the latest security standard, which relies on OAuth with mTLS. It will stop working in November 2023.

Ariba will therefore request that all existing consumers of the Transaction Monitoring API, to stepwise move to the new Ariba Integration Monitoring API.

As a consequence, our Ariba Network monitoring solution, as defined by SAP Solution Manager Application Operations, is in the process of being deprecated as well.

Also, we recommend our customers consider using SAP Cloud ALM or SAP Focused Run (at least 3.0 FP02), as they both consume the new Ariba Integration Monitoring API.

SAP Ariba is SAP's cloud based marketplace for business-to-business transactions. SAP Ariba runs the Ariba Network in which buyers and suppliers can find each other and do business in one network. You can integrate SAP Ariba Network with your on-premise system either through SAP Integration Suite - Cloud Integration or SAP PI.

Integration Scenario

For SAP Ariba the following integration scenarios are possible: 

 

The different scenarios contain the following exceptions and point-to-point connections:

  1. Integrating ABAP backend with the SAP Ariba Network in a direct connectivity scenario: 1, 2, 4, 8
  2. Integrating ABAP backend with the SAP Ariba Network mediated via SAP integration Suite - Cloud Integration: 1, 2, 4, 6, 8
  3. Integrating ABAP backend with the SAP Ariba Network mediated via SAP Process Integration (Web Service based): 1, 2, 4, 7, 8
  4. Integrating ABAP backend with the SAP Ariba Network mediated via SAP Process Integration (IDoc based): 3, 5, 7, 8

 

Scenario Component

Monitored Content

Interface Channel Type

Since SP 
1Systems: ABAP on-premise systemExceptions in Ariba Integration Add-onCloud: Cloud (Ariba Add-on)7.2 SP08
2Systems: ABAP on-premise systemApplication Log Messages related to Ariba integrationRFC or WebService channels7.1 SP05*
3Systems: ABAP on-premise systemIDocsIDoc7.1 SP12
4Systems: ABAP on-premise system Web Service errors and performanceWeb Service: Web Service ABAP (STAD) or Web Service ABAP (SOAP)7.1 SP05*
5Systems: ABAP on-premise system Messages in the ABAP proxy framework 

Process Integration: Process Integration (PI – ABAP only)

7.1 SP12
6Cloud Services: SAP Integration Suite - Cloud IntegrationExceptions in integration flows (IFlow) in SAP Integration Suite - Cloud IntegrationCloud: Cloud (SAP Cloud Integration)7.1 SP12*
7Systems: SAP PI on-premise system PI Messages and Channels

Process Integration

7.1 SP12
8Cloud Services: SAP AribaExceptions in SAP Ariba NetworkCloud (Ariba Network)7.2 SP07

*) Monitoring content was extended with later support packages (see monitoring template page for details)

To know which IDocs, WebServices and Application Log entries are relevant for the Ariba integration scenario, please refer to the following documentation: 

To learn how to monitor Ariba Application Log messages using Interface and Connection Monitoring please scroll the the end on this page.

Technical Prerequisites

The following technical prerequisites have to be met in order to monitor this scenario:

  • To collect single exceptions in the SAP Ariba Network Integration add-in, you need SAP Solution Manager 7.2 SP03 or higher.
  • To monitor single exceptions in the SAP Ariba Network Integration add-in using Interface and Connection Monitoring, you need SAP Solution Manager 7.2 SP08 or higher.
  • To monitor exceptions in SAP Ariba Network Supply Chain Collaboration, you need SAP Solution Manager 7.2 SP07 or higher

Available Monitoring Content

The following SAP Ariba scenarios are currently covered in public cloud operations with SAP Solution Manager:

  • SAP Ariba Supply Chain Collaboration (Buyers) currently restricted to the following document types:
    • Purchase Orders
    • Order Confirmations
    • Ship Notices
    • Goods Receipts
    • Invoices
    • Payment Remittances

Additionally you can use SAP AIF in your on-premise system to set up monitoring for your SAP Ariba integration. The message statistics from SAP AIF can then be monitored by SAP Solution Manager as described here.

  • 2191913 - Collective note: SAP AIF Support of Ariba Network Integration Add-On 

Monitoring Templates: Cloud (Ariba Network) 

Metric Name Description MAI Category

Since SP

Ariba Network Channel available

Interface Channel Availability. Availability is checked via EEM script execution on the source system or target system.

Availability

 7.2 SP07
Number of Exceptions in Ariba Network (last 24h)

Number of exceptions detected in Ariba Network during the last 24 hours.

 

 Exceptions 7.2 SP07 

Number of Exceptions in Ariba Network

Number of exceptions detected in SAP Ariba Network.

Exception statistics are retrieved from central Exception Management in SAP Solution Manager.

Exceptions

 7.2 SP07
Number of Messages in status Warning (last 24h)

Number of messages in status Warning detected in SAP Ariba Network during the last 24 hours.

Exception statistics is retrieved from central Exception Management in SAP Solution Manager.

Exceptions 7.2 SP07 
Number of Messages in status Warning

Number of messages in status Warning detected in SAP Ariba Network.

Exception statistics is retrieved from central Exception Management in SAP Solution Manager.

Exceptions 7.2 SP07 
Single exceptions in Ariba Network

Single exceptions detected in SAP Ariba Network.

Exceptions are retrieved via the Transaction Monitoring API from SAP Ariba Network into central Exception Management in SAP Solution Manager.

 Exceptions 7.2 SP07 
Single messages in status Warning

Single messages in status Warning detected in SAP Ariba Network.

Messages are retrieved via the Transaction Monitoring API from SAP Ariba Network into central Exception Management in SAP Solution Manager.

 Exceptions 7.2 SP07 

Monitoring Template: Cloud (Ariba Add-on) 

Metric Name Description MAI Category Since SP
Single exceptions in Ariba Add-On Single exceptions detected in Application Log of for the Ariba Integration Add-on  Exceptions  7.2 SP08 

Connect Cloud Service

Preparations in SAP Ariba

Register for API Developer Portal

To create the required cloud service in SAP Solution Manager, first request production access to the SAP Ariba Network 'Transaction Monitoring API' service, following these guidelines:

Once you have registered in the Open API Developer portal you shall register for the service 'Transaction Monitoring API', which will provide access to the error and warning events, related to the SAP Ariba document processing.

While working through the above-mentioned process, keep in mind to note down the information, like Application Key, OAuth Client ID and Client Secret, which is needed to configure the SAP Ariba cloud service access on SAP Solution Manager side. 

Connect Cloud Service to SAP Solution Manager

Create Cloud Service

  1. Select 'Cloud Service Operations' → Create Cloud Service.
  2. For the Service Type, select: 'SAP Ariba' from the drop-down list.
  3. Define Service:
    • Tenant: Enter a name for the tenant and a description
  4. Define Root URL: The root URL for production is always invalid link: https://openapi.ariba.com
    • You can also adjust the extended service ID (the ID used as SID in LMDB) here.
  5. Confirmation: Check your input values and click 'Finish'.

Create the End-Point

  1. Select your SAP Ariba cloud service from the list and click 'Configure Cloud Service' .
  2. Configure Endpoints: Click the 'Add' button on the 'HTTP Endpoints' tab.
  3. Enter the following information:
  • Description: A meaningful description
  • OAuth URL: https://api.ariba.com/v2/oauth/token
  • Application Key: Unique ID per application, generated on creation of the application, checked by the Open API Gateway
  • Client ID: Another Unique ID per application, generated on approval of application
  • Client Secret: Unique ID per application used to generate access tokens for applications
  • If necessary add proxy information to connect to the SAP Ariba Network

Monitoring Configuration

Step 1: Configure Exception Management

For SAP Ariba Network, you might have to set up two distinct exception log stores as described below and, depending on your integration solution, to monitor the full SAP Ariba Network Supply Chain Collaboration solution. You have to set up the exception store for exceptions occurring in SAP Ariba Network Supply Chain Collaboration. Additionally, if your integration includes the SAP Ariba Network Integration add-on installed in the SAP ABAP on premise system, you need to set up one log store that collects the exceptions occurring in this add-on.

Exceptions in SAP Ariba Network Integration Add-On

The SAP Ariba Network Integration add-on writes single exceptions into error messages in the ABAP Application Log. These application log entries can be collected with the log store for the SAP Ariba Network Integration add-on.

The log store is set up on the SAP ABAP on-premise system on which the add-on is installed.

To access Exception Management setup, go to transaction SOLMAN_SETUP → Application Operations → Exception Management 

  1. In the 'Define Scope' step, select the 'Technical Systems' tab and your SAP ABAP system. If you did not configure the system before, make sure to select 'All Systems' in the view drop-down. Click 'Configure' or click 'Next' two times. You will enter the 'Exception Configuration' step.
  2. Click 'Add / Configure Log Store' → Standard then select 'SAP Ariba Network Integration Add-on Logs'.
  3. Select the fields for filtering for your log store. The 'SUBOBJECT' field is selected by default. While there are many filter fields available, as this log store is based on the Application Log log store, it does not necessarily make sense to use them all. Usually, just the 'SUBOBJECT' field is enough. If you want to filter on the rest, check the actual log record you are looking to catch in SLG1 and maintain the filter fields accordingly. The following filter fields are available:
    • SUBOBJECT (mandatory): Choose between INBOUND, POLLING or OUTBOUND
    • EXTNUMBER: External ID of the Application Log entry
    • MSGID: Message Class (e.g. E (Error))
    • MSGNO: Message Number
    • MSGTXT: Message Text
    • PROGRAM: Program triggering the log entry
    • STATUS: Select E (Error) or W (Warning)
    • TCODE: Transaction code triggering the log entry
    • USER: The user who triggered the log entry
  4. Maintain the filter values for the fields in the 'Filter Definition' panel under the log stores table. You can also add, remove or change filter fields and values later on in this area. You can use different operators for your filter value. You can add more than one filter field combination per log store. To add an additional filter field combination, click the 'Add Filter' button in the 'Configured Log Stores' panel.
  5. You should not set up the monitoring for the exceptions in the Exception Management. If you activate the monitoring here, you will receive an alert (and if set up this way an email) for every single exception in the application log. Instead we will use Interface and Connection Monitoring to monitor the central exceptions store for exceptions. 

Exceptions in SAP Ariba Network

Typically you collect exceptions directly from SAP Ariba Network. Please note that you need SAP Solution Manager 7.2 SP 07 to do this.

To access the Exception Management setup please go to transaction SOLMAN_SETUP → Application Operations → Exception Management 

  1. In the step 'Define Scope' select the tab 'Cloud Services' and your SAP Ariba cloud service. If you didn't configure the system before make sure to select 'All Cloud Services' in the view drop-down. Click on 'Configure' or click 'Next' two times. You will enter the step 'Exception Configuration'.
  2. Click 'Add / Configure Log Store'. Select 'SAP Ariba Network Transaction Monitoring API'. Select the correct end-point for the SAP Ariba Network if you have more than one.
  3. Select the fields for filtering for your log store.  The following filter fields are available:
    • alert_type (mandatory): Select FAILURE or WARNING
    • process_name: The specific business document that is tracked in an event. (e.g. TRANSACTION_TRACKING_CONFIRMATIONDOCUMENT)
    • receiver_id: The receiver of the business document. This is a unique SAP Ariba Network ID. An SAP Ariba Network ID is always AN followed by 11 digits (e.g. AN12345678901)
    • sender_id: The sender of the business document. This is a unique SAP Ariba Network ID.
  4. Maintain the filter values for the fields in the Filter Definition panel under the log stores table. You can also add, remove or change filter fields and values later on in the area. You can use different operators for your filter value. You can add more than one filter field combination per log store. To add an additional filter field combination click on the button 'Add Filter' in the 'Configured Log Stores' panel.
  5. You should not set up the monitoring for the exceptions in the Exception Management. If you activate the monitoring here, you will receive an alert (and if set up this way an email) for every single exception in the application log. Instead we will use Interface and Connection Monitoring to monitor the central exceptions store for exceptions.

Step 2: Configure Interface and Connection Monitoring

To access the Integration Monitoring setup please go to SAP Solution Manager Configuration (SOLMAN_SETUP) → Application Operations → Integration Monitoring → Interface and Connections.

Navigate to the 'Define Scope' step. You can create a new scenario for the SAP Ariba monitoring or use an existing scenario. Make sure the on premise system for the SAP Ariba scenario and the Cloud Service created for SAP Ariba are part of the 'Interface and Connection Monitoring' scenario. If you use the integration via SAP Integration Suite - Cloud Integration this cloud service should be added as well. 

Monitoring Template: Cloud (Ariba Add-on) 

Create the Interface Channel:

  1. Select the scenario and click 'Next'
  2. In step 'Preparation' perform all relevant manual activities and run all automatic activities.
  3. In step 'Configuration' click the 'Add' button.
    • Channel Name: Enter a meaning full name (max. 30 characters)
    • Type: Select 'Cloud'
    • Monitoring Template: Select 'Cloud (S/4 CE)'
    • Description: Enter a description for the channel
  4. Click Next.
  5. Source type:
    • If the source system is the on premise system, please select 'Technical System
    • If the source system is the SAP S/4 CE system please select 'External Service'
  6. Source: Select the on premise system resp. the SAP S/4 CE Cloud Service from the drop-down list
  7. Target Type:
    • If the target system is the on premise system, please select 'Technical System'
    • If the target system is the SAP S/4 CE system please select 'External Service'
  8. Target: Select the on premise system resp. the SAP S/4 CE Cloud Service from the drop-down list
  9. The measuring point is selected automatically
  10. If more than one client are connected for the on premise system please select the correct client for the monitoring
  11. Click Next.
  12. Click Finish.

Maintain the Interface:

  1. Select the interface channel you created
  2. The interface channel type does not have any configurable parameters on the 'Interfaces' tab

Select Metrics:

  1. On the tab 'Metrics' select the metrics you want to monitor
  2. Provide the following information:
    • Parameter Set Name: You can enter a name for the parameter set to distinguish it if you have more than one
    • Sub-object name: Enter the sub-object of the log
    • User name: The user that triggered the exception
    • Client (expert field): The source client for the exception
    • External ID (expert field): The external ID of the exception
    • Message ID (expert field): Message Class (e.g. E (Error))
    • Message no. (expert field): Message Number
    • Message text (expert field): Message Text
    • Transaction Code (expert field): Transaction code triggering the exceptions
  3. Save your interface channel by clicking on the 'Save' button.

Monitoring Template: Cloud (Ariba Network)

Create the Interface Channel:

  1. Select the scenario and click 'Next'.
  2. In the 'Preparation' step, perform all relevant manual activities and run all automatic activities.
  3. In the 'Configuration' step, click the 'Add' button.
    • Channel Name: Enter a meaningful name (max. 30 characters)
    • Type: 'Cloud'
    • Monitoring Template: 'Cloud (SAP Ariba)'
    • Description: Enter a description for the channel
  4. Click 'Next'.
  5. Source Type:
    • If the source system is the on-premise system, select 'Technical System'.
    • If the source system is the SAP Ariba cloud service, select 'External Service'.
  6. Source: Select the on-premise system respectively the SAP Ariba Cloud Service from the drop-down list.
  7. Target Type:
    • If the target system is the on-premise system, select 'Technical System'.
    • If the target system is the SAP Ariba cloud service, select 'External Service'.
  8. Target: Select the on-premise system respectively the SAP Ariba Cloud Service from the drop-down list.
  9. The measuring point is selected automatically.
  10.  If more than one client are connected for the on-premise system, select the correct client for monitoring.
  11.  Click 'Next'.
  12.  Click 'Finish'

Maintain the Interface:

  1. Select the interface channel you created
  2. On the 'Interfaces' tab click the 'Add' button.
  3. Provide the following information:
    • Interface Name: Enter a name for the interface.
    • Process Name (CP): The specific business document that is tracked in an event (e.g. TRANSACTION_TRACKING_PURCHASEORDER).
    • Event Name (CP): This is the event name that indicates the document processing stage (e.g. DOCUMENT_RECEIVE_FAILED).
    • Sender ID (CP): The sender of the business document. This is a unique SAP Ariba Network ID. An SAP Ariba
    • Receiver ID (CP): The receiver of the business document. This is a unique SAP Ariba Network ID.

Select Metrics:

  1. On the 'Metrics' tab, select the metrics you want to monitor.
  2. Enter the metric parameters (only for some of the metrics):
    • Script Name: Enter the name of the UXMon script used to monitor the Ariba Network availability.
      • The script shall, depending on the integration scenario, check the availability of the following URL:
        • Integrating SAP ERP with SAP Ariba Network via direct connectivity: https://service.ariba.com/ANSapGateway.aw/ad/ping.
        • Otherwise: https://service.ariba.com/ANCXMLDispatcher.aw/ad/ping.
    • Message text: Filter on the message text of the exception Note.
  3. Save your interface channel by clicking on the 'Save' button.

Attention

If you activate a metric please make sure:

  • To create at least one Parameter Set
  • Enter a value or '*' in at least one of the filter parameter marked with (CP) above

The filter parameters marked with (CP) in the list above are used to create an extended context. This means that you can group your results using these parameters. The data collection will then count the exceptions based in these grouping criteria. 

  • For exceptions in Ariba Network the filter parameter 'Sender ID', 'Receiver ID' or 'Process Name' are good candidates for basic grouping

You can use one or several filter parameters to group. Please keep in mind the more filter parameters you use for the grouping the more fine granular your result set gets. E.g. If you use 'Process Name' and 'Sender ID' you would get one entry for each Process and Sender combination in your result set.

Filter Values in Interface and Connection Monitoring

Since the data collection is based on the content of the global exceptions store, you can always check the collected exceptions in Exception Management. All filter parameters are part of the collection context of the exceptions. The filters applied in Interface and Connection Monitoring allow you to filter the exceptions collected by the Exception Management further. However if the filters in Exception Management do not collect an exception, it is not available in the central exception store and you will not be able to find it in Interface and Connection Monitoring! 

Configuration for Monitoring Template: Web Services ABAP

This monitoring template is used to monitor the performance and for exceptions happening in the Web Service communication between the SAP Ariba Network Integration add-on in SAP ABAP and SAP Ariba Network or SAP Integration Suite - Cloud Integration integrating SAP ERP and SAP Ariba.

For detailed setup information on how to set up this channel type, refer to the Interface and Connection Monitoring documentation for configuration of Web Service Channels.

Which Web Service proxy/name you need to enter depends on the scenario in the SAP Ariba Network integration: 

Scenario

Web Service proxy/name
Polling messages from SAP Ariba Network
  • CO_ARBFND_PRX_ GPDQ _OUT (synchronous outbound)
Receiving messages from SAP Ariba Network
  • II_ARBFND_PRX_CCPAYP_IN (asynchronous inbound)
  • II_ARBFND_PRX_CONF_IN (asynchronous inbound)
  • II_ARBFND_PRX_INVC_IN (asynchronous inbound)
  • II_ARBFND_PRX_ORDR_IN (asynchronous inbound)
  • II_ARBFND_PRX_PAYR_IN (asynchronous inbound)
  • II_ARBFND_PRX_PREM_IN (asynchronous inbound)
  • II_ARBFND_PRX_QTEM_IN (asynchronous inbound)
  • II_ARBFND_PRX_RCPT_IN (asynchronous inbound)
  • II_ARBFND_PRX_SHIP_IN (asynchronous inbound)
  • II_ARBFND_PRX_SRVE_IN (asynchronous inbound)
Sending messages to SAP Ariba Network
  • CO_ARBFND_PRX_OADP_OUT (synchronous outbound)
  • II_ARBFND_PRX_OADP_IN (asynchronous outbound)

Configuration for Monitoring for Application Log Messages

The Ariba Integration Add-On as well as the Cloud Integration Gateway Integration Add-on (CIG) write messages in the ABAP Application Log. Some of these Application Log messages are covered by the 'SAP Ariba Network Integration Add-on Logs' log store. However the object and sub-objects that are proposed in that log store might not reflect your situation. If you want to monitor Application Log messages that are not covered (yet) you can use the following channel types as a workaround:

  • RFC Channel: Use metric 'Number of AppLog Errors (RFC)' and deactivate all other metrics. You can add any RFC destination in the interface configuration (e.g. NONE). The RFC destination is irrelevant for the metric  'Number of AppLog Errors (RFC)'
  • Web Service Channel: Use metric 'Number of AppLog Errors (WS)' and deactivate all other metrics. While you can enter any Web Service in the interface configuration, it would make sense to us this channel and the respective metrics to monitor Ariba related Web Services.
The setup in Interface and Connection Monitoring will automatically create the necessary setup in Exception Management.

Changes to Application Logs in SAP S/4 HANA 1610

The log store 'SAP Ariba Network Integration Add-on Logs' collects only Application Logs with object ARIBA_INTEGRATION. 

With SAP S/4HANA 1610, the log object CXML_INTEGRATION has been introduced. This has the following impact:

  • Log entries created as of SAP S/4HANA 1610 can be found under the log object CXML_INTEGRATION.

  • Log entries created in earlier releases can be found under the log object ARIBA_INTEGRATION.

Note that the subobjects for both log objects are identical.

To monitor Ariba Application Log entries in SAP S/4HANA 1610 or newer, please use one of the channel types mentioned above, as the log store 'SAP Ariba Network Integration Add-on Logs' will not collect the logs.

Thresholds and the collection schedule are maintained in the next step of the guided procedure. Once you have maintained all your channels, click 'Next' in the main guided procedure to move to the 'Activation' step.

Maintain Thresholds and Schedule:

  1. Select the alert for the SAP Ariba Network channel (the alert is the line with the red flash icon next to it).
    • On alert level you can maintain notification and incident message creation
    • Do not remove the flag for 'Do not Group Individual Occurrences' as this flag ensures that an alert each time new exceptions are found during a data collection interval
  2. Select the metrics.
    • Do not change the data collector type or data collector name on the tab 'Data Collection' as the monitor will not work anymore if this is changed.
    • Do not change the threshold if it is set to 'Already Rated'.
  3. Click 'Apply and Activate' → <Choose one option> to activate the monitoring.

If not active you can also activate the reporting for the channels by checking the box in the column 'Reporting'. This way you can see a history of the number of exceptions that happened and also place the metric on the OCC Dashboard in Focused Insights. 

Notifications from SAP Ariba Network

Note that SAP Ariba offers, independently of SAP Solution Manager, a notification mechanism, via e-mail, for the Supply Chain Collaboration buyers.

These e-mails inform about various events, as documented in the 'SAP Ariba Supply Chain Collaboration integration and configuration' guide. They are sent, either upon event occurrence (which could potentially generate a high number of e-mails), or as a daily summary report.

As a consequence, when you set up SAP Solution Manager for SAP Ariba Monitoring, you could decide to switch off the e-mail notification in SAP Ariba by unchecking the notifications for the 'General Notification Option'.

However, business users generally register for other relevant network notifications to be informed about business related information such as order confirmation rejected or downtime notifications.