Learn more
 

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!

In this article

Related articles

Use JayDeBeApi to access Epicor Kinetic Data in Python


Use standard Python scripting and the development environment of your choice to access live Epicor Kinetic data.

Access Epicor Kinetic data with Python scripts and standard SQL on any machine where Python and Java can be installed. You can use the CData JDBC Driver for Epicor Kinetic and the JayDeBeApi module to work with remote Epicor Kinetic data in Python. By using the CData Driver, you are leveraging a driver written for industry-proven standards to access your data in the popular Python language. This article shows how to use the driver to execute SQL queries to Epicor Kinetic and visualize Epicor Kinetic data with standard Python.

Use the JayDeBeApi module

JayDeBeApi is a Python library that serves as a JDBC (Java Database Connectivity) bridge, allowing Python programs to interact with Java databases, including CData JDBC Drivers. Use the pip install command to install the module:

pip install JayDeBeApi

Create the JDBC URL

Once you have JayDeBeApi installed, you are ready to work with Epicor Kinetic data in Python using SQL.

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 sample variable assignment, including a typical JDBC connection string:

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

Access Epicor Kinetic data in Python

With the JDBC URL configured, you only need the absolute path to the JDBC driver JAR file, which is in the "lib" folder in the installation directory ("C:\Program Files\CData[product_name] 20XX\lib\cdata.jdbc.epicorkinetic.jar" on Windows).

NOTE: If you haven't already, set the JAVA_HOME environment variable to the Java installation directory.

Use code similar to the follow to read and print data from Epicor Kinetic:

import jaydebeapi #The JDBC connection string jdbc_url = "jdbc:epicorkinetic:Service=Erp.BO.CustomerSvc;ERPInstance=MyInstance;URL=https://myaccount.epicorsaas.com;User=username;Password=password;InitiateOAuth=GETANDREFRESH" username = "****" password = "****" #The absolute Path to the JDBC driver JAR file, typically: jdbc_driver_jar = "C:\Program Files\CData[product_name] 20XX\lib\cdata.jdbc.epicorkinetic.jar" conn = jaydebeapi.connect( "cdata.jdbc.epicorkinetic.jar", jdbc_url, [username, password], jdbc_driver_jar, ) cursor = conn.cursor() cursor.execute("SELECT * FROM Customers;") results = cursor.fetchall() for row in results: print(row) cursor.close() conn.close()

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 Python. Reach out to our Support Team if you have any questions.