The CData Cmdlets Module for Acumatica is a standard
PowerShell module offering straightforward integration with Acumatica.
Below, you will
find examples of using our Acumatica Cmdlets with native PowerShell cmdlets.
Creating a Connection to Your Acumatica Data
Set the following connection properties to connect to Acumatica:
- User: Set this to your username.
- Password: Set this to your password.
- Company: Set this to your company.
- Url: Set this to your Acumatica URL, in the format http://{Acumatica ERP instance URL}/entity/{Endpoint name}/{Endpoint version}/.
For example: https://acumatica.com/entity/Default/17.200.001/
See the Getting Started guide in the CData driver documentation for more information.
$conn = Connect-Acumatica -Url "$Url" -User "$User" -Password "$Password" -Company "$Company"
Selecting Data
Follow the steps below to retrieve data from the Events table and pipe the result into to a CSV file:
Select-Acumatica -Connection $conn -Table Events | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myEventsData.csv -NoTypeInformation
You will notice that we piped the results from Select-Acumatica 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-Acumatica -Connection $conn -Table Events -Where "Id = 1" | Remove-Acumatica
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 Acumatica, checking first whether a record already exists and needs to be updated instead of inserted.
Import-Csv -Path C:\MyEventsUpdates.csv | %{
$record = Select-Acumatica -Connection $Acumatica -Table Events -Where ("Id = `'"+$_.Id+"`'")
if($record){
Update-Acumatica -Connection $acumatica -Table Events -Columns ("Id","location_displayname") -Values ($_.Id, $_.location_displayname) -Where ("Id = `'"+$_.Id+"`'")
}else{
Add-Acumatica -Connection $acumatica -Table Events -Columns ("Id","location_displayname") -Values ($_.Id, $_.location_displayname)
}
}
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!