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

Dibyendu Datta
Lead Technology Evangelist

CData JDBC Driver を使用して、ColdFusion で Xero のデータをインポートして活用する方法を説明します。

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

ColdFusion と CData JDBC Driver for Xeroを組み合わせると、ColdFusion の Web およびモバイルアプリケーションを Xero の運用データに接続できます。これにより、アプリケーションをより堅牢で完成度の高いものにできます。この記事では、 JDBC Driver を使用して、ColdFusion マークアップファイル内で Xero データを含むテーブルを作成する方法を説明します。

CData JDBC Driver は、最適化されたデータ処理機能を組み込んでおり、Xero のデータとのリアルタイム連携において圧倒的なパフォーマンスを提供します。複雑な SQL クエリを Xero に発行すると、ドライバーはフィルタや集計などのサポートされている SQL 操作を Xero に直接プッシュし、サポートされていない操作（多くの場合 SQL 関数や JOIN 操作）は組み込みの SQL エンジンがクライアント側で処理します。組み込みの動的メタデータクエリ機能により、ネイティブのデータ型を使用して Xero のデータを操作・分析できます。

Xero データ連携について

CData を使用すれば、Xero のライブデータへのアクセスと統合がこれまでになく簡単になります。お客様は CData の接続機能を以下の目的で利用しています：

Xero Accounts と、米国およびオーストラリアの Payroll API の両方に接続できます。
Customers、Transactions、Invoices、Sales Receipts などの Xero オブジェクトの読み取り、書き込み、更新、削除ができます。
SQL ストアドプロシージャを使用して、カートへのアイテム追加、注文の送信、添付ファイルのダウンロードなどのアクションを実行できます。
会計、給与、ファイル、固定資産、プロジェクトデータを扱うことができます。

お客様は、Tableau、Qlik Sense、Excel などのお気に入りのツールと Xero データを定期的に統合し、Xero データをデータベースやデータウェアハウスに統合しています。

はじめに

Xero への接続を設定

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

接続には、認証用の値に加えてSchema 接続プロパティを設定してください。Xero はプライベートアプリケーション、パブリックアプリケーション、パートナーアプリケーションに認証を提供します。設定したアプリケーションに応じて、XeroAppAuthentication プロパティを PUBLIC、PRIVATE、またはPARTNER に設定する必要があります。プライベートアプリケーションから接続するには、追加でOAuthAccessToken、OAuthClientId、 OAuthClientSecret、CertificateStoreType、CertificateStore、およびCertificateStorePassword を設定してください。

パブリックまたはパートナーアプリケーションから接続する場合は、埋め込みOAuthClientId、OAuthClientSecret、およびCallbackURL を指定するか、アプリを登録してOAuth の値を入手できます。

Xero への認証については、ヘルプドキュメントの「はじめに」を参照してください。

組み込みの接続文字列デザイナー

JDBC URL の構築をサポートするために、Xero JDBC Driver に組み込まれている接続文字列デザイナーを使用できます。JAR ファイルをダブルクリックするか、コマンドラインから JAR ファイルを実行してください。

java -jar cdata.jdbc.xero.jar

組み込みの接続文字列デザイナーを使用して JDBC URL を生成（xero の例）

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

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

Xero 用の JDBC Driver と lic ファイルを「C:\Program Files\CData[product_name]\lib」から「C:\ColdFusion2021\cfusion\wwwroot\WEB-INF\lib」にコピーします。
```
            cdata.jdbc.xero.jar
            cdata.jdbc.xero.lic
        
```
注意：.lic ファイルを jar と一緒にコピーしないと、有効なライセンスがインストールされていないことを示すライセンスエラーが表示されます。これはトライアル版と製品版の両方に当てはまります。
ColdFusion 管理画面から、Data & Services を選択します。
ここで「Add New Data Source」をクリックします。データソース名は、ColdFusion の変数命名規則に従っていれば任意の名前を指定できます。 JDBC Driver の場合は「other」を選択し、「Add」ボタンをクリックします。
次に、ドライバーのプロパティを入力します。
- JDBC URL は次の形式で指定します： jdbc:xero:|connectionString|
- 一般的な接続文字列は次のようになります：
  
  jdbc:xero:
- Driver Class：cdata.jdbc.xero.XeroDriver
- Driver Name は任意で、ColdFusion 管理コンソールでデータソースを識別するためだけに使用されます。
作成した CDataXeroJDBC データソースの左側にあるチェックマークをクリックして、接続をテストします。データソースが「OK」ステータスを報告すれば、使用可能な状態です。

次に、新しい ColdFusion マークアップファイル（.cfm）を作成し、ColdFusion の wwwroot ディレクトリ（「C:\ColdFusion2021\cfusion\wwwroot」）に配置します。

以下のコードでデータソースにクエリを実行します：

            
        <cfquery name="XeroQuery" dataSource="CDataXeroJDBC">
          SELECT * FROM Items
        </cfquery>

CFTable を使用すると、HTML でテーブルを素早く出力できます：

            
          <cftable
          query = "XeroQuery"
          border = "1"
          colHeaders
          colSpacing = "2"
          headerLines = "2"
          HTMLTable
          maxRows = "500"
          startRow = "1">

          <cfcol header="<b>Name</b>" align="Left" width=2 text="Name"/>

          <cfcol header="<b>QuantityOnHand</b>" align="Left" width=15 text="QuantityOnHand"/>

          ...

        </cftable>

HTML 部分を含む完全なコードは以下のとおりです：

            
        <html>
        <head><title>CData Software | Xero Items Table Demo </title></head>
        <body>
        <cfoutput>#ucase("Xero Items Table Demo")#</cfoutput>
        <cfquery name="XeroQuery" dataSource="CDataXeroJDBC">

          SELECT * FROM Items

        </cfquery>
        <cftable
          query = "XeroQuery"
          border = "1"
          colHeaders
          colSpacing = "2"
          headerLines = "2"
          HTMLTable
          maxRows = "500"
          startRow = "1">
          <cfcol header="<b>Name</b>" align="Left" width=2 text="Name"/>

          <cfcol header="<b>QuantityOnHand</b>" align="Left" width=15 text="QuantityOnHand"/>

          ...

        </cftable>
        </body>

        </html>