PowerShell Scripting to Replicate SAP ByDesign Data to MySQL

Ready to get started?

Download for a free trial:

Download Now

Learn more:

SAP ByDesign Cmdlets

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

Write a simple PowerShell script to replicate SAP ByDesign data to a MySQL database.

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

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

Set the following connection properties to connect to SAP ByDesign.

  • Url: Set this to the Url of your SAP ByDesign site. For example, https://test.sapbydesign.com
  • User: Set this to the username of your account.
  • Password: Set this to the password of your account.
  • CustomService or AnalyticsService: Only one of these must be specified. If you have a custom service you want to retrieve data from, specify CustomService. If you want to retrieve the reports of a analytical service, specify AnalyticsService.
    If neither is specified, 'cc_home_analytics.svc' will used as a default for the AnalyticsService property. If you are not sure what service to specify, you can always query the Services view to list available services.

Collecting SAP ByDesign Data

  1. Install the module:

    Install-Module SAPByDesignCmdlets
  2. Connect to SAP ByDesign:

    $sapbydesign = Connect-SAPByDesign -URL $URL -User $User -Password $Password -CustomService $CustomService
  3. Retrieve the data from a specific resource:

    $data = Select-SAPByDesign -Connection $sapbydesign -Table "[Inventory Balance]"

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

    $data = Invoke-SAPByDesign -Connection $sapbydesign -Query 'SELECT * FROM [Inventory Balance] WHERE ProductCategoryID = @ProductCategoryID' -Params @{'@ProductCategoryID'='1234567'}
  4. Save a list of the column names from the returned data.

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

Inserting SAP ByDesign 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 SAP ByDesign 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 SAP ByDesign resource ([Inventory Balance]) and to exist in the database.

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

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


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

    Select-SAPByDesign -Connection $sapbydesign -Table "[Inventory Balance]" | % { $row = $_ $values = @() $columns | % { $col = $_ $values += $row.$($col) } Add-MySQL -Connection $mysql -Table "[Inventory Balance]" -Columns $columns -Values $values }
  • If you wish to replicate the SAP ByDesign 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-SAPByDesign 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')}