Mule アプリケーションからZuora のデータにアクセス：CData JDBC Driver

こんにちは！ドライバー周りのヘルプドキュメントを担当している古川です。

CData JDBC Driver for Zuora はZuora のデータをMule アプリケーションと連携することで、読み、書き、更新、削除といった機能をおなじみのSQL クエリを使って実現します。JDBC ドライバーを使えば、Zuora のデータをバックアップ、変換、レポート作成、分析するMule アプリケーションをユーザーは簡単に作成できます。

本記事では、Mule プロジェクト内でCData JDBC Driver for Zuora を使用して、Zuora のデータのWeb インターフェースを作成する方法を紹介します。作成したアプリケーションを使えば、HTTP 経由でZuora のデータをリクエストして、JSON 形式で結果を取得できます。まったく同様の手順で、すべてのCData JDBC ドライバで250 を超えるデータソースのWeb インターフェースを作成できます。手順は以下のとおりです。

1. Anypoint Studio で新しいMule プロジェクトを作る。
2. Message Flow にHTTP コネクタを追加する。
3. HTTP コネクタのアドレスを設定する。
4. HTTP コネクタの追加後、Database Select コネクタを同じフローに追加する。
5. データベースへの新しい接続を作成し（または既存の接続を編集し）、プロパティを設定する。
   • 接続を「Generic Connection」に設定
   • Required Libraries セクションでCData JDBC ドライバのJAR ファイルを指定する(例：cdata.jdbc.zuora.jar)。
   • Zuora の接続文字列に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

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

   • Driver クラス名をcdata.jdbc.zuora.ZuoraDriver に指定します。
   • 「接続テスト」をクリックします。
6. SQL Query Text をZuora のデータをリクエストするためのSQL クエリに設定します。例えば、SELECT Id, BillingCity FROM Invoices WHERE BillingState = 'CA'。
7. Transform Message コンポーネントをフローに追加します。
8. Output スクリプトを次のように設定して、ペイロードをJSON に変換します。

   %dw 2.0
   output application/json
   ---
   payload
           

9. Zuora のデータを閲覧するには、HTTP コネクタ用に設定したアドレスに移動します（デフォルトでは、localhost:8081）：http://localhost:8081。Web ブラウザおよびJSON エンドポイントを使用可能な他のツール内で、Zuora のデータをJSON として利用できます。

これで、カスタムアプリケーションおよび他のさまざまなBI、帳票、ETL ツールからZuora のデータを（JSON データとして）扱うための簡易なWeb インターフェースを作成できました。Mule アプリケーションからお好みのデータソースにアクセスできる、JDBC Driver for Zuora の30日の無償評価版のダウンロードはこちらから。