Query Anaplan Data in DataGrip

DataGrip is a database IDE that allows SQL developers to query, create, and manage databases. When paired with the CData JDBC Driver for Anaplan, DataGrip can work with live Anaplan data. This article shows how to establish a connection to Anaplan data in DataGrip.

Create a New Driver Definition for Anaplan

The steps below describe how to create a new Data Source in DataGrip for Anaplan.

1. In DataGrip, click File -> New > Project and name the project
2. In the Database Explorer, click the plus icon () and select Driver.
3. In the Driver tab:
   • Set Name to a user-friendly name (e.g. "CData Anaplan Driver")
   • Set Driver Files to the appropriate JAR file. To add the file, click the plus (), select "Add Files," navigate to the "lib" folder in the driver's installation directory and select the JAR file (e.g. cdata.jdbc.anaplan.jar).
   • Set Class to cdata.jdbc.anaplan.Anaplan.jar
   Additionally, in the advanced tab you can change driver properties and some other settings like VM Options, VM environment, VM home path, DBMS, etc
   • For most cases, change the DBMS type to "Unknown" in Expert options to avoid native SQL Server queries (Transact-SQL), which might result in an invalid function error
4. Click "Apply" then "OK" to save the Connection

Configure a Connection to Anaplan

1. Once the connection is saved, click the plus (), then "Data Source" then "CData Anaplan Driver" to create a new Anaplan Data Source.
2. In the new window, configure the connection to Anaplan with a JDBC URL.

   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.

   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.

   
3. Set URL to the connection string, e.g.,

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

4. Click "Apply" and "OK" to save the connection string

At this point, you will see the data source in the Data Explorer.

Execute SQL Queries Against Anaplan

To browse through the Anaplan entities (available as tables) accessible through the JDBC Driver, expand the Data Source.

To execute queries, right click on any table and select "New" -> "Query Console."

In the Console, write the SQL query you wish to execute. For example:

SELECT Region, Product FROM [Workspace].[Model].[Sales] WHERE Value = '100'

Download a free, 30-day trial of the CData JDBC Driver for Anaplan and start working with your live Anaplan data in DataGrip. Reach out to our Support Team if you have any questions.