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

Create a DAO for the Clari Calls 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 MyCallsDAO {
  //request specific data from Clari (String type is used for simplicity)
  @SqlQuery("SELECT SourceId FROM Calls WHERE Status = :status")
  String findSourceIdByStatus(@Bind("status") String status);

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

Open a Connection to Clari

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

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

Clari API Profile Settings

Obtain your API Key and API Secret from Clari workspace settings under Integrations > Clari Copilot API.

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the Clari 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 Clari will typically look like the following:

jdbc:api:Profile=C:\profiles\Clari.apip;ProfileSettings='APIKey=your_api_key;APISecret=your_api_secret';

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\Clari.apip;ProfileSettings='APIKey=your_api_key;APISecret=your_api_secret';");
MyCallsDAO dao = dbi.open(MyCallsDAO.class);

//do stuff with the DAO

dao.close();

Read Clari Data

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

//disply the result of our 'find' method
String sourceId = dao.findSourceIdByStatus("completed");
System.out.println(sourceId);

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