Ready to get started?

Learn more about the CData ODBC Driver for Epicor ERP or download a free trial:

Download Now

Query Epicor ERP Data in MySQL Workbench

Execute MySQL queries against live Epicor ERP data from MySQL Workbench.

You can use the SQL Gateway from the ODBC Driver for Epicor ERP to query Epicor ERP data through a MySQL interface. Follow the procedure below to start the MySQL remoting service of the SQL Gateway and work with live Epicor ERP data in MySQL Workbench.

Connect to Epicor ERP 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 ERP 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.

Query Epicor ERP from MySQL Workbench

The steps below outline connecting to the virtual Epicor ERP database created in the SQL Gateway from MySQL Workbench and issuing basic queries to work with live Epicor ERP data.

Connect to Epicor ERP through the SQL Gateway

  1. In MySQL Workbench, click to add a new MySQL connection.
  2. Name the connection (CData SQL Gateway for Epicor ERP).
  3. Set the Hostname, Port, and Username parameters to connect to the SQL Gateway.
  4. Click Store in Vault to set and store the password.
  5. Click Test Connection to ensure the connection is configured properly and click OK.

Query Epicor ERP Data

  1. Open the connection you just created (CData SQL Gateway for Epicor ERP).
  2. Click File -> New Query Tab.
  3. Write a SQL query to retrieve Epicor ERP data, like SELECT * FROM `CData EpicorERP Sys`.Customers;

With access to live Epicor ERP data from MySQL Workbench, you can easily query and update Epicor ERP, just like you would a MySQL database. Get started now with a free, 30-day trial of the CData ODBC Driver for Epicor ERP and the CData SQL Gateway.