TIBCO Data Virtualization で Outlook のデータ にリアルタイムアクセスする方法

CData TIBCO DV Adapter for Outlook を使って、TIBCO Data Virtualization Studio でOutlook のデータソースを作成し、TDV Server からOutlook のデータにリアルタイムでアクセスする方法を解説します。

TIBCO Data Virtualization(TDV)は、複数の多様なデータソースへのアクセスを一元管理するエンタープライズデータ仮想化ソリューションです。CData TIBCO DV Adapter for Outlook と組み合わせることで、TIBCO Data Virtualization 内からOutlook のデータに直接フェデレーテッドアクセスが可能になります。この記事では、アダプターのデプロイと Outlook に基づく新しいデータソースの作成手順を解説します。

CData TIBCO DV Adapter は、最適化されたデータ処理機能が組み込まれており、Outlook のデータ とのインタラクションにおいて比類のないパフォーマンスを発揮します。Outlook に対して複雑な SQL クエリを発行すると、アダプターはフィルタや集計などサポートされている SQL 操作を直接 Outlook にプッシュします。組み込みの動的メタデータクエリにより、ネイティブのデータ型を使用してOutlook のデータを操作・分析できます。

Outlook TIBCO DV Adapter のデプロイ

  1. コンソールで、TDV Server のインストールディレクトリ内の bin フォルダに移動します。現在のバージョンのアダプターがインストールされている場合は、先にアンデプロイする必要があります。

    .\server_util.bat -server localhost -user admin -password ******** -undeploy -version 1 -name API
    
  2. CData TIBCO DV Adapter をローカルフォルダに解凍し、解凍した場所から JAR ファイル(tdv.api.jar)をサーバーにデプロイします。

    .\server_util.bat -server localhost -user admin -password ******** -deploy -package /PATH/TO/tdv.api.jar
    

新しい JAR ファイルが正しくロードされるように、サーバーの再起動が必要な場合があります。再起動は、C:\Program Files\TIBCO\TDV Server <version>\bin にある composite.bat スクリプトを実行して行えます。サーバーを再起動した後は、TDV Studio への再認証が必要です。

再起動コマンドの例

.\composite.bat monitor restart

OAuth を使用して Outlook で認証する

Outlook は OAuth プロトコルを使用して認証を行いますが、TDV Studio は内部でブラウザベースの認証をサポートしていないため、OAuth トークンを取得するための簡単な Java アプリケーションを作成して実行する必要があります。取得したトークンは、アダプターから直接 Outlook に接続するために使用されます。

Create the Java Application

  1. Create a new Java file with preferred name for example GenOAuthSettings.java. This Java file leverages the APIOAuth class contained within the TDV Adapter JAR to initiate a test connection and perform the required OAuth authentication flow
  2. Copy and insert the following code into the .java file:
  3. 
    public class GenOAuthSettings {
        public static void main(String[] args) {
            try {
        	    if (args.length != 2) {
        			throw new Exception("Input must have two arguments: 'data source', 'connection string'");
        		}
        
        		String source = args[0].replace(" ", "").toLowerCase();
        		String connectionString = args[1];
        		String prefix;
        
        		if (source.equals("api")) {
        			prefix = "jdbc:api:";
        
        			com.cdata.cis.api.APIOAuth oauth = new com.cdata.cis.api.APIOAuth();
        
        			if (!connectionString.startsWith(prefix)) connectionString = prefix + connectionString;
        			oauth.generateOAuthSettingsFile(connectionString);
        		}
        		// More sources can be added below using the same format.  You must add the import statement and ensure the jar file resides in the classpath
    			//            else if (source.equals("googlebigquery") || source.equals("bigquery")) {
    			//                prefix = "jdbc:googlebigquery:";
    			//
    			//                com.cdata.cis.googlebigquery.GoogleBigQueryOAuth oauth = new com.cdata.cis.googlebigquery.GoogleBigQueryOAuth();
    			//
    			//                if (!connectionString.startsWith(prefix)) connectionString = prefix + connectionString;
    			//                oauth.generateOAuthSettingsFile(connectionString);
    			//            }
        		else {
    				throw new Exception("Data Source not supported.  Available Data Sources: Outlook");
    			}
    			
    			System.out.println("Test Connection Successful!");
    		} catch (Exception e) {
    			e.printStackTrace();
    		}
    	}
    }
    
  4. Place the .java file in the same directory as the tdv.api.jar file. This is required to prevent classpath resolution errors during compilation and execution

Build and run the Java Application

  1. Open Console and navigate to the directory containing the .java file and adapter jar
  2. Compile the Java file using the following command:
  3. javac -cp .;tdv.api.jar GenOAuthSettings.java
    
  4. Execute the application using one of the following commands:
  5. java -cp .;tdv.api.jar GenOAuthSettings "API" "connection string"
    

This command initiates the OAuth authentication flow and generates the OAuth settings file at the location specified in the OAuthSettingsLocation parameter. Once you deploy the adapter and authenticate, you can create a new data source for Outlook in TDV Studio.

TDV Studio で Outlook データソースを作成する

CData TIBCO DV Adapter for Outlook を使用すると、Outlook 用のデータソースを簡単に作成し、データソースをイントロスペクトしてリソースを TDV に追加できます。

データソースの作成

  1. データソースを追加するフォルダを右クリックし、New -> New Data Source を選択します。
  2. アダプター(例:Outlook)が表示されるまでスクロールし、Next をクリックします。
  3. データソースに名前を付けます(例:CData Outlook Source)。
  4. 必要な接続プロパティを入力します。

    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 に設定します。
    • InitiateOAuthGETANDREFRESH に設定します。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;
    

    NOTE:DV Adapter の OAuthSettingsLocation プロパティには、OAuth 認証(上記参照)を実行したときと同じ値を設定してください。

  5. Create & Close をクリックします。

データソースのイントロスペクト

データソースを作成したら、右クリックして Open を選択することでデータソースをイントロスペクトできます。ダッシュボードで Add/Remove Resources をクリックし、データソースの一部として含めるテーブル、ビュー、ストアドプロシージャを選択します。Next をクリックし、Finish をクリックして、選択した Outlook のテーブル、ビュー、ストアドプロシージャをリソースとして追加します。

After creating and introspecting the data source, you are ready to work with Outlook のデータ in TIBCO Data Virtualization just like you would any other relational data source. You can create views, query using SQL, publish the data source, and more.

データソースを作成してイントロスペクトしたら、他のリレーショナルデータソースと同様に TIBCO Data Virtualization でOutlook のデータを操作できるようになります。ビューの作成、SQL によるクエリ、データソースの公開など、さまざまな操作が可能です。

はじめる準備はできましたか?

詳細:

TIBCO DV アダプタ