Manage Highrise Data in DBArtisan as a JDBC Source

The CData JDBC Driver for Highrise seamlessly integrates Highrise data into database management tools like DBArtisan by enabling you to access Highrise data as a database. This article shows how to create a JDBC source for Highrise in DBArtisan. You can then edit data visually and execute standard SQL.

Integrate Highrise Data into DBArtisan Projects

Follow the steps below to register Highrise data as a database instance in your project:

1. In DBArtisan, click Data Source -> Register Datasource.
2. Select Generic JDBC.
3. Click Manage.
4. In the resulting dialog, click New. Enter a name for the driver and click Add. In the resulting dialog, navigate to the driver JAR. The driver JAR is located in the lib subfolder of the installation directory.
5. In the Connection URL box, enter credentials and other required connection properties in the JDBC URL.

   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.

   Below is a typical connection string:

   jdbc:highrise:OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost;AccountId=MyAccountId;InitiateOAuth=GETANDREFRESH
6. Finish the wizard to connect to Highrise data. Highrise entities are displayed in the Datasource Explorer.

You can now work with Highrise data as you work with any other database. See the driver help documentation for more information on the queries supported by the Highrise API.