Ready to get started?

Download a free trial of the SAP Business One Driver to get started:

 Download Now

Learn more:

SAP Business One Icon SAP Business One JDBC Driver

Straightforward SAP Business One integration. Now accessing SAP Business One Accounts, Activities, Orders, Customers, etc. from any JDBC client is as easy as querying a database.

Create a Data Access Object for SAP Business One Data using JDBI

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

Create a DAO for the SAP Business One Orders 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 MyOrdersDAO { //insert new data into SAP Business One @SqlUpdate("INSERT INTO Orders (DocType, DocType) values (:docType, :docType)") void insert(@Bind("docType") String docType, @Bind("docType") String docType); //request specific data from SAP Business One (String type is used for simplicity) @SqlQuery("SELECT DocType FROM Orders WHERE DocType = :docType") String findDocTypeByDocType(@Bind("docType") String docType); /* * close with no args is used to close the connection */ void close(); }

Open a Connection to SAP Business One

Collect the necessary connection properties and construct the appropriate JDBC URL for connecting to SAP Business One.

To authenticate to SAP Business One you must provide the Userand Passwordproperties.

To connect to data, specify Url. This is your SAP Business One Service Layer root URL.

Built-in Connection String Designer

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

java -jar cdata.jdbc.sapbusinessone.jar

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

A connection string for SAP Business One 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:sapbusinessone:Url=http://localhost:50000/b1s/v1;User=username;Password=password;CompanyDB=dbname;InitiateOAuth=GETANDREFRESH"); MyOrdersDAO dao =; //do stuff with the DAO dao.close();

Read SAP Business One Data

With the connection open to SAP Business One, simply call the previously defined method to retrieve data from the Orders entity in SAP Business One.

//disply the result of our 'find' method String docType = dao.findDocTypeByDocType("dDocument_Items"); System.out.println(docType);

Write SAP Business One Data

It is also simple to write data to SAP Business One, using the previously defined method.

//add a new entry to the Orders entity dao.insert(newDocType, newDocType);

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