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

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

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

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

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

Harvest への接続を設定

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

まず、Profile 接続プロパティをディスク上のHarvest プロファイルの場所に設定します（例：C:\profiles\Harvest.apip）。次に、ProfileSettings 接続プロパティをHarvest の接続文字列に設定します（以下を参照）。

Harvest API プロファイル設定

Harvest に認証するには、トークン認証またはOAuth 標準のいずれかを使用できます。自分のデータに接続するにはBasic 認証を使用します。他のユーザーが自分のデータに接続できるようにするにはOAuth を使用します。

トークン認証の使用

トークン認証を使用するには、ProfileSettings 接続プロパティでAPIKey にHarvest パーソナルアクセストークンを設定します。APIKey に加えて、ProfileSettings でAccountId を設定して接続します。

OAuth 認証の使用

まず、Harvest でOAuth2 アプリケーションを登録します。アプリケーションはHarvest ID の「Developers」セクションから作成できます。

以下の接続プロパティを設定すると、接続できるようになります。

  • ProfileSettings：ProfileSettings でAccountId を設定します。
  • AuthScheme：OAuth に設定します。
  • OAuthClientId：アプリ設定で指定したclient ID に設定します。
  • OAuthClientSecret：アプリ設定で指定したclient secret に設定します。
  • CallbackURL：アプリ設定で指定したRedirect URI に設定します。
  • InitiateOAuth：GETANDREFRESH に設定します。InitiateOAuth を使用して、ドライバーがOAuthAccessToken を取得および更新する方法を管理できます。

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

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

java -jar cdata.jdbc.api.jar

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

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

  1. Harvest 用の JDBC Driver と lic ファイルを「C:\Program Files\CData[product_name]\lib」から 「C:\ColdFusion2021\cfusion\wwwroot\WEB-INF\lib」にコピーします。 
                cdata.jdbc.api.jar
            cdata.jdbc.api.lic

    注意：.lic ファイルを jar と一緒にコピーしないと、有効なライセンスがインストールされていないことを示すライセンスエラーが表示されます。 これはトライアル版と製品版の両方に当てはまります。

  2. ColdFusion 管理画面から、Data & Services を選択します。
  3. ここで「Add New Data Source」をクリックします。データソース名は、ColdFusion の変数命名規則に従っていれば任意の名前を指定できます。 JDBC Driver の場合は「other」を選択し、「Add」ボタンをクリックします。
  4. 次に、ドライバーのプロパティを入力します。
    • JDBC URL は次の形式で指定します： jdbc:api:|connectionString|
    • 一般的な接続文字列は次のようになります：

      jdbc:api:Profile=C:\profiles\Harvest.apip;ProfileSettings='APIKey=my_personal_key;AccountId=_your_account_id';

    • Driver Class：cdata.jdbc.api.APIDriver
    • Driver Name は任意で、ColdFusion 管理コンソールでデータソースを識別するためだけに使用されます。
  5. 作成した CDataHarvestJDBC データソースの左側にあるチェックマークをクリックして、接続をテストします。 データソースが「OK」ステータスを報告すれば、使用可能な状態です。
  6. 次に、新しい ColdFusion マークアップファイル（.cfm）を作成し、ColdFusion の wwwroot ディレクトリ（「C:\ColdFusion2021\cfusion\wwwroot」）に配置します。

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

                
        <cfquery name="HarvestQuery" dataSource="CDataHarvestJDBC">
          SELECT * FROM Invoices
        </cfquery>
    CFTable を使用すると、HTML でテーブルを素早く出力できます： 
                
          <cftable
          query = "HarvestQuery"
          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>ClientName</b>" align="Left" width=15 text="ClientName"/>

          ...

        </cftable>
    HTML 部分を含む完全なコードは以下のとおりです： 
                
        <html>
        <head><title>CData Software | Harvest Invoices Table Demo </title></head>
        <body>
        <cfoutput>#ucase("Harvest Invoices Table Demo")#</cfoutput>
        <cfquery name="HarvestQuery" dataSource="CDataHarvestJDBC">

          SELECT * FROM Invoices

        </cfquery>
        <cftable
          query = "HarvestQuery"
          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>ClientName</b>" align="Left" width=15 text="ClientName"/>

          ...

        </cftable>
        </body>

        </html>
  7. 最後に、デフォルトポート 8500 でブラウザからコードをローカルで実行します。Harvest データが入力されたテーブルが表示されます。

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

SELECT * FROM Account WHERE name =

おわりに

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

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

API Driver で Harvest のライブデータに接続

Harvest に接続 お問い合わせ

この記事の内容

関連記事