エンタープライズサーチのNeuron にUKG Pro HCM のデータを取り込んで検索利用

杉本和也
杉本和也
リードエンジニア
企業内検索エンジンサービスの Neuron にUKG Pro HCM のデータを取り込んで検索する方法:CData JDBC Driver。



ブレインズテクノロジー社のNeuron は、先端OSS 技術(Apache Solr)を活用したエンタープライズサーチ(企業内検索エンジン)サービスです。Apache Solr は、エンタープライズサーチ機能をAPI として提供してくれますが、Neuron はApache Solr に企業ユーザーがデータを探索するためのシンプルかつ使いやすいユーザーインターフェースと管理画面・運用機能を提供してくれます。これによりエンドユーザーが簡単にエンタープライズサーチを利用することができます。管理画面では、ファイルやデータのクローリング設定がUI で行えるようになっています。この記事では、Neuron に備わっているJDBC インターフェース経由で、CData JDBC Driver for API を利用することでNeuron にUKG Pro HCM のデータを取り込んで検索で利用できるようにします。

Neuron にCData JDBC Driver for API データをロード

CData JDBC Driver for API のインストールと.jar ファイルの配置

  • CData JDBC Driver for API をNeuron と同じマシンにインストールします。
  • 以下のパスにJDBC Driver がインストールされます。
    C:\Program Files\CData\CData JDBC Driver for API 20xxJ\lib\cdata.jdbc.api.jar
  • このcdata.jdbc.api.jar とcdata.jdbc.api.lic ファイルをコピーして、Neuron のC:\APP cf\lib フォルダに配置します。

Neuron CF でのUKG Pro HCM のデータを扱うリポジトリの作成

  • Neuron CF でクローラーの設定をGUI で行います。JDBC を読み取るためのリポジトリを作成します。Neuron の管理画面にログインし、[リポジトリ]→[リポジトリコレクション一覧]→[新規]をクリックします。
  • 任意のリポジトリ名を入力します。タイプは[JDBC]を選択します。
  • 次に、ドライバーのクラス名とJDBC 接続文字列でUKG Pro HCM への接続を行います。

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


    ドライバクラス名:cdata.jdbc.api.APIDriver
    接続文字列: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';
  • [更新]をクリックして、UKG Pro HCM に接続するリポジトリコレクションができました。

Neuron でUKG Pro HCM のデータをクローリングするジョブを作成

続いて、UKG Pro HCM のどのデータをどのようにクローリングするのかをジョブで定義していきます。

  • 管理画面で[ジョブ]→[ジョブ一覧]→[新規]とクリックします。
  • 任意のジョブ名を入力します。出力先にはSolr を選択します。リポジトリは先ほど作成したUKG Pro HCM に接続するリポジトリコレクションを選びます。
  • 次に基本タブからジョブ実行を手動にするか、定期実行するかを自由に設定します。
  • SQL タブでは、どんなデータを取得するのか、テーブル名やカラム、フィルタリング条件などを設定できます。CData JDBC ドライバがUKG Pro HCM のデータをテーブルにモデル化しているので、標準SQL でUKG Pro HCM をクエリすることができます。
    • SQL文:SELECT UserId, UserName FROM UserDetails
    • キーカラム:Id など取得テーブルのキーとなるカラム
    • 検索対象カラム:検索の対象とするカラム
    • タイトルカラム:検索結果のタイトルとするカラム
    • タイムスタンプカラム:タイムスタンプとなるカラムがあれば、ここで指定します
  • リクエストパラメータでは、検索結果レコードのURL (があれば)を設定することもできます。URL を表示できると表示された検索結果からレコードに簡単に移動できます。
  • 取得元では、ラベルを設定しておきます。[更新]をクリックして、クローラージョブの設定を完了します。

Neuron でUKG Pro HCM のデータをクロールするジョブを実行

実際にNeuron で作成したジョブを実行します。[ジョブ]→[状態とジョブ管理]をクリックし、作成したジョブの[Start]をクリックします。

ジョブが正常完了すると、[Done]がステータスとして表示されます。

Neuron 上でのUKG Pro HCM のデータの検索の実施

実際にNeuron 上で検索ができるか確認してみます。取得元を絞り込むこと、内容やファイル名での検索、ファイルサイズやファイル更新日の絞り込み、部分一致や全部一致で検索が可能です。 検索をかけてみると、以下のようにデータを取得できました。

CData JDBC Driver for API をNeuron で使うことで、UKG Pro HCM コネクタとして機能し、簡単にデータを取得して同期することができました。ぜひ、30日の無償評価版をお試しください。

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

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

UKG Pro HCM に接続