Automate FormSite Integration Tasks from PowerShell

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

ADO.NET Provider

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

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

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

FormSite API Profile Settings

Log into your Formsite account and visit the Admin Portal to generate or retrieve your API key. Your

ServerNumber
is the numeric part of your server URL and
UserDirectory
is your account's directory path.

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

     
    $conn= New-Object System.Data.CData.API.APIConnection("Profile=C:\profiles\FormSite.apip;ProfileSettings='APIKey=your_api_key;ServerNumber=your_server_number;UserDirectory=your_user_directory';")
    $conn.Open()
    
  3. Instantiate the APIDataAdapter, execute an SQL query, and output the results:

    $sql="SELECT Id, Label from FormItems"
    
    $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 $_.label
    }
      

Ready to get started?

Connect to live data from FormSite with the API Driver

Connect to FormSite