Automate Dotmailer Integration Tasks from PowerShell

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Are you in search of a quick and easy way to access Dotmailer data from PowerShell? This article demonstrates how to utilize the Dotmailer Cmdlets for tasks like connecting to Dotmailer 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 Dotmailer.

ADO.NET Provider

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

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

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

Dotmailer API Profile Settings

Create an API user in the Dotdigital platform under Setup > Access > API Users > New User. Your RegionId can be found in your account URL (e.g.,

r1
from
r1.dotdigitalgroup.com
).

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

     
    $conn= New-Object System.Data.CData.API.APIConnection("Profile=C:\profiles\Dotmailer.apip;ProfileSettings='User=your_api_username;Password=your_api_password;RegionId=your_region_id';")
    $conn.Open()
    
  3. Instantiate the APIDataAdapter, execute an SQL query, and output the results:

    $sql="SELECT Name, Type from Account"
    
    $da= New-Object System.Data.CData.API.APIDataAdapter($sql, $conn)
    $dt= New-Object System.Data.DataTable
    $da.Fill($dt)
    
    $dt.Rows | foreach {
    	Write-Host $_.name $_.type
    }
      

Ready to get started?

Connect to live data from Dotmailer with the API Driver

Connect to Dotmailer