How to connect to Anaplan Data from IntelliJ

The CData JDBC Driver for Anaplan enables you to access Anaplan as a JDBC data source, providing integration with rapid development tools in IDEs. This article shows how to use the data source configuration wizard to connect to Anaplan data in IntelliJ.

Create a JBDC Data Source for Anaplan

Follow the steps below to add the driver JAR and define connection properties required to connect to Anaplan data.

1. In the Data Sources window, right-click and then click Add Data Source -> DB Data Source.

2. In the Data Source Properties dialog that appears, the following properties are required:

   • JDBC Driver Files: Click the button next to this menu to add the JDBC Driver file cdata.jdbc.anaplan.jar, located in the installation directory.
   • JDBC Driver Class: In this menu, select cdata.jdbc.anaplan.AnaplanDriver from the list.

   • Database URL: Enter the connection URL in the JDBC URL property. The URL must start with jdbc:anaplan: and includes connection properties separated with semicolons.

     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 typical JDBC URL is the following:

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

Edit and Save Anaplan Data

To discover schema information, right-click the data source you just created and click Refresh Tables. To query a table, right-click it and then click Open Tables Editor.