Ready to get started?

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

Download Now

Connect to Acumatica Data in Aqua Data Studio

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

The CData JDBC Driver for Acumatica integrates Acumatica data with wizards and analytics in IDEs like Aqua Data Studio. This article shows how to connect to Acumatica 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 Acumatica 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, Acumatica.
    • Driver Location: Click the Browse button and select the cdata.jdbc.acumatica.jar file, located in the lib subfolder of the installation directory.
    • Driver: Enter the Driver's class name, cdata.jdbc.acumatica.AcumaticaDriver.
    • URL: Enter the JDBC URL, which starts with jdbc:acumatica: and is followed by a semicolon-separated list of connection properties.

      Set the following connection properties to connect to Acumatica:

      • User: Set this to your username.
      • Password: Set this to your password.
      • Company: Set this to your company.
      • Url: Set this to your Acumatica URL, in the format http://{Acumatica ERP instance URL}/entity/{Endpoint name}/{Endpoint version}/.
        For example: https://acumatica.com/entity/Default/17.200.001/

      See the Getting Started guide in the CData driver documentation for more information.

      Built-in Connection String Designer

      For assistance in constructing the JDBC URL, use the connection string designer built into the Acumatica JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

      java -jar cdata.jdbc.acumatica.jar

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

      A typical JDBC URL is below:

      jdbc:acumatica:Url = https://try.acumatica.com/ISV/entity/Default/17.200.001/;User=user;Password=password;Company=CompanyName;

Query Acumatica Data

You can now query the tables exposed.