Load SAP ByDesign Data to a Database Using Embulk

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

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live SAP ByDesign data. When you issue complex SQL queries to SAP ByDesign, the driver pushes supported SQL operations, like filters and aggregations, directly to SAP ByDesign and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations).

Configure a JDBC Connection to SAP ByDesign 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 ByDesign\lib).

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

Set the following connection properties to connect to SAP ByDesign.

• Url: Set this to the Url of your SAP ByDesign site. For example, https://test.sapbydesign.com
• User: Set this to the username of your account.
• Password: Set this to the password of your account.
• CustomService or AnalyticsService: Only one of these must be specified. If you have a custom service you want to retrieve data from, specify CustomService. If you want to retrieve the reports of a analytical service, specify AnalyticsService.
  If neither is specified, 'cc_home_analytics.svc' will used as a default for the AnalyticsService property. If you are not sure what service to specify, you can always query the Services view to list available services.

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the SAP ByDesign JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

java -jar cdata.jdbc.sapbydesign.jar

Fill in the connection properties and copy the connection string to the clipboard.

Below is a typical JDBC connection string for SAP ByDesign:

jdbc:sapbydesign:URL=https://my999999.sapbydesign.com;User=username;Password=password;CustomService=servicename;

Load SAP ByDesign 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 ByDesign data into MySQL using Embulk.

Create a Job to Load SAP ByDesign Data

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

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

Sample Config File (sapbydesign-mysql.yml)

in:
	type: jdbc
	driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.sapbydesign.jar
	driver_class: cdata.jdbc.sapbydesign.SAPByDesignDriver
	url: jdbc:sapbydesign:URL=https://my999999.sapbydesign.com;User=username;Password=password;CustomService=servicename;
	table: "[Inventory Balance]"
out: 
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "[Inventory Balance]"
	mode: insert

After creating the file, run the Embulk job.

embulk run sapbydesign-mysql.yml

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

Load Filtered SAP ByDesign 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.sapbydesign.jar
	driver_class: cdata.jdbc.sapbydesign.SAPByDesignDriver
	url: jdbc:sapbydesign:URL=https://my999999.sapbydesign.com;User=username;Password=password;CustomService=servicename;
	query: "SELECT ID, ProductCategoryID FROM [Inventory Balance] WHERE [RecordId] = 1"
out: 
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "[Inventory Balance]"
	mode: insert

More Information & Free Trial

By using CData JDBC Driver for SAP ByDesign as a connector, Embulk can integrate SAP ByDesign 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.