How to connect to Epicor Kinetic Data from IntelliJ

The CData JDBC Driver for Epicor Kinetic enables you to access Epicor Kinetic as a JDBC data source, providing integration with rapid development tools in IDEs. This article shows how to use the data source configuration wizard to connect to Epicor Kinetic data in IntelliJ.

Create a JBDC Data Source for Epicor Kinetic

Follow the steps below to add the driver JAR and define connection properties required to connect to Epicor Kinetic data.

1. In the Data Sources window, right-click and then click Add Data Source -> DB Data Source.

2. In the Data Source Properties dialog that appears, the following properties are required:

   • JDBC Driver Files: Click the button next to this menu to add the JDBC Driver file cdata.jdbc.epicorkinetic.jar, located in the installation directory.
   • JDBC Driver Class: In this menu, select cdata.jdbc.epicorkinetic.epicorKineticDriver from the list.

   • Database URL: Enter the connection URL in the JDBC URL property. The URL must start with jdbc:epicorkinetic: and includes connection properties separated with semicolons.

     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 the following:

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

Edit and Save Epicor Kinetic Data

To discover schema information, right-click the data source you just created and click Refresh Tables. To query a table, right-click it and then click Open Tables Editor. You can also modify records in the Table Editor.