Access Live Epicor Kinetic Data in Coginiti Pro



Connect to and query live Epicor Kinetic data from the GUI in the Coginiti Pro: SQL Analytics Tool.

Coginiti Pro is a single tool for all your SQL data and analytics needs, designed specifically for data engineers, analysts, and data scientists. When paired with the CData JDBC Driver for Epicor Kinetic, Coginiti Pro can access and query live Epicor Kinetic data. This article describes how to connect to and query Epicor Kinetic data from Coginiti Pro.

With built-in optimized data processing, the CData JDBC Driver for Epicor Kinetic 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). In addition, its built-in dynamic metadata querying allows you to work with and analyze Epicor Kinetic data using native data types.

Gather Connection Properties and Build a Connection String

Download the CData JDBC Driver for Epicor Kinetic installer, unzip the package, and run the JAR file to install the driver. Then gather the required connection properties.

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.

NOTE: To use the JDBC driver in Coginiti Pro, you may need a license (full or trial) and a Runtime Key (RTK). For more information on obtaining this license (or a trial), contact our sales team.

Built-in Connection String Designer

For assistance constructing the JDBC URL, use the connection string designer built into the Epicor Kinetic JDBC Driver. 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 (including the RTK) and copy the connection string to the clipboard.

Create a JDBC Data Source for Epicor Kinetic Data

  1. Open Coginiti Pro and in the File menu, select "Edit Drivers."
  2. In the newly opened wizard, click "Add" and select "Generic."
  3. In the "JDBC Drivers" wizard, set the driver properties (below) and click "Create Driver."

    • Set JDBC Driver Name to a useful name, like CData JDBC Driver for Epicor Kinetic.
    • Click "Add Files" to add the JAR file from the "lib" folder in the installation directory (e.g. cdata.jdbc.epicorkinetic.jar)
    • Select the Class Name: cdata.jdbc.epicorkinetic.epicorKineticDriver.

Create a Connection using the CData JDBC Driver for Epicor Kinetic

  1. In the File menu, click "Edit Connections."
  2. In the newly opened wizard, click "Add" and select "Generic."
  3. In the "Connections" wizard, set the connection properties.
    • Set Connection name to an identifying name.
    • Set Database JDBC driver to the Driver you configured earlier.
    • Set JDBC URL to the JDBC URL configured using the built-in connection string designer (e.g. jdbc:epicorkinetic:Service=Erp.BO.CustomerSvc;ERPInstance=MyInstance;URL=https://myaccount.epicorsaas.com;User=username;Password=password;InitiateOAuth=GETANDREFRESH
  4. Click "Test" to ensure the connection is configured properly. Click "Save."

Query Epicor Kinetic Using SQL

  1. Open the Connections tab by clicking on database icon: .
  2. Click the plus sign () to add a new query tab.
  3. Once the query console is open, write the SQL script you wish to execute and click "Run at Cursor".

    NOTE: You can use the explorer on the left to determine table/view names and column names.

    Using the explorer

    1. In the "Select connection" field, select the connection you wish to query.
    2. Expand your newly created connection, expand the "CData" catalog, and expand the Epicor Kinetic catalog.
    3. Expand "Tables" or "Views" to find the entity you wish to query.
    4. Expand your selected entity to explore the fields (columns).

Free Trial & More Information

Download a free, 30-day trial of the CData JDBC Driver for Epicor Kinetic and start working with your live Epicor Kinetic data in Coginiti Pro. Reach out to our Support Team if you have any questions.

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!