Ready to get started?

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

Download Now

Connect to Epicor ERP Data in Aqua Data Studio

Access Epicor ERP data from tools in Aqua Data Studio such as the Visual Query Builder and the Table Data Editor.

The CData JDBC Driver for Epicor ERP integrates Epicor ERP data with wizards and analytics in IDEs like Aqua Data Studio. This article shows how to connect to Epicor ERP data through the connection manager and execute queries.

Create a JDBC Data Source

You can use the connection manager to define connection properties and save them in a new JDBC data source. The Epicor ERP data source can then be accessed from Aqua Data Studio tools.

  1. In Aqua Data Studio, select Register Server from the Servers menu.
  2. In the Register Server form, select the 'Generic - JDBC' connection.
  3. Enter the following JDBC connection properties:
    • Name: Enter a name for the data source; for example, Epicor ERP.
    • Driver Location: Click the Browse button and select the cdata.jdbc.epicorerp.jar file, located in the lib subfolder of the installation directory.
    • Driver: Enter the Driver's class name, cdata.jdbc.epicorerp.EpicorERPDriver.
    • URL: Enter the JDBC URL, which starts with jdbc:epicorerp: and is followed by a semicolon-separated list of connection properties.

      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 ERP JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

      java -jar cdata.jdbc.epicorerp.jar

      Fill in the connection properties and copy the connection string to the clipboard.

      A typical JDBC URL is below:

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

Query Epicor ERP Data

You can now query the tables exposed.