The SAP Ariba spoke is built by Bristlecone, Inc. Manage the primary and transactional data of buying and sourcing suites in the SAP Ariba instance from your ServiceNow instance. The SAP Ariba system offers a single SaaS offering edition and the SAP Ariba spoke works as-is irrespective of the datacenter chosen.

Important: The SAP Ariba spoke uses the ITK-style service (file upload or file download) REST APIs via MIME multi-part format, and not ITK jar. So, although SAP Ariba announced end of life of ITK jar by Dec 31st, 2023, which resulted in the removal of ITK from the SAP download site and SAP Portal, there is no functionality impact to the existing SAP Ariba spoke.

Request apps on Store

Visit the ServiceNow Store website to view all the available apps and for information about submitting requests to the store. For cumulative release notes information for all released apps, see the ServiceNow Store version history release notes.

Starting on March 1st 2022, all SAP spokes will be available only on the Store.

Integration Hub subscription

This spoke requires an Integration Hub subscription. For more information, see Legal schedules - IntegrationHub overview.

Spoke version

SAP Ariba spoke v1.10.0 is the latest version.

Spoke requirements

  • Enable file upload or file download REST services by creating a shared secret. Copy and record the integration password for later use.
    Note: If you want to create two shared secrets, one for sourcing suite and another for buying a suite, you must provide the same shared secret.
    • To create a shared secret for sourcing suite, navigate to Administration in your SAP Ariba solution.
    • To create a shared secret for buying a suite, navigate to Core Administration in your SAP Ariba solution.
    To create a new shared secret:
    1. Log in to your SAP Ariba solution.
    2. Select Manage in the navigation menu.
    3. Select Core Administration or Administration.
    4. Select the expansion arrow for Integration Manager.
    5. Select Integration Toolkit Security.
    6. In Shared Secret Authentication, enter integration password in Integration password.
    7. Select Save.

    For more information, see Security Configuration for Master Data Integration in SAP Help Portal.

  • Copy and record the realm of your SAP Ariba instance.
  • In Administration, create an inbound endpoint in End Point Configuration under Integration Manager. Copy and record the login password that you have provided under HTTP Authentication. For information about creating an endpoint, see Configure the SAP Ariba Solution in SAP Help Portal.
    To create an integration end point in your SAP Ariba solution:
    1. Log in to your SAP Ariba solution.
    2. Select Manage in the navigation menu.
    3. Select Administration.
    4. Select the expansion arrow for Integration Manager.
    5. Select End Point Configuration.
    6. Select Create New.
    7. On the End Point Configuration - Create End Point page, enter a name for the end point in Name and select Inbound for Type.
    8. In the HTTP Authentication section, enter a user ID in the Login field and a password in the Password field.

      You need the user ID and password to authenticate your HTTP calls later.

    9. Select Save.
    Enable SOAP service of the Import Sourcing Project task for your inbound endpoint in Integration Configuration under Integration Manager.
    • Copy and record the URL in the Integration Task URL field.
    • Open the WSDL file. Copy and record the value of the targetNamespace parameter.
    For information about Integration Task URL and targetNamespace, see Configure the SAP Ariba Solution in SAP Help Portal.
    To enable an integration task and link it to an existing end point:
    1. Log in to your SAP Ariba solution.
    2. Select Manage in the navigation menu.
    3. Select Administration.
    4. Select the expansion arrow for Integration Manager.
    5. Select Integration Configuration.
    6. Locate the task that you want to enable.

      Select List All or enter search criteria.

    7. Select Search.
    8. Select Actions and select Edit for the required task.
    9. In the Edit data import/export task page, select Enabled for Status.
    10. For End point, select the required end point.
    11. Select Save.

  • In Core Administration, create an inbound endpoint in End Point Configuration under Integration Manager. Copy and record the login password that you have provided under HTTP Authentication. For information about creating an endpoint, see Configure the SAP Ariba Solution in SAP Help Portal.

    To create an integration end point in your SAP Ariba solution:
    1. Log in into your SAP Ariba solution.
    2. Select Manage in the navigation menu.
    3. Select Core Administration.
    4. Select the expansion arrow for Integration Manager.
    5. Select End Point Configuration.
    6. Select Create New.
    7. On the End Point Configuration - Create End Point page, enter a name for the end point for Name.
    8. Select Inbound for Type.
    9. In the HTTP Authentication section, enter a user ID in the Login field and a password in the Password field.

      You need the user ID and password to authenticate your HTTP calls later.

    10. Select Save.
    Enable SOAP service of the Import Suppliers task for your inbound endpoint in Integration Configuration under Integration Manager.
    • Copy and record the URL in the Integration Task URL field.
    • Open the WSDL file. Copy and record the value of the targetNamespace parameter.
    To enable an integration task and link it to an existing end point:
    1. Log in into your SAP Ariba solution.
    2. Select Manage in the navigation menu.
    3. Select Core Administration.
    4. Select the expansion arrow for Integration Manager.
    5. Select Integration Configuration.
    6. Locate the task that you want to enable.

      Select List All or enter search criteria.

    7. Select Search.
    8. Select Actions and select Edit for the required task.
    9. In the Edit data import/export task page, select Enabled for Status.
    10. For End point, select the required end point.
    11. Select Save.

    For information about Integration Task URL and targetNamespace, see Configure the SAP ARiba Solution in SAP Help Portal.

Spoke dependencies

If you’re having trouble installing the app, ensure that these dependent plugins are installed:
  • ServiceNow IntegrationHub Action Step - REST (com.glide.hub.action_step.rest)
  • ServiceNow IntegrationHub Action Step - SOAP (com.glide.hub.action_step.soap)
  • Complex Object (com.glide.cobject)
  • ServiceNow Flow Designer - Dynamic Inputs (com.glide.hub.dynamic_inputs)
  • ServiceNow IntegrationHub Runtime (com.glide.hub.integration.runtime)
  • Flow Designer Action Step - Script on MID (com.glide.hub.action_step.script_mid)
  • Utility Actions Spoke
Note: Some of these plugins are licensable features and require appropriate licenses, if used outside the spoke implementation.

Spoke flows

The SAP Ariba spoke provides sample flows to demonstrate automating the SAP Ariba tasks. To customize a sample flow, copy it to the required application scope. Available sample flows include:

Flow Description
Import Supplier Organizations Buyer Imports supplier organizations from ServiceNow to the buying suite of your SAP Ariba instance.
Import Supplier Organizations Sourcing Imports supplier organizations from ServiceNow to the sourcing suite of your SAP Ariba instance.

Spoke subflows

The SAP Ariba spoke provides sample subflows to demonstrate the sequence of reusable actions in a flow. To customize the sample subflows, copy them to the required application scope.

Table 1. Spoke subflows
Subflow Description
Look up Export Task - Subflow Searches for the export task event ZIP file, copies the ZIP file to an SFTP location. Then the file is unzipped and the unzipped XLS or CSV files are copied to the specified ServiceNow table record.
Update Requisition sample subflow Updates the requestions specified in the payload.
Create Requisition sample subflow Creates a requisition record after verifying that a requestion with the specified requisition details does not exist.
Note: The sample subflow requires a server host, port, and working directory.

Spoke actions

The SAP Ariba spoke provides actions to automate SAP Ariba tasks when events occurs in your ServiceNow instance. Available actions include:

Category Action Description
Export Management Copy Ariba File To Data Source Takes sys ID of the source record and transfers the attachment to the target data source.
Execute Ariba Export Task Executes the Ariba export task event where a file is received as response and stored to the Ariba task execution table records.
Import Management Execute Ariba Import Task Triggers the SAP Ariba import task for the specified operation.
Look up Export Task Executes an Ariba export task event where a ZIP file is received as response and stored to the selected data source.
Invoice Management Look up Invoices CXML Retrieves invoices from SAP business network in cXML format.
Look up Pending Messages ID CXML Retrieves the pending messages ID in CXML format.
Reject Invoice CXML Rejects the specified invoice submitted by suppliers in SAP business network.
Approvals Procurement Management Look up Approvals Status Retrieves tasks that are pending for approval.
Look up Downstream Approvals Stream Retrieves details related to the approvable invoices or requisitions.
Update Downstream Approval Status Retrieves the details of approval entities.
Approval Sourcing Management Create Approval Status Performs the specified action on an entity. Possible values for the entity task are Approve, Deny, and DenyWithResubmit.
Look up Approval Entities Retrieves the details of approval entities.
Buyer Management Look up Purchase Order Lines Stream Retrieves information from line items in purchase orders for a specified buyer.
Look up Purchase Orders Stream Retrieves header information in purchase orders for a specified buyer.
Procurement Export Management Look up Downstream Supplier Locations Initiates an Ariba export process, prompting the system to generate and deliver a ZIP file which contains essential data stored as a response within the user's selected data source.
Look up Receipts Initiates an Ariba export process, prompting the system to generate and deliver a ZIP file which contains essential data stored as a response within the user's selected data source.
Procurement Import Management Import Downstream Supplier Creates or updates supplier details in Ariba system along with supplier location and supplier remittance location.
Receipt Management Create Receipt Creates receipt or import receipt from external applications.
Requisition Management (SOAP-based) Create Requisition Creates a requisition record with the provided details.
Update Requisition Updates a requisition record with the specified information.
Procurement Management (REST-based) Look up Conversion Rates Stream Retrieves details related to conversion rates.
Look up Cost Centers Stream Retrieves cost centers details from SAP ARIBA REST.
Look up Currency Rates Stream Retrieves details related to the currency rates.
Look up Fixed Assets Stream Retrieves fixed assets details from SAP ARIBA REST.
Look up GL Accounts Stream Retrieves details of the available primary data entities.
Look up Legal Entities Stream Retrieves metadata for legal entity.
Look up Material Groups Stream Retrieves the primary data of material group from SAP Ariba.
Look up Materials Stream Retrieves the general data of materials in SAP Ariba REST.
Look up Payment Terms Stream Retrieves details of the available primary data entities.
Look up Purchase Groups Stream Retrieves purchase group details from SAP system.
Look up Purchasing Organizations Stream Retrieves purchasing organization details from SAP ARIBA REST.
Look up Upstream Supplier Locations Stream Retrieves the primary data of supplier locations.
Sourcing Event Management Create Award Scenario Creates an award scenario with the provided details.
Create Event Line Items Adds line items to the specified event and sets term values as specified.
Create Event Questions Adds questions to the specified event and sets term values as specified.
Create Item Attachments Uploads a file as an attachment for the specified item and term in the specified event. The item and term must exist. The event state must be Draft.
Create Sourcing Event Initiates the process of creating a sourcing event, such as a request for proposal (RFP), within the SAP Ariba Event Management.
Create Supplier Award Awards the supplier by recognizing their successful proposal.
Create Supplier Invitations Invites multiple suppliers to the specified event.
Delete Supplier Invitations Deletes multiple suppliers for the specified event.
Download Attachment from Supplier Bid Responses Retrieves details of the supplier response.
Look up Awarded Bids Retrieves details of the awarded bids for an event.
Look up Event Templates Retrieves sourcing template IDs and other template details, including item definitions.
Look up Supplier Bids Retrieves supplier bids for an event.
Update Event State Modifies an event's state using its unique identifier that is, Event ID.
Supplier Management Create Sourcing Project Creates a sourcing project with the provided details.
Update Sourcing Project Updates the project header fields of an existing sourcing project.
Sourcing Management (REST-based) Look up Departments Stream Retrieves the department primary data available in the system.
SSH Management Copy Attachments to SFTP Server Executes SSH commands to copy specified attachment record to the selected server's working directory.
Unzip and Copy Files to ServiceNow Target Table Executes SSH commands to unzip the zip attachment stored in the selected server's working directory and copies extracted files to ServiceNow instance.
Supplier Management (REST-based) Look up Upstream Suppliers Stream Retrieves the general data of the primary supplier.
Look up Downstream Remittance Location Stream Retrieves details of the available master data entities.
Look up Downstream Suppliers Stream Retrieves details related to the suppliers.
Supplier Management (SOAP-based) Create Suppliers Creates a supplier with the provided details.

Spoke module

The SAP Ariba spoke adds the SAP Ariba Spoke application to your instance and includes these modules:
ModuleDescription
Ariba Export Configuration Definition Displays the list of available export configurations. By default, 33 export configurations are available along with the spoke. You can modify the default export configuration or create export configurations, according to requirements.

For example, if you have used the Execute Ariba Export Task action in your flow to export receipts, data is retrieved from your SAP Ariba instance to ServiceNow instance. You must copy these records to data source. Otherwise, the records are deleted after the time period mentioned in the Ariba Export Task Scheduler scheduled script has lapsed. You can use the Copy Ariba File To Data Source action in your flow to copy the record to your data source.
Ariba Export Task Execution Displays the CSV files generated when data is exported from your SAP Ariba instance to ServiceNow instance. You must copy these records to data source. Otherwise, the records are deleted after the time period mentioned in the Ariba Export Task Scheduler scheduled script has lapsed.
Ariba Import Configuration Definition Displays the list of available import configurations. By default, two import configurations are available along with the spoke. You must use Execute Ariba Import Task action in your flow to create the required records.
  • If you have selected the MasterDataBatchPull task in the Execute Ariba Import Task action, the primary data records for the sourcing suite are created or updated in your SAP Ariba instance.
  • If you have selected the CombinedDataPull task in the Execute Ariba Import Task action, the primary data records for the buying suite are created or updated in your SAP Ariba instance.
Supplier IDs Buyer Displays information about the suppliers in the buying suite. Admin must create the supplier records here.

The Look Up Supplier IDs Buyer Records action in the Import Supplier Organizations Buyer sample flow uses these records to run the flow.
Supplier IDs Sourcing Displays information about the suppliers in the sourcing suite. An admin must create the supplier records here.

The Look Up Supplier IDs Sourcing Records action in the Import Supplier Organizations Sourcing sample flow uses these records to run the flow.
Supplier Organizations Buyer Displays information about the supplier organizations in the buying suite. Admin must create records here.

The Look Up Supplier Organizations Buyer Records action in the Import Supplier Organizations Buyer sample flow uses these records to run the flow.
Supplier Organizations Sourcing Displays information about the supplier organizations in the sourcing suite. An admin must create records here.

The Look Up Supplier Organizations Sourcing Records action in the Import Supplier Organizations Sourcing sample flow uses these records to run the flow.
Data accessed through these spoke modules is stored in these tables:
TableDescription
Ariba Export Configuration Definition [sn_sap_ariba_spoke_ariba_file_definition] Stores information about the export configurations.
Ariba Import Configuration Definition [sn_sap_ariba_spoke_ariba_import_configuration_definition] Stores information about the import configurations.
Ariba Export Task Execution [sn_sap_ariba_spoke_ariba_task_execution] Stores information about the CSV files generated when data is exported from your SAP Ariba instance to ServiceNow instance.
Supplier Organizations Sourcing [sn_sap_ariba_spoke_import_supplier_organizations_csv] Stores information about the supplier organizations in the sourcing suite. Admin must create these records in the Supplier Organizations Sourcing module.
Supplier IDs Sourcing [sn_sap_ariba_spoke_supplier_ids] Stores information about the suppliers in the sourcing suite. Admin must create these records in the Supplier IDs Sourcing module.
Supplier IDs Buyer [sn_sap_ariba_spoke_supplier_ids_buyer] Stores information about the suppliers in the buying suite. Admin must create these records in the Supplier IDs Buyer module.
Supplier Organizations Buyer [sn_sap_ariba_spoke_supplier_organizations] Stores information about the supplier organizations in the buying suite. Admin must create these records in the Supplier Organizations Buyer module.

Spoke scheduled script and system property

A scheduled script, Ariba Export Task Scheduler, and system property, sn_sap_ariba_spoke.ariba.export.task.scheduler, are available along with the spoke. The system property defines the number of days by which all the records older than this will be purged. The script uses this value to purge the records that have not been copied to the data source.

  • To view the scheduled script, enter sysauto_script_list.do in the filter navigator and search for the script, Ariba Export Task Scheduler.
  • To view the system property, navigate to System Properties > All Properties and search for the system property, sn_sap_ariba_spoke.ariba.export.task.scheduler.
You can configure the scheduled script and system property according to your requirement.

Connection and credential alias requirements

Integration Hub uses aliases to manage connection and credential information. Using an alias eliminates the need to configure multiple credentials and connection information profiles when using multiple environments. If the connection or credential information changes, you don't need to update any actions that use the connection. For more information, see Connections and Credentials.

These connection and credential alias records are available along with the spoke:
Connection & Credential AliasAssociated spoke action category
SAP_Ariba_Import Import Management
SAP_Ariba_Export Export Management
SAP_Ariba_Sourcing Sourcing Management
SAP_Ariba_Suppliers Supplier Management (SOAP-based)
SAP Ariba SSH SSH Management
SAP Ariba Rest Procurement Procurement Management (REST-based)
SAP Ariba Rest Buyer Buyer Management
SAP Ariba Rest Sourcing Sourcing Management (REST-based)
SAP Ariba Procurement Export Procurement Export Management
SAP Ariba Soap Receipts Receipt Management
SAP Ariba Procurement Import Procurement Import Management
SAP Ariba Rest Suppliers Supplier Management (REST-based)
SAP Ariba Approvals Procurement Approvals Procurement Management
SAP Ariba Approvals Sourcing
  • Approvals Sourcing Management
  • Approvals Procurement Management
SAP Ariba Rest Event Sourcing Event Management
SAP Ariba Soap Requisition Requisition Management(SOAP-based)

For information about setting up the spoke, see Set up the SAP Ariba spoke.

MID Server requirements

These actions use REST calls, which can run on an instance or MID Server. Use the connection record associated with the SAP Ariba alias to configure where actions run as well as set MID Server selection attributes. For more information about running actions on the MID Server, see Integration steps
Note:
  • You must set up MID Server to use the Execute Ariba Export Task, Copy Attachments to SFTP Server, and Unzip and Copy Files to ServiceNow Target Table actions.
  • The Linux server that is needed to create the SSH credential record, must be installed in the same network’s machine or virtual machine where your MID Server is installed.

To set up the MID Server for this spoke, see Set up MID Server for a spoke.