Connect to SAP SuccessFactors LMS Data from PowerBuilder via JDBC

The CData JDBC driver for SAP SuccessFactors LMS is a standards-based control that can be used from any platform or development technology that supports JDBC, including PowerBuilder. This article shows how to use the CData JDBC Driver for SAP SuccessFactors LMS in PowerBuilder.

This article shows how to create a basic PowerBuilder application that uses the CData JDBC Driver for SAP SuccessFactors LMS to retrieve data.

Connect to SAP SuccessFactors LMS Data from PowerBuilder

Follow the steps below to use the Database Painter tool to create a database profile based on an JDBC URL for SAP SuccessFactors LMS. You can use a database profile to save connection properties. In the Database Painter, you can graphically manipulate data as well as execute SQL queries.

1. Add the driver JAR to the PowerBuilder classpath. Set the CLASSPATH system environment variable to the path to the driver JAR, located in the lib subfolder of the installation directory.

   Note: If you are using PowerBuilder Classic, you can also add the path to the driver JAR by clicking Tools -> System Options -> Java.

2. Click Tools -> Database Painter.
3. Right-click the JDBC node and click New Profile.
4. In the Database Profile Setup dialog, enter the following:
   • Profile Name: Enter a user-friendly name for the profile.
   • Driver Name: Enter the class name of the driver, cdata.jdbc.sapsuccessfactorslms.SAPSuccessFactorsLMSDriver
   • URL: Enter the JDBC URL.

     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 typical JDBC URL is below:

     jdbc:sapsuccessfactorslms:User=username;CompanyId=CompanyId;Url=https://api4.successfactors.com;InitiateOAuth=GETANDREFRESH;

   
5. To view and modify a table, right-click a table and then click Edit Data -> Grid.

Using SAP SuccessFactors LMS Data with PowerBuilder Controls

You can use standard PowerBuilder objects to connect to JDBC data sources and execute queries. The following example shows how to retrieve SAP SuccessFactors LMS data into a DataWindow. You can add the following code to the open method:

SQLCA.DBMS = "JDBC"
SQLCA.AutoCommit = False
SQLCA.DBParm = "Driver='cdata.jdbc.sapsuccessfactorslms.SAPSuccessFactorsLMSDriver',URL='jdbc:sapsuccessfactorslms:User=username;CompanyId=CompanyId;Url=https://api4.successfactors.com;InitiateOAuth=GETANDREFRESH;";
CONNECT USING SQLCA;
dw_items.SetTransObject(SQLCA);
dw_items.Retrieve();