ColdFusion でZuora のデータに連携する方法

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

CData JDBC Driver for Zuora は、ColdFusion のrapid development tools を使ってZuora への接続をシームレスに統合します。この記事では、ColdFusion でZuora に連携しZuora テーブルをクエリする方法を説明します。

ColdFusion にZuora のJDBC データソースを作成

下記の手順に従ってZuora のデータソースを作成し、ColdFusion アプリケーションへの連携を可能にします。

1. ドライバーのJAR および.lic ファイルを、インストールディレクトリから C:\ColdFusion10\cfusion\wwwroot\WEB-INF\lib にコピーします。

   ドライバーのJAR およびlicense はインストールディレクトリの［lib］サブフォルダに配置されています。

2. ドライバーをデータソースとして追加：

   ColdFusion Administrator インターフェースで［Data & Services］ノードを展開し、［Data Sources］>［Add New Data Source］をクリックします。ダイアログが表示されたら、以下のプロパティを入力します。

   • Data Source Name：データソースの名前を入力。名前はColdFusion 変数命名規則に一致する必要があります。
   • Driver：［Other］を選択。

3. JDBC Driver のプロパティ設定:

   • JDBC URL：JDBC URL に接続プロパティを入力。JDBC のURL は以下で始まり jdbc:zuora: 次に、セミコロン区切りでname=value ペアの接続プロパティを入力します。以下は一般的なJDBC URL です：

     jdbc:zuora:OAuthClientID=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;Tenant=USProduction;ZuoraService=DataQuery;

     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回再試行可能で、その後失敗として返されます。
   • Driver Class：ドライバーのクラスを入力。ドライバークラスは、以下のとおりです。cdata.jdbc.zuora.ZuoraDriver
   • Driver Name：ユーザー定義のドライバー名を入力。ドライバー名はColdFusion Administrator コンソールでデータソースを認識するために使われます。
   • Username：認証するユーザーネームを入力。
   • Password：認証するパスワードを入力。

［Actions］ カラムのCData Zuora のデータソースを有効にして、接続をテストできます。ステータスがOK になったら、Zuora のデータソースを使うことができます。

クエリを実行

下記の手順に従って、Zuora の基準に合ったレコードをクエリし、結果をHTML テーブルに出力する簡単なアプリケーションを作成します。

1. 新規ColdFusion markup ファイルでクエリを定義：C:\ColdFusion10\cfusion\wwwroot directory for ColdFusion の.cfm ファイルに次のコードを入力：

   <cfquery name="ZuoraQuery" dataSource="CDataZuora"> SELECT * FROM Invoices </cfquery>

   Note：CData JDBC Drivers は、cfqueryparam エレメントを使ってパラメータ化されたクエリもサポートします。例：

   <cfquery name="ZuoraQuery" dataSource="CDataZuora"> SELECT * FROM Invoices WHERE BillingState = <cfqueryparam>CA</cfqueryparam> </cfquery>

2. CFTable を使ってHTML にテーブルを出力：

   <cftable query = "ZuoraQuery" border = "1" colHeaders colSpacing = "2" headerLines = "2" HTMLTable maxRows = "500" startRow = "1"/> <cfcol header="<b>Id</b>" align="Left" width=2 text="#Id#"></cfcol> <cfcol header="<b>BillingCity</b>" align="Left" width=11 text="#BillingCity#"></cfcol> </cftable>

3. コードを実行してグリッドを表示します。

HTML 部分を含む以下のフルコードが利用できます。