We are proud to share our inclusion in the 2024 Gartner Magic Quadrant for Data Integration Tools. We believe this recognition reflects the differentiated business outcomes CData delivers to our customers.
Get the Report →Connect to Harvest Data in HULFT Integrate
Connect to Harvest as a JDBC data source in HULFT Integrate
HULFT Integrate is a modern data integration platform that provides a drag-and-drop user interface to create cooperation flows, data conversion, and processing so that complex data connections are easier than ever to execute. When paired with the CData API Driver for JDBC, HULFT Integrate can work with live Harvest data. This article walks through connecting to Harvest and moving the data into a CSV file.
With built-in optimized data processing, the CData JDBC driver offers unmatched performance for interacting with live Harvest data. When you issue complex SQL queries 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). Its built-in dynamic metadata querying allows you to work with and analyze Harvest data using native data types.
Enable Access to Harvest
To enable access to Harvest data from HULFT Integrate projects:
- Copy the CData JDBC Driver JAR file (and license file if it exists), cdata.jdbc.api.jar (and cdata.jdbc.api.lic), to the jdbc_adapter subfolder for the Integrate Server
- Restart the HULFT Integrate Server and launch HULFT Integrate Studio
Build a Project with Access to Harvest Data
Once you copy the JAR files, you can create a project with access to Harvest data. Start by opening Integrate Studio and creating a new project.
- Name the project
- Ensure the "Create script" checkbox is checked
- Click Next
- Name the script (e.g.: APItoCSV)
Once you create the project, add components to the script to copy Harvest data to a CSV file.
Configure an Execute Select SQL Component
Drag an "Execute Select SQL" component from the Tool Palette (Database -> JDBC) into the Script workspace.
- In the "Required settings" tab for the Destination, click "Add" to create a new connection for Harvest. Set the following properties:
- Name: Harvest Connection Settings
- Driver class name: cdata.jdbc.api.APIDriver
- URL: jdbc:api:Profile=C:\profiles\Harvest.apip;ProfileSettings='APIKey=my_personal_key;AccountId=_your_account_id';
Built-in Connection String Designer
For assistance 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.
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.
- Write your SQL statement. For example:
SELECT Id, ClientName FROM Invoices
- Click "Extraction test" to ensure the connection and query are configured properly
- Click "Execute SQL statement and set output schema"
- Click "Finish"
Configure a Write CSV File Component
Drag a "Write CSV File" component from the Tool Palette (File -> CSV) onto the workspace.
- Set a file to write the query results to (e.g. Invoices.csv)
- Set "Input data" to the "Select SQL" component
- Add columns for each field selected in the SQL query
- In the "Write settings" tab, check the checkbox to "Insert column names into first row"
- Click "Finish"
Map Harvest Fields to the CSV Columns
Map each column from the "Select" component to the corresponding column for the "CSV" component.
Finish the Script
Drag the "Start" component onto the "Select" component and the "CSV" component onto the "End" component. Build the script and run the script to move Harvest data into a CSV file.
Download a free, 30-day trial of the CData API Driver for JDBC and start working with your live Harvest data in HULFT Integrate. Reach out to our Support Team if you have any questions.