PowerShell Scripting to Replicate Harvest Data to MySQL

The CData Cmdlets for Harvest offer live access to Harvest data from within PowerShell. Using PowerShell scripts, you can easily automate regular tasks like data replication. This article will walk through using the CData Cmdlets for Harvest and the CData Cmdlets for MySQL in PowerShell to replicate Harvest data to a MySQL database.

After obtaining the needed connection properties, accessing Harvest data in PowerShell and preparing for replication consists of four basic steps.

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.

Collecting Harvest Data

1. Install the module:

   Install-Module APICmdlets

2. Connect to Harvest:

   $api = Connect-API -Profile $Profile -ProfileSettings $ProfileSettings -AccountId $AccountId

3. Retrieve the data from a specific resource:

   $data = Select-API -Connection $api -Table "Invoices"

   You can also use the Invoke-API cmdlet to execute pure SQL-92 statements:

   $data = Invoke-API -Connection $api -Query 'SELECT * FROM Invoices WHERE State = @State' -Params @{'@State'='open'}

4. Save a list of the column names from the returned data.

   $columns = ($data | Get-Member -MemberType NoteProperty | Select-Object -Property Name).Name

Inserting Harvest Data into the MySQL Database

With the data and column names collected, you are ready to replicate the data into a MySQL database.

1. Install the module:

   Install-Module MySQLCmdlets

2. Connect to MySQL, using the server address and port of the MySQL server, valid user credentials, and a specific database with the table in which the data will be replicated:

   $mysql = Connect-MySQL -User $User -Password $Password -Database $Database -Server $Server -Port $Port

3. Loop through the Harvest data, store the values, and use the Add-MySQL cmdlet to insert the data into the MySQL database, one row at a time. In this example, the table will need to have the same name as the Harvest resource (Invoices) and to exist in the database.

   $data | % { $row = $_ $values = @() $columns | % { $col = $_ $values += $row.$($col) } Add-MySQL -Connection $mysql -Table "Invoices" -Columns $columns -Values $values }

You have now replicated your Harvest data to a MySQL database. This gives you freedom to work with Harvest data in the same way that you work with other MySQL tables, whether that is performing analytics, building reports, or other business functions.

Notes

• Once you have connected to Harvest and MySQL in PowerShell, you can pipe command results to perform the replication in a single line:

  Select-API -Connection $api -Table "Invoices" | % { $row = $_ $values = @() $columns | % { $col = $_ $values += $row.$($col) } Add-MySQL -Connection $mysql -Table "Invoices" -Columns $columns -Values $values }

• If you wish to replicate the Harvest data to another database using another PowerShell module, you will want to exclude the Columns, Connection, and Table columns from the data returned by the Select-API cmdlet since those columns are used to help pipe data from one CData cmdlet to another:

  $columns = ($data | Get-Member -MemberType NoteProperty | Select-Object -Property Name).Name | ? {$_ -NotIn @('Columns','Connection','Table')}