Connect to Epicor Kinetic Data in DBeaver

The CData JDBC Driver for Epicor Kinetic implements JDBC standards that enable third-party tools to interoperate, from wizards in IDEs to business intelligence tools. This article shows how to connect to Epicor Kinetic data with wizards in DBeaver and browse data in the DBeaver GUI.

Create a JDBC Data Source for Epicor Kinetic Data

Follow the steps below to load the driver JAR in DBeaver.

1. Open the DBeaver application and, in the Databases menu, select the Driver Manager option. Click New to open the Create New Driver form.
2. In the Driver Name box, enter a user-friendly name for the driver.
3. To add the .jar, click Add File.
4. In the create new driver dialog that appears, select the cdata.jdbc.epicorkinetic.jar file, located in the lib subfolder of the installation directory.
5. Click the Find Class button and select the epicorKineticDriver class from the results. This will automatically fill the Class Name field at the top of the form. The class name for the driver is cdata.jdbc.epicorkinetic.epicorKineticDriver.
6. Add jdbc:epicorkinetic: in the URL Template field.

Create a Connection to Epicor Kinetic Data

Follow the steps below to add credentials and other required connection properties.

1. In the Databases menu, click New Connection.
2. In the Create new connection wizard that results, select the driver.
3. On the next page of the wizard, click the driver properties tab.

4. Enter values for authentication credentials and other properties required to connect to Epicor Kinetic.

   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 typical connection string:

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

Query Epicor Kinetic Data

You can now query information from the tables exposed by the connection: Right-click a Table and then click Edit Table. The data is available on the Data tab.