PowerShell Scripting to Replicate SAP SuccessFactors LMS Data to MySQL

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

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

SAP SuccessFactors LMS uses OAuth authentication. Before connecting, you must configure an OAuth application tied to your SAP SuccessFactors LMS account.

To establish a connection, set the following properties:

• User: Your SAP SuccessFactors LMS username.
• CompanyId: Your SAP SuccessFactors company identifier.
• Url: The SAP SuccessFactors API URL (e.g., https://api4.successfactors.com).
• OAuthClientId: The client Id assigned when you registered your custom OAuth application.
• OAuthClientSecret: The client secret assigned when you registered your custom OAuth application.

See the Getting Started chapter of the help documentation for a guide to creating a custom OAuth app and using OAuth.

Collecting SAP SuccessFactors LMS Data

1. Install the module:

   Install-Module SAPSuccessFactorsLMSCmdlets

2. Connect to SAP SuccessFactors LMS:

     $sapsuccessfactorslms = Connect-SAPSuccessFactorsLMS  -User $User -CompanyId $CompanyId -Url $Url -InitiateOAuth $InitiateOAuth
     

3. Retrieve the data from a specific resource:

     $data = Select-SAPSuccessFactorsLMS -Connection $sapsuccessfactorslms -Table "Items"
     

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

     $data = Invoke-SAPSuccessFactorsLMS -Connection $sapsuccessfactorslms -Query 'SELECT * FROM Items WHERE Active = @Active' -Params @{'@Active'='true'}
     

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 SuccessFactors LMS 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 SuccessFactors LMS 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 SuccessFactors LMS resource (Items) and to exist in the database.

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

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

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

• If you wish to replicate the SAP SuccessFactors LMS 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-SAPSuccessFactorsLMS 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')}