Automate SageHR Integration Tasks from PowerShell

The CData API Driver for ADO.NET is a standard ADO.NET Provider that make it easy to accomplish data cleansing, normalization, backup, and other integration tasks by enabling real-time access to SageHR.

ADO.NET Provider

The ADO.NET Provider provides a SQL interface for SageHR; this tutorial shows how to use the Provider to retrieve SageHR data.

Once you have acquired the necessary connection properties, accessing SageHR data in PowerShell can be enabled in three steps.

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

SageHR API Profile Settings

Navigate to Settings > Integrations > API in your SageHR account and click Enable API Access to obtain your API key. Your Subdomain is the prefix of your SageHR URL.

1. Load the provider's assembly:

   [Reflection.Assembly]::LoadFile("C:\Program Files\CData\CData API Driver for ADO.NET\lib\System.Data.CData.API.dll")
       

2. Connect to SageHR:

    
   $conn= New-Object System.Data.CData.API.APIConnection("Profile=C:\profiles\SageHR.apip;ProfileSettings='APIKey=your_api_key;Subdomain=your_subdomain';")
   $conn.Open()
   

3. Instantiate the APIDataAdapter, execute an SQL query, and output the results:

   $sql="SELECT ApplicantId, Action from ApplicantActions"
   
   $da= New-Object System.Data.CData.API.APIDataAdapter($sql, $conn)
   $dt= New-Object System.Data.DataTable
   $da.Fill($dt)
   
   $dt.Rows | foreach {
   	Write-Host $_.applicantid $_.action
   }