Connect to Anaplan Data in RapidMiner

This article shows how you can easily integrate the CData JDBC driver for Anaplan into your processes in RapidMiner. This article uses the CData JDBC Driver for Anaplan to transfer Anaplan data to a process in RapidMiner.

Connect to Anaplan in RapidMiner as a JDBC Data Source

You can follow the procedure below to establish a JDBC connection to Anaplan:

1. Add a new database driver for Anaplan: Click Connections -> Manage Database Drivers.
2. In the resulting wizard, click the Add button and enter a name for the connection.
3. Enter the prefix for the JDBC URL:

   jdbc:anaplan:
   

4. Enter the path to the cdata.jdbc.anaplan.jar file, located in the lib subfolder of the installation directory.
5. Enter the driver class:

   cdata.jdbc.anaplan.AnaplanDriver
   

   
6. Create a new Anaplan connection: Click Connections -> Manage Database Connections.
7. Enter a name for your connection.
8. For Database System, select the Anaplan driver you configured previously.
9. Enter your connection string in the Host box.

   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 connection string is below:

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

10. Enter your username and password if necessary.

You can now use your Anaplan connection with the various RapidMiner operators in your process. To retrieve Anaplan data, drag the Retrieve operator from the Operators view. With the Retrieve operator selected, you can then define which table to retrieve in the Parameters view by clicking the folder icon next to the "repository entry." In the resulting Repository Browser, you can expand your connection node to select the desired example set.

Finally, wire the output to the Retrieve process to a result, and run the process to see the Anaplan data.