Feed Harvest Data into FineReport

The CData JDBC Driver for Harvest fully implements the JDBC standard and can provide Harvest data connectivity to a wide variety of BI, reporting, and ETL tools and custom applications. In this article, we explain how to set Harvest data as JDBC data source in FineReport and view Harvest data as a table in the Report Designer.

Set Up a JDBC Data Source of Harvest Data

Follow the instruction below to set Harvest data as a FineReport database connection.

1. Copy the cdata.jdbc.api.jar file from the lib folder in the CData JDBC Driver for Harvest installation directory to the lib folder of the FineReport installation directory. You will need to copy the cdata.jdbc.api.lic file as well.
2. From the Server tab, select Define Data Connection, click to add a new connection, and click JDBC.

Next we will set up the data connection definition in the window.

1. Database: Others
2. JDBC Driver: cdata.jdbc.api.APIDriver
3. URL: A standard JDBC connection string using semicolon-separated connection properties.

   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 JDBC URL is below:

   jdbc:api:Profile=C:\profiles\Harvest.apip;ProfileSettings='APIKey=my_personal_key;AccountId=_your_account_id';
4. Click Connection pool attributes and set Test before getting connections to No.

Click Test connection to ensure you have configured the connection properly. With the connection to Harvest set up, you can use it as FineReport data source.

Select Harvest Data in the Report Designer.

1. Click to add a new template data set and select DB query to open the database query window.
2. Choose the JDBC connection that you created from the dropdown list.
3. The Harvest entities will appear as tables on the left pane.
4. Write a SELECT statement for the Harvest data tables and columns that you want to load.
5. Click preview and data is shown as table.

With these simple steps, Harvest can be used as a JDBC data source in FineReport.