Automate Salesforce Integration Tasks from PowerShell

The CData Cmdlets for Salesforce are standard PowerShell cmdlets that make it easy to accomplish data cleansing, normalization, backup, and other integration tasks by enabling real-time and bidirectional access to Salesforce.

Getting Started

---

PowerShell Cmdlets or ADO.NET Provider?

The Cmdlets are not only a PowerShell interface to Salesforce, but also an SQL interface; this tutorial shows how to use both to create, retrieve, update, and delete Salesforce data. We also show examples of the ADO.NET equivalent, which is possible with the CData ADO.NET Provider for Salesforce. To access Salesforce data from other .NET applications, like LINQPad, use the CData ADO.NET Provider for Salesforce.

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

There are several authentication methods available for connecting to Salesforce: OAuth, Login (or basic), and SSO. The Login method requires you to have the username, password, and security token of the user.

OAuth Authentication (default)

The default authentication mechanism (and the one preferred by Salesforce) is OAuth. To use OAuth with CData's embedded OAuth application, leave the connection properties blank. If you have configured your own custom OAuth application with Salesforce (see the Help documentation for more information), set OAuthClientId, OAuthClientSecret, and CallbackURL to the properties for you application. Set InitiateOAuth to the desired OAuth flow ("GETANDREFRESH" will have the connector manage the entire OAuth flow).

Login (or Basic) Authentication

If you do not wish do not wish to use OAuth authentication, you can use Login (or basic) authentication. Set AuthScheme to Basic, and set the User, Password, and SecurityToken properties. You can configure your security token in Salesforce.

SSO (single sign-on) Authentication

SSO (single sign-on) can be used by setting the SSOProperties, SSOLoginUrl, and SSOExchangeURL connection properties, which allow you to authenticate to an identity provider. See the "Getting Started" chapter in the Help documentation for more information.

Multi-Factor Authentication (MFA)

If your Salesforce org has MFA enforcement enabled, set MFACode to the time-based one-time passcode (TOTP) generated by your authenticator app (such as Salesforce Authenticator or Google Authenticator). MFACode applies to both OAuth and Login authentication flows.

PowerShell

1. Install the module:

   Install-Module SalesforceCmdlets

2. Connect:

   $salesforce = Connect-Salesforce -InitiateOAuth "$InitiateOAuth" -MFACode "$MFACode"
   

3. Search for and retrieve data:

   $name = "GenePoint"
   $account = Select-Salesforce -Connection $salesforce -Table "Account" -Where "Name = `'$Name`'"
   $account
   

   You can also use the Invoke-Salesforce cmdlet to execute SQL commands:

   $account = Invoke-Salesforce -Connection $salesforce -Query 'SELECT * FROM Account WHERE Name = @Name' -Params @{'@Name'='GenePoint'}
   

ADO.NET

1. Load the provider's assembly:

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

2. Connect to Salesforce:

    
   $conn= New-Object System.Data.CData.Salesforce.SalesforceConnection("InitiateOAuth=GETANDREFRESH;MFACode=YourMFACode")
   $conn.Open()
   

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

   $sql="SELECT Industry, AnnualRevenue from Account"
   
   $da= New-Object System.Data.CData.Salesforce.SalesforceDataAdapter($sql, $conn)
   $dt= New-Object System.Data.DataTable
   $da.Fill($dt)
   
   $dt.Rows | foreach {
   	Write-Host $_.industry $_.annualrevenue
   }
    

Update Salesforce Data

PowerShell

Update-Salesforce -Connection $Salesforce -Columns @('Industry','AnnualRevenue') -Values @('MyIndustry', 'MyAnnualRevenue') -Table Account -Id "MyId"

ADO.NET

$cmd = New-Object System.Data.CData.Salesforce.SalesforceCommand("UPDATE Account SET Name='GenePoint' WHERE Id = @myId", $conn)
$cmd.Parameters.Add((New-Object System.Data.CData.Salesforce.SalesforceParameter("@myId","10456255-0015501366")))
$cmd.ExecuteNonQuery()

Insert Salesforce Data

PowerShell

Add-Salesforce -Connection $Salesforce -Table Account -Columns @("Industry", "AnnualRevenue") -Values @("MyIndustry", "MyAnnualRevenue") 

ADO.NET

$cmd = New-Object System.Data.CData.Salesforce.SalesforceCommand("INSERT INTO Account (Name) VALUES (@myName)", $conn)
$cmd.Parameters.Add((New-Object System.Data.CData.Salesforce.SalesforceParameter("@myName","GenePoint")))
$cmd.ExecuteNonQuery()

Delete Salesforce Data

PowerShell

Remove-Salesforce -Connection $Salesforce -Table "Account" -Id "MyId"

ADO.NET

$cmd = New-Object System.Data.CData.Salesforce.SalesforceCommand("DELETE FROM Account WHERE Id=@myId", $conn)
$cmd.Parameters.Add((New-Object System.Data.CData.Salesforce.SalesforceParameter("@myId","001d000000YBRseAAH")))
$cmd.ExecuteNonQuery()

CodeProject