Create a Data Access Object for OnePageCrm 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 OnePageCrm integrates connectivity to live OnePageCrm data in Java applications. By pairing these technologies, you gain simple, programmatic access to OnePageCrm data. This article explains how to build a basic Data Access Object (DAO) and the accompanying code to read OnePageCrm data.

Create a DAO for the OnePageCrm Actions 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 MyActionsDAO {
  //request specific data from OnePageCrm (String type is used for simplicity)
  @SqlQuery("SELECT ContactId FROM Actions WHERE Status = :status")
  String findContactIdByStatus(@Bind("status") String status);

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

Open a Connection to OnePageCrm

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

Start by setting the Profile connection property to the location of the OnePageCrm Profile on disk (e.g. C:\profiles\OnePageCrm.apip). Next, set the ProfileSettings connection property to the connection string for OnePageCrm (see below).

OnePageCrm API Profile Settings

In your OnePageCRM account, go to Apps and Integrations > API (Developer Access) > Configuration to find your User ID and API Key.

Built-in Connection String Designer

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

java -jar cdata.jdbc.api.jar

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

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

jdbc:api:Profile=C:\profiles\OnePageCrm.apip;ProfileSettings='User=your_user_id;Password=your_api_key';

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:api:Profile=C:\profiles\OnePageCrm.apip;ProfileSettings='User=your_user_id;Password=your_api_key';");
MyActionsDAO dao = dbi.open(MyActionsDAO.class);

//do stuff with the DAO

dao.close();

Read OnePageCrm Data

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

//disply the result of our 'find' method
String contactId = dao.findContactIdByStatus("done");
System.out.println(contactId);

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