Connect to Acumatica Data in DBeaver

The CData JDBC Driver for Acumatica implements JDBC standards that enable third-party tools to interoperate, from wizards in IDEs to business intelligence tools. This article shows how to connect to Acumatica data with wizards in DBeaver and browse data in the DBeaver GUI.

Create a JDBC Data Source for Acumatica Data

Follow the steps below to load the driver JAR in DBeaver.

1. Open the DBeaver application and, in the Databases menu, select the Driver Manager option. Click New to open the Create New Driver form.
2. In the Driver Name box, enter a user-friendly name for the driver.
3. To add the .jar, click Add File.
4. In the create new driver dialog that appears, select the cdata.jdbc.acumatica.jar file, located in the lib subfolder of the installation directory.
5. Click the Find Class button and select the AcumaticaDriver class from the results. This will automatically fill the Class Name field at the top of the form. The class name for the driver is cdata.jdbc.acumatica.AcumaticaDriver.
6. Add jdbc:acumatica: in the URL Template field.

Create a Connection to Acumatica Data

Follow the steps below to add credentials and other required connection properties.

1. In the Databases menu, click New Connection.
2. In the Create new connection wizard that results, select the driver.
3. On the next page of the wizard, click the driver properties tab.

4. Enter values for authentication credentials and other properties required to connect to Acumatica.

   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.

   Below is a typical connection string:

   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 information from the tables exposed by the connection: Right-click a Table and then click Edit Table. The data is available on the Data tab.