Ready to get started?

Download a free trial of the Highrise Driver to get started:

 Download Now

Learn more:

Highrise Icon Highrise JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Highrise account data including Accounts, Deals, Emails, People, Tasks, and more!

Connect to Highrise Data in CloverDX (formerly CloverETL)



Transfer Highrise data using the visual workflow in the CloverDX data integration tool.

The CData JDBC Driver for Highrise enables you to use the data transformation components in CloverDX (formerly CloverETL) to work with Highrise as sources and destinations. In this article, you will use the JDBC Driver for Highrise to set up a simple transfer into a flat file. The CData JDBC Driver for Highrise enables you to use the data transformation components in CloverDX (formerly CloverETL) to work with Highrise as sources and destinations. In this article, you will use the JDBC Driver for Highrise to set up a simple transfer into a flat file.

Connect to Highrise as a JDBC Data Source

  1. Create the connection to Highrise data. In a new CloverDX graph, right-click the Connections node in the Outline pane and click Connections -> Create Connection. The Database Connection wizard is displayed.
  2. Click the plus icon to load a driver from a JAR. Browse to the lib subfolder of the installation directory and select the cdata.jdbc.highrise.jar file.
  3. Enter 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.

    A typical JDBC URL is below:

    jdbc:highrise:OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost;AccountId=MyAccountId;InitiateOAuth=GETANDREFRESH

Query Highrise Data with the DBInputTable Component

  1. Drag a DBInputTable from the Readers selection of the Palette onto the job flow and double-click it to open the configuration editor.
  2. In the DB connection property, select the Highrise JDBC data source from the drop-down menu.
  3. Enter the SQL query. For example: SELECT Name, Price FROM Deals

Write the Output of the Query to a UniversalDataWriter

  1. Drag a UniversalDataWriter from the Writers selection onto the jobflow.
  2. Double-click the UniversalDataWriter to open the configuration editor and add a file URL.
  3. Right-click the DBInputTable and then click Extract Metadata.
  4. Connect the output port of the DBInputTable to the UniversalDataWriter.
  5. In the resulting Select Metadata menu for the UniversalDataWriter, choose the Deals table. (You can also open this menu by right-clicking the input port for the UniversalDataWriter.)
  6. Click Run to write to the file.