Jaspersoft Studio から Outlook のデータに接続

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Jaspersoft Studio でOutlook のデータにSQL を実行。



この記事では、CData JDBC Driver for Outlook を使って、Jaspersoft Studio からOutlook に標準JDBC データソースとして接続する方法を説明します。標準のJaspersoft ウィザードを使ってOutlook へのSQL クエリを作成していきます。クエリは直接Outlook API に実行されるため、Outlook のデータへのリアルタイム接続が可能になります。

Outlook のデータにJDBC データソースとして接続

Jaspersoft Studio でJDBC データソースを作成するには、データアダプタを作成します。

  1. Repository Explorer ビューで、Data Adapters ノードを右クリックし、Create Data Adapter をクリックします。
  2. Database JDBC Connection を選択します。
  3. ドライバーのわかりやすい名前を入力します。
  4. Driver Classpath タブで、Add をクリックします。表示されたダイアログで、インストールディレクトリのlib サブフォルダに移動し、ドライバーJAR を選択します。
  5. Database Location タブで、JDBC ドライバーのクラス名を入力します:cdata.jdbc.api.APIDriver
  6. JDBC URL を入力します。

    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;
    

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

    JDBC URL の構成をサポートするために、Outlook JDBC Driver に組み込まれている接続文字列デザイナーを使用してください。JAR ファイルをダブルクリックするか、コマンドラインからjar ファイルを実行します。

    java -jar cdata.jdbc.api.jar
    

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

    JDBC URL を構成する際に、Max Rows 接続プロパティも設定できます。これにより返される行数が制限され、レポートやビジュアライゼーションの設計時のパフォーマンス向上に役立ちます。

    以下はOutlook の一般的なJDBC URL です:

    jdbc:api: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;
    

Outlook のデータでレポートを作成

以下のステップに従って、Outlook へのSQL クエリを作成します。これはシンプルなレポートの基礎となります。

  1. File -> New Jasper Report をクリックします。テンプレートを選択し、親プロジェクトを選択して、レポートファイルを指定します。
  2. Data Adapter メニューで、前のセクションで作成したデータアダプタを選択します。
  3. Diagram タブで、テーブルをボックスにドラッグして、使用したいカラムをクリックします。または、Texts タブでカスタムクエリを入力します。例:
    SELECT ,  FROM CalendarGroupCalendars WHERE CalendarGroupId = 'group_id'
    
  4. データセットに含めるフィールドを選択します。この例では、すべてのフィールドを使用します。
  5. Group By ステップをスキップして、ウィザードを完了します。

Preview タブで、現在のOutlook のデータでレポートがどのように表示されるかをプレビューできます。

チャートを作成

以下のセクションでは、独自のSQL クエリに紐づいたチャートを作成する方法を説明します。リモートデータソースからデータを取得する際、特定のレポートオブジェクト用に作成したより制限的なクエリを使用すると、パフォーマンスが向上する場合があります。

DataSet を作成

以下のステップに従って、チャートを入力する新しいデータセットを作成します。

  1. レポートの編集エリアで、Design タブをクリックします。
  2. Outline ビューで、レポートのルートノードを右クリックし、Create Dataset をクリックします。
  3. データセットの名前を入力し、接続またはデータソースから新しいデータセットを作成するオプションをクリックします。
  4. Data Adapter メニューで、最初のセクションで作成したデータアダプタを選択します。
  5. 次のようなクエリを入力します:
    SELECT ,  FROM CalendarGroupCalendars WHERE CalendarGroupId = 'group_id'
    
  6. データセットに含めるフィールドを選択します。この例では と を使用します。
  7. フィールドによるグループ化のステップをスキップして、ウィザードを完了します。

チャートを構成

データセットを追加した後、以下のステップに従ってチャートウィザードでカラム値をチャートの軸にマッピングします。

  1. Outline ビューでSummary ノードをクリックします。Properties ビューで、高さを400ピクセルに設定します。Summary バンドはレポートの最後に印刷されます。
  2. パレットからチャートをSummary にドラッグします。チャートウィザードが表示されます。
  3. チャートのタイプを選択します。この例では棒グラフを使用します。
  4. Dataset メニューで、チャート用に作成したデータセットを選択します。
  5. Dataset タブで、マスターレポートの入力に使用されたものと同じJDBC 接続を使用するオプションを選択します。
  6. チャートのシリーズを指定します:Series メニューの横にあるボタンをクリックし、Add をクリックします。表示されたExpression Editor で、 カラムをダブルクリックして、式を$F{} に設定します。
  7. y 軸の値を指定します:チャートウィザードで、Value ボックスの横にあるボタンをクリックします。Expression Editor で、 をダブルクリックして、式を$F{} に設定します。

  8. シリーズ要素のラベルを指定します:チャートウィザードで、Label ボックスの横にあるボタンをクリックします。Expression Editor で、 カラムをダブルクリックして、式を$F{} に設定します。必要に応じて、以下の式のようにカラムの型を文字列に変換します:
    $F{}.toString()
    
  9. チャートを拡大してSummary セクションを埋めます:チャートを右クリックして、Size to Container -> Fit Both をクリックします。

レポートの実行

他のJDBC データソースと同様に、Outlook のデータでレポートを生成できるようになりました。Jaspersoft Studio はレポートの実行ごとにデータを定期的に更新します。

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

API Driver で Outlook のライブデータに接続

Outlook に接続