Automate Retently Integration Tasks from PowerShell

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Are you in search of a quick and easy way to access Retently data from PowerShell? This article demonstrates how to utilize the Retently Cmdlets for tasks like connecting to Retently data, automating operations, downloading data, and more.

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 Retently.

ADO.NET Provider

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

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

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

Retently API Profile Settings

Log into your Retently account and navigate to the OAuth settings page to register an application and receive a Client ID and Client Secret.

  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 Retently:

     
    $conn= New-Object System.Data.CData.API.APIConnection("Profile=C:\profiles\Retently.apip;Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;")
    $conn.Open()
    
  3. Instantiate the APIDataAdapter, execute an SQL query, and output the results:

    $sql="SELECT Id, Value from Campaigns"
    
    $da= New-Object System.Data.CData.API.APIDataAdapter($sql, $conn)
    $dt= New-Object System.Data.DataTable
    $da.Fill($dt)
    
    $dt.Rows | foreach {
    	Write-Host $_.id $_.value
    }
      

Ready to get started?

Connect to live data from Retently with the API Driver

Connect to Retently