Establishing a Connection

With the CData Cmdlets users can install a data module, set the connection properties, and start scripting. This section provides examples of using our RaiserEdgeNXT Cmdlets with native PowerShell cmdlets, like the CSV import and export cmdlets.

Installing and Connecting

If you have PSGet, installing the cmdlets can be accomplished from the PowerShell Gallery with the following command. You can also obtain a setup from the CData site.

Install-Module RaiserEdgeNXTCmdlets

The following line is then added to your profile, loading the cmdlets on the next session:

Import-Module RaiserEdgeNXTCmdlets;

You can then use the Connect-RaiserEdgeNXT cmdlet to create a connection object that can be passed to other cmdlets:

$conn = Connect-RaiserEdgeNXT -OAuthClientId "MyOAuthClientId" -OAuthClientSecret "MyOAuthClientSecret" -SubscriptionKey "MySubscriptionKey" -CallbackURL "http://localhost:33333"

Connecting to BlackBaud Raiser's Edge NXT

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

Authenticating to BlackBaud Raiser's Edge NXT

BlackBaud Raiser's Edge NXT provides embedded OAuth credentials that simplify connection from a Desktop application or a Headless machine. To connect from a Web application, you must create a custom OAuth application, as described in Creating a Custom OAuth Application.

To connect from all authentication flows, you must:

set AuthScheme to OAuth
set the SubscriptionKey to your Subscription Key
enable BlackBaud Raiser's Edge NXT on an authorization account to retrieve results

The following subsections describe how to authenticate to BlackBaud Raiser's Edge NXT from all available OAuth flows. For information about how to create a custom OAuth application to connect via the Web, see Creating a Custom OAuth Application. For a complete list of connection string properties available in BlackBaud Raiser's Edge NXT, see Connection.

Desktop Applications

If you are connecting from a Desktop Application, you can either connect via the embedded OAuth application, or authenticate from the desktop via a custom OAuth application, which you configure and register at the BlackBaud Raiser's Edge NXT console. For further information, see Creating a Custom OAuth Application.

Before you connect, set these properties:

Custom applications only:
- CallbackURL: The Redirect URL specified in your custom OAuth application settings.
- OAuthClientId: The Client Id specified in your custom OAuth application settings.
- OAuthClientSecret: The Client Secret specified in your custom OAuth application settings.

When you connect, the cmdlet opens the OAuth endpoint in your default browser. Log in and grant permissions to the application. The cmdlet then completes the OAuth process as follows:

Extracts the access token from the callback URL.
Obtains a new access token when the old one expires.
Saves OAuth values in OAuthSettingsLocation that persist across connections.

Web Applications

When connecting via a Web application, you must create and register a custom OAuth application with BlackBaud Raiser's Edge NXT. You can then use the cmdlet to acquire and manage the OAuth token values. For information about how to create a custom OAuth application and set it up so that it connects properly to your BlackBaud Raiser's Edge NXT environment, see Creating a Custom OAuth Application.

Get an OAuth Access Token

To obtain the OAuthAccessToken, set these properties:

OAuthClientId: The Client Id specified in your custom OAuth application settings.
OAuthClientSecret: The Client Secret specified in your custom OAuth application settings.

Then call stored procedures to complete the OAuth exchange:

Call the GetOAuthAuthorizationURL stored procedure. Set the AuthMode input to WEB and set the CallbackURL input to the Redirect URI you specified when you configured your custom OAuth application. If necessary, set the Permissions parameter to request custom permissions. The stored procedure returns the URL to the OAuth endpoint.
Navigate to the URL that the stored procedure returned in Step 1. Log in to the custom OAuth application and authorize the web application. Once the application has been authenticated, the browser redirects you to the callback URL.
Call the GetOAuthAccessToken stored procedure. Set AuthMode to WEB and the Verifier input to the "code" parameter in the query string of the callback URL. If necessary, set the Permissions parameter to request custom permissions.

To connect to data, set the OAuthAccessToken connection property to the access token returned by the stored procedure. When the access token expires after ExpiresIn seconds, call GetOAuthAccessToken again to obtain a new access token.

Headless Machines

To configure the driver to use OAuth with a user account on a headless machine, you must authenticate on another device that has an internet browser.

Choose one of the following options:
- Option 1: Obtain the OAuthVerifier value as described in Obtain and Exchange a Verifier Code, below.
- Option 2: Install the cmdlet on a machine with an Internet browser and transfer the OAuth authentication values after you authenticate through the usual browser-based flow, as described in Option 2: Transfer OAuth Settings, below.
Then configure the cmdlet to automatically refresh the access token on the headless machine.

Option 1: Obtain and Exchange a Verifier Code

To obtain a verifier code, you must authenticate at the OAuth authorization URL.

Follow the steps below to authenticate from the machine with an Internet browser and obtain the OAuthVerifier connection property.

Choose one of these options:
- If you are using the Embedded OAuth Application click BlackBaud Raiser's Edge NXT OAuth endpoint to open the endpoint in your browser.
- If you are using a custom OAuth application, create the Authorization URL by setting the following properties:
  - InitiateOAuth: Set to OFF.
  - OAuthClientId: Set to the client Id specified in your custom OAuth application.
  - OAuthClientSecret: Set to the client secret specified in your custom OAuth application.
  Then call the GetOAuthAuthorizationURL stored procedure with the appropriate CallbackURL. Open the URL returned by the stored procedure in a browser.
Log in and grant permissions to the cmdlet. You are then redirected to the callback URL, which contains the verifier code.
Save the value of the verifier code. Later you will set this in the OAuthVerifier connection property.

Next, you must exchange the OAuth verifier code for OAuth refresh and access tokens.

On the headless machine, to obtain the OAuth authentication values, set these connection properties:

InitiateOAuth: REFRESH.
OAuthVerifier: The verifier code.
OAuthSettingsLocation: Persist the encrypted OAuth authentication values to the specified location.
Custom applications only:
- OAuthClientId: The Client Id specified in your custom OAuth application settings.
- OAuthClientSecret: The Client Secret specified in your custom OAuth application settings.

After the OAuth settings file is generated, you must re-set the following properties to connect:

InitiateOAuth: REFRESH.
OAuthSettingsLocation: The location containing the encrypted OAuth authentication values. Make sure this location gives read and write permissions to the cmdlet to enable the automatic refreshing of the access token.
Custom applications only:
- OAuthClientId: The client Id specified in your custom OAuth application settings.
- OAuthClientSecret: The client secret specified in your custom OAuth application settings.

Option 2: Transfer OAuth Settings

Before you can connect on a headless machine, you need to create and install a connection with the driver on a device that supports an Internet browser. Set the connection properties as described in Desktop Applications, above.

After completing the instructions in Desktop Applications, the resulting authentication values are encrypted and written to the location specified by OAuthSettingsLocation. The default filename is OAuthSettings.txt.

Once you have successfully tested the connection, copy the OAuth settings file to your headless machine, then set the following connection properties to connect to data:

InitiateOAuth: REFRESH.
OAuthSettingsLocation: Set this to the location of your OAuth settings file. Make sure this location gives read and write permissions to the cmdlet to enable the automatic refreshing of the access token.
Custom applications only:
- OAuthClientId: The client Id specified in your custom OAuth application settings.
- OAuthClientSecret: The client secret specified in your custom OAuth application settings.

Retrieving Data

The Select-RaiserEdgeNXT cmdlet provides a native PowerShell interface for retrieving data:

$results = Select-RaiserEdgeNXT -Connection $conn -Table "Constituents" -Columns @("Id, AddressLines") -Where "Type='Home'"

The Invoke-RaiserEdgeNXT cmdlet provides an SQL interface. This cmdlet can be used to execute an SQL query via the Query parameter.

Piping Cmdlet Output

The cmdlets return row objects to the pipeline one row at a time. The following line exports results to a CSV file:

Select-RaiserEdgeNXT -Connection $conn -Table Constituents -Where "Type = 'Home'" | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myConstituentsData.csv -NoTypeInformation

You will notice that we piped the results from Select-RaiserEdgeNXT into a Select-Object cmdlet and excluded some properties before piping them into an Export-CSV cmdlet. We do this because the CData Cmdlets append Connection, Table, and Columns information onto each row object in the result set, and we do not necessarily want that information in our CSV file.

However, this makes it easy to pipe the output of one cmdlet to another. The following is an example of converting a result set to JSON:

 
PS C:\> $conn  = Connect-RaiserEdgeNXT -OAuthClientId "MyOAuthClientId" -OAuthClientSecret "MyOAuthClientSecret" -SubscriptionKey "MySubscriptionKey" -CallbackURL "http://localhost:33333"
PS C:\> $row = Select-RaiserEdgeNXT -Connection $conn -Table "Constituents" -Columns (Id, AddressLines) -Where "Type = 'Home'" | select -first 1
PS C:\> $row | ConvertTo-Json
{
  "Connection":  {

  },
  "Table":  "Constituents",
  "Columns":  [

  ],
  "Id":  "MyId",
  "AddressLines":  "MyAddressLines"
}

Modifying Data

The cmdlets make data transformation easy as well as data cleansing. The following example loads data from a CSV file into BlackBaud Raiser's Edge NXT, checking first whether a record already exists and needs to be updated instead of inserted.

Import-Csv -Path C:\MyConstituentsUpdates.csv | %{
  $record = Select-RaiserEdgeNXT -Connection $conn -Table Constituents -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-RaiserEdgeNXT -Connection $conn -Table Constituents -Columns @("Id","AddressLines") -Values @($_.Id, $_.AddressLines) -Where "Id  = `'$_.Id`'"
  }else{
    Add-RaiserEdgeNXT -Connection $conn -Table Constituents -Columns @("Id","AddressLines") -Values @($_.Id, $_.AddressLines)
  }
}

Cmdlets for Blackbaud Raisers Edge NXT