Connect to SAP SuccessFactors LMS Data in CloverDX (formerly CloverETL)

The CData JDBC Driver for SAP SuccessFactors LMS enables you to use the data transformation components in CloverDX (formerly CloverETL) to work with SAP SuccessFactors LMS as sources. In this article, you will use the JDBC Driver for SAP SuccessFactors LMS to set up a simple transfer into a flat file. The CData JDBC Driver for SAP SuccessFactors LMS enables you to use the data transformation components in CloverDX (formerly CloverETL) to work with SAP SuccessFactors LMS as sources. In this article, you will use the JDBC Driver for SAP SuccessFactors LMS to set up a simple transfer into a flat file.

Connect to SAP SuccessFactors LMS as a JDBC Data Source

1. Create the connection to SAP SuccessFactors LMS data. In a new CloverDX graph, right-click the Connections node in the Outline pane and click Connections -> Create Connection. The Database Connection wizard is displayed.
2. Click the plus icon to load a driver from a JAR. Browse to the lib subfolder of the installation directory and select the cdata.jdbc.sapsuccessfactorslms.jar file.
3. 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.

   👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
   

   A typical JDBC URL is below:

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

Query SAP SuccessFactors LMS Data with the DBInputTable Component

1. Drag a DBInputTable from the Readers selection of the Palette onto the job flow and double-click it to open the configuration editor.
2. In the DB connection property, select the SAP SuccessFactors LMS JDBC data source from the drop-down menu.
3. Enter the SQL query. For example:

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

Write the Output of the Query to a UniversalDataWriter

1. Drag a UniversalDataWriter from the Writers selection onto the jobflow.
2. Double-click the UniversalDataWriter to open the configuration editor and add a file URL.
3. Right-click the DBInputTable and then click Extract Metadata.
4. Connect the output port of the DBInputTable to the UniversalDataWriter.
5. In the resulting Select Metadata menu for the UniversalDataWriter, choose the Items table. (You can also open this menu by right-clicking the input port for the UniversalDataWriter.)
6. Click Run to write to the file.