UKG Pro HCM のデータをPythonのpetlでETL処理する方法｜CData Connect AI

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
CData Connect AI Python SDKとpetlフレームワークで、リアルタイムのUKG Pro HCM のデータを抽出・変換するETLパイプラインの構築方法を解説。

CData Connect AI の Python SDK と petl フレームワークを使うと、UKG Pro HCM のデータをローカルにドライバーをインストールすることなく、Pythonで直接抽出・変換・ロードするETLパイプラインを構築できます。パーソナルアクセストークンで接続し、数行のコードで設定完了です。

Python は豊富なモジュールのエコシステムを備えているため、素早く作業に取りかかり、システムをより効果的に連携できます。CData Connect AI Python SDK と petl フレームワークを使えば、UKG Pro HCM のデータを抽出・変換して CSV などに出力する UKG Pro HCM 連携のアプリケーションやパイプラインを構築できます。この記事では、Connect AI に接続し、petl を使ってUKG Pro HCM のデータを抽出・変換し、CSV ファイルに書き出す方法をご紹介します。

Connect AI Python SDK（cdata-connect-ai）は DB-API 2.0（PEP 249）に準拠したクライアントなので、petl は etl.fromdb を使って SDK の接続から直接読み取れます。ソースごとにドライバーをインストールする必要はありません。パーソナルアクセストークンで接続して、パイプラインを構築しましょう。

Python + petl でできること

UKG Pro HCM データの定期抽出パイプライン構築

SQL クエリで取得した UKG Pro HCM のレコードを petl の etl.fromdb で抽出し、etl.sort などの変換処理をはさんでから CSV に書き出す、軽量な ETL パイプラインを構築できます。

複数データソースとの統合分析

DB-API 2.0 準拠のクライアントなので、同じコードパターンで UKG Pro HCM 以外のデータソースにも接続でき、petl 上で結合・整形してから任意の出力先にロードできます。

UKG Pro HCM への書き戻し処理の自動化

書き込みに対応した権限を持つ PAT で接続していれば、cursor.executemany を使ったバッチ INSERT により、変換済みデータを UKG Pro HCM に自動で書き戻す処理を組み込めます。

Connect AI で UKG Pro HCM に接続する方法は？

CData Connect AI では、直感的なクリック操作ベースのインターフェースでデータソースに接続できます。

  1. Connect AI にログインし、Sources をクリックして、 Add Connection をクリックします
    2. 接続の追加
  2. 「Add Connection」パネルから「UKG Pro HCM」を選択します
    3. データソースの選択
  3. 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）をご参照ください。

    接続の設定（Salesforce の例）
  4. 「Save & Test」をクリックします
  5. 「Permissions」タブに移動し、ユーザーベースの権限を更新します。 権限の更新

パーソナルアクセストークン（PAT）を生成する

Python SDK は、アカウントのメールアドレスとパーソナルアクセストークン（PAT）を使って Connect AI に認証します。アクセスの粒度を保つために、アプリケーションごとに個別の PAT を作成することをおすすめします。

  1. Connect AI アプリの右上にある歯車アイコン（）をクリックして、設定ページを開きます。
  2. 設定ページの Access Tokens セクションに移動し、 Create PAT をクリックします。
  3. PAT に名前を付けて Create をクリックします。 新しい PAT の作成
  4. パーソナルアクセストークンは作成時にのみ表示されます。必ずコピーして安全な場所に保管してください。

必要なモジュールをインストールする方法は？

pip ユーティリティを使って、SDK と petl フレームワークをインストールします。

pip install cdata-connect-ai
pip install petl

Python で UKG Pro HCM のデータの ETL アプリを構築する方法は？

必要なモジュールをインストールしたら、ETL アプリを構築する準備は完了です。以下にコードスニペットを紹介しますが、完全なソースコードは記事の末尾に掲載しています。

まずモジュールをインポートし、アカウントのメールアドレスと PAT で Connect AI に接続します。

import petl as etl
import cdata_connect_ai

conn = cdata_connect_ai.connect(
    username="[email protected]",
    password="<your_pat>",
)

UKG Pro HCM をクエリする SQL ステートメントを作成する方法は？

SQL を使って、UKG Pro HCM をクエリするステートメントを作成します。この記事では、UserDetails エンティティからデータを読み取ります。識別子は <Connection>.<Schema>.<Table> という3つの部分で構成されており、接続名はデフォルトでソース名（例：API1）になります。

sql = (
    "SELECT UserId, UserName "
    "FROM [API1].[API].[UserDetails] "
    "WHERE UserStatus = 'A'"
)

UKG Pro HCM のデータの抽出・変換・ロードを実装する方法は？

接続とクエリが準備できたら、petl を使ってUKG Pro HCM のデータを抽出・変換・ロードします。この例では、UKG Pro HCM のデータを抽出し、UserName カラムでデータを並べ替えて、CSV ファイルにロードします。

table1 = etl.fromdb(conn, sql)

table2 = etl.sort(table1, 'UserName')

etl.tocsv(table2, 'userdetails_data.csv')

UKG Pro HCM は Connect AI では読み取り専用のソースのため、このパイプラインではUKG Pro HCM のデータの抽出と変換はできますが、行の書き戻しはできません。抽出が完了したら接続を閉じましょう。

conn.close()

CData Connect AI Python SDK を使えば、petl のような ETL パッケージでのデータへの直接アクセスも含め、通常のデータベースと同じようにUKG Pro HCM のデータを扱えます。

関連情報と無料トライアル

これで、CData Connect AI Python SDK を使って、petl でリアルタイムのUKG Pro HCM のデータをパイプライン処理できるようになりました。UKG Pro HCM（および数百種類のその他のデータソース）への接続について詳しくは、Connect AI のページをご覧ください。

CData Connect AI の詳細、または無料トライアルにお申し込みください：

無料トライアル お問い合わせ


完全なソースコード

import petl as etl
import cdata_connect_ai

conn = cdata_connect_ai.connect(
    username="[email protected]",
    password="<your_pat>",
)

sql = (
    "SELECT UserId, UserName "
    "FROM [API1].[API].[UserDetails] "
    "WHERE UserStatus = 'A'"
)

table1 = etl.fromdb(conn, sql)

table2 = etl.sort(table1, 'UserName')

etl.tocsv(table2, 'userdetails_data.csv')
conn.close()

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

CData Connect AI の詳細、または無料トライアルにお申し込みください：

無料トライアル

この記事の内容

関連記事