Create a Data Access Object for Acumatica Data using JDBI

JDBI is a SQL convenience library for Java that exposes two different style APIs, a fluent style and a SQL object style. The CData JDBC Driver for Acumatica integrates connectivity to live Acumatica data in Java applications. By pairing these technologies, you gain simple, programmatic access to Acumatica data. This article explains how to build a basic Data Access Object (DAO) and the accompanying code to read and write Acumatica data.

Create a DAO for the Acumatica Events Entity

The interface below declares the desired behavior for the SQL object to create a single method for each SQL statement to be implemented.

public interface MyEventsDAO {
 //insert new data into Acumatica
 @SqlUpdate("INSERT INTO Events (Id, location_displayname) values (:id, :location_displayname)")
 void insert(@Bind("id") String id, @Bind("location_displayname") String location_displayname);

 //request specific data from Acumatica (String type is used for simplicity)
 @SqlQuery("SELECT location_displayname FROM Events WHERE Id = :id")
 String findlocation_displaynameById(@Bind("id") String id);

 /*
 * close with no args is used to close the connection
 */
 void close();
}

Open a Connection to Acumatica

Collect the necessary connection properties and construct the appropriate JDBC URL for connecting 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.

A connection string for Acumatica will typically look like the following:

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

Use the configured JDBC URL to obtain an instance of the DAO interface. The particular method shown below will open a handle bound to the instance, so the instance needs to be closed explicitly to release the handle and the bound JDBC connection.

DBI dbi = new DBI("jdbc:acumatica:Url = https://try.acumatica.com/ISV/entity/Default/17.200.001/;User=user;Password=password;Company=CompanyName;");
MyEventsDAO dao = dbi.open(MyEventsDAO.class);

//do stuff with the DAO

dao.close();

Read Acumatica Data

With the connection open to Acumatica, simply call the previously defined method to retrieve data from the Events entity in Acumatica.

//disply the result of our 'find' method
String location_displayname = dao.findlocation_displaynameById("1");
System.out.println(location_displayname);

Write Acumatica Data

It is also simple to write data to Acumatica, using the previously defined method.

//add a new entry to the Events entity
dao.insert(newId, newlocation_displayname);

Since the JDBI library is able to work with JDBC connections, you can easily produce a SQL Object API for Acumatica by integrating with the CData JDBC Driver for Acumatica. Download a free trial and work with live Acumatica data in custom Java applications today.