Load SAP Netweaver Gateway Data to a Database Using Embulk

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

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

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

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

SAP Gateway allows both basic and OAuth 2.0 authentication. You can use basic authentication to connect to your own account, or you can use OAuth to enable other users to retrieve data from your service with their accounts. In addition to authenticating, set the following connection properties to access SAP Gateway tables.

• Url: Set this to the URL of your environment, or to the full URL of the service. For example, the full URL might appear as: https://sapes5.sapdevcenter.com/sap/opu/odata/IWBEP/GWSAMPLE_BASIC/. In this example, the environment URL would just be: https://sapes5.sapdevcenter.com.
• Namespace: Set the appropriate Service Namespace. In the example above, IWBEP is the namespace. It is optional if the full URL to the service is specified.
• Service: Set this to the service you want to retrieve data from. In the example above, the service is GWSAMPLE_BASIC. It is not required if the full URL is specified.

Authenticate via Basic Authentication

In basic authentication, you use your login credentials to connect. Set the following properties:

• User: This is the username you use to log in to SAP Gateway.
• Password: This is the password you use to log in to SAP Gateway.

Authenticate via OAuth Authentication

You can connect to SAP Gateway using the embedded OAuth connectivity (without setting any additional authentication connection properties). When you connect, the OAuth endpoint opens in your browser. Log in and grant permissions to complete the OAuth process. See the OAuth section in the online Help documentation for more information on other OAuth authentication flows.

Built-in Connection String Designer

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

java -jar cdata.jdbc.sapgateway.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.)

Below is a typical JDBC connection string for SAP Netweaver Gateway:

jdbc:sapgateway:User=user;Password=password;URL=https://sapes5.sapdevcenter.com/sap/opu/odata/IWBEP/GWSAMPLE_BASIC/;InitiateOAuth=GETANDREFRESH;

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

Create a Job to Load SAP Netweaver Gateway Data

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

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

Sample Config File (sapgateway-mysql.yml)

in:
	type: jdbc
	driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.sapgateway.jar
	driver_class: cdata.jdbc.sapgateway.SAPGatewayDriver
	url: jdbc:sapgateway:User=user;Password=password;URL=https://sapes5.sapdevcenter.com/sap/opu/odata/IWBEP/GWSAMPLE_BASIC/;InitiateOAuth=GETANDREFRESH;
	table: "SalesOrderLineItems"
out: 
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "SalesOrderLineItems"
	mode: insert

After creating the file, run the Embulk job.

embulk run sapgateway-mysql.yml

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

Load Filtered SAP Netweaver Gateway 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.sapgateway.jar
	driver_class: cdata.jdbc.sapgateway.SAPGatewayDriver
	url: jdbc:sapgateway:User=user;Password=password;URL=https://sapes5.sapdevcenter.com/sap/opu/odata/IWBEP/GWSAMPLE_BASIC/;InitiateOAuth=GETANDREFRESH;
	query: "SELECT ProductID, Quantity FROM SalesOrderLineItems WHERE [RecordId] = 1"
out: 
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "SalesOrderLineItems"
	mode: insert

More Information & Free Trial

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