Create a Data Access Object for SAP Ariba Procurement Data using 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 Procurement integrates connectivity to live SAP Ariba Procurement data in Java applications. By pairing these technologies, you gain simple, programmatic access to SAP Ariba Procurement data. This article explains how to build a basic Data Access Object (DAO) and the accompanying code to read SAP Ariba Procurement data.

Create a DAO for the SAP Ariba Procurement Orders 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 MyOrdersDAO {
 //request specific data from SAP Ariba Procurement (String type is used for simplicity)
 @SqlQuery("SELECT Revision FROM Orders WHERE OrderStatus = :orderStatus")
 String findRevisionByOrderStatus(@Bind("orderStatus") String orderStatus);

 /*
 * close with no args is used to close the connection
 */
 void close();
}

Open a Connection to SAP Ariba Procurement

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

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

• ANID: Your Ariba Network ID.
• ANID: Specify which API you would like the provider to retrieve SAP Ariba data from. Select the Buyer or Supplier API based on your business role (possible values are PurchaseOrdersBuyerAPIV1 or PurchaseOrdersSupplierAPIV1).
• Environment: Indicate whether you are connecting to a test or production environment (possible values are TEST or PRODUCTION).

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 Procurement JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

java -jar cdata.jdbc.saparibaprocurement.jar

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

👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)

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

jdbc:saparibaprocurement:ANID=AN02000000280;API=PurchaseOrdersBuyerAPI-V1;APIKey=wWVLn7WTAXrIRMAzZ6VnuEj7Ekot5jnU;AuthScheme=OAuthClient;InitiateOAuth=GETANDREFRESH;

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:saparibaprocurement:ANID=AN02000000280;API=PurchaseOrdersBuyerAPI-V1;APIKey=wWVLn7WTAXrIRMAzZ6VnuEj7Ekot5jnU;AuthScheme=OAuthClient;InitiateOAuth=GETANDREFRESH;");
MyOrdersDAO dao = dbi.open(MyOrdersDAO.class);

//do stuff with the DAO

dao.close();

Read SAP Ariba Procurement Data

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

//disply the result of our 'find' method
String revision = dao.findRevisionByOrderStatus("CHANGED");
System.out.println(revision);

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