PowerShell からHCL Domino のデータに接続してデータの取得・CSV エクスポートを実行する方法

CData Cmdlets for Domino を使えば、PowerShell からHCL Domino に手軽に連携して、データのCRUD やエクスポートを実行できます。

本記事では、HCL Domino への接続方法からCSV エクスポート、データの操作までサンプルコード付きで解説していきます。

HCL Domino への接続を設定

それでは、まずはHCL Domino への接続設定からはじめていきましょう。接続設定にはCData HCL Domino Cmdlets が必要となります。右側のサイドバーから製品の全機能が使える30日間の無償トライアルがダウンロードできるので、ぜひご利用ください。

インストールが完了したら、プロファイルに以下の行を追加してください。次のPowerShell セッションでモジュールがロードされます。

    Import-Module DominoCmdlets;

Connect-Domino コマンドを使ってHCL Domino との接続を設定します。各接続プロパティの取得方法は次に説明します。

    $conn = Connect-Domino  -URL "$URL" -DatabaseScope "$DatabaseScope" -TableTypes "$TableTypes" -AuthScheme "$AuthScheme" -User "$User" -Password "$Password"

Domino への接続

それでは、Domino のデータに接続していきましょう。接続するには、以下のプロパティを設定してください。

• URL：Domino データベースをホスティングしているサーバーのホスト名またはIP アドレス。Domino データベースをホスティングしているサーバーのポートを含めます。例：http://sampleserver:1234/
• DatabaseScope：Domino Web UI でのスコープ名。CData 製品は、指定されたスコープに適合するスキーマのフォームとビューを公開します。Domino Admin UI で、サイドバーのScopes メニューを選択してください。このプロパティを既存のスコープ名に設定します

Domino での認証

続いて、認証方法を設定しましょう。Domino では、ログインクレデンシャル（OAuthPassword）またはMicrosoft Entra ID（AzureAD）のいずれかによる認証をサポートしています。

ログインクレデンシャル

ログインクレデンシャルで認証するには、以下のプロパティを設定してください：

• AuthScheme：OAuthPassword
• User：認証するDomino ユーザーのユーザー名
• Password：認証するDomino ユーザーに関連付けられたパスワード

ドライバーがログインクレデンシャルを使用して、自動的にOAuth トークン交換を実行します。

Microsoft Entra ID（Azure AD）

この認証方法は、Azure Active Directory をIdP として使用してJWT トークンを取得します。Azure Active Directory にカスタムのアプリケーションを作成し、それをIdP として設定する必要があります。詳しい手順については、ヘルプドキュメントの指示に従ってください。その後、以下のプロパティを設定します。

• AuthScheme：AzureAD
• InitiateOAuth：これをGETANDREFRESH に設定します。InitiateOAuth を使用すると、OAuth 交換の繰り返しやOAuthAccessToken の手動設定を避けることができます
• OAuthClientId：カスタムAzure AD アプリケーションの作成時に取得したクライアントID
• OAuthClientSecret：カスタムAzure AD アプリケーションの作成時に取得したクライアントシークレット
• CallbackURL：カスタムAzure AD アプリケーションの登録時に指定されたリダイレクトURI。例えば、https://localhost:33333
• AzureTenant：データにアクセスするために使用されるMicrosoft Online テナント。companyname.microsoft.com 形式の値またはテナントID のいずれかを指定してください

テナントID は、Azure ポータルのAzure Active Directory > プロパティページに表示されているディレクトリID と同じです。

これで接続設定は完了です。

HCL Domino のデータを取得してCSV にパイプライン

接続が完了したので、ByName テーブルデータを取得して結果をCSV ファイルにエクスポートします。

Select-Domino -Connection $conn -Table ByName | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myByNameData.csv -NoTypeInformation

このコードでは、Select-Domino から取得した結果をSelect-Object に流して、Export-Csv に渡す前にいくつかのプロパティを除外しています。これは、CData Cmdlets が接続情報、テーブル、およびカラム情報を結果セットのそれぞれの行に挿入するためです。それらの情報を表示したくない場合に、Export-Csv コマンドに渡す前に除外を先に行い、そのあとでCSV ファイルにエクスポートします。

おわりに

このように、CData Cmdlets を使えばPowerShell でのHCL Domino のデータへの連携をシンプルに実現できます。ぜひCData PowerShell Cmdlets の30日間無償トライアルをダウンロードして、シンプルかつパワフルなデータ連携をお試しください。