How to connect to Harvest Data from IntelliJ

The CData JDBC Driver for Harvest enables you to access Harvest as a JDBC data source, providing integration with rapid development tools in IDEs. This article shows how to use the data source configuration wizard to connect to Harvest data in IntelliJ.

Create a JBDC Data Source for Harvest

Follow the steps below to add the driver JAR and define connection properties required to connect to Harvest data.

1. In the Data Sources window, right-click and then click Add Data Source -> DB Data Source.

2. In the Data Source Properties dialog that appears, the following properties are required:

   • JDBC Driver Files: Click the button next to this menu to add the JDBC Driver file cdata.jdbc.api.jar, located in the installation directory.
   • JDBC Driver Class: In this menu, select cdata.jdbc.api.APIDriver from the list.

   • Database URL: Enter the connection URL in the JDBC URL property. The URL must start with jdbc:api: and includes connection properties separated with semicolons.

     Start by setting the Profile connection property to the location of the Harvest Profile on disk (e.g. C:\profiles\Harvest.apip). Next, set the ProfileSettings connection property to the connection string for Harvest (see below).

     Harvest API Profile Settings

     To authenticate to Harvest, you can use either Token authentication or the OAuth standard. Use Basic authentication to connect to your own data. Use OAuth to allow other users to connect to their data.

     Using Token Authentication

     To use Token Authentication, set the APIKey to your Harvest Personal Access Token in the ProfileSettings connection property. In addition to APIKey, set your AccountId in ProfileSettings to connect.

     Using OAuth Authentication

     First, register an OAuth2 application with Harvest. The application can be created from the "Developers" section of Harvest ID.

     After setting the following connection properties, you are ready to connect:

     • ProfileSettings: Set your AccountId in ProfileSettings.
     • AuthScheme: Set this to OAuth.
     • OAuthClientId: Set this to the client ID that you specified in your app settings.
     • OAuthClientSecret: Set this to the client secret that you specified in your app settings.
     • CallbackURL: Set this to the Redirect URI that you specified in your app settings.
     • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage how the driver obtains and refreshes the OAuthAccessToken.

     Built-in Connection String Designer

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

     java -jar cdata.jdbc.api.jar
     

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

     👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
     

     A typical JDBC URL is the following:

     jdbc:api:Profile=C:\profiles\Harvest.apip;ProfileSettings='APIKey=my_personal_key;AccountId=_your_account_id';

Edit and Save Harvest Data

To discover schema information, right-click the data source you just created and click Refresh Tables. To query a table, right-click it and then click Open Tables Editor.