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

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

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

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

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

UKG Pro HCM への接続を設定

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

まず、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）をご参照ください。

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

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


java -jar cdata.jdbc.api.jar
組み込みの接続文字列デザイナーを使用して JDBC URL を生成（ukg pro hcm の例）

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

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

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

      jdbc:api:Profile=C:\profiles\UKGProHCM.apip;AuthScheme=Basic;User=your_username;Password=your_password;ProfileSettings='Host=yourcompany.ultipro.com;CustomerAPIKey=your_customer_api_key';

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

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

                
        <cfquery name="UKG Pro HCMQuery" dataSource="CDataUKG Pro HCMJDBC">
          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 HCMJDBC">

          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>
  7. 最後に、デフォルトポート 8500 でブラウザからコードをローカルで実行します。UKG Pro HCM データが入力されたテーブルが表示されます。 コードの実行

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

SELECT * FROM Account WHERE name =

おわりに

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

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

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

UKG Pro HCM に接続

この記事の内容

関連記事