How to pipe Highrise Data to CSV in PowerShell

The CData Cmdlets Module for Highrise is a standard PowerShell module offering straightforward integration with Highrise. Below, you will find examples of using our Highrise Cmdlets with native PowerShell cmdlets.

Creating a Connection to Your Highrise Data

Highrise uses the OAuth authentication standard. To authenticate to Highrise, you will need to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL by registering an app with Highrise. You will also need to set the AccountId to connect to data.

See the "Getting Started" section in the help documentation for a guide to using OAuth.

$conn = Connect-Highrise  -OAuthClientId "$OAuthClientId" -OAuthClientSecret "$OAuthClientSecret" -CallbackURL "$CallbackURL" -AccountId "$AccountId"

Selecting Data

Follow the steps below to retrieve data from the Deals table and pipe the result into to a CSV file:

Select-Highrise -Connection $conn -Table Deals | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myDealsData.csv -NoTypeInformation

You will notice that we piped the results from Select-Highrise into a Select-Object cmdlet and excluded some properties before piping them into an Export-Csv cmdlet. We do this because the CData Cmdlets append Connection, Table, and Columns information onto each "row" in the result set, and we do not necessarily want that information in our CSV file.

Deleting Data

The following line deletes any records that match the criteria:

Select-Highrise -Connection $conn -Table Deals -Where "GroupId = MyGroupId" | Remove-Highrise

Inserting and Updating Data

The cmdlets make data transformation easy as well as data cleansing. The following example loads data from a CSV file into Highrise, checking first whether a record already exists and needs to be updated instead of inserted.

Import-Csv -Path C:\MyDealsUpdates.csv | %{
  $record = Select-Highrise -Connection $Highrise -Table Deals -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-Highrise -Connection $highrise -Table Deals -Columns ("Name","Price") -Values ($_.Name, $_.Price) -Where ("Id = `'"+$_.Id+"`'")
  }else{
    Add-Highrise -Connection $highrise -Table Deals -Columns ("Name","Price") -Values ($_.Name, $_.Price)
  }
}

As always, our goal is to simplify the way you connect to data. With cmdlets users can install a data module, set the connection properties, and start building. Download Cmdlets and start working with your data in PowerShell today!