Ready to get started?

Learn more about the Sage 300 PowerShell Cmdlets or download a free trial:

Download Now

PowerShell Scripting to Replicate Sage 300 Data to MySQL

Write a simple PowerShell script to replicate Sage 300 data to a MySQL database.

The CData Cmdlets for Sage 300 offer live access to Sage 300 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 Sage 300 and the CData Cmdlets for MySQL in PowerShell to replicate Sage 300 data to a MySQL database.

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

Sage 300 requires some initial setup in order to communicate over the Sage 300 Web API.

  • Set up the security groups for the Sage 300 user. Give the Sage 300 user access to the option under Security Groups (per each module required).
  • Edit both web.config files in the /Online/Web and /Online/WebApi folders; change the key AllowWebApiAccessForAdmin to true. Restart the webAPI app-pool for the settings to take.
  • Once the user access is configured, click https://server/Sage300WebApi/ to ensure access to the web API.

Authenticate to Sage 300 using Basic authentication.

Connect Using Basic Authentication

You must provide values for the following properties to successfully authenticate to Sage 300. Note that the provider reuses the session opened by Sage 300 using cookies. This means that your credentials are used only on the first request to open the session. After that, cookies returned from Sage 300 are used for authentication.

  • Url: Set this to the url of the server hosting Sage 300. Construct a URL for the Sage 300 Web API as follows: {protocol}://{host-application-path}/v{version}/{tenant}/ For example, http://localhost/Sage300WebApi/v1.0/-/.
  • User: Set this to the username of your account.
  • Password: Set this to the password of your account.

Collecting Sage 300 Data

  1. Install the module:

    Install-Module Sage300Cmdlets
  2. Connect to Sage 300:

    $sage300 = Connect-Sage300 -User $User -Password $Password -URL $URL -Company $Company
  3. Retrieve the data from a specific resource:

    $data = Select-Sage300 -Connection $sage300 -Table "OEInvoices"

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

    $data = Invoke-Sage300 -Connection $sage300 -Query 'SELECT * FROM OEInvoices WHERE AllowPartialShipments = @AllowPartialShipments' -Params @{'@AllowPartialShipments'='Yes'}
  4. Save a list of the column names from the returned data.

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

Inserting Sage 300 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 Sage 300 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 Sage 300 resource (OEInvoices) and to exist in the database.

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

You have now replicated your Sage 300 data to a MySQL database. This gives you freedom to work with Sage 300 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 Sage 300 and MySQL in PowerShell, you can pipe command results to perform the replication in a single line:

    Select-Sage300 -Connection $sage300 -Table "OEInvoices" | % { $row = $_ $values = @() $columns | % { $col = $_ $values += $row.$($col) } Add-MySQL -Connection $mysql -Table "OEInvoices" -Columns $columns -Values $values }
  • If you wish to replicate the Sage 300 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-Sage300 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')}