Build Dashboards with Harvest Data in DBxtra

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 connect to Harvest data as a generic ODBC Data Provider and create charts, reports, and dashboards based on Harvest data in DBxtra.

Connect to Harvest Data

1. If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can configure the DSN using the built-in Microsoft ODBC Data Source Administrator. 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.

2. Open the DBxtra application and in the New menu click Project and name the Project. 👁 Creating a New Project.
   
3. Select ODBC Connection as the Data Connection Type. 👁 Creating an ODBC Connection.
   
4. Click the browse option () for the Data Source.
5. In the Data Link Properties window, select Microsoft OLE DB Provider for ODBC Drivers on the Provider tab. 👁 Select the Provider
   
6. On the Connection tab, select the Data Source Name and the initial catalog to use (CData). 👁 Select the Provider
   
7. Name the Connection and select the appropriate User Groups. 👁 Connection name and User Groups
   
8. Double-click the Connection from within the Project to connect to the data. 👁 Connecting to the data.
   

Create a Dashboard with Harvest Data

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

1. Right-click Report Objects under the Project and select New Report Object. 👁 Creating a Report Object for the Project
   
2. In the new Report Object, click the link to create the Query.
3. In the Select Data Connection window, select the newly created data connection. 👁 Select Data Connection
   
4. On the Query tab, expand the connection objects and select the Tables, Views, and specific columns you wish to include in your dashboard. You can specify search requirements and even create complex queries which include JOINs and aggregations. 👁 Selecting the data/building the query.
   
5. On the Dashboard tab, select the visualizations and features for your dashboard. Assign the data values from the query to the appropriate fields for the Dashboards items (Values, Series, etc.) 👁 Building the Dashboard.
   

With a new Dashboard created, you are ready to begin analysis of Harvest data. Thanks to the ODBC Driver for Harvest, you can refresh the Dashboard and immediately see any changes made at the source. In the same way, you can create and view Reports with live, up-to-date Harvest data.