UKG Pro HCM のデータ のPostgreSQL インターフェースを作成

加藤龍彦
加藤龍彦
デジタルマーケティング
UKG Pro HCM JDBC Driver のリモート機能を使用し、データアクセス用のPostgreSQL エントリポイントを作成します。



PostgreSQL には多くの対応クライアントがあります。標準のドライバーからBI、アナリティクスツールまで、PostgreSQL はデータ接続の人気のインターフェースです。JDBC ドライバーを使用することで、簡単に任意の標準クライアントから接続できるPostgreSQL エントリポイントを作成できます。

UKG Pro HCM にPostgreSQL データベースとしてアクセスするには、CData JDBC Driver for API とJDBC foreign data wrapper (FDW) を使用します。この記事ではFDW をコンパイルしてインストールし、PostgreSQL サーバーからUKG Pro HCM にクエリを実行します。

JDBC データソースとしてUKG Pro HCM のデータに接続する

JDBC データソースとしてUKG Pro HCM に接続するには、以下が必要です。

  • Driver のJAR パス:JAR ファイルは、インストールディレクトリのlib サブフォルダにあります。
  • Driver クラス

    
    cdata.jdbc.api.APIDriver
    
  • JDBC URL: URL は、"jdbc:api:" で始まり、セミコロンで区切られた名前と値の組み合わせで任意の接続プロパティを含めることができます。

    まず、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
    

    接続プロパティを入力し、接続文字列をクリップボードにコピーします。

    Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)

    以下は一般的なJDBC URL です。

    
    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';
    

JDBC FDW を構築する

FDW は、PostgreSQL を再コンパイルせずに、PostgreSQL の拡張機能としてインストールできます。例としてjdbc2_fdw 拡張子を使用します。

  1. ご使用のバージョンのJRE 共有オブジェクトから、/usr/lib/libjvm.so にシンボリックリンクを追加します。コマンド例:
    
    ln -s /usr/lib/jvm/java-6-openjdk/jre/lib/amd64/server/libjvm.so /usr/lib/libjvm.so
    
  2. ビルドするには、以下のコマンドを実行してください。
    
    make install USE_PGXS=1
    

UKG Pro HCM のデータをPostgreSQL データベースとしてクエリする

拡張機能をインストールした後、以下のステップに従ってUKG Pro HCM へのクエリの実行を開始します。

  1. データベースにログイン
  2. データベースの拡張機能をロード
    
    CREATE EXTENSION jdbc2_fdw;
    
  3. UKG Pro HCM のオブジェクトを作成
    
    CREATE SERVER API
    FOREIGN DATA WRAPPER jdbc2_fdw OPTIONS (
    drivername 'cdata.jdbc.api.APIDriver',
    url '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';',
    querytimeout '15',
    jarfile '/home/MyUser/CData/CData\ JDBC\ Driver\ for\ Salesforce MyDriverEdition/lib/cdata.jdbc.api.jar');
    
  4. PostgreSQL デーモンに認識されているユーザーのユーザー名とパスワードのユーザーマッピングを作成
    
    CREATE USER MAPPING for postgres SERVER API OPTIONS (
    username 'admin',
    password 'test');
    
  5. ローカルデータベースに外部テーブルを作成
    
    postgres=# CREATE FOREIGN TABLE userdetails (
    userdetails_id text,
    userdetails_UserId text,
    userdetails_UserName numeric)
    SERVER API OPTIONS (
    table_name 'userdetails');
    
UKG Pro HCM に対してSELECTコマンドを実行可能にする

postgres=# SELECT * FROM userdetails;

おわりに

このようにCData JDBC Driver for API を使って簡単にUKG Pro HCM のデータを取得して検索対象にすることができました。ぜひ、30日の無償評価版 をお試しください。

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

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

UKG Pro HCM に接続