JReport Designer で Postmark のデータを連携利用

CData JDBC Driver for Postmark のデータ を使えば、ダッシュボードやレポートから Postmark をリレーショナルデータベースのように扱い、使い慣れた SQL クエリで Postmark のデータ のライブデータにアクセスできます。この記事では、JReport Designer で Postmark のデータ に JDBC データソースとして接続し、Postmark のデータ のデータをもとにレポートを作成する方法を説明します。

Postmark ののデータに接続

1. C:\JReport\Designer\bin\setenv.bat を編集して、JAR ファイルの場所を ADDCLASSPATH 変数に追加します。

   ...
   set ADDCLASSPATH=%JAVAHOME%\lib\tools.jar;C:\Program Files\CData\CData JDBC Driver for Postmark 2016\lib\cdata.jdbc.api.jar;
   ...
   

2. File メニューから New、Data Source と進み、新しいデータソースを作成します。
3. 表示されるダイアログでデータソース名を入力し（例：CData JDBC Driver for Postmark）、JDBC を選択して OK をクリックします。
4. Get JDBC Connection Information ダイアログで、JDBC ドライバーへの接続を設定します。
   • Driver: Driver ボックスにチェックが入っていることを確認し、ドライバーのクラス名を入力します。

     cdata.jdbc.api.APIDriver

   • URL: JDBC URL を入力します。URL は jdbc:api: から始まり、その後に接続プロパティをセミコロン区切りで記述します。

     API キー認証の設定

     Postmark は、リクエストの認証にサーバー API トークンを使用します。各 Postmark サーバーは独自の API トークンを持ち、そのサーバーに関連付けられたメッセージ、バウンス、テンプレート、統計情報へのアクセスを制御します。

     Server API Token を取得するには、Postmark アカウントにログインし、接続したいサーバーに移動します。サーバー設定の API Tokens に移動して、Server API token というラベルのトークンをコピーしてください。

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

     • AuthScheme：APIKey に設定します。
     • APIKey：Postmark の Server API Token に設定します。この値は、すべてのリクエストで X-Postmark-Server-Token ヘッダーとして送信されます。

     接続文字列の例：

     Profile=C:\profiles\Postmark.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your-server-api-token"
     

     Postmark への接続

     認証を設定すると、Postmark に接続して、OutboundMessages、Bounces、Templates などの利用可能なテーブルからデータをクエリできます。

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

     JDBC URL の構築には、Postmark JDBC Driver に組み込まれている接続文字列デザイナーを使用できます。JAR ファイルをダブルクリックするか、コマンドラインから JAR ファイルを実行します。

     java -jar cdata.jdbc.api.jar
     

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

     

     JDBC URL を設定する際には、Max Rows 接続プロパティの設定も検討してください。これにより返される行数が制限され、レポートやビジュアライゼーションのデザイン時のパフォーマンス向上に役立ちます。

     一般的な JDBC URL は次のとおりです。

     jdbc:api:Profile=C:\profiles\Postmark.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your-server-api-token"

   • User: 認証に使用するユーザー名です。通常は空白のままにします。
   • Password: 認証に使用するパスワードです。通常は空白のままにします。
   

5. Add Table ダイアログで、レポートに含めるテーブル（または、このデータソースを使用する今後のレポート用のテーブル）を選択し、Add をクリックします。

   

   テーブルの読み込みが完了したら Done をクリックします。

6. Catalog Browser で、レポートを作成するためのクエリを作成できます。これはレポート作成前でも作成後でも行えます。データソース（CData JDBC Driver for Postmark）を展開（）し、Queries を右クリックして Add Query を選択します。
7. Add Table/View/Query ダイアログで、JDBC URL と Tables を展開（）し、クエリで使用するテーブルを選択して OK をクリックします。
8. Query Editor ダイアログで、含めるカラムを選択するか、SQL ボタンをクリックして独自のクエリを手動で入力します。例えば次のようになります。

   SELECT ,  FROM Bounces WHERE  = ''
   

   

   クエリが構築できたら、OK をクリックして Query Editor ダイアログを閉じます。これで Postmark のデータ を新規または既存のレポートに追加する準備が整いました。

   NOTE: クエリが構築できたら、そのクエリをもとに Business View を作成できます。Business View を使用すると、クエリに基づいた Web レポートやライブラリコンポーネントを作成できます。詳しくは、JReport のチュートリアルを参照してください。

Postmark ののデータをレポートに追加

これで Postmark のデータ を使用したレポートを作成する準備が整いました。

1. File メニューから New、Page Report と進んで新しいレポートを作成するか、既存のレポートの Chart Wizard を開きます。
2. Query を選択します（または新規作成します。上記を参照）。

3. クエリのカラムからチャートの Category と Value を設定し、Finish をクリックします。

4. レポートの View タブをクリックして、チャートを表示します。