How to connect to Harvest Data in DBVisualizer



Integrate Harvest data with visual data analysis tools and data connection wizards in DBVisualizer

The CData API Driver for JDBC implements JDBC standards to provide connectivity to Harvest data in applications ranging from business intelligence tools to IDEs. This article shows how to establish a connection to Harvest data in DBVisualizer and use the table editor to load Harvest data.

Create a New Driver Definition for Harvest Data

Follow the steps below to use the Driver Manager to provide connectivity to Harvest data from DBVisualizer tools.

  1. In DBVisualizer, click Tools -> Driver Manager.
  2. Click the plus sign "" to create a new driver.
  3. Select "Custom" as the template.
  4. On the Driver Settings tab:
    • Set Name to a user-friendly name (e.g. "CData Harvest Driver")
    • Set URL Format to jdbc:api:
    • In Driver artifacts and jar files (jars are loaded in order from top):
      1. Click the plus sign "" -> "Add Files"
      2. Navigate to the "lib" folder in the installation directory (C:\Program Files\CData[product_name] XXXX\)
      3. Select the JAR file (cdata.jdbc.API.jar) and click "Open"
  5. The Driver Class should populate automatically. If not, select class (cdata.jdbc.api.APIDriver).

Define the Connection to the JDBC Data Source

Close the "Driver Manager" and follow the steps below to save connection properties in the JDBC URL.

  1. In the "Databases" tab, click the plus sign "" and select the driver you just created.
  2. In the "Connection" section, set the following options:

    • Database Type: If you selected the wizard option, the database type is automatically detected. If you selected the "No Wizard" option, select the Generic or Auto Detect option in the Database Type menu.
    • Driver Type: Select the driver you just created.
    • Database URL: Enter the full JDBC URL. The syntax of the JDBC URL is jdbc:api: followed by the connection properties in a semicolon-separated list of name-value pairs.

      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.

      When you configure the JDBC URL, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

      A typical connection string is below:

      jdbc:api:Profile=C:\profiles\Harvest.apip;ProfileSettings='APIKey=my_personal_key;AccountId=_your_account_id';
    • NOTE: Since Harvest does not require a User or Password to authenticate, you may use whatever values you wish for Database Userid and Database Password.
  3. On the Connection tab, click Connect.

To browse through tables exposed by the Harvest JDBC Driver, right-click a table and click "Open in New Tab."

To execute SQL queries, use the SQL Commander tool: Click SQL Commander -> New SQL Commander. Select the Database Connection, Database, and Schema from the available menus.

See the "Supported SQL" chapter in the help documentation for more information on the supported SQL. See the "Data Model" chapter for table-specific information.

More Information & Free Trial

Download a free, 30-day trial of the CData API Driver for JDBC and start working with your live Harvest data in DbVisualizer. Join the CData Community or reach out to our Support Team if you have any questions.

Ready to get started?

Connect to live data from Harvest with the API Driver

Connect to Harvest