PHPからUKG Pro HCMのデータに接続する方法｜ODBC接続3ステップ

古川えりか
古川えりか
コンテンツスペシャリスト
PHPアプリケーションからUKG Pro HCMのデータにODBC接続する方法を3ステップで解説。CData ODBC DriverでPHPのODBCネイティブサポートを活用します。



CData ODBC Driver for API は、PHP アプリケーションからUKG Pro HCM のデータへの連携を実現します。本記事では、UKG Pro HCM のデータをPHP のビルトインODBC 機能でクエリする手順を説明します。

CData ODBC ドライバとは？

CData ODBC ドライバは、以下のような特徴を持ったリアルタイムデータ連携ソリューションです。

  1. UKG Pro HCM をはじめとする、CRM、MA、会計ツールなど多様なカテゴリの270種類以上のSaaS / オンプレミスデータソースに対応
  2. 多様なアプリケーション、ツールにUKG Pro HCM のデータを連携
  3. ノーコードでの手軽な接続設定
  4. 標準 SQL での柔軟なデータ読み込み・書き込み

CData ODBC ドライバでは、1.データソースとしてUKG Pro HCM の接続を設定、2.PHP 側でODBC Driver との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。

CData ODBC ドライバのインストールとUKG Pro HCM への接続設定

まずは、本記事右側のサイドバーからAPI ODBC Driver の無償トライアルをダウンロード・インストールしてください。30日間無償で、製品版の全機能が使用できます。

UKG Pro HCM に接続するDSN を作成します。

  1. まずODBC DSN に必要な接続プロパティの値を入力します。インストールが終わると、自動的にODBC DSN 設定画面が起動します。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）をご参照ください。

UKG Pro HCM への接続の確立

odbc_connect を呼び出して、UKG Pro HCM への接続を開きます。 odbc_pconnect メソッドでも可能です。コネクションを閉じるには、odbc_close もしくはodbc_close_all を使います。


$conn = odbc_connect("CData API Source","user","password");

コネクションはodbc_connect で開かれ、スクリプトが終わると終了します。odbc_pconnect メソッドで開いたコネクションは、スクリプトが終わっても開いたままです。これにより同じクレデンシャルであれば他のスクリプトでコネクションを共有することが可能です:


$conn = odbc_pconnect("CData API Source","user","password");
...
odbc_close($conn); //persistent connection must be closed explicitly

エレメントの作成

odbc_prepare を使って、Prepared ステートメントおよびパラメータライズドクエリを作成します。 


$query = odbc_prepare($conn, "SELECT * FROM UserDetails WHERE UserStatus = ?");

クエリの実行

Prepared ステートメントをodbc_execute を使って実行します。 


$conn = odbc_connect("CData API Source","user","password");
$query = odbc_prepare($conn, "SELECT * FROM UserDetails WHERE UserStatus = ?");
$success = odbc_execute($query, array('A'));

Non-Parameterized クエリは、odbc_exec を使います。 


$conn = odbc_connect("CData API Source","user","password");
$query = odbc_exec($conn, "SELECT * FROM UserDetails");

結果の処理

odbc_fetch_array ファンクションの結果セット配列としてアクセスします。


$conn = odbc_connect("CData API Source","user","password");
$query = odbc_exec($conn, "SELECT * FROM UserDetails");
while($row = odbc_fetch_array($query)){
 echo $row["UserId"] . "\n";
}

odbc_result_all ファンクションで、結果セットをHTML テーブルとして表示します。


$conn = odbc_connect("CData API Sourcee","user","password");
$query = odbc_prepare($conn, "SELECT * FROM UserDetails WHERE UserStatus = ?");
$success = odbc_execute($query, array('A'));
if($success)
  odbc_result_all($query);

サンプルクエリのテスト

スタンドアロンのテスト環境をたちあげる簡単な方法はPHP のビルトインテストサーバーを使うことです。やっていきましょう。

  1. PHP の最新版のバイナリのダウンロード。

  2. フォルダにファイルを入れる。

  3. フォルダを開く。

  4. php.ini-development をphp.ini に変更。

  5. ブラウザからテストスクリプトにアクセスするためのコマンドを実行。

    
php -S localhost:8000 -t C:\path-to-your-scripts -c C:\path-to-php\php.ini

他のサンプルクエリ

サポートされているSQL の詳細は、ヘルプドキュメントを参照してください。上記のサンプルは、PHP のコミュニティドキュメントを参考に、UKG Pro HCM 向けに最適化したものです。

UKG Pro HCM からPHP へのデータ連携には、ぜひCData ODBC ドライバをご利用ください

このようにCData ODBC ドライバと併用することで、270を超えるSaaS、NoSQL データをコーディングなしで扱うことができます。30日の無償評価版が利用できますので、ぜひ自社で使っているクラウドサービスやNoSQL と合わせて活用してみてください。

CData ODBC ドライバは日本のユーザー向けに、UI の日本語化、ドキュメントの日本語化、日本語でのテクニカルサポートを提供しています。

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

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

UKG Pro HCM に接続

この記事の内容

関連記事