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  -Server "$Server" -Database "$Database" -Port "$Port" -SSLClientCertType "$SSLClientCertType" -SSLClientCert "$SSLClientCert" -SSLServerCert "$SSLServerCert"

Domino 接続プロパティの取得・設定方法

接続の前に

CData 製品を経由してDomino に接続するには、「Proton コンポーネント」のインストールが必要です。通常、 Proton はAppDev パックの一部として配布されています。Proton またはAppDev パックの入手およびインストール方法については、HCL のドキュメントを参照してください。

CData 製品は匿名アクセス、またはクライアント証明書の提供によりProton を認証できます。 これらのオプションは両方ともDomino で特定の設定が必要です。

次の2セクションでは、接続に必要な事前設定について説明します。使用したい認証方法に対応するセクションを参照してください。

クライアント証明書による認証の設定

クライアント証明書による認証では、CData 製品は専用のユーザーアカウントとして接続します。このユーザーには、接続するすべてのデータベースに対するdesigner またはそれ以上のアクセス権が付与する必要があります。

また、CData 製品を使用するためにはユーザーがインターネット証明書を取得する必要があります。サーバーコンソールで以下のコマンドを実行することで、Proton にこの証明書を作成させることができます。 APPUSER はCData 製品でアクセス設定するユーザーアカウント名、ADMINISTRATOR は証明書を受け取るユーザー名です。

新しい証明書は、Notes のADMINISTRATOR メールボックスから利用できます。証明書は、クライアント証明書（clientcert）およびキー（clientkey）の2ファイルに分けて送信される場合があります。 キーファイルのテキストを証明書ファイルの末尾にコピーアンドペーストして、2つのファイルを結合する必要があります。

匿名認証の設定

匿名アクセスでは、CData 製品はAnonymous という一般的なユーザーアカウントで接続します。 接続するすべてのデータベースには、次の2つの権限が設定される必要があります。

• Anonymous ユーザーには、designer またはそれ以上のデータベースへのアクセス権が付与される必要があります。
• データベースは、Maximum Internet name and password オプションがdesigner またはそれ以上のアクセスに設定される必要があります。 この設定は、データベースのAccess Control List オプションのAdvanced タブにあります。

Domino への接続

接続するには以下を設定します。

• Server：Proton サービスを使ってDomino を実行中のサーバーのIP アドレス。
• Port：Proton サービスがリッスンしているポート番号。
• Database：.nsf 拡張子を含むデータベースファイル名。
• SSLServerCert：サーバーが受け入れ可能なTLS/SSL 証明書に設定。コンピュータによって信頼されていない他の証明書はすべて拒否されます。または、"*" を設定するとすべての証明書を受け入れます。

Domino への認証

CData 製品は、クライアント証明書を使用してProton に認証することも、匿名アクセスで認証することも可能です。

クライアント証明書による認証

クライアント証明書で認証するには以下を設定します。

• AuthScheme：SSLCertificate に設定。
• SSLClientCertType：これは、証明書ファイルの形式と一致する必要があります。 通常、.pem 証明書の場合はPEMKEY_FILE、.pfx 証明書の場合はPFXFILE のいずれかになります。
• SSLClientCert：証明書ファイルへのパス。

匿名認証

匿名認証を使用するには、AuthScheme をAnonymous に設定します。

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

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日間無償トライアルをダウンロードして、シンプルかつパワフルなデータ連携をお試しください。