PowerShell Scripting to Replicate Clio Data to MySQL

The CData Cmdlets for Clio offer live access to Clio 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 Clio and the CData Cmdlets for MySQL in PowerShell to replicate Clio data to a MySQL database.

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

Start by setting the Profile connection property to the location of the Clio Profile on disk (e.g. C:\profiles\Clio.apip). Next, set the ProfileSettings connection property to the connection string for Clio (see below).

Clio API Profile Settings

Clio uses OAuth-based authentication.

First, register an OAuth application with Clio. You can do so by logging to your Developer Account and clicking the Add button. Enter details and select the scope of your application here - these details will be shown to Clio users when they're asked to authorize your application. Your Oauth application will be assigned a client id (key) and a client secret (secret). Additionally you will need to set the Region in ProfileSettings connection property.

After setting the following connection properties, you are ready to connect:

• AuthScheme: Set this to OAuth.
• InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.
• OAuthClientId: Set this to the client_id that is specified in you app settings.
• OAuthClientSecret: Set this to the client_secret that is specified in you app settings.
• CallbackURL: Set this to the Redirect URI that is specified in your app settings.
• Region: Set this in ProfileSettings to your Clio geographic region. Defaults to app.clio.com.

Collecting Clio Data

1. Install the module:

   Install-Module APICmdlets

2. Connect to Clio:

   $api = Connect-API -Profile $Profile -ProfileSettings $ProfileSettings -Authscheme $Authscheme -OAuthClientId $OAuthClientId -OAuthClientSecret $OAuthClientSecret -CallbackUrl $CallbackUrl

3. Retrieve the data from a specific resource:

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

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

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

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

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

Inserting Clio 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 Clio 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 Clio resource (Bills) and to exist in the database.

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

You have now replicated your Clio data to a MySQL database. This gives you freedom to work with Clio 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 Clio and MySQL in PowerShell, you can pipe command results to perform the replication in a single line:

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

• If you wish to replicate the Clio 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')}