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!

Connect to Epicor Kinetic Data in CloverDX (formerly CloverETL)



Transfer Epicor Kinetic data using the visual workflow in the CloverDX data integration tool.

The CData JDBC Driver for Epicor Kinetic enables you to use the data transformation components in CloverDX (formerly CloverETL) to work with Epicor Kinetic as sources and destinations. In this article, you will use the JDBC Driver for Epicor Kinetic to set up a simple transfer into a flat file. The CData JDBC Driver for Epicor Kinetic enables you to use the data transformation components in CloverDX (formerly CloverETL) to work with Epicor Kinetic as sources and destinations. In this article, you will use the JDBC Driver for Epicor Kinetic to set up a simple transfer into a flat file.

Connect to Epicor Kinetic as a JDBC Data Source

  1. Create the connection to Epicor Kinetic data. In a new CloverDX graph, right-click the Connections node in the Outline pane and click Connections -> Create Connection. The Database Connection wizard is displayed.
  2. Click the plus icon to load a driver from a JAR. Browse to the lib subfolder of the installation directory and select the cdata.jdbc.epicorkinetic.jar file.
  3. Enter the JDBC URL.

    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.

    A typical JDBC URL is below:

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

Query Epicor Kinetic Data with the DBInputTable Component

  1. Drag a DBInputTable from the Readers selection of the Palette onto the job flow and double-click it to open the configuration editor.
  2. In the DB connection property, select the Epicor Kinetic JDBC data source from the drop-down menu.
  3. Enter the SQL query. For example: SELECT CustNum, Company FROM Customers WHERE CompanyName = 'CompanyName'

Write the Output of the Query to a UniversalDataWriter

  1. Drag a UniversalDataWriter from the Writers selection onto the jobflow.
  2. Double-click the UniversalDataWriter to open the configuration editor and add a file URL.
  3. Right-click the DBInputTable and then click Extract Metadata.
  4. Connect the output port of the DBInputTable to the UniversalDataWriter.
  5. In the resulting Select Metadata menu for the UniversalDataWriter, choose the Customers table. (You can also open this menu by right-clicking the input port for the UniversalDataWriter.)
  6. Click Run to write to the file.