JasperReports Server で Zuora のレポートを作成
CData JDBC Driver for Zuora を使用すると、企業全体で Zuora のデータ へのアクセスを提供できます。この記事では、JasperReports Server にドライバーをデプロイし、Zuora のデータ のビジネスビューであるレポートドメインに基づいたシンプルなレポートを作成する方法を説明します。
ドライバー JAR のデプロイ
以下の手順に従って、JasperReports Server にドライバー JAR をデプロイします。この手順は Zuora と JasperReports Server にバンドルされている Tomcat サーバーに固有のものです。Tomcat ではなく JBoss AS 7 を使用している場合は、標準的なプロセスに従って JBoss への Zuora JDBC Driver のデプロイを行ってください。
- インストールディレクトリの lib サブフォルダにあるドライバー JAR と .lic ファイルを、JasperReports Server インストールディレクトリ内の apache-tomcat フォルダの lib サブフォルダにコピーします。
-
apache-tomcat -> webapps -> jasperserver-pro -> META-INF に移動し、以下のリソースエントリを context.xml ファイルに追加します。
<Resource name="jdbc/zuora" auth="Container" type="javax.sql.DataSource" driverClassName="cdata.jdbc.zuora.ZuoraDriver" url="jdbc:zuora:OAuthClientID=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;Tenant=USProduction;ZuoraService=DataQuery;" maxActive="20" maxIdle="10" maxWait="-1" factory="com.jaspersoft.jasperserver.tomcat.jndi.JSCommonsBasicDataSourceFactory"/>
JDBC URL(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 接続プロパティを設定することもできます。これにより返される行数が制限され、レポートやビジュアライゼーションを設計する際のパフォーマンス向上に役立ちます。
-
jasperserver-pro -> WEB-INF に移動し、以下の参照を web.xml ファイルに追加します。
Zuora のデータ JSP jdbc/zuora javax.sql.DataSource Container
- サーバーを再起動します。
Zuora JDBC データソースの作成
以下の手順に従って、Zuora JDBC Driver を JDBC データソースにマッピングします。
- JasperReports Server にログインし、Create -> Data Source をクリックします。
- Type メニューで、JNDI Data Source を選択します。
- Service Name ボックスに、web.xml ファイルのリソース定義で指定した JNDI ルックアップを入力します。この例では、ルックアップは「jdbc/zuora」です。
- Save をクリックしてデータソースを作成します。
ドメインの作成
ドメインは、レポート作成者に関連するビジネスビューを提供するメタデータおよびアクセス制御レイヤーです。以下の手順に従って、Zuora のカラムを選択し、フィルタを適用し、SQL を実行してドメインを作成します。
- Create -> Domain をクリックします。ドメインの ID を入力し、保存場所を選択します。
- Data Source セクションで Browse をクリックし、作成した Zuora データソースを選択します。
- Domain Design セクションで、Create with Domain Designer をクリックします。
- テーブルが含まれるスキーマを選択します。
- Tables タブで、Data Source ペインからテーブルを選択し、矢印をクリックして Selected Tables ペインに追加します。
- Derived Tables タブでは、SQL クエリに基づいてドメインを定義できます。例えば、
SELECT Id, BillingCity FROM Invoices WHERE BillingState = 'CA'
- Joins タブでは、結合条件を構築するカラムを選択し、結合タイプを選択することでテーブルを結合できます。
- Pre-Filters タブでは、カラムをドラッグ&ドロップして、ドメインを通じて公開されるデータをフィルタする検索条件を定義します。
- Display タブで、ユーザーに提示されるデータセットに Zuora データを選択します。
- OK をクリックして変更を確定し、Submit をクリックしてドメインを作成します。
リアルタイムでデータを探索
ドメインを作成したら、データに接続する準備が整います。以下の手順に従って、Ad Hoc Editor で Ad Hoc ビューを作成します。
- Create -> Ad Hoc View をクリックします。
-
表示されるダイアログで、作成した Zuora ドメインを選択します。
-
Choose Data ページで、ビューで使用するカラムを選択します。Pre-Filters セクションでは、選択したフィールドに基づいてフィルタを作成できます。Display セクションでは、ドメインで表示されるカラム情報を変更できます。
- ウィザードが完了したら、ビュータイプを選択し、ビューにカラムを追加します。JasperSoft はドライバーのメタデータを使用して、データ型に基づいて利用可能なディメンションとメジャーを検出します。ディメンションとメジャーを Columns ボックスと Rows ボックスにドラッグします。メジャーを右クリックして集計計算を変更できます。Filters セクションで Columns スライダーを目的のデータレベルにドラッグします。
- ビューの設計中にデータの更新にアクセスするには、設計モードのツールバーでメニュー選択を Sample Data から Full Data に変更します。変更を行うと、JasperSoft Server はドライバーに対して基になる SQL クエリを実行します。
- ビューを保存します。
リアルタイムレポートの作成
これで、JasperSoft Server でホストされるレポートを作成できます。Ad Hoc Editor から作成するには、Save Ad Hoc View をクリックし、Create Report をクリックします。