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

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

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

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

接続の設定

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

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

UKGProHCM API プロファイル設定

UKG Pro HCM では、Basic 認証とカスタマー API キーを組み合わせて API へのアクセスを認可します。接続には、UKG Pro HCM の認証情報と、UKG が発行したカスタマー API キーが必要です。

認証するには、以下の接続プロパティを設定します。

  • AuthScheme：Basic に設定します。
  • User：UKG Pro HCM のユーザー名に設定します。
  • Password：UKG Pro HCM のパスワードに設定します。
  • ProfileSettings：以下の項目をセミコロン区切りで指定します。
    • Host：UKG Pro HCM テナントのホスト名（例：yourcompany.ultipro.com）。
    • CustomerAPIKey：UKG のカスタマー API キー。各 API 呼び出しで US-CUSTOMER-API-KEY リクエストヘッダーとして渡されます。

カスタマー API キーの入手方法については、UKG Pro HCM の管理者にお問い合わせいただくか、UKG Developer Portal（https://developer.ukg.com）をご参照ください。

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

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

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

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

              
      <cfquery name="UKG Pro HCMQuery" dataSource="CDataUKG Pro HCMODBC">
        SELECT * FROM UserDetails
      </cfquery>
    CFTable を使用すると、HTML でテーブルを簡単に出力できます： 
              
        <cftable
        query = "UKG Pro HCMQuery"
        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>UserName</b>" align="Left" width=15 text="UserName"/>

        ...

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

        SELECT * FROM UserDetails

      </cfquery>
      <cftable
        query = "UKG Pro HCMQuery"
        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>UserName</b>" align="Left" width=15 text="UserName"/>

        ...

      </cftable>
      </body>

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

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

SELECT * FROM Account WHERE name =

おわりに

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

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

API Driver で UKG Pro HCM のライブデータに接続

UKG Pro HCM に接続

この記事の内容

関連記事