Learn more
 

Ready to get started?

Connect to live data from Harvest with the API Driver

Connect to Harvest

In this article

Related articles

Build Charts with Harvest Data in Clear Analytics


Create dynamic charts and perform analytics based on Harvest data in Clear Analytics.

The CData ODBC Driver for Harvest enables access to live data from Harvest under the ODBC standard, allowing you work with Harvest data in a wide variety of BI, reporting, and ETL tools and directly, using familiar SQL queries. This article shows how to use Clear Analytics, a Microsoft Excel Add-In, to connect to Harvest as an ODBC source and create queries, tables, and charts (including PivotTables) based on Harvest data.

Connect to Harvest Data


Configure the ODBC Data Source Name

If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can use the built-in Microsoft ODBC Data Source Administrator to configure the DSN. This is also the last step of the driver installation. See the "Getting Started" chapter in the help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.

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.

When you configure the DSN, 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.

Configure the Data Source in Clear Analytics

  1. Open Excel and navigate to the CLEAR ANALYTICS ribbon. Once there, open the Data Manager.
  2. Select Database as the data source.
  3. In the Set Connection section, click the option to create a new database.
  4. Select Microsoft ODBC Data Source as the data source and click OK.
  5. Select the DSN you already configured from the drop-down menu.
  6. Back on the Set Connection section, select Standard (ANSI ODBC) Query Builder as the SQL Builder Provider and click Next.
  7. Select the Schema/Owner and choose the domains (tables) that you wish to use in Clear Analytics.
  8. Prepare your data objects as needed by customizing the display names and descriptions of the tables and columns.
  9. For the vast majority of the CData ODBC Drivers, you will not set a key date for your domains.
  10. In the Domain Relations section, add any relational information between tables.
  11. In the Domain Tree section, create groups for your data and add the available items to the groups.
  12. Review the summary of your data and click Finish.

Create a Chart with Harvest Data

You are now ready to create a chart with Harvest data.

Create a New Query

  1. Click Repository in the CLEAR ANALYTICS ribbon.
  2. Create a new query.
  3. Select the columns you wish to retrieve.
  4. Set the aggregation type for your data (use the blank entry if you do not wish to aggregate the data).
  5. Set filters and formulas by dragging columns to the lower window.
  6. Name your query and click Save.

Build a Chart Based on a Query Report

With the query created, you are now ready to execute a report and display a chart.
  1. Click Report Explorer in the CLEAR ANALYTICS ribbon.
  2. In the Report Explorer pane, click the 'New Report' icon in the toolbar.
  3. Select the query you just created.
  4. Name the report and click 'Save and Execute'.
  5. Click the Results tab within the Report Explorer
  6. Expand your report and drag the chart to the Excel spreadsheet.
  7. In the resulting PivotChart window, drag the fields (columns) to the Filters, Legends, Axis (Categories), and Values windows.

With a new data source in Clear Analytics established and a chart created, you are ready to begin analysis of Harvest data. With the ODBC Driver for Harvest and Clear Analytics, you can perform self-service analytics in Excel with live data, directly from Harvest.