How to Import Harvest Data into SQL Server using SSIS

Using SQL Server as a backup for critical business data provides an essential safety net against loss. Backing up data to SQL Server enables business users to more easily connect that data with features like reporting, analytics, and more.

This example demonstrates how to use the CData SSIS Tasks for Harvest inside of a SQL Server SSIS workflow to transfer Harvest data into a Microsoft SQL Server database.

Add the Components

To get started, add a new Harvest source and SQL Server ADO.NET destination to a new data flow task.

Create a New Connection Manager

Follow the steps below to save Harvest connection properties in a connection manager.

1. In the Connection Manager window, right-click and then click New Connection. The Add SSIS Connection Manager dialog is displayed.
2. In the Connection Manager type menu, select API. The CData Harvest Connection Manager is displayed.
3. Configure 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.

Configure the Harvest Source

Follow the steps below to specify the query to be used to extract Harvest data.

1. Double-click the Harvest source to open the source component editor.
2. In the Connection Manager menu, select the connection manager previously created.
3. Specify the query to use for the data extraction. For example: SELECT Id, ClientName FROM Invoices WHERE State = 'open'
4. Close the Harvest Source control and connect it to the ADO.NET Destination.

Configure the SQL Server Destination

Follow the steps below to specify the SQL server table to load the Harvest data into.

1. Open the ADO.NET Destination and add a New Connection. Enter your server and database information here.
2. In the Data access mode menu, select "table or view".
3. In the Table Or View menu, select the table or view to populate.
4. Configure any properties you wish to on the Mappings screen.

Run the Project

You can now run the project. After the SSIS Task has finished executing, your database will be populated with Harvest data.