Ready to get started?

Download a free trial of the SuiteCRM Cmdlets to get started:

 Download Now

Learn more:

SuiteCRM Icon SuiteCRM Cmdlets

An easy-to-use set of PowerShell Cmdlets offering real-time access to SuiteCRM data. The Cmdlets allow users to easily read, write, update, and delete live data - just like working with SQL server.

How to pipe SuiteCRM Data to CSV in PowerShell

Use standard PowerShell cmdlets to access SuiteCRM tables.

The CData Cmdlets Module for SuiteCRM is a standard PowerShell module offering straightforward integration with SuiteCRM. Below, you will find examples of using our SuiteCRM Cmdlets with native PowerShell cmdlets.

Creating a Connection to Your SuiteCRM Data

The User and Password properties must be set to valid SuiteCRM user credentials. Additionally, specify the URL to the SuiteCRM application, for example

Note that retrieving SuiteCRM metadata can be expensive. It is advised that you store the metadata locally as described in the Caching Metadata section of the data provider help documentation.

$conn = Connect-SuiteCRM  -URL "$URL" -User "$User" -Password "$Password"

Selecting Data

Follow the steps below to retrieve data from the Accounts table and pipe the result into to a CSV file:

Select-SuiteCRM -Connection $conn -Table Accounts | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myAccountsData.csv -NoTypeInformation

You will notice that we piped the results from Select-SuiteCRM into a Select-Object cmdlet and excluded some properties before piping them into an Export-Csv cmdlet. We do this because the CData Cmdlets append Connection, Table, and Columns information onto each "row" in the result set, and we do not necessarily want that information in our CSV file.

The Connection, Table, and Columns are appended to the results in order to facilitate piping results from one of the CData Cmdlets directly into another one.

Deleting Data

The following line deletes any records that match the criteria:

Select-SuiteCRM -Connection $conn -Table Accounts -Where "Industry = Manufacturing" | Remove-SuiteCRM

Inserting and Updating Data

The cmdlets make data transformation easy as well as data cleansing. The following example loads data from a CSV file into SuiteCRM, checking first whether a record already exists and needs to be updated instead of inserted.

Import-Csv -Path C:\MyAccountsUpdates.csv | %{
  $record = Select-SuiteCRM -Connection $SuiteCRM -Table Accounts -Where ("Id = `'"+$_.Id+"`'")
    Update-SuiteCRM -Connection $suitecrm -Table Accounts -Columns ("Name","Industry") -Values ($_.Name, $_.Industry) -Where ("Id = `'"+$_.Id+"`'")
    Add-SuiteCRM -Connection $suitecrm -Table Accounts -Columns ("Name","Industry") -Values ($_.Name, $_.Industry)

As always, our goal is to simplify the way you connect to data. With cmdlets users can install a data module, set the connection properties, and start building. Download Cmdlets and start working with your data in PowerShell today!