Query SAP SuccessFactors LMS Data in DataGrip

DataGrip is a database IDE that allows SQL developers to query, create, and manage databases. When paired with the CData JDBC Driver for SAP SuccessFactors LMS, DataGrip can work with live SAP SuccessFactors LMS data. This article shows how to establish a connection to SAP SuccessFactors LMS data in DataGrip.

Create a New Driver Definition for SAP SuccessFactors LMS

The steps below describe how to create a new Data Source in DataGrip for SAP SuccessFactors LMS.

1. In DataGrip, click File -> New > Project and name the project
2. In the Database Explorer, click the plus icon () and select Driver.
3. In the Driver tab:
   • Set Name to a user-friendly name (e.g. "CData SAP SuccessFactors LMS Driver")
   • Set Driver Files to the appropriate JAR file. To add the file, click the plus (), select "Add Files," navigate to the "lib" folder in the driver's installation directory and select the JAR file (e.g. cdata.jdbc.sapsuccessfactorslms.jar).
   • Set Class to cdata.jdbc.sapsuccessfactorslms.SAPSuccessFactorsLMS.jar
   Additionally, in the advanced tab you can change driver properties and some other settings like VM Options, VM environment, VM home path, DBMS, etc
   • For most cases, change the DBMS type to "Unknown" in Expert options to avoid native SQL Server queries (Transact-SQL), which might result in an invalid function error
4. Click "Apply" then "OK" to save the Connection

Configure a Connection to SAP SuccessFactors LMS

1. Once the connection is saved, click the plus (), then "Data Source" then "CData SAP SuccessFactors LMS Driver" to create a new SAP SuccessFactors LMS Data Source.
2. In the new window, configure the connection to SAP SuccessFactors LMS with a JDBC URL.

   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.

   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.

   
3. Set URL to the connection string, e.g.,

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

4. Click "Apply" and "OK" to save the connection string

At this point, you will see the data source in the Data Explorer.

Execute SQL Queries Against SAP SuccessFactors LMS

To browse through the SAP SuccessFactors LMS entities (available as tables) accessible through the JDBC Driver, expand the Data Source.

To execute queries, right click on any table and select "New" -> "Query Console."

In the Console, write the SQL query you wish to execute. For example:

SELECT ItemID, ItemTitle FROM [Admin].[Search_Service].[Items] WHERE Active = true

Download a free, 30-day trial of the CData JDBC Driver for SAP SuccessFactors LMS and start working with your live SAP SuccessFactors LMS data in DataGrip. Reach out to our Support Team if you have any questions.