Ready to get started?

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

 Download Now

Learn more:

Acumatica Icon Acumatica Cmdlets

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

PowerShell Scripting to Replicate Acumatica Data to MySQL



Write a simple PowerShell script to replicate Acumatica data to a MySQL database.

The CData Cmdlets for Acumatica offer live access to Acumatica data from within PowerShell. Using PowerShell scripts, you can easily automate regular tasks like data replication. This article will walk through using the CData Cmdlets for Acumatica and the CData Cmdlets for MySQL in PowerShell to replicate Acumatica data to a MySQL database.

After obtaining the needed connection properties, accessing Acumatica data in PowerShell and preparing for replication consists of four basic steps.

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.

Collecting Acumatica Data

  1. Install the module:

    Install-Module AcumaticaCmdlets
  2. Connect to Acumatica:

    $acumatica = Connect-Acumatica -Url $Url -User $User -Password $Password -Company $Company
  3. Retrieve the data from a specific resource:

    $data = Select-Acumatica -Connection $acumatica -Table "Events"

    You can also use the Invoke-Acumatica cmdlet to execute pure SQL-92 statements:

    $data = Invoke-Acumatica -Connection $acumatica -Query 'SELECT * FROM Events WHERE Id = @Id' -Params @{'@Id'='1'}
  4. Save a list of the column names from the returned data.

    $columns = ($data | Get-Member -MemberType NoteProperty | Select-Object -Property Name).Name

Inserting Acumatica Data into the MySQL Database

With the data and column names collected, you are ready to replicate the data into a MySQL database.

  1. Install the module:

    Install-Module MySQLCmdlets
  2. Connect to MySQL, using the server address and port of the MySQL server, valid user credentials, and a specific database with the table in which the data will be replicated:

    $mysql = Connect-MySQL -User $User -Password $Password -Database $Database -Server $Server -Port $Port
  3. Loop through the Acumatica data, store the values, and use the Add-MySQL cmdlet to insert the data into the MySQL database, one row at a time. In this example, the table will need to have the same name as the Acumatica resource (Events) and to exist in the database.

    $data | % { $row = $_ $values = @() $columns | % { $col = $_ $values += $row.$($col) } Add-MySQL -Connection $mysql -Table "Events" -Columns $columns -Values $values }

You have now replicated your Acumatica data to a MySQL database. This gives you freedom to work with Acumatica data in the same way that you work with other MySQL tables, whether that is performing analytics, building reports, or other business functions.

Notes

  • Once you have connected to Acumatica and MySQL in PowerShell, you can pipe command results to perform the replication in a single line:

    Select-Acumatica -Connection $acumatica -Table "Events" | % { $row = $_ $values = @() $columns | % { $col = $_ $values += $row.$($col) } Add-MySQL -Connection $mysql -Table "Events" -Columns $columns -Values $values }
  • If you wish to replicate the Acumatica data to another database using another PowerShell module, you will want to exclude the Columns, Connection, and Table columns from the data returned by the Select-Acumatica cmdlet since those columns are used to help pipe data from one CData cmdlet to another:

    $columns = ($data | Get-Member -MemberType NoteProperty | Select-Object -Property Name).Name | ? {$_ -NotIn @('Columns','Connection','Table')}