PowerShell Scripting to Replicate Raisers Edge NXT Data to MySQL

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Raisers Edge NXT Data Cmdlets

An easy-to-use set of PowerShell Cmdlets offering real-time access to Raisers Edge NXT. The Cmdlets allow users to easily access live data - just like working with SQL server.



Write a simple PowerShell script to replicate Raisers Edge NXT data to a MySQL database.

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

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

Before establishing a connection, supply the SubscriptionKey, found in the Blackbaud Raiser's Edge NXT Profile.

Authenticating to Raiser's Edge NXT

Blackbaud Raiser's Edge NXT uses the OAuth authentication standard. You can connect to without setting any connection properties using the embedded OAuth credentials.

Alternatively, you can authenticate by creating a custom app to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties.

See the Help documentation for an authentication guide.

Collecting Raisers Edge NXT Data

  1. Install the module:

    Install-Module RaiserEdgeNXTCmdlets
  2. Connect to Raisers Edge NXT:

    $raiseredgenxt = Connect-RaiserEdgeNXT -SubscriptionKey $SubscriptionKey -OAuthClientId $OAuthClientId -OAuthClientSecret $OAuthClientSecret -CallbackURL $CallbackURL
  3. Retrieve the data from a specific resource:

    $data = Select-RaiserEdgeNXT -Connection $raiseredgenxt -Table "Constituents"

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

    $data = Invoke-RaiserEdgeNXT -Connection $raiseredgenxt -Query 'SELECT * FROM Constituents WHERE Type = @Type' -Params @{'@Type'='Home'}
  4. Save a list of the column names from the returned data.

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

Inserting Raisers Edge NXT 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 Raisers Edge NXT 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 Raisers Edge NXT resource (Constituents) and to exist in the database.

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

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

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