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

Create a DAO for the Pipeliner CRM Account 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 MyAccountDAO {
  //request specific data from Pipeliner CRM (String type is used for simplicity)
  @SqlQuery("SELECT Id FROM Account WHERE Name = :name")
  String findIdByName(@Bind("name") String name);

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

Open a Connection to Pipeliner CRM

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

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

Pipeliner CRM API Profile Settings

Navigate to Administration > Obtain API Key within your Pipeliner CRM workspace to retrieve the API Token, API Password, Space ID, and Service URL.

Built-in Connection String Designer

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

jdbc:api:Profile=C:\profiles\Pipeliner.apip;ProfileSettings='User=your_api_token;Password=your_api_password;SpaceId=your_space_id;ServiceUrl=your_service_url';

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\Pipeliner.apip;ProfileSettings='User=your_api_token;Password=your_api_password;SpaceId=your_space_id;ServiceUrl=your_service_url';");
MyAccountDAO dao = dbi.open(MyAccountDAO.class);

//do stuff with the DAO

dao.close();

Read Pipeliner CRM Data

With the connection open to Pipeliner CRM, simply call the previously defined method to retrieve data from the Account entity in Pipeliner CRM.

//disply the result of our 'find' method
String id = dao.findIdByName("Acme Corporation");
System.out.println(id);

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