Ready to get started?

Download a free trial of the Dynamics GP Driver to get started:

 Download Now

Learn more:

Dynamics GP Icon Dynamics GP JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Dynamics GP account data including Vendors, Customers, Invoices, Quotes, and more!

Create a Data Access Object for Dynamics GP Data using JDBI

A brief overview of creating a SQL Object API for Dynamics GP data in 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 Dynamics GP integrates connectivity to live Dynamics GP data in Java applications. By pairing these technologies, you gain simple, programmatic access to Dynamics GP data. This article walks through building a basic Data Access Object (DAO) and the accompanying code to read and write Dynamics GP data.

Create a DAO for the Dynamics GP SalesInvoice 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 MySalesInvoiceDAO { //insert new data into Dynamics GP @SqlUpdate("INSERT INTO SalesInvoice (CustomerName, TotalAmount) values (:customerName, :totalAmount)") void insert(@Bind("customerName") String customerName, @Bind("totalAmount") String totalAmount); //request specific data from Dynamics GP (String type is used for simplicity) @SqlQuery("SELECT TotalAmount FROM SalesInvoice WHERE CustomerName = :customerName") String findTotalAmountByCustomerName(@Bind("customerName") String customerName); /* * close with no args is used to close the connection */ void close(); }

Open a Connection to Dynamics GP

Collect the necessary connection properties and construct the appropriate JDBC URL for connecting to Dynamics GP.

To authenticate set the User and Password connection properties.

To connect set the URL to the Web services endpoint; for example, http://{servername}:{port}/Dynamics/GPService. Additionally, set CompanyId; you can obtain this value in the company setup window: Click Tools -> Setup -> Company.

By default, data summaries are not returned to save performance. Set LookupIds to true to return details such as line items; however, note that entities must be retrieved one at a time.

Built-in Connection String Designer

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

java -jar cdata.jdbc.dynamicsgp.jar

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

A connection string for Dynamics GP will typically look like the following:

jdbc:dynamicsgp:CompanyId=mycompanyId;user=myuser;password=mypassword;URL= http://{servername}:{port}/Dynamics/GPService;

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:dynamicsgp:CompanyId=mycompanyId;user=myuser;password=mypassword;URL= http://{servername}:{port}/Dynamics/GPService;"); MySalesInvoiceDAO dao =; //do stuff with the DAO dao.close();

Read Dynamics GP Data

With the connection open to Dynamics GP, simply call the previously defined method to retrieve data from the SalesInvoice entity in Dynamics GP.

//disply the result of our 'find' method String totalAmount = dao.findTotalAmountByCustomerName("Bob"); System.out.println(totalAmount);

Write Dynamics GP Data

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

//add a new entry to the SalesInvoice entity dao.insert(newCustomerName, newTotalAmount);

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