Query Epicor Kinetic Data as a MySQL Database in Node.js

You can use the SQL Gateway from the ODBC Driver for Epicor Kinetic to query Epicor Kinetic data through a MySQL interface. Follow the procedure below to start the MySQL remoting service of the SQL Gateway and start querying using Node.js.

Connect to Epicor Kinetic Data

If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can use the built-in Microsoft ODBC Data Source Administrator to configure the DSN. This is also the last step of the driver installation. See the "Getting Started" chapter in the help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.

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.

Configure the SQL Gateway

See the SQL Gateway Overview to set up connectivity to Epicor Kinetic data as a virtual MySQL database. You will configure a MySQL remoting service that listens for MySQL requests from clients. The service can be configured in the SQL Gateway UI.

👁 Creating a MySQL Remoting Service in SQL Gateway (Salesforce is shown)

Query Epicor Kinetic from Node.js

The following example shows how to define a connection and execute queries to Epicor Kinetic with the mysql module. You will need the following information:

• Host name or address, and port: The machine and port where the MySQL remoting service is listening for MySQL connections.
• Username and password: The username and password of a user you authorized on the Users tab of the SQL Gateway.
• Database name: The DSN you configured for the MySQL remoting service.

Connect to Epicor Kinetic data and start executing queries with the code below:

var mysql = require('mysql');
var connection = mysql.createConnection({
 host : 'localhost',
 database : 'CData EpicorERP Sys',
 port	 : '3306',
 user : 'mysql_user',
 password : 'test'
});
connection.connect();
connection.query('SELECT * FROM Customers', function(err, rows, fields) {
 if (err) throw err;
 console.log(rows);
});

connection.end();