How to work with SAP SuccessFactors LMS Data in Apache Spark using SQL

Apache Spark is a fast and general engine for large-scale data processing. When paired with the CData JDBC Driver for SAP SuccessFactors LMS, Spark can work with live SAP SuccessFactors LMS data. This article describes how to connect to and query SAP SuccessFactors LMS data from a Spark shell.

The CData JDBC Driver offers unmatched performance for interacting with live SAP SuccessFactors LMS data due to optimized data processing built into the driver. When you issue complex SQL queries to SAP SuccessFactors LMS, the driver pushes supported SQL operations, like filters and aggregations, directly to SAP SuccessFactors LMS and utilizes the embedded SQL engine to process unsupported operations (often SQL functions and JOIN operations) client-side. With built-in dynamic metadata querying, you can work with and analyze SAP SuccessFactors LMS data using native data types.

Install the CData JDBC Driver for SAP SuccessFactors LMS

Download the CData JDBC Driver for SAP SuccessFactors LMS installer, unzip the package, and run the JAR file to install the driver.

Start a Spark Shell and Connect to SAP SuccessFactors LMS Data

1. Open a terminal and start the Spark shell with the CData JDBC Driver for SAP SuccessFactors LMS JAR file as the jars parameter:

   $ spark-shell --jars /CData/CData JDBC Driver for SAP SuccessFactors LMS/lib/cdata.jdbc.sapsuccessfactorslms.jar
   

2. With the shell running, you can connect to SAP SuccessFactors LMS with a JDBC URL and use the SQL Context load() function to read a table.

   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.

   

   Configure the connection to SAP SuccessFactors LMS, using the connection string generated above.

   scala> val sapsuccessfactorslms_df = spark.sqlContext.read.format("jdbc").option("url", "jdbc:sapsuccessfactorslms:User=username;CompanyId=CompanyId;Url=https://api4.successfactors.com;InitiateOAuth=GETANDREFRESH;").option("dbtable","Items").option("driver","cdata.jdbc.sapsuccessfactorslms.SAPSuccessFactorsLMSDriver").load()
   

3. Once you connect and the data is loaded you will see the table schema displayed.

4. Register the SAP SuccessFactors LMS data as a temporary table:

   scala> sapsuccessfactorslms_df.registerTable("items")

5. Perform custom SQL queries against the Data using commands like the one below:

   scala> sapsuccessfactorslms_df.sqlContext.sql("SELECT ItemID, ItemTitle FROM Items WHERE Active = true").collect.foreach(println)

   You will see the results displayed in the console, similar to the following:

   

Using the CData JDBC Driver for SAP SuccessFactors LMS in Apache Spark, you are able to perform fast and complex analytics on SAP SuccessFactors LMS data, combining the power and utility of Spark with your data. Download a free, 30 day trial of any of the 200+ CData JDBC Drivers and get started today.