How to connect to SAP SuccessFactors LMS Data with Squirrel SQL client

The CData JDBC Driver for SAP SuccessFactors LMS enables you to execute queries to SAP SuccessFactors LMS data in tools like Squirrel SQL Client. In this article, you will create a JDBC data source for SAP SuccessFactors LMS data and execute queries.

Add the JDBC Driver for SAP SuccessFactors LMS

Follow the steps below to add the driver JAR.

1. In Squirrel SQL, click Windows -> View Drivers.
2. Click the plus icon to open the Add Driver wizard.
3. In the Name box, enter a user-friendly name for the driver; for example, CData JDBC Driver for SAP SuccessFactors LMS.
4. In the Example URL box, enter jdbc:sapsuccessfactorslms:
5. In the Extra Class Path tab, click Add.
6. In the file explorer dialog that opens, select the JAR file for the driver, located in the lib subfolder of the installation directory.
7. Click List Drivers to populate the Class Name menu with the class name for the driver, cdata.jdbc.sapsuccessfactorslms.SAPSuccessFactorsLMSDriver.

Define Connection Properties

Follow the steps below to save connection properties in the driver alias.

1. Click Windows -> View Aliases.
2. In the pane that lists the aliases, click the plus icon.

3. In the Add Alias wizard that opens, the following fields are required for the JDBC driver:

   • Name: Enter a name for the alias; for example, CData SAP SuccessFactors LMS Source.
   • Driver: Select the CData JDBC Driver for SAP SuccessFactors LMS.
   • URL: Enter jdbc:sapsuccessfactorslms:
   • User Name: Enter the username, which is added to the JDBC URL.
   
4. If you want to define any additional properties, click Properties.
5. In the Driver properties tab of the dialog that appears, select the Use driver properties checkbox.
6. In the Specify column, select the checkboxes for the required 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.

   Below is a typical connection string:

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

   
7. In the dialog that appears after you click OK, click connect to test the connection.

Discover Schemas and Query SAP SuccessFactors LMS Data

After the metadata has loaded, a new tab for the SAP SuccessFactors LMS data source is displayed. On the Objects subtab, you can discover schema information, such as the available tables and views.

To view table data, select the table on the Objects tab. The table data is then loaded in a grid on the Content tab.

To execute an SQL query, enter the query on the SQL tab and then click Run SQL (the runner icon). For example:

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