Establishing a Connection

Creating a JDBC Data Source

You can create a JDBC data source to connect from your Java application, based on CData JDBC Driver for Anaplan.

Follow these steps:

Add the driver JAR file to the classpath. The JAR file is located in the installation directory's lib subfolder. Ensure that the .lic file is located in the same folder as the JAR file.
Provide the driver class. For example:
```
cdata.jdbc.anaplan.AnaplanDriver
```
Provide the JDBC URL. For example:
```
jdbc:anaplan:AuthScheme=Basic;[email protected];Password=password;
```
Or, if there is a conflict in your application between drivers using the same URL format, use this form to ensure that you are using the CData driver:
```
jdbc:cdata:anaplan:AuthScheme=Basic;[email protected];Password=password;
```
Ensure that the URL starts with either jdbc:anaplan: or jdbc:cdata:anaplan:. The URL can include any of the connection properties in name-value pairs separated with semicolons.

Connecting to Anaplan

To authenticate to Anaplan, you can use Basic, Certificate, or OAuth authentication.

Basic

Set the following connection properties to connect to Anaplan using Basic authentication:

AuthScheme: Set this to Basic.
User: Your Anaplan username.
Password: The password for your Anaplan account.
Region: The region where your account data is hosted.

Note: If your workspace uses single sign-on (SSO), you must be assigned as an Exception User to use Basic authentication.

Certificate

Set the following connection properties to connect to Anaplan using Certificate authentication:

AuthScheme: Set this to Certificate.
Certificate: The absolute path to the certificate file or the certificate content in PEM format encoded in Base64, depending on the value of CertificateType.
CertificateType: The type of Certificate.
CertificatePassword: The password for the certificate, if the certificate is password-protected.
PrivateKey: The absolute path to the private key file or the private key content in PEM format encoded in Base64, depending on the value of PrivateKeyType.
PrivateKeyType: The type of PrivateKey.
PrivateKeyPassword: The password for the private key, if the private key is encrypted.
Region: The region where your account data is hosted.

The certificate must be a CA-issued X.509 certificate that has been registered with your Anaplan tenant administrator.

OAuth

Desktop Applications

You must create a custom OAuth application. See Creating a Custom OAuth App for information about creating custom applications.

Get and Refresh the OAuth Access Token

After setting the following, you are ready to connect:

InitiateOAuth: GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
OAuthClientId: The client Id assigned when you registered your application.
OAuthClientSecret: The client secret assigned when you registered your application.
CallbackURL: The redirect URI defined when you registered your application.
Region: The region where your account data is hosted. Defaults to US1.

When you connect, the driver opens Anaplan's OAuth endpoint in your default browser. Log in and grant permissions to the application. The driver then completes the OAuth process:

The driver obtains an access token from Anaplan and uses it to request data.
The OAuth values are saved in the location specified in OAuthSettingsLocation. These values persist across connections.

The driver refreshes the access token automatically when it expires.

Web Applications

When connecting via a Web application, you need to register a custom OAuth application with Anaplan. You can then use the driver to get and manage the OAuth token values. See Creating a Custom OAuth App for more information.

Get an OAuth Access Token

Set the following connection properties to obtain the OAuthAccessToken:

OAuthClientId: The client Id in your application settings.
OAuthClientSecret: The client secret in your application settings.

Then call stored procedures to complete the OAuth exchange:

Call the GetOAuthAuthorizationUrl stored procedure. Set the AuthMode input to WEB and the CallbackURL according to requirements. The stored procedure returns the URL to the OAuth endpoint.
Navigate to the URL that the stored procedure returned in Step 1. Log in and authorize the web application. You are redirected back to the callback URL.
Call the GetOAuthAccessToken stored procedure. Set the AuthMode input to WEB. Set the Verifier input to the code parameter in the query string of the redirect URI.

After you have obtained the access and refresh tokens, you can connect to data and refresh the OAuth access token automatically.

Automatic Refresh of the OAuth Access Token

To have the driver automatically refresh the OAuth access token, set the following on the first data connection.

InitiateOAuth: REFRESH
OAuthClientId: The client Id in your application settings.
OAuthClientSecret: The client secret in your application settings.
OAuthAccessToken: The access token returned by GetOAuthAccessToken.
OAuthSettingsLocation: The location where you want the driver to save the OAuth values, which persist across connections.

On subsequent data connections, set the following:

Headless Machines

To configure the driver to use OAuth with a user account on a headless machine, you need to authenticate on another device that has an internet browser.

Choose one of two options:
- Option 1: Obtain the OAuthVerifier value as described in "Obtain and Exchange a Verifier Code" below.
- Option 2: Install the driver on a machine with an internet browser and transfer the OAuth authentication values after you authenticate through the usual browser-based flow, as described in "Transfer OAuth Settings" below.
Then configure the driver to automatically refresh the access token on the headless machine.

Option 1: Obtain and Exchange a Verifier Code

To obtain a verifier code, you must authenticate at the OAuth authorization URL.

Follow the steps below to authenticate from the machine with an internet browser and obtain the OAuthVerifier connection property.

Choose one of these options:
- If you are using the Embedded OAuth Application, call the GetOAuthAuthorizationUrl stored procedure. Open the URL returned by the stored procedure in a browser.
- If you are using a custom OAuth application, set the following properties:
  - InitiateOAuth: Set to OFF.
  - OAuthClientId: Set to the client Id assigned when you registered your application.
  - OAuthClientSecret: Set to the client secret assigned when you registered your application.
  Then call the GetOAuthAuthorizationUrl stored procedure with the appropriate CallbackURL. Open the URL returned by the stored procedure in a browser.
Log in and grant permissions to the driver. You are then redirected to the redirect URI. There will be a parameter called code appended to the redirect URI. Note the value of this parameter. Later you will set this in the OAuthVerifier connection property.

Next, you need to exchange the OAuth verifier code for OAuth refresh and access tokens.

On the headless machine, set the following connection properties to obtain the OAuth authentication values:

InitiateOAuth: REFRESH
OAuthVerifier: The noted verifier code (the value of the code parameter in the redirect URI).
OAuthClientId: The client Id in your custom OAuth application settings.
OAuthClientSecret: The client secret in the custom OAuth application settings.
OAuthSettingsLocation: Set this to persist the encrypted OAuth authentication values to the specified location.

Test the connection to generate the OAuth settings file, then re-set the following properties to connect:

InitiateOAuth: REFRESH
OAuthClientId: The client Id assigned when you registered your application.
OAuthClientSecret: The client secret assigned when you registered your application.
OAuthSettingsLocation: The location containing the encrypted OAuth authentication values. Make sure this location gives read and write permissions to the driver to enable the automatic refreshing of the access token.

Option 2: Transfer OAuth Settings

Prior to connecting on a headless machine, you need to install and create a connection with the driver on a device that supports an internet browser. Set the connection properties as described in "Desktop Applications" above.

After completing the instructions in "Desktop Applications", the resulting authentication values are encrypted and written to the location specified by OAuthSettingsLocation. The default filename is OAuthSettings.txt.

Test the connection to generate the OAuth settings file, then copy the OAuth settings file to your headless machine.

On the headless machine, set the following connection properties to connect to data:

InitiateOAuth: REFRESH
OAuthClientId: The client Id assigned when you registered your application.
OAuthClientSecret: The client secret assigned when you registered your application.
OAuthSettingsLocation: The location of the OAuth settings file you copied from the machine with the browser. Make sure this location gives read and write permissions to the driver to enable the automatic refreshing of the access token.