Create a Data Access Object for Exact Online Data using JDBI

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Exact Online JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Exact Online account data including Contacts, Opportunities, Accounts, and more!



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

Create a DAO for the Exact Online Accounts 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 MyAccountsDAO { //insert new data into Exact Online @SqlUpdate("INSERT INTO Accounts (IsCompetitor, CreditLinePurchase) values (:isCompetitor, :creditLinePurchase)") void insert(@Bind("isCompetitor") String isCompetitor, @Bind("creditLinePurchase") String creditLinePurchase); //request specific data from Exact Online (String type is used for simplicity) @SqlQuery("SELECT CreditLinePurchase FROM Accounts WHERE IsCompetitor = :isCompetitor") String findCreditLinePurchaseByIsCompetitor(@Bind("isCompetitor") String isCompetitor); /* * close with no args is used to close the connection */ void close(); }

Open a Connection to Exact Online

Collect the necessary connection properties and construct the appropriate JDBC URL for connecting to Exact Online.

Exact Online uses the OAuth authentication standard. The InitiateOAuth connection property facilitates the OAuth flow -- by default, this is set to GETANDREFRESH. You can also use the embedded OAuth credentials or you can register an OAuth app with Exact to obtain your own. In addition to the OAuth values, provide the Region. If Division is not set, the default Division is determined.

See the "Getting Started" chapter of the help documentation for more information.

Built-in Connection String Designer

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

java -jar cdata.jdbc.exactonline.jar

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

A connection string for Exact Online will typically look like the following:

jdbc:exactonline:Region='United States';Division=5512;InitiateOAuth=GETANDREFRESH

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:exactonline:Region='United States';Division=5512;InitiateOAuth=GETANDREFRESH"); MyAccountsDAO dao = dbi.open(MyAccountsDAO.class); //do stuff with the DAO dao.close();

Read Exact Online Data

With the connection open to Exact Online, simply call the previously defined method to retrieve data from the Accounts entity in Exact Online.

//disply the result of our 'find' method String creditLinePurchase = dao.findCreditLinePurchaseByIsCompetitor("False"); System.out.println(creditLinePurchase);

Write Exact Online Data

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

//add a new entry to the Accounts entity dao.insert(newIsCompetitor, newCreditLinePurchase);

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