Connect to Highrise Data in Aqua Data Studio

The CData JDBC Driver for Highrise integrates Highrise data with wizards and analytics in IDEs like Aqua Data Studio. This article shows how to connect to Highrise data through the connection manager and execute queries.

Create a JDBC Data Source

You can use the connection manager to define connection properties and save them in a new JDBC data source. The Highrise data source can then be accessed from Aqua Data Studio tools.

1. In Aqua Data Studio, select Register Server from the Servers menu.
2. In the Register Server form, select the 'Generic - JDBC' connection.
3. Enter the following JDBC connection properties:
   • Name: Enter a name for the data source; for example, Highrise.
   • Driver Location: Click the Browse button and select the cdata.jdbc.highrise.jar file, located in the lib subfolder of the installation directory.
   • Driver: Enter the Driver's class name, cdata.jdbc.highrise.HighriseDriver.

   • URL: Enter the JDBC URL, which starts with jdbc:highrise: and is followed by a semicolon-separated list of connection properties.

     Highrise uses the OAuth authentication standard. To authenticate to Highrise, you will need to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL by registering an app with Highrise. You will also need to set the AccountId to connect to data.

     See the "Getting Started" section in the help documentation for a guide to using OAuth.

     Built-in Connection String Designer

     For assistance in constructing the JDBC URL, use the connection string designer built into the Highrise JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

     java -jar cdata.jdbc.highrise.jar

     Fill in the connection properties and copy the connection string to the clipboard.

     A typical JDBC URL is below:
     jdbc:highrise:OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost;AccountId=MyAccountId;InitiateOAuth=GETANDREFRESH

Query Highrise Data

You can now query the tables exposed.