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

Create a DAO for the Anaplan Sales 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 MySalesDAO {
  //request specific data from Anaplan (String type is used for simplicity)
  @SqlQuery("SELECT Product FROM Sales WHERE Value = :value")
  String findProductByValue(@Bind("value") String value);

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

Open a Connection to Anaplan

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

Authenticating to Anaplan

The driver supports authenticating with Basic, Certificate, or OAuth. In every case, set Region to the region where your Anaplan account data is hosted (e.g., US1, which is the default).

Using Basic Authentication

Set AuthScheme to Basic, then supply your Anaplan User and Password. If your workspace uses single sign-on (SSO), you must be assigned as an Exception User to use Basic authentication.

Using Certificate Authentication

Set AuthScheme to Certificate, then supply the Certificate, CertificateType, and PrivateKey properties (and the matching CertificatePassword / PrivateKeyPassword if either is encrypted). The certificate must be a CA-issued X.509 certificate registered with your Anaplan tenant administrator.

Using OAuth Authentication

Register a custom OAuth application in Anaplan, then set the following properties:

• OAuthClientId: The client Id assigned when you registered your custom OAuth application.
• OAuthClientSecret: The client secret assigned when you registered your custom OAuth application.
• CallbackURL: The redirect URI defined when you registered your application.
• InitiateOAuth: Set to GETANDREFRESH to have the driver manage the OAuth token exchange and refresh automatically.

See the Getting Started chapter of the help documentation for a guide to creating a custom OAuth app and using OAuth.

Built-in Connection String Designer

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

java -jar cdata.jdbc.anaplan.jar

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

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

jdbc:anaplan:OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackURL=your_callback_url;Region=US1;InitiateOAuth=GETANDREFRESH;

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:anaplan:OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackURL=your_callback_url;Region=US1;InitiateOAuth=GETANDREFRESH;");
MySalesDAO dao = dbi.open(MySalesDAO.class);

//do stuff with the DAO

dao.close();

Read Anaplan Data

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

//disply the result of our 'find' method
String product = dao.findProductByValue("100");
System.out.println(product);

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