Create a Data Access Object for Sage 300 Data using JDBI

Ready to get started?

Download a free trial:

Download Now

Learn more:

Sage 300 JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Sage 300.

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

Create a DAO for the Sage 300 OEInvoices 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 MyOEInvoicesDAO { //request specific data from Sage 300 (String type is used for simplicity) @SqlQuery("SELECT ApprovedLimit FROM OEInvoices WHERE AllowPartialShipments = :allowPartialShipments") String findApprovedLimitByAllowPartialShipments(@Bind("allowPartialShipments") String allowPartialShipments); /* * close with no args is used to close the connection */ void close(); }

Open a Connection to Sage 300

Collect the necessary connection properties and construct the appropriate JDBC URL for connecting to Sage 300.

Sage 300 requires some initial setup in order to communicate over the Sage 300 Web API.

  • Set up the security groups for the Sage 300 user. Give the Sage 300 user access to the option under Security Groups (per each module required).
  • Edit both web.config files in the /Online/Web and /Online/WebApi folders; change the key AllowWebApiAccessForAdmin to true. Restart the webAPI app-pool for the settings to take.
  • Once the user access is configured, click https://server/Sage300WebApi/ to ensure access to the web API.

Authenticate to Sage 300 using Basic authentication.

Connect Using Basic Authentication

You must provide values for the following properties to successfully authenticate to Sage 300. Note that the provider reuses the session opened by Sage 300 using cookies. This means that your credentials are used only on the first request to open the session. After that, cookies returned from Sage 300 are used for authentication.

  • Url: Set this to the url of the server hosting Sage 300. Construct a URL for the Sage 300 Web API as follows: {protocol}://{host-application-path}/v{version}/{tenant}/ For example, http://localhost/Sage300WebApi/v1.0/-/.
  • User: Set this to the username of your account.
  • Password: Set this to the password of your account.

Built-in Connection String Designer

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

java -jar cdata.jdbc.sage300.jar

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

A connection string for Sage 300 will typically look like the following:


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:sage300:User=SAMPLE;Password=password;URL=;Company=SAMINC;"); MyOEInvoicesDAO dao =; //do stuff with the DAO dao.close();

Read Sage 300 Data

With the connection open to Sage 300, simply call the previously defined method to retrieve data from the OEInvoices entity in Sage 300.

//disply the result of our 'find' method String approvedLimit = dao.findApprovedLimitByAllowPartialShipments("Yes"); System.out.println(approvedLimit);

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