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

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

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

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

接続の設定

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

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

ApprovalMax API プロファイル設定

ApprovalMax Public API では、OAuth 2.0 の認可コードフローで認証を行います。自分のデータに接続するだけでなく、他のユーザーが各自のデータに接続できるようにすることも可能です。

まず、ApprovalMax に OAuth アプリケーションを登録する必要があります。ApprovalMax Developer Portal（https://developer.approvalmax.com/applications）にサインインし、新しいアプリケーションを作成します。OAuth アプリケーションには Client ID と Client Secret が割り当てられます。また、Redirect URI（Callback URL）を少なくとも1つ登録しておく必要があります。

Public API を利用するには、ApprovalMax の Premium サブスクリプション（または有効なトライアル）が必要です。

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

  • AuthScheme：OAuth に設定します。
  • InitiateOAuth：GETANDREFRESH に設定します。InitiateOAuth を使うと、OAuthAccessToken を取得するプロセスを管理できます。
  • OAuthClientId：ApprovalMax Developer Portal のアプリケーション設定に表示される Client ID に設定します。
  • OAuthClientSecret：ApprovalMax Developer Portal のアプリケーション設定に表示される Client Secret に設定します。
  • CallbackURL：アプリケーション設定で登録した Redirect URI に設定します。
  • Scope：（オプション）デフォルトの OAuth スコープを上書きします。デフォルト値の openid offline_access https://www.approvalmax.com/scopes/public_api/read は、このプロファイルのすべてのテーブルへの読み取り専用アクセスを許可し、リフレッシュトークンを有効にします。スコープを絞り込む際は、最小権限の原則に従ってください。

OAuth の Authorization URL は https://identity.approvalmax.com/connect/authorize、Token URL は https://identity.approvalmax.com/connect/token です。グラントタイプは authorization_code と refresh_token の両方に対応しています。

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

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

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

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

              
      <cfquery name="ApprovalMaxQuery" dataSource="CDataApprovalMaxODBC">
        SELECT * FROM UserProfiles
      </cfquery>
    CFTable を使用すると、HTML でテーブルを簡単に出力できます： 
              
        <cftable
        query = "ApprovalMaxQuery"
        border = "1"
        colHeaders
        colSpacing = "2"
        headerLines = "2"
        HTMLTable
        maxRows = "500"
        startRow = "1">

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

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

        ...

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

        SELECT * FROM UserProfiles

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

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

        ...

      </cftable>
      </body>

      </html>
  6. 最後に、ブラウザでコードを実行します。ApprovalMax のデータを含むテーブルが表示されます。 コードの実行

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

SELECT * FROM Account WHERE name =

おわりに

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

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

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

ApprovalMax に接続

この記事の内容

関連記事