Tableau Connector for Highrise

Build 23.0.8839

Configuring a Connection

After Installing the Connector you can connect and create a Data Source for data in Highrise.

Setting Up a Data Source

Complete the following steps to connect to the data:

  1. Under Connect | To a Server, click More....
  2. Select the data source called Highrise by CData.
  3. Enter the information required for the connection.
  4. Click Sign In.
  5. If necessary, select a Database and Schema to discover what tables and views are available.

Using the Connection Builder

The connector makes the most common connection properties available directly in Tableau. However, it can be difficult to use if you need to use more advanced settings or need to troubleshoot connection issues. The connector includes a separate connection builder that allows you to create and test connections outside of Tableau.

There are two ways to access the connection builder:

  • On Windows, use a shortcut called Connection Builder in the Start menu, under the CData Tableau Connector for Highrise folder.
  • You can also start the connection builder by going to the driver install directory and running the .jar file in the lib directory.

In the connection builder, you can set values for connection properties and click Test Connection to validate that they work. You can also use the Copy to Clipboard button to save the connection string. This connection string can be given to the Connection String option included in the connector connection window in Tableau.

Authenticating to Highrise

Highrise supports OAuth and API token authentication schemes.

OAuth

Highrise uses the OAuth authentication standard. To authenticate to Highrise, you need to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL.

In all OAuth flows, you must set AuthScheme to OAuth. The following sections assume you have done so.

Desktop Applications

CData provides an embedded OAuth application that simplifies OAuth desktop Authentication. Alternatively, you can create a custom OAuth application. See Creating a Custom OAuth App for information about creating custom applications and reasons for doing so.

Get and Refresh the OAuth Access Token

After setting the following, you are ready to connect:

  • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
  • OAuthClientId (custom applications only): Set this to the client Id assigned when you registered your application.
  • OAuthClientSecret (custom applications only): Set this to the client secret assigned when you registered your application.
  • CallbackURL (custom application only): Set this to the redirect URI defined when you registered your application.
When you connect, the connector opens Highrise's OAuth endpoint in your default browser. Log in and grant permissions to the application. The connector then completes the OAuth process:

  1. The connector obtains an access token from Highrise and uses it to request data.
  2. The OAuth values are saved in the location specified in OAuthSettingsLocation. These values persist across connections.
The connector refreshes the access token automatically when it expires.

API Token

To authenticate to Highrise with an API token, set the following:

  • AuthScheme: Set AuthScheme to APIToken.
  • APIToken: The APIToken of the user. To obtain your API token, log in to your Highrise account and click the My Info link. If you are an admin or a user, this is located under the "Settings" section of the account. See Find Your API Token in the Highrise documentation for more information.
  • AccountId: The Account Id of the user.

Next Step

See Using the Connector to create data visualizations.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 23.0.8839