Automate Salesforce Integration Tasks from PowerShell

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Salesforce ADO.NET Provider

Rapidly create and deploy powerful .NET applications that integrate with Salesforce account data including Leads, Contacts, Opportunities, Accounts, and more!



Are you looking for a quick and easy way to access Salesforce data from PowerShell? We show how to use the Cmdlets for Salesforce and the CData ADO.NET Provider for Salesforce to connect to Salesforce data and synchronize, automate, download, and more.

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.

Cmdlets or ADO.NET?

The cmdlets are not only a PowerShell interface to the Salesforce API, 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.

After obtaining the needed connection properties, accessing Salesforce data in PowerShell consists of three basic steps.

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

If you do not have access to the username and password or do not wish to require them, you can use OAuth authentication.

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

PowerShell

  1. Install the module:

    Install-Module SalesforceCmdlets
  2. Connect:

    $salesforce = Connect-Salesforce -User "$User" -Password "$Password" -SecurityToken "$SecurityToken"
  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("User=username;Password=password;SecurityToken=Your_Security_Token;") $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 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 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 System.Data.CData.Salesforce.SalesforceParameter("@myId","001d000000YBRseAAH")) $cmd.ExecuteNonQuery()