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

Create a DAO for the SAP SuccessFactors LMS Items 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 MyItemsDAO {
 //request specific data from SAP SuccessFactors LMS (String type is used for simplicity)
 @SqlQuery("SELECT ItemTitle FROM Items WHERE Active = :active")
 String findItemTitleByActive(@Bind("active") String active);

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

Open a Connection to SAP SuccessFactors LMS

Collect the necessary connection properties and construct the appropriate JDBC URL for connecting to SAP SuccessFactors LMS.

SAP SuccessFactors LMS uses OAuth authentication. Before connecting, you must configure an OAuth application tied to your SAP SuccessFactors LMS account.

To establish a connection, set the following properties:

• User: Your SAP SuccessFactors LMS username.
• CompanyId: Your SAP SuccessFactors company identifier.
• Url: The SAP SuccessFactors API URL (e.g., https://api4.successfactors.com).
• OAuthClientId: The client Id assigned when you registered your custom OAuth application.
• OAuthClientSecret: The client secret assigned when you registered your custom OAuth application.

See the Getting Started chapter of the help documentation for a guide to creating a custom OAuth app and using OAuth.

Built-in Connection String Designer

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

java -jar cdata.jdbc.sapsuccessfactorslms.jar

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

A connection string for SAP SuccessFactors LMS will typically look like the following:

jdbc:sapsuccessfactorslms:User=username;CompanyId=CompanyId;Url=https://api4.successfactors.com;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:sapsuccessfactorslms:User=username;CompanyId=CompanyId;Url=https://api4.successfactors.com;InitiateOAuth=GETANDREFRESH;");
MyItemsDAO dao = dbi.open(MyItemsDAO.class);

//do stuff with the DAO

dao.close();

Read SAP SuccessFactors LMS Data

With the connection open to SAP SuccessFactors LMS, simply call the previously defined method to retrieve data from the Items entity in SAP SuccessFactors LMS.

//disply the result of our 'find' method
String itemTitle = dao.findItemTitleByActive("true");
System.out.println(itemTitle);

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