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

Connect to Epicor Kinetic Data in JRuby


Create a simple JRuby app with access to live Epicor Kinetic data.

JRuby is a high-performance, stable, fully threaded Java implementation of the Ruby programming language. The CData JDBC Driver for Epicor Kinetic makes it easy to integrate connectivity to live Epicor Kinetic data in JRuby. This article shows how to create a simple JRuby app that connects to Epicor Kinetic data, executes a query, and displays the results.

Configure a JDBC Connection to Epicor Kinetic Data

Before creating the app, note the installation location for the JAR file for the JDBC Driver (typically C:\Program Files\CData\CData JDBC Driver for Epicor Kinetic\lib).

JRuby natively supports JDBC, so you can easily connect to Epicor Kinetic and execute SQL queries. Initialize the JDBC connection with the getConnection function of the java.sql.DriverManager class.

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 JDBC connection string for Epicor Kinetic:

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

Create a JRuby App with Connectivity to Epicor Kinetic Data

Create a new Ruby file (for example: epicorKineticSelect.rb) and open it in a text editor. Copy the following code into your file:

require 'java' require 'rubygems' require 'C:/Program Files/CData/CData JDBC Driver for Epicor Kinetic 2018/lib/cdata.jdbc.epicorkinetic.jar' url = "jdbc:epicorkinetic:Service=Erp.BO.CustomerSvc;ERPInstance=MyInstance;URL=https://myaccount.epicorsaas.com;User=username;Password=password;InitiateOAuth=GETANDREFRESH" conn = java.sql.DriverManager.getConnection(url) stmt = conn.createStatement rs = stmt.executeQuery("SELECT CustNum, Company FROM Customers") while (rs.next) do puts rs.getString(1) + ' ' + rs.getString(2) end

With the file completed, you are ready to display your Epicor Kinetic data with JRuby. To do so, simply run your file from the command line:

jruby -S epicorKineticSelect.rb

Writing SQL-92 queries to Epicor Kinetic allows you to quickly and easily incorporate Epicor Kinetic data into your own JRuby applications. Download a free trial today!