Ready to get started?

Learn more about the Xero WorkflowMax PowerShell Cmdlets or download a free trial:

Download Now

Pipe Xero WorkflowMax Data to CSV in PowerShell

Use standard PowerShell cmdlets to access Xero WorkflowMax tables.

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

Creating a Connection to Your Xero WorkflowMax Data

To connect to the WorkflowMax API, obtain an APIKey and AccountKey from Xero. This can only be done by contacting Xero support (https://www.workflowmax.com/contact-us).

After obtaining an API Key and Account Key, set the values in the APIKey and AccountKey connection properties. Once these are set, you are ready to connect.

$conn = Connect-XeroWorkflowMax  -APIKey "$APIKey" -AccountKey "$AccountKey"

Selecting Data

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

Select-XeroWorkflowMax -Connection $conn -Table Clients | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myClientsData.csv -NoTypeInformation

You will notice that we piped the results from Select-XeroWorkflowMax 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-XeroWorkflowMax -Connection $conn -Table Clients -Where "Name = Cynthia" | Remove-XeroWorkflowMax

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 Xero WorkflowMax, checking first whether a record already exists and needs to be updated instead of inserted.

Import-Csv -Path C:\MyClientsUpdates.csv | %{
  $record = Select-XeroWorkflowMax -Connection $XeroWorkflowMax -Table Clients -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-XeroWorkflowMax -Connection $xeroworkflowmax -Table Clients -Columns ("Id","Name") -Values ($_.Id, $_.Name) -Where ("Id = `'"+$_.Id+"`'")
  }else{
    Add-XeroWorkflowMax -Connection $xeroworkflowmax -Table Clients -Columns ("Id","Name") -Values ($_.Id, $_.Name)
  }
}

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!