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.

Create a Data Access Object for SAP Ariba Source Data using JDBI

A brief overview of creating a SQL Object API for SAP Ariba Source data in JDBI.

JDBI is a SQL convenience library for Java that exposes two different style APIs, a fluent style and a SQL object style. The CData JDBC Driver for SAP Ariba Source integrates connectivity to live SAP Ariba Source data in Java applications. By pairing these technologies, you gain simple, programmatic access to SAP Ariba Source data. This article walks through building a basic Data Access Object (DAO) and the accompanying code to read and write SAP Ariba Source data.

Create a DAO for the SAP Ariba Source Vendors Entity

The interface below declares the desired behavior for the SQL object to create a single method for each SQL statement to be implemented.

public interface MyVendorsDAO { //insert new data into SAP Ariba Source @SqlUpdate("INSERT INTO Vendors (Region, Category) values (:region, :category)") void insert(@Bind("region") String region, @Bind("category") String category); //request specific data from SAP Ariba Source (String type is used for simplicity) @SqlQuery("SELECT Category FROM Vendors WHERE Region = :region") String findCategoryByRegion(@Bind("region") String region); /* * close with no args is used to close the connection */ void close(); }

Open a Connection to SAP Ariba Source

Collect the necessary connection properties and construct the appropriate JDBC URL for connecting to SAP Ariba Source.

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.

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the SAP Ariba Source JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

java -jar cdata.jdbc.saparibasource.jar

Fill in the connection properties and copy the connection string to the clipboard.

A connection string for SAP Ariba Source will typically look like the following:


Use the configured JDBC URL to obtain an instance of the DAO interface. The particular method shown below will open a handle bound to the instance, so the instance needs to be closed explicitly to release the handle and the bound JDBC connection.

DBI dbi = new DBI("jdbc:saparibasource:API=SupplierDataAPIWithPagination-V4;APIKey=wWVLn7WTAXrIRMAzZ6VnuEj7Ekot5jnU;Environment=SANDBOX;Realm=testRealm;AuthScheme=OAuthClient;InitiateOAuth=GETANDREFRESH"); MyVendorsDAO dao =; //do stuff with the DAO dao.close();

Read SAP Ariba Source Data

With the connection open to SAP Ariba Source, simply call the previously defined method to retrieve data from the Vendors entity in SAP Ariba Source.

//disply the result of our 'find' method String category = dao.findCategoryByRegion("USA"); System.out.println(category);

Write SAP Ariba Source Data

It is also simple to write data to SAP Ariba Source, using the previously defined method.

//add a new entry to the Vendors entity dao.insert(newRegion, newCategory);

Since the JDBI library is able to work with JDBC connections, you can easily produce a SQL Object API for SAP Ariba Source by integrating with the CData JDBC Driver for SAP Ariba Source. Download a free trial and work with live SAP Ariba Source data in custom Java applications today.