ODBC を介してNode.js からUKG Pro HCM のデータをクエリ

Node.js はブラウザ上以外でJavaScript コードを使用できるJavaScript ランタイム環境です。CData ODBC Driver for API を使用すれば、Node.js アプリとスクリプトから、リアルタイムUKG Pro HCM のデータにアクセスできます。この記事ではnode-odbc のインストールと、リアルタイムUKG Pro HCM のデータへのアクセスが可能な、シンプルなNode.js アプリケーションを作成するために必要なツールについて説明します。

ビルトインの最適化されたデータ処理により、CData ODBC Driver は比類のないパフォーマンスで、Node.js のリアルタイムUKG Pro HCM のデータとやりとりできます。Node.js からUKG Pro HCM に複雑なSQL クエリを発行すると、ドライバーはフィルタや集計などのサポートされているSQL 操作をUKG Pro HCM に直接プッシュし、組み込まれたSQL エンジンを利用してサポートされていない操作（主にSQL 関数とJOIN 操作）をクライアント側で処理します。

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.Node.js 側でODBC Driver との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。

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

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

必要な接続プロパティの値が未入力の場合には、データソース名（DSN）で入力します。組み込みのMicrosoft ODBC Data Source Administrator を使用し、DSN を構成できます。ドライバーのインストールの最後にアドミニストレーターが開きます。Microsoft 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）をご参照ください。

node-odbc を構築する

CData ODBC Driver を介してUKG Pro HCM に接続するには、必要なツールをインストールした後に、node-odbc を手動で構築する必要があります。

必要なツールをインストールする

以下のコマンドでは、node-odbc の構築に必要なツールをインストールします。（ツールをグローバルにインストールする-g パラメータに注意してください。）

npm i -g windows-build-tools
npm i -g node-gyp

node-odbc を構築する

必要なツールをインストールしたらNode.js アプリケーションのディレクトリを作成し、Node.js スクリプトで使用するバイナリを構築するodbc をインストールします。

mkdir nodeodbc
cd nodeodbc
npm i -g node

Node.js からUKG Pro HCM をクエリ

ODBC Driver がインストールされ、DSN が構成されて、node-odbc が構築されたら、Node.js アプリケーションからリアルタイムUKG Pro HCM のデータをクエリすることができるようになります。以下のサンプルコードは、特定のDSN に接続してUserDetails テーブルをクエリします。

myscript.js

const odbc = require('odbc');

async function queryAPI() {
    const connection = await odbc.connect(`DSN=CData API Source`);
    const data = await connection.query('SELECT UserId, UserName FROM UserDetails');
    console.log(data);
}

queryAPI();

アプリケーションを作成したら、node を使用してスクリプトを実行します。

node myscript.js

おわりに

CData ODBC Driver for API の30日の無償評価版 をダウンロードすればNode.js でリアルタイムUKG Pro HCM のデータを使用できます。ご不明な点があれば、サポートチームにお問い合わせください。