PowerShell Scripting to Replicate ADP Data to MySQL

Ready to get started?

Download for a free trial:

Download Now

Learn more:

ADP Data Cmdlets

An easy-to-use set of PowerShell Cmdlets offering real-time access to ADP. 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 ADP data to a MySQL database.

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

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

Connect to ADP by specifying the following properties:

  • SSLClientCert: Set this to the certificate provided during registration.
  • SSLClientCertPassword: Set this to the password of the certificate.
  • UseUAT: The connector makes requests to the production environment by default. If using a developer account, set UseUAT = true.
  • RowScanDepth: The maximum number of rows to scan for the custom fields columns available in the table. The default value will be set to 100. Setting a high value may decrease performance.

The connector uses OAuth to authenticate with ADP. OAuth requires the authenticating user to interact with ADP using the browser. For more information, refer to the OAuth section in the Help documentation.

Collecting ADP Data

  1. Install the module:

    Install-Module ADPCmdlets
  2. Connect to ADP:

    $adp = Connect-ADP -OAuthClientId $OAuthClientId -OAuthClientSecret $OAuthClientSecret -SSLClientCert $SSLClientCert -SSLClientCertPassword $SSLClientCertPassword
  3. Retrieve the data from a specific resource:

    $data = Select-ADP -Connection $adp -Table "Workers"

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

    $data = Invoke-ADP -Connection $adp -Query 'SELECT * FROM Workers WHERE AssociateOID = @AssociateOID' -Params @{'@AssociateOID'='G3349PZGBADQY8H8'}
  4. Save a list of the column names from the returned data.

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

Inserting ADP 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 ADP 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 ADP resource (Workers) and to exist in the database.

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

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

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