Connect to SAP SuccessFactors LMS Data in Aqua Data Studio

The CData JDBC Driver for SAP SuccessFactors LMS integrates SAP SuccessFactors LMS data with wizards and analytics in IDEs like Aqua Data Studio. This article shows how to connect to SAP SuccessFactors LMS data through the connection manager and execute queries.

Create a JDBC Data Source

You can use the connection manager to define connection properties and save them in a new JDBC data source. The SAP SuccessFactors LMS data source can then be accessed from Aqua Data Studio tools.

1. In Aqua Data Studio, select Register Server from the Servers menu.
2. In the Register Server form, select the 'Generic - JDBC' connection.
3. Enter the following JDBC connection properties:
   • Name: Enter a name for the data source; for example, SAP SuccessFactors LMS.
   • Driver Location: Click the Browse button and select the cdata.jdbc.sapsuccessfactorslms.jar file, located in the lib subfolder of the installation directory.
   • Driver: Enter the Driver's class name, cdata.jdbc.sapsuccessfactorslms.SAPSuccessFactorsLMSDriver.

   • URL: Enter the JDBC URL, which starts with jdbc:sapsuccessfactorslms: and is followed by a semicolon-separated list of connection properties.

     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;

   

Query SAP SuccessFactors LMS Data

You can now query the tables exposed.