Active Query Builder を使用してHCL Domino 駆動型アプリを素早く開発

SQL インターフェースを介してHCL Domino を公開する標準.NET を記述します。Active Query Builder は、開発者がSQL インターフェースを作成するのに役立ちます。CData ODBC Driver for Domino は、HCL Domino への標準ベースのアクセスを可能にします。この統合では、ODBC ドライバーとActive Query Builder オブジェクト間のブリッジとして、Microsoft ADO.NET Provider for ODBC を使用してビジュアルSQL コンポーザーを構築します。

CData ODBC ドライバとは？

CData ODBC ドライバは、以下のような特徴を持った製品です。

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

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

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

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

未指定の場合は、初めに ODBC DSN（データソース名）で接続プロパティを指定します。ドライバーのインストールの最後にアドミニストレーターが開きます。Microsoft ODBC データソースアドミニストレーターを使用して、ODBC DSN を作成および設定できます。

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 と同じです。

SQL を使用してHCL Domino と対話

以下のステップに従ってWinForms ビジュアルクエリビルダーを作成します。

1. 新しいWindows Forms プロジェクトで、QueryBuilder を［Toolbox］からフォームにドラッグします。
2. ActiveQueryBuilder.ODBCMetadataProvider への参照を追加します。
3. OdbcConnection を追加し、最初のセクションで作成したDSN に接続文字列を設定します。

   OdbcConnection connection = new OdbcConnection();
   connection.ConnectionString = "DSN=Domino"
   

4. ODBCMetadataProvider インスタンスとGeneralSyntaxProvider インスタンスを初期化し、ODBCMetadataProvider オブジェクトのConnection プロパティをOdbcConnection に設定します。

   GenericSyntaxProvider syntaxProvider = new GenericSyntaxProvider();
   ODBCMetadataProvider metadataProvider = new ODBCMetadataProvider();
   metadataProvider.Connection = connection;
   

5. QueryBuilder オブジェクトの、対応するMetadataProvider プロパティとSyntaxProvider プロパティを設定します。

     queryBuilder1.MetadataProvider = metadataProvider;
     queryBuilder1.SyntaxProvider = syntaxProvider;
   

6. QueryBuilder クラスのInitiatelizeDatabaseSchemaTree メソッドを呼び出してHCL Domino メタデータを取得し、HCL Domino テーブルのツリーデビューを生成します。

   queryBuilder1.InitializeDatabaseSchemaTree();

7. QueryBuilder を作成したら、それをTextBox に接続するか、使用する場合は、ActiveQueryBuilder SQLTextEditor に接続しますSQLTextEditor をデザイナにドラッグし、ドロップします。

8. 以下のコードをSQLTextEditor のValidating イベントに追加します。

   private void sqlTextEditor1_Validating(object sender, CancelEventArgs e) {
     try {
   
       // Update the query builder with manually edited query text:
       queryBuilder1.SQL = sqlTextEditor1.Text;
     }
     catch (SQLParsingException ex) {
       e.Cancel = true;
   
       // Set caret to error position
       sqlTextEditor1.SelectionStart = ex.ErrorPos.pos;
   
       // Report error
       MessageBox.Show(ex.Message, "Parsing error");
     }
   }
   

9. SQLUpdated イベントに以下を追加します。

   private void queryBuilder1_SQLUpdated(object sender, EventArgs e) {
     sqlTextEditor1.Text = queryBuilder1.FormattedSQL;
   }
   

10. これで、クエリをビジュアルに作成できます。［Columns Pane Area］のテーブルをダブルクリックすると、［entity/relationship］ダイアグラムが［Query Building Area］に表示されます。ダイアグラムで選択したカラムがクエリに追加されます。