Learn more
 

Ready to get started?

Connect to live data from Harvest with the API Driver

Connect to Harvest

In this article

Related articles

Load Harvest Data to a Database Using Embulk


Use CData JDBC drivers with the open source ETL/ELT tool Embulk to load Harvest data to a database.

Embulk is an open source bulk data loader. When paired with the CData API Driver for JDBC, Embulk easily loads data from Harvest to any supported destination. In this article, we explain how to use the CData API Driver for JDBC in Embulk to load Harvest data to a MySQL dtabase.

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).

Configure a JDBC Connection to Harvest Data

Before creating a bulk load job in Embulk, note the installation location for the JAR file for the JDBC Driver (typically C:\Program Files\CData\CData API Driver for JDBC\lib).

Embulk supports JDBC connectivity, so you can easily connect to Harvest and execute SQL queries. Before creating a bulk load job, create a JDBC URL for authenticating with Harvest.

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.

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';

Load Harvest Data in Embulk

After installing the CData JDBC Driver and creating a JDBC connection string, install the required Embulk plugins.

Install Embulk Input & Output Plugins

  1. Install the JDBC Input Plugin in Embulk.
    https://github.com/embulk/embulk-input-jdbc/tree/master/embulk-input-jdbc
    2. embulk gem install embulk-input-jdbc
  2. In this article, we use MySQL as the destination database. You can also choose SQL Server, PostgreSQL, or Google BigQuery as the destination using the output Plugins.
    https://github.com/embulk/embulk-output-jdbc/tree/master/embulk-output-mysql embulk gem install embulk-output-mysql

With the input and output plugins installed, we are ready to load Harvest data into MySQL using Embulk.

Create a Job to Load Harvest Data

Start by creating a config file in Embulk, using a name like api-mysql.yml.

  1. For the input plugin options, use the CData API Driver for JDBC, including the path to the driver JAR file, the driver class (e.g. cdata.jdbc.api.APIDriver), and the JDBC URL from above
  2. For the output plugin options, use the values and credentials for the MySQL database

Sample Config File (api-mysql.yml)

in: type: jdbc driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.api.jar driver_class: cdata.jdbc.api.APIDriver url: jdbc:api:Profile=C:\profiles\Harvest.apip;ProfileSettings='APIKey=my_personal_key;AccountId=_your_account_id'; table: "Invoices" out: type: mysql host: localhost database: DatabaseName user: UserId password: UserPassword table: "Invoices" mode: insert

After creating the file, run the Embulk job.

embulk run api-mysql.yml

After running the the Embulk job, find the Salesforce data in the MySQL table.

Load Filtered Harvest Data

In addition to loading data directly from a table, you can use a custom SQL query to have more granular control of the data loaded. You can also perform increment loads by setting a last updated column in a SQL WHERE clause in the query field.

in: type: jdbc driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.api.jar driver_class: cdata.jdbc.api.APIDriver url: jdbc:api:Profile=C:\profiles\Harvest.apip;ProfileSettings='APIKey=my_personal_key;AccountId=_your_account_id'; query: "SELECT Id, ClientName FROM Invoices WHERE [RecordId] = 1" out: type: mysql host: localhost database: DatabaseName user: UserId password: UserPassword table: "Invoices" mode: insert

More Information & Free Trial

By using CData API Driver for JDBC as a connector, Embulk can integrate Harvest data into your data load jobs. And with drivers for more than 200+ other enterprise sources, you can integrate any enterprise SaaS, big data, or NoSQL source as well. Download a 30-day free trial and get started today.