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

Dibyendu Datta
Dibyendu Datta
Lead Technology Evangelist
CData ODBC ドライバーを使って、ColdFusion でZuora のデータ をインポート・活用。

Adobe ColdFusion は、Web およびモバイルアプリケーションの開発プラットフォームです。独自のスクリプト言語である ColdFusion Markup Language(CFML)を使用して、データ駆動型の Web サイトを作成したり、REST などのリモートサービスを生成したりできます。ColdFusion を CData ODBC Driver for Zuora と組み合わせることで、ColdFusion の Web およびモバイルアプリケーションとZuora のライブデータを連携できます。これにより、アプリケーションをより堅牢で完全なものにすることができます。この記事では、ODBC ドライバーを使って、ColdFusion マークアップファイル内でZuora のデータを取得してテーブルを作成する方法を説明します。

このチュートリアルを進めるには、CData ODBC Driver for Zuora と Adobe ColdFusion をインストールする必要があります。

接続の設定

まだ設定していない場合は、ODBC DSN(データソース名)で接続プロパティを指定します。これはドライバーインストールの最終ステップです。Microsoft ODBC データソースアドミニストレーターを使って ODBC DSN を作成・設定できます。

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 サービスを使用します。デフォルトでは、ZuoraServiceAQuADataExport に設定されています。

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回再試行可能で、その後失敗として返されます。

データソースの追加とテーブルの作成

DSN を作成したら、以下の手順に従って、新しいデータソースを追加し、接続をテストし、ColdFusion マークアップファイルを作成し、最後にZuora のデータをインポートして ColdFusion でテーブルに表示します。

  1. ColdFusion 管理インターフェースから、Data & Services を選択します。
  2. ここで「Add New Data Source」をクリックします。データソース名は、ColdFusion の変数命名規則に準拠していれば任意の名前で構いません。ODBC ドライバーの場合は「ODBC Socket」を選択し、「Add」ボタンをクリックします。
  3. ODBC DSN ドロップダウンメニューから CData Zuora Sys を選択します。Advanced Settings セクションでは、Connection String は空白のままにしておきます。なお、この入力フィールドで指定されたプロパティは、DSN 設定で指定されたものを上書きします。
  4. 次に、先ほど作成した CDataZuoraODBC データソースの左側にあるチェックマークを押して、接続をテストします。データソースが「OK」ステータスを報告したら、使用する準備ができています。
  5. 次に、新しい ColdFusion マークアップファイル(.cfm)を作成し、ColdFusion の wwwroot ディレクトリ(「C:\ColdFusion2021\cfusion\wwwroot」)に配置します。

    以下のコードでデータソースをクエリします:

              
          <cfquery name="ZuoraQuery" dataSource="CDataZuoraODBC">
            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="CDataZuoraODBC">
    
            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>
      
  6. 最後に、ブラウザでコードを実行します。Zuora のデータを含むテーブルが表示されます。

なお、CData ODBC ドライバーは cfqueryparam 要素を使用したパラメータ化クエリもサポートしています。例:

SELECT * FROM Account WHERE name =  

おわりに

CData ODBC Driver for Zuora の 30日間無償トライアルをダウンロードして、Adobe ColdFusion でZuora 連携アプリケーションの構築を始めましょう。ご不明な点がございましたら、サポートチームまでお問い合わせください。

はじめる準備はできましたか?

Zuora ODBC Driver の無料トライアルをダウンロードしてお試しください:

 ダウンロード

詳細:

Zuora Icon Zuora ODBC Driver お問い合わせ

Zuora ODBC Driver を使って、ODBC 接続をサポートするあらゆるアプリケーション・ツールからZuora にデータ連携。

Zuora データにデータベースと同感覚でアクセスして、Zuora に使い慣れたODBC インターフェースで連携。