PowerShell Scripting to Replicate HCL Domino Data to MySQL

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

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

Connecting to Domino

To connect to Domino data, set the following properties:

• URL: The host name or IP of the server hosting the Domino database. Include the port of the server hosting the Domino database. For example: http://sampleserver:1234/
• DatabaseScope: The name of a scope in the Domino Web UI. The driver exposes forms and views for the schema governed by the specified scope. In the Domino Admin UI, select the Scopes menu in the sidebar. Set this property to the name of an existing scope.

Authenticating with Domino

Domino supports authenticating via login credentials or an Entra ID (formerly Azure AD) OAuth application:

Login Credentials

To authenticate with login credentials, set the following properties:

• AuthScheme: Set this to "OAuthPassword"
• User: The username of the authenticating Domino user
• Password: The password associated with the authenticating Domino user

The driver uses the login credentials to automatically perform an OAuth token exchange.

EntraID (formerly AzureAD)

This authentication method uses Entra ID (formerly Azure AD) as an IdP to obtain a JWT token. You need to create a custom OAuth application in Entra ID (formerly Azure AD) and configure it as an IdP. To do so, follow the instructions in the Help documentation. Then set the following properties:

• AuthScheme: Set this to "EntraID (formerly AzureAD)"
• InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
• OAuthClientId: The Client ID obtained when setting up the custom OAuth application.
• OAuthClientSecret: The Client secret obtained when setting up the custom OAuth application.
• CallbackURL: The redirect URI defined when you registered your app. For example: https://localhost:33333
• AzureTenant: The Microsoft Online tenant being used to access data. Supply either a value in the form companyname.microsoft.com or the tenant ID.

  The tenant ID is the same as the directory ID shown in the Azure Portal's Entra ID (formerly Azure AD) > Properties page.

Collecting HCL Domino Data

1. Install the module:

   Install-Module DominoCmdlets

2. Connect to HCL Domino:

    $domino = Connect-Domino -Server $Server -AuthScheme $AuthScheme -User $User -Password $Password
    

3. Retrieve the data from a specific resource:

    $data = Select-Domino -Connection $domino -Table "ByName"
    

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

    $data = Invoke-Domino -Connection $domino -Query 'SELECT * FROM ByName WHERE City = @City' -Params @{'@City'='Miami'}
    

4. Save a list of the column names from the returned data.

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

Inserting HCL Domino 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 HCL Domino 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 HCL Domino resource (ByName) and to exist in the database.

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

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

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

• If you wish to replicate the HCL Domino 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-Domino 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')}