Ariba Networks (Using Transaction Monitoring API V2)
Run Mode: BACKGROUND AND DIALOG Aggregation: NOT SUPPORTED Iteration: SUPPORTED FOR SELECT FIELDS Duplicate Check: NOT SUPPORTED
Metadata retrieval: SUPPORTED Extraction Strategy: INDUVIDUAL SELECTION AND KEY BASED SELECTION Special Permissions: NONE
This source type generates an openAPI query, extracts data via Transaction management API, compares data in SAP Solution Manager.
The SAP Ariba Transaction Monitoring REST API gives users of SAP Ariba cloud solutions a fast and reliable mechanism to track business documents as they flow between applications. This allows a high degree of visibility and traceability into business processes and documents.
Parameters
The following parameters must be entered:
| Parameter | Description |
|---|---|
| OAuth Destination | RFC connection to the authentication service which is an HTTPS service which the username and password must be saved which will generate the token |
| OpenAPI Destination | The other destination to be created will be the service to the HTTP service which holds the TM API. |
| API Key | API key for the API. Unique to every customer |
| The following fields are non-editable and generated by the tool | |
| Query | OpenAPI query generated from the data model. |
Requirements for Ariba Networks
Follow the steps for enabling the Transaction monitoring API as detailed in the SAP Ariba Transaction monitoring REST API guide available here.
The following steps are required to use the Transaction Monitoring API with Ariba Network:
- Enable alternate cXML document flow in Ariba Network.
SAP Ariba Customer Support must enable alternate cXML document routing for the supplier-buyer relationship. Ask your Designated Support Contact to log a service request.
- Create SAP Ariba OpenAPI account.
To create your account, access the SAP Ariba Open API portal (https://developer.ariba.com/api/login), click Don’t have an account yet? and complete the Registration Request Form. Alternatively, contact your SAP Ariba Customer Success Manager or Account Manager to create the account.
- Provision TM OpenAPI and BPM integration (Client-ID to ANID mapping).
To create the client-ID mapping, contact your SAP Ariba Customer Success Manager or Account Manager
Documents supported
| Ariba Process Name | Document Name |
|---|---|
| TRANSACTION_TRACKING_PURCHASEORDER | Purchase Order |
| TRANSACTION_TRACKING_SHIPNOTICEDOCUMENT | (Advanced) Ship Notice |
TRANSACTION_TRACKING_COMPONENTCONSUMPTIONREQUEST | Component Consumption Request |
TRANSACTION_TRACKING_CONFIRMATIONDOCUMENT | Order Confirmation |
| TRANSACTION_TRACKING_COPYREQUEST | Wrapper which contains another document type (like the copy of a Purchase Order to another trading partner) |
| TRANSACTION_TRACKING_PRODUCTACTIVITYMESSAGE | Forecast |
| TRANSACTION_TRACKING_PRODUCTREPLENISHMENTMESSAGE | Forecast Commit and Manufacturing Visibility |
Metadata provided
| Fieldname | Key | Description |
|---|---|---|
document_id | X | This is the unique identifier of the business document that is being tracked in an event. This could contain the value of one of the following identifiers: OrderID, ConfirmID, ShipmentID, and InvoiceID. |
sender_id |
| Identity of the sender of the business document. This is a unique Ariba Network ID for the sender. For example, the sender's Ariba Network ID. |
reciever_id |
| Identity of the receiver of the business document. This is a unique Ariba Network ID for the sender. For example, the sender's Ariba Network ID. |
| process_name | The specific business document that is tracked in an event. Processes relating to the following documents are tracked:
| |
changed_by |
| This is the name of the application/node of the published event. |
events_NR_correlation_id |
| This is the purchase order (PO) ID from the source system. This helps in easy identification of the PO numbers which are affected. This is specified only when the document is a Change PO, an Advance Ship Notice (ASN), or an Order Confirmation. |
events_NR_order_date |
| This is the date on which the order was created in the source system. This field is mapped either to the Document Date or the Reference Document Date. It is mapped to Reference Document Date to trace the lineage in PO change instances as PO change does not contain orderReference information. |
| events_NR_alert_type | This is the business document processing status. This indicates the success or failure of document processing. It also includes warnings, if there are any. | |
events_NR_event_name |
| This is the event name that indicates the document processing stage. |
events_NR_event_timestamp |
| This is the time the event was triggered |
events_NR_event_id |
| The unique identifier of the event. |
| events_NR_host | This is the webhost domain link | |
events_NR_reference_payload_id |
| This is the cXML Payload ID for the PO. This will help associate the PO to other associated business documents, such as Order Confirmation and Advance Ship Notice. |
events_NR_error_message |
| This is the error information from Ariba Network, which contains more information on why an error has occurred. This will allow the user to quickly identify corrective actions. |
events_NR_source |
| This is the source of the event. |
| events_NR_date_happened | This is the event date, which is the date and time when the event was triggered. Dates are in epoch format. | |
date_happened |
| This is the event date, which is the date and time when the event was triggered. Dates are in epoch format. |
Iteration support
The Ariba source type for CDC supports iteration and key-based selection for the following fields (Only one can be selected at a given time):
- document_id
- correlation_id
- transaction_id
Limitations
Due to the CDC Source type making use of the API, it is limited in a few ways. These are:
- When the ARIBA source type is a primary source type, the date_happened filter is mandatory and must be between two time frames and cannot be more than 30 days in the past. Relative time filters are advised.
- Filters can only be applied to the fields as detailed in the filters section. Other combinations are not possible.