Manage Epicor Kinetic Data in DBArtisan as a JDBC Source

The CData JDBC Driver for Epicor Kinetic seamlessly integrates Epicor Kinetic data into database management tools like DBArtisan by enabling you to access Epicor Kinetic data as a database. This article shows how to create a JDBC source for Epicor Kinetic in DBArtisan. You can then edit data visually and execute standard SQL.

Integrate Epicor Kinetic Data into DBArtisan Projects

Follow the steps below to register Epicor Kinetic data as a database instance in your project:

1. In DBArtisan, click Data Source -> Register Datasource.
2. Select Generic JDBC.
3. Click Manage.
4. In the resulting dialog, click New. Enter a name for the driver and click Add. In the resulting dialog, navigate to the driver JAR. The driver JAR is located in the lib subfolder of the installation directory.
5. In the Connection URL box, enter credentials and other required connection properties in the JDBC URL.

   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
6. Finish the wizard to connect to Epicor Kinetic data. Epicor Kinetic entities are displayed in the Datasource Explorer.

You can now work with Epicor Kinetic data as you work with any other database. See the driver help documentation for more information on the queries supported by the Epicor Kinetic API.