An AWARD® Account Administrator sets up a SAP Ariba integration under
Administration → Account → Ariba System Settings.
This article is a field-by-field reference for creating and maintaining a SAP Ariba system. Once a system is configured, users can be linked to it and supplier responses imported.
Self-service SAP Ariba configuration has to be switched on for your account by a Commerce Decisions (CDL) Administrator before the Ariba System Settings section appears. If you cannot see it, contact the AWARD® support desk and ask for "Ariba Self-Service Configuration" to be enabled for your account. Once it is on, Account Administrators can create and maintain Ariba systems directly, without further support involvement.
Where to configure it
Go to Administration → Account and open the Ariba System Settings section. From here you can view existing systems, and Create, Edit or Delete a system. Creating a system is a two-step wizard: first the system details, then the API credentials.
Step 1 — System details
| Field | What to enter |
|---|---|
| Type | Whether this is a Live or Sandbox SAP Ariba system. |
| System key | A short key that identifies this system within your account. |
| Name | A display name for the system. Names must be unique within your account. |
| OAuth URL | The SAP Ariba OAuth token endpoint. |
| Base URL | The SAP Ariba API base URL. |
Both URLs must be https:// addresses on an approved SAP/Ariba host (for example a sap.com or ariba.com host). Plain http://, IP addresses, and internal/private hosts are rejected. If a URL is refused, you will see the message: "{field} must be a valid https:// URL on an approved SAP/Ariba host."
Step 2 — API credentials
A SAP Ariba system must define all five API areas, each with its own credentials. The five areas are:
- Master Data Retrieval
- Sourcing Project Management
- Event Management
- Operational Reporting for Sourcing
- Project Document Management
For each of the five areas you provide:
| Field | What to enter |
|---|---|
| API | The API area (set automatically — this is the area name, e.g. Event Management). |
| API Endpoint | The endpoint URL for that API area. |
| OAuth Client ID | The OAuth client ID issued for that API area. |
| API Key | The API key for that area. Stored securely (a secret). |
| OAuth Secret | The OAuth client secret for that area. Stored securely (a secret). |
You do not enter an "Encoded Client ID/Secret" — AWARD® derives it from the OAuth Client ID and OAuth Secret you supply.
All five areas are required, and each must have an API Endpoint, OAuth Client ID, API Key and OAuth Secret. If any are missing you will see: "An Ariba system must define all five APIs (Master Data Retrieval, Sourcing Project Management, Event Management, Sourcing Reporting and Project Document Management), each with an endpoint, OAuth client ID, API key and OAuth secret."
These credentials, URLs and endpoints are all issued from your organisation's SAP Ariba environment. If you do not have them, your SAP Ariba administrator will be able to provide them.
How AWARD® checks the connection
When you save a SAP Ariba system, AWARD® tests the credentials against SAP Ariba (an OAuth connection check — no data is transferred).
- If the check passes, the system is saved as Active and is ready to be used by imports.
- If the check fails, the system is still saved, but as Inactive, so it cannot be used for imports until the credentials are corrected. Re-open the system, check the URLs and credentials, and save again.
Editing a system and its secrets
Secrets are never shown back to you. On the View page, the API Key and OAuth Secret show only as Configured or Not configured. On the Edit page these fields are blank — leave them blank to keep the stored value, or enter a new value to replace it.
Deleting a system
A SAP Ariba system cannot be deleted while it is still assigned to an eSourcing System. Remove that assignment first, then delete the Ariba system.