Load SAP SuccessFactors LMS Data to a Database Using Embulk

Embulk is an open source bulk data loader. When paired with the CData JDBC Driver for SAP SuccessFactors LMS, Embulk easily loads data from SAP SuccessFactors LMS to any supported destination. In this article, we explain how to use the CData JDBC Driver for SAP SuccessFactors LMS in Embulk to load SAP SuccessFactors LMS data to a MySQL dtabase.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live SAP SuccessFactors LMS data. 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 client-side (often SQL functions and JOIN operations).

Configure a JDBC Connection to SAP SuccessFactors LMS Data

Before creating a bulk load job in Embulk, note the installation location for the JAR file for the JDBC Driver (typically C:\Program Files\CData\CData JDBC Driver for SAP SuccessFactors LMS\lib).

Embulk supports JDBC connectivity, so you can easily connect to SAP SuccessFactors LMS and execute SQL queries. Before creating a bulk load job, create a JDBC URL for authenticating with SAP SuccessFactors LMS.

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.

Below is a typical JDBC connection string for SAP SuccessFactors LMS:

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

Load SAP SuccessFactors LMS Data in Embulk

After installing the CData JDBC Driver and creating a JDBC connection string, install the required Embulk plugins.

Install Embulk Input & Output Plugins

1. Install the JDBC Input Plugin in Embulk.
   https://github.com/embulk/embulk-input-jdbc/tree/master/embulk-input-jdbc

embulk gem install embulk-input-jdbc

2. In this article, we use MySQL as the destination database. You can also choose SQL Server, PostgreSQL, or Google BigQuery as the destination using the output Plugins.
   https://github.com/embulk/embulk-output-jdbc/tree/master/embulk-output-mysql

   embulk gem install embulk-output-mysql
   

With the input and output plugins installed, we are ready to load SAP SuccessFactors LMS data into MySQL using Embulk.

Create a Job to Load SAP SuccessFactors LMS Data

Start by creating a config file in Embulk, using a name like sapsuccessfactorslms-mysql.yml.

1. For the input plugin options, use the CData JDBC Driver for SAP SuccessFactors LMS, including the path to the driver JAR file, the driver class (e.g. cdata.jdbc.sapsuccessfactorslms.SAPSuccessFactorsLMSDriver), and the JDBC URL from above
2. For the output plugin options, use the values and credentials for the MySQL database

Sample Config File (sapsuccessfactorslms-mysql.yml)

in:
	type: jdbc
	driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.sapsuccessfactorslms.jar
	driver_class: cdata.jdbc.sapsuccessfactorslms.SAPSuccessFactorsLMSDriver
	url: jdbc:sapsuccessfactorslms:User=username;CompanyId=CompanyId;Url=https://api4.successfactors.com;InitiateOAuth=GETANDREFRESH;
	table: "Items"
out: 
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "Items"
	mode: insert

After creating the file, run the Embulk job.

embulk run sapsuccessfactorslms-mysql.yml

After running the the Embulk job, find the Salesforce data in the MySQL table.

Load Filtered SAP SuccessFactors LMS Data

In addition to loading data directly from a table, you can use a custom SQL query to have more granular control of the data loaded. You can also perform increment loads by setting a last updated column in a SQL WHERE clause in the query field.

in:
	type: jdbc
	driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.sapsuccessfactorslms.jar
	driver_class: cdata.jdbc.sapsuccessfactorslms.SAPSuccessFactorsLMSDriver
	url: jdbc:sapsuccessfactorslms:User=username;CompanyId=CompanyId;Url=https://api4.successfactors.com;InitiateOAuth=GETANDREFRESH;
	query: "SELECT ItemID, ItemTitle FROM Items WHERE [RecordId] = 1"
out: 
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "Items"
	mode: insert

More Information & Free Trial

By using CData JDBC Driver for SAP SuccessFactors LMS as a connector, Embulk can integrate SAP SuccessFactors LMS data into your data load jobs. And with drivers for more than 200+ other enterprise sources, you can integrate any enterprise SaaS, big data, or NoSQL source as well. Download a 30-day free trial and get started today.