ColdFusion にリアルタイムZuora データをインポートしてアプリケーションを構築

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

Adobe ColdFusion は、Web アプリケーションおよびモバイルアプリケーション開発プラットフォームです。独自のスクリプト言語であるColdFusion Markup Language（CFML）を使用し、データドリブンなWeb サイトを作成したり、REST などのリモートサービスを生成したりすることができます。

ColdFusion とCData JDBC Driver for Zuora を組み合わせると、ColdFusion のWeb アプリケーションやモバイルアプリケーションを、運用中のZuora データにリンクできます。 これにより、アプリケーションの堅牢性と完成度を高めることができます。この記事では、JDBC ドライバーを使ってColdFusion マークアップファイルからZuora のデータを入力したテーブルを作成する方法について詳しく説明します。

最適化されたデータ処理が組み込まれたCData JDBC ドライバは、リアルタイムZuora データを扱う上で高いパフォーマンスを提供します。 Zuora にSQL クエリを発行すると、CData ドライバーはフィルタや集計などのZuora 側でサポートしているSQL 操作をZuora に直接渡し、サポートされていない操作（主にSQL 関数とJOIN 操作）は組み込みSQL エンジンを利用してクライアント側で処理します。 組み込みの動的メタデータクエリを使用すると、ネイティブのデータ型を使ってZuora データを操作および分析できます。

Zuora への接続を設定する

Coldfusion とZuora の接続を確立するには、JDBC 接続文字列が必要です。

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

データソースを追加してテーブルを作成する

接続を設定したのち、次の手順に従ってはじめにCData JDBC ドライバをColdFusion のlib ディレクトリに追加し、続けて新しいデータソースを追加、接続をテスト、ColdFusion マークアップファイルを作成し、最後にZuora データとリアルタイム接続してColdFusion Markup Language（CFML）で記述されるテーブルに表示します。

1. JDBC Driver for Zuora およびlic ファイルを"C:\Program Files\CData\CData JDBC Driver for Zuora\lib" から"C:\ColdFusion2021\cfusion\wwwroot\WEB-INF\lib"にコピーします。 cdata.jdbc.zuora.jar cdata.jdbc.zuora.lic

   Note：.lic ファイルをjar ファイルとともにコピーしないと、有効なライセンスがインストールされていないことを示すライセンスエラーが表示されます。 これは評価版、製品版ともに同様です。

2. ColdFusion Administrator インターフェースで「データとサービス」を選択します。
3. 「新規のデータソースの追加」を行います。データソース名は、ColdFusion の変数命名規則に従っていればどのような名前でもかまいません。 JDBC ドライバーの場合は、「その他」を選択して「追加」ボタンをクリックします。
4. 次に、ドライバーのプロパティを入力します。
   • 「JDBC URL」は、次のような形式である必要があります： jdbc:zuora:|connectionString|
   • 典型的な接続文字列は次のようになります：
     jdbc:zuora:OAuthClientID=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;Tenant=USProduction;ZuoraService=DataQuery;InitiateOAuth=GETANDREFRESH
   • 「ドライバクラス」は次のようになります：cdata.jdbc.zuora.ZuoraDriver
   • 「ドライバ名」の入力は任意で、これは単にColdFusion Administrator コンソールでデータソースを認識するために使われます。
5. ここで、作成したCDataZuoraJDBC データソースの左側にあるチェックマークをクリックして、接続をテストしてください。 データソースのステータスが「OK」になると、使用可能な状態です。
6. 次に、ColdFusion Markup ファイル（.cfm）を新規作成し、ColdFusion のwwwroot ディレクトリ（"C:\ColdFusion2021\cfusion\wwwroot"）に配置します。

   次のコードは、データソースにクエリを実行します。

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

   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 header="<b>BillingCity</b>" align="Left" width=15 text="BillingCity"/> 
   
             ...
   
           </cftable> 
       

   HTML 部分を含むコード全体を以下に掲載します。

               
           <html> 
           <head><title>CData Software | Zuora Invoices Table Demo </title></head> 
           <body> 
           <cfoutput>#ucase("Zuora Invoices Table Demo")#</cfoutput> 
           <cfquery name="ZuoraQuery" dataSource="CDataZuoraJDBC"> 
   
             SELECT * FROM Invoices 
   
           </cfquery> 
           <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 header="<b>BillingCity</b>" align="Left" width=15 text="BillingCity"/> 
   
             ...
   
           </cftable> 
           </body> 
   
           </html>  
       

7. 最後に、デフォルトのポート8500のブラウザでコードをローカルに実行します。これでZuora のデータが入力されたテーブルが作成されました！

なお、CData JDBC ドライバはcfqueryparam 要素を使用したパラメータ化クエリもサポートしています。 次に例を示します。 SELECT * FROM Account WHERE name =

今日からはじめましょう

CData JDBC Driver for Zuora の 30日間無償トライアル をダウンロードして、Adobe ColdFusion でZuora と連携したアプリケーションの作成をはじめましょう！ご不明な点があれば、サポートチームにお問い合わせください。