DBeaver からHCL Domino のデータに連携して可視化する方法とは？

こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。

CData JDBC Driver for Domino は、IDE からBI ツールまで、サードパーティーツールからHCL Domino のデータの読み書きを可能にするJDBC 標準を提供します。本記事では、DBeaver のウィザードを使ってHCL Domino のデータに接続し、GUI 上でデータを参照する方法を紹介します。

CData JDBC ドライバとは？

CData JDBC ドライバは、以下の特徴を持ったリアルタイムデータ接続ツールです。

1. HCL Domino をはじめとする、CRM、MA、グループウェア、広告、会計ツールなど多様な270種類以上のSaaS / DB に対応
2. DBeaver を含む多様なアプリケーション、ツールにHCL Domino のデータを連携
3. ノーコードでの手軽な接続設定
4. 標準 SQL での柔軟なデータ読み込み・書き込み

CData JDBC ドライバでは、1.データソースとしてHCL Domino の接続を設定、2.DBeaver 側でJDBC Driver との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。

CData JDBC ドライバのインストールとHCL Domino への接続設定

まずは、本記事右側のサイドバーからDomino JDBC Driver の無償トライアルをダウンロード・インストールしてください。30日間無償で、製品版の全機能が使用できます。

次に、以下の手順でDBeaver にドライバーのJAR ファイルをロードします。

1. DBeaver アプリケーションを開き、「データベース」メニューの「ドライバーマネジャー」オプションを選択します。「新規」をクリックして「新しいドライバを作成する」フォームを開きます。
2. 設定タブで：
   • ドライバ名をわかりやすい名前に設定します（例：CData JDBC Driver for HCL Domino）。
   • クラス名をJDBC ドライバーのクラス名「cdata.jdbc.domino.DominoDriver」に設定します。
   • URL テンプレートをjdbc:domino: に設定します。
3. ライブラリタブで「ファイルを追加」をクリックし、インストールディレクトリ（C:\Program Files\CData\CData JDBC Driver for HCL Domino XXXX\）の「lib」フォルダに移動してJAR ファイル（cdata.jdbc.Domino.jar）を選択します。

HCL Domino のデータの接続を作成

以下の手順で、認証情報およびその他の必要な接続プロパティを追加します。

1. 「データベース」メニューで、「新しい接続」をクリックします。
2. 表示される「新しい接続を作成する」 ウィザードで、先ほど作成したドライバー（例：CData JDBC Driver for HCL Domino）を選択し、「次へ >」をクリックします。
3. 設定ウィザードの一般タブで、以下を参考に必要な接続プロパティを使用してJDBC URL を設定します。

   Domino への接続

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

   • URL: Domino データベースをホスティングしているサーバーのホスト名、またはIP を入力します。サーバーのポート番号を含めてください。例えば、http://sampleserver:1234/。
   • DatabaseScope: Domino Web UI 内のスコープ名を入力します。ドライバーは、ここで指定したスコープによって制御されるスキーマの、フォームとビューを公開します。Domino Admin UI で、サイドバーからScopes メニューを選択します。このプロパティを、既存のスコープ名に設定します。

   Domino での認証

   Domino は、ログインクレデンシャルまたはAzure Active Directory OAuth アプリケーションを使用した認証をサポートしています。

   ログインクレデンシャル

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

   • AuthScheme: これを"OAuthPassword" に設定します
   • User: 認証するDomino ユーザーのユーザー名
   • Password: 認証するDominoユ ーザーに関連付けられたパスワード

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

   AzureAD

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

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

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

   組み込みの接続文字列デザイナー

   JDBC URL の作成の補助として、HCL Domino JDBC Driver に組み込まれている接続文字列デザイナーが使用できます。JAR ファイルをダブルクリックするか、コマンドラインからjar ファイルを実行します。

   java -jar cdata.jdbc.domino.jar

   接続プロパティを入力し、接続文字列をクリップボードにコピーします。

   一般的な接続文字列：

   jdbc:domino:Server=https://domino.corp.com;Database=names.nsf;Port=3002;SSLClientCertType=PEMKEY_FILE;SSLClientCert=full_path_of_certificate.pem;SSLServerCert=*
4. 「テスト接続」をクリックして、接続が正しく設定されていることを確認します。
5. 「終了」をクリックします。

HCL Domino のデータにクエリを実行

これで、接続できたことで公開されたテーブルのデータにクエリを実行できるようになりました。テーブルを右クリックし、「ビュー表」をクリックします。「データ」タブでデータを確認できます。

おわりに