Using the CData ODBC Driver for Epicor Kinetic in PyCharm

The CData ODBC Drivers can be used in any environment that supports loading an ODBC Driver. In this tutorial we will explore using the CData ODBC Driver for Epicor Kinetic from within PyCharm. Included are steps for adding the CData ODBC Driver as a data source, as well as basic PyCharm code to query the data source and display results.

To begin, this tutorial will assume that you have already installed the CData ODBC Driver for Epicor Kinetic as well as PyCharm.

Add Pyodbc to the Project

Follow the steps below to add the pyodbc module to your project.

1. Click File -> Settings to open the project settings window.
2. Click Project Interpreter from the Project: YourProjectName menu.
3. To add pyodbc, click the + button and enter pyodbc.
4. Click Install Package to install pyodbc.

Connect to Epicor Kinetic

You can now connect with an ODBC connection string or a DSN. See the Getting Started section in the CData driver documentation for a guide to creating a DSN on your OS.

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.

Below is the syntax for a DSN:

[CData EpicorERP Source]
Driver = CData ODBC Driver for Epicor Kinetic
Description = My Description
Service = Erp.BO.CustomerSvc
ERPInstance = MyInstance
URL = https://myaccount.epicorsaas.com
User = username
Password = password
InitiateOAuth = GETANDREFRESH

Execute SQL to Epicor Kinetic

Instantiate a Cursor and use the execute method of the Cursor class to execute any SQL statement.

import pyodbc

cnxn = pyodbc.connect('DRIVER={CData ODBC Driver for EpicorERP};Service = Erp.BO.CustomerSvc;ERPInstance = MyInstance;URL = https://myaccount.epicorsaas.com;User = username;Password = password;InitiateOAuth = GETANDREFRESH;')
cursor = cnxn.cursor()
cursor.execute("SELECT CustNum, Company FROM Customers WHERE CompanyName = 'CompanyName'")
rows = cursor.fetchall()
for row in rows:
 print(row.CustNum, row.Company)

After connecting to Epicor Kinetic in PyCharm using the CData ODBC Driver, you will be able to build Python apps with access to Epicor Kinetic data as if it were a standard database. If you have any questions, comments, or feedback regarding this tutorial, please contact us at [email protected].