Build Visualizations of Harvest Data in Birst

Birst is a cloud business intelligence (BI) tool and analytics platform that helps organizations quickly understand and optimize complex processes. When paired with the CData API Driver for JDBC, you can connect to live Harvest data through the Birst Cloud Agent and build real-time visualizations. In this article, we walk you through, step-by-step, how to connect to Harvest using the Cloud Agent and create dynamic reports in Birst.

With powerful data processing capabilities, the CData JDBC driver offers unmatched performance for live Harvest data operations in Birst. When you issue complex SQL queries from Birst to Harvest, the driver pushes supported SQL operations, like filters and aggregations, directly to Harvest and utilizes the embedded SQL Engine to process unsupported operations client-side (often SQL functions and JOIN operations). With built-in dynamic metadata querying, the JDBC driver enables you to visualize and analyze Harvest data using native Birst data types.

Configure a JDBC Connection to Harvest Data in Birst

Before creating the Birst project, you will need to install the Birst Cloud Agent (in order to work with the installed JDBC Driver). Also, copy the JAR file for the JDBC Driver (and the LIC file, if it exists) to the /drivers/ directory in the installation location for the Cloud Agent.

With the driver and Cloud Agent installed, you are ready to begin.

1. Create a new project in Birst.
2. Name the connection (e.g. CDataAPI).
3. Choose Live Access.
4. Select an agent.
5. Set Database Type to Other.
6. Set SQL Type to MSSQL
7. Set the Connection string.

   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.

   Below is a typical JDBC connection string for Harvest:

   jdbc:api:Profile=C:\profiles\Harvest.apip;ProfileSettings='APIKey=my_personal_key;AccountId=_your_account_id';
8. Set the Driver Name: cdata.jdbc.api.APIDriver and click Save.

NOTE: Since authentication to Harvest is managed from the connection string, you can leave Security Credentials blank.

Configure Harvest Data Objects

Now that the connection is configured, we are ready to configure the schema for the dataset, choosing the tables, views, and columns we wish to visualize.

1. Select the Schema (e.g. API).
2. Click on Tables and/or Views to connect to those entities and click Apply.
3. Select the Tables and Columns you want to access and click Done.

With the objects configured, you can perform any data preparation and discover any relationships in your data using the Pronto Prepare and Relate tools.

Build a Visualization

After you prepare your data and define relationships between the connected objects, you are ready to build your visualization.

1. Select the Visualizer tool from the menu.
2. Select Measures & Categories from your objects
3. Select and configure the appropriate visualization for the Measure(s) you selected.

Using the CData API Driver for JDBC with the Cloud Agent and Birst, you can easily create robust visualizations and reports on Harvest data. Download a free, 30-day trial and start building Birst visualizations today.