Ready to get started?

Download a free trial of the Epicor Kinetic Driver to get started:

 Download Now

Learn more:

Epicor Kinetic Icon Epicor Kinetic JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Epicor Kinetic data, including Sales Orders, Purchase Orders, Accounts, and more!

Load Epicor Kinetic Data to a Database Using Embulk



Use CData JDBC Driver for Epicor Kinetic with the open source ETL/ELT tool Embulk to load Epicor Kinetic data to a database.

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

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

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

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

To successfully connect to your ERP instance, you must specify the following connection properties:

  • Url:the URL of the server hosting your ERP instance. For example, https://myserver.EpicorSaaS.com
  • ERPInstance: the name of your ERP instance.
  • User: the username of your account.
  • Password: the password of your account.
  • Service: the service you want to retrieve data from. For example, BaqSvc.

In addition, you may also set the optional connection properties:

  • ApiKey: An optional key that may be required for connection to some services depending on your account configuration.
  • ApiVersion: Defaults to v1. May be set to v2 to use the newer Epicor API.
  • Company: Required if you set the ApiVersion to v2.

Built-in Connection String Designer

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

java -jar cdata.jdbc.epicorkinetic.jar

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

Below is a typical JDBC connection string for Epicor Kinetic:

jdbc:epicorkinetic:Service=Erp.BO.CustomerSvc;ERPInstance=MyInstance;URL=https://myaccount.epicorsaas.com;User=username;Password=password;InitiateOAuth=GETANDREFRESH

Load Epicor Kinetic 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
  2. embulk gem install embulk-input-jdbc
  3. 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 Epicor Kinetic data into MySQL using Embulk.

Create a Job to Load Epicor Kinetic Data

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

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

Sample Config File (epicorkinetic-mysql.yml)

in: type: jdbc driver_path: C:\Program Files\CData\CData JDBC Driver for Epicor Kinetic 20xx\lib\cdata.jdbc.epicorkinetic.jar driver_class: cdata.jdbc.epicorkinetic.epicorKineticDriver url: jdbc:epicorkinetic:Service=Erp.BO.CustomerSvc;ERPInstance=MyInstance;URL=https://myaccount.epicorsaas.com;User=username;Password=password;InitiateOAuth=REFRESH table: "Customers" out: type: mysql host: localhost database: DatabaseName user: UserId password: UserPassword table: "Customers" mode: insert

After creating the file, run the Embulk job.

embulk run epicorkinetic-mysql.yml

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

Load Filtered Epicor Kinetic 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\CData JDBC Driver for Epicor Kinetic 20xx\lib\cdata.jdbc.epicorkinetic.jar driver_class: cdata.jdbc.epicorkinetic.epicorKineticDriver url: jdbc:epicorkinetic:Service=Erp.BO.CustomerSvc;ERPInstance=MyInstance;URL=https://myaccount.epicorsaas.com;User=username;Password=password;InitiateOAuth=REFRESH query: "SELECT CustNum, Company FROM Customers WHERE [RecordId] = 1" out: type: mysql host: localhost database: DatabaseName user: UserId password: UserPassword table: "Customers" mode: insert

More Information & Free Trial

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