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

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

CData ODBC ドライバとは？

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

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

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

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

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

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

OAuth 認証の設定

Microsoft Graph API は認証に OAuth 2.0 を使用します。OAuth 認証情報（Client ID と Client Secret）を取得するには、Microsoft Azure Portal でアプリケーションを登録する必要があります。

OAuth 認証情報の取得

1. Azure Portal にログインします。
2. Azure Active Directory > App registrations に移動します。
3. New registration をクリックして新しいアプリケーションを作成します。
4. アプリケーション名を入力し、適切なアカウントの種類を選択します。
5. Redirect URI をアプリケーションのコールバック URL に設定します（デスクトップアプリの場合は http://localhost:33333 など）。
6. Register をクリックしてアプリケーションを作成します。
7. アプリケーションの概要ページで Application (client) ID をコピーします。これが OAuthClientId になります。
8. Certificates & secrets に移動して、新しいクライアントシークレットを作成します。
9. クライアントシークレットの値をコピーします。これが OAuthClientSecret になります。
10. API permissions に移動して、必要な Microsoft Graph API の権限を追加します：
    • Mail.Read - メールメッセージへのアクセス用
    • Contacts.Read - 連絡先へのアクセス用
    • Calendars.Read - カレンダーイベントへのアクセス用
    • Tasks.Read - To Do タスクへのアクセス用
    • offline_access - リフレッシュトークンの取得用
11. Grant admin consent をクリックして、これらの権限を付与します。

OAuth での接続

以下の接続プロパティを設定して接続を確立してください：

• AuthScheme：OAuth に設定します。
• InitiateOAuth：GETANDREFRESH に設定します。CData API Profile for Outlook が OAuth プロセスを自動的に進め、アクセストークンを取得します。
• OAuthClientId：Azure Portal の Application (client) ID に設定します。
• OAuthClientSecret：Azure Portal のクライアントシークレットの値に設定します。
• TenantId：Azure AD のテナント識別子（GUID または 'contoso.onmicrosoft.com' のようなドメイン名）に設定します。
• CallbackURL：アプリ登録で指定したリダイレクト URI に設定します（デスクトップアプリの場合は http://localhost:33333 など）。

接続文字列の例

Profile=C:\profiles\Outlook.apip;AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;TenantId=your_tenant_id;CallbackUrl=http://localhost:33333;

SQL を使用してOutlook と対話

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

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

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

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 メソッドを呼び出してOutlook メタデータを取得し、Outlook テーブルのツリーデビューを生成します。

   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］に表示されます。ダイアグラムで選択したカラムがクエリに追加されます。