JReport Designer でZuora データを連携

こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。

CData JDBC Driver for Zuora を使用すると、Zuora がリレーショナルデータベースであるかのようにダッシュボードやレポートからリアルタイムデータにアクセスでき、使い慣れたSQL クエリを使用してZuora] をクエリできます。ここでは、JDBC データソースとしてZuora に連携し、JReport Designer でZuora のレポートを作成する方法を説明します。

Zuora データに接続

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

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

2. ［File］［New］［Data Source］と進み、新しいデータソースを作成します。
3. 表示されるダイアログで、データソースの名前(CData JDBC Driver for Zuora) を作成し、JDBC を選択して［OK］をクリックします。
4. ［JDBC Connection Information］ダイアログで、JDBC ドライバーへの接続を構成します。
   • Driver:［Driver］ボックスにチェックがついていることを確認し、ドライバーのクラスの名前を入力します。 cdata.jdbc.zuora.ZuoraDriver
   • URL:jdbc:zuora: から始まり、その後にセミコロンで区切られた接続プロパティのリストが続くJDBC URL を入力します。

     Zuora はユーザー認証にOAuth 標準を使用しています。OAuth 認証ついて詳しくは、オンラインヘルプドキュメントを参照してください。

     Tenant プロパティの設定

     プロバイダへの有効な接続を作成するには、アカウントの設定と合致するテナント値を1つ選択する必要があります。以下は、利用可能なオプションのリストです。
     • USProduction：リクエストはhttps://rest.zuora.com に送信されます。
     • USAPISandbox：リクエストはhttps://rest.apisandbox.zuora.com に送信されます。
     • USPerformanceTest：リクエストはhttps://rest.pt1.zuora.com に送信されます。
     • EUProduction：リクエストはhttps://rest.eu.zuora.com に送信されます。
     • EUSandbox：リクエストはhttps://rest.sandbox.eu.zuora.com に送信されます。

     デフォルトではUSProduction テナントを使用します。

     Zuora サービスの選択

     データクエリとAQuA API の2つのZuora サービスを使用します。デフォルトでは、ZuoraService はAQuADataExport に設定されています。

     DataQuery

     データクエリ機能は、非同期の読み取り専用SQL クエリを実行することで、Zuora テナントからのデータのエクスポートを実現します。 このサービスは、素早く軽量なSQL クエリでの使用を推奨します。

     制限

     • フィルタ適用後の、テーブルごとの入力レコードの最大数： 1,000,000
     • 出力レコードの最大数： 100,000
     • テナントごとの、実行用に送信される同時クエリの最大数： 5
     • テナントごとの、同時クエリの制限に達した後に実行用に送信され、キューに追加されるクエリの最大数： 10
     • 1時間単位での、各クエリの最大処理時間： 1
     • GB 単位での、各クエリに割り当てられるメモリの最大サイズ： 2
     • Index Join を使用する際のインデックスの最大値。言い換えれば、Index Join を使用する際にWHERE 句で使われる一意の値に基づいた、左のテーブルから返されるレコードの最大数： 20.000

     AQuADataExport

     AQuA API のエクスポートは、すべてのオブジェクト（テーブル）のすべてのレコードをエクスポートするように設計されています。AQuA のクエリジョブには以下の制限があります。

     制限

     • AQuA のジョブ内のクエリが8時間以上実行されている場合、ジョブは自動的に停止されます。
     • 停止されたAQuA のジョブは3回再試行可能で、その後失敗として返されます。

     ビルトイン接続文字列デザイナー

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

     java -jar cdata.jdbc.zuora.jar

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

     JDBC URL を構成する際、Max Rows 接続プロパティを設定することもできます。これによって戻される行数を制限するため、可視化・レポートのデザイン設計時のパフォーマンスを向上させるのに役立ちます。

     以下は一般的なJDBC URLです。

     jdbc:zuora:OAuthClientID=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;Tenant=USProduction;ZuoraService=DataQuery;InitiateOAuth=GETANDREFRESH
   • User:認証に使用するユーザー名は、通常空白のままにします。
   • Password:User と同様に認証に使用するパスワードも、通常は空白のままにします。

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

   ダイアログがテーブルのロードを完了したら、［Done］をクリックします。

6. ［Catalog Browser］では、レポートの作成に使用するクエリを作成できます。今すぐ、またはレポートの作成後に作成できますが、どちらにしても、 データソース(CData JDBC Driver for Zuora) を展開()し、［Queries］を右クリックして［Add Query］を選択します。
7. ［Add Table/View/Query］ダイアログで、JDBC URL とTables を展開() し、クエリで使用するテーブルを選択して［OK］をクリックします。
8. ［Query Editor］ダイアログで、含めるカラムを選択するか、［SQL］ボタンをクリックして以下のようにカスタムクエリを手動で入力できます。

   SELECT Id, BillingCity FROM Invoices WHERE BillingState = 'CA'
   

   クエリが作成されたら、［OK］をクリックして［Query Editor］ダイアログを閉じます。この時点で、Zuora を新規または既存のレポートに追加する準備が整いました。

   NOTE: クエリが作成されると、クエリに基づいて［Business View］を作成できます。［Business View］を使用すると、クエリに基づいてWeb レポートまたはライブラリコンポーネントを作成できます。これについてのより詳しい情報は、JReport のチュートリアルを参照してください。

レポートにZuora データを追加

Zuora を使用してレポートを作成することができるようになりました。

1. 新しいレポートを作成(［File］［New］［Page Report］) するか、既存のレポートの［Chart Wizard］を開きます。
2. クエリを選択(または上記を参照して新しいクエリを作成) します。
3. クエリのカラムからグラフの［Category］と［Value］を割り当て、［Finish］をクリックします。
4. レポートの［View］タブをクリックし、チャートを表示します。