Ready to get started?

Download a free trial of the SAP Ariba Source Driver to get started:

 Download Now

Learn more:

SAP Ariba Source Icon SAP Ariba Source JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with SAP Ariba Source.

How to connect to SAP Ariba Source Data with Squirrel SQL client



Connect to SAP Ariba Source data and execute queries in the Squirrel SQL Client.

The CData JDBC Driver for SAP Ariba Source enables you to execute queries to SAP Ariba Source data in tools like Squirrel SQL Client. In this article, you will create a JDBC data source for SAP Ariba Source data and execute queries.

Add the JDBC Driver for SAP Ariba Source

Follow the steps below to add the driver JAR.

  1. In Squirrel SQL, click Windows -> View Drivers.
  2. Click the plus icon to open the Add Driver wizard.
  3. In the Name box, enter a user-friendly name for the driver; for example, CData JDBC Driver for SAP Ariba Source.
  4. In the Example URL box, enter jdbc:saparibasource:
  5. In the Extra Class Path tab, click Add.
  6. In the file explorer dialog that opens, select the JAR file for the driver, located in the lib subfolder of the installation directory.
  7. Click List Drivers to populate the Class Name menu with the class name for the driver, cdata.jdbc.saparibasource.SAPAribaSourceDriver.

Define Connection Properties

Follow the steps below to save connection properties in the driver alias.

  1. Click Windows -> View Aliases.
  2. In the pane that lists the aliases, click the plus icon.
  3. In the Add Alias wizard that opens, the following fields are required for the JDBC driver:

    • Name: Enter a name for the alias; for example, CData SAP Ariba Source Source.
    • Driver: Select the CData JDBC Driver for SAP Ariba Source.
    • URL: Enter jdbc:saparibasource:
  4. If you want to define any additional properties, click Properties.
  5. In the Driver properties tab of the dialog that appears, select the Use driver properties checkbox.
  6. In the Specify column, select the checkboxes for the required connection properties.

    In order to connect with SAP Ariba Source, set the following:

    • API: Specify which API you would like the provider to retrieve SAP Ariba data from. Select the Supplier, Sourcing Project Management, or Contract API based on your business role (possible values are SupplierDataAPIWithPaginationV4, SourcingProjectManagementAPIV2, or ContractAPIV1).
    • DataCenter: The data center where your account's data is hosted.
    • Realm: The name of the site you want to access.
    • Environment: Indicate whether you are connecting to a test or production environment (possible values are TEST or PRODUCTION).

    If you are connecting to the Supplier Data API or the Contract API, additionally set the following:

    • User: Id of the user on whose behalf API calls are invoked.
    • PasswordAdapter: The password associated with the authenticating User.

    If you're connecting to the Supplier API, set ProjectId to the Id of the sourcing project you want to retrieve data from.

    Authenticating with OAuth

    After setting connection properties, you need to configure OAuth connectivity to authenticate.

    • Set AuthScheme to OAuthClient.
    • Register an application with the service to obtain the APIKey, OAuthClientId and OAuthClientSecret.

      For more information on creating an OAuth application, refer to the Help documentation.

    Automatic OAuth

    After setting the following, you are ready to connect:

      APIKey: The Application key in your app settings. OAuthClientId: The OAuth Client Id in your app settings. OAuthClientSecret: The OAuth Secret in your app settings.

    When you connect, the provider automatically completes the OAuth process:

    1. The provider obtains an access token from SAP Ariba and uses it to request data.
    2. The provider refreshes the access token automatically when it expires.
    3. The OAuth values are saved in memory relative to the location specified in OAuthSettingsLocation.

    Below is a typical connection string:

    jdbc:saparibasource:API=SupplierDataAPIWithPagination-V4;APIKey=wWVLn7WTAXrIRMAzZ6VnuEj7Ekot5jnU;Environment=SANDBOX;Realm=testRealm;AuthScheme=OAuthClient;InitiateOAuth=GETANDREFRESH
  7. In the dialog that appears after you click OK, click connect to test the connection.

Discover Schemas and Query SAP Ariba Source Data

After the metadata has loaded, a new tab for the SAP Ariba Source data source is displayed. On the Objects subtab, you can discover schema information, such as the available tables and views.

To view table data, select the table on the Objects tab. The table data is then loaded in a grid on the Content tab.

To execute an SQL query, enter the query on the SQL tab and then click Run SQL (the runner icon). For example:

SELECT SMVendorID, Category FROM Vendors WHERE Region = 'USA'