Python でUKG Pro WFM のデータを変換・出力するETL 処理を作る方法

加藤龍彦
加藤龍彦
デジタルマーケティング
CData Python Connector とpetl モジュールを使って、UKG Pro WFM のデータを変換後にCSV ファイルに吐き出すETL 処理を実装します。



Pythonエコシステムには多くのモジュールがあり、システム構築を素早く効率的に行うことができます。本記事では、CData Python Connector for API とpetl フレームワークを使って、UKG Pro WFM のデータにPython から接続してデータを変換、CSV に出力するETL 変換を実装してみます。

CData Python Connector は効率的なデータ処理によりUKG Pro WFM のデータ にPython から接続し、高いパフォーマンスを発揮します。UKG Pro WFM にデータをクエリする際、ドライバーはフィルタリング、集計などがサポートされている場合SQL 処理を直接UKG Pro WFM 側に行わせ、サポートされていないSQL 処理については、組み込みのSQL エンジンによりクライアント側で処理を行います（JOIN やSQL 関数など）。

必要なモジュールのインストール

pip で必要なモジュールおよびフレームワークをインストールします：

pip install petl
pip install pandas

Python でUKG Pro WFM のデータをETL 処理するアプリを構築

モジュールとフレームワークをインストールしたら、ETL アプリケーションを組んでいきます。コードのスニペットは以下の通りです。フルコードは記事の末尾に付いています。

CData Connector を含むモジュールをインポートします。

import petl as etl
import pandas as pd
import cdata.api as mod

接続文字列で接続を確立します。connect 関数を使って、CData UKG Pro WFM Connector からUKG Pro WFM への接続を行います 

cnxn = mod.connect("Profile=C:\profiles\UKGProWFM.apip;AuthScheme=OAuthPassword;ProfileSettings='Host=yourcompany.mykronos.com;User=your_username;Password=your_password;';OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;")

まず、Profile 接続プロパティをディスク上の UKGProWFM プロファイルの場所に設定します（例：C:\profiles\UKGProWFM.apip）。次に、ProfileSettings 接続プロパティを UKGProWFM の接続文字列に設定します（以下を参照）。

UKGProWFM API プロファイル設定

UKG Pro Workforce Management では、OAuth 2.0 の Resource Owner Password Credentials グラント（grant_type=password）を使用して API へのアクセスを認可します。一般的な OAuth ベースのプロファイルとは異なり、ブラウザでのリダイレクトや認可コードのステップはありません。ドライバーが UKG Pro WFM のユーザー名、パスワード、クライアント ID、クライアントシークレットを使って、直接アクセストークンを取得します。

認証するには、以下の接続プロパティを設定します。

  • AuthScheme：OAuthPassword に設定します。
  • Host：UKG Pro Workforce Management のデータセンター/テナントのホスト名に設定します（例：yourcompany.mykronos.com）。プロトコル（https://）や末尾のスラッシュは含めないでください。
  • OAuthClientId：UKG Pro Workforce Management の OAuth アプリケーションに発行されたクライアント ID に設定します。
  • OAuthClientSecret：UKG Pro Workforce Management の OAuth アプリケーションに発行されたクライアントシークレットに設定します。
  • User：UKG Pro Workforce Management のユーザー名に設定します。
  • Password：UKG Pro Workforce Management のパスワードに設定します。

アクセストークンは https://{Host}/api/authentication/access_token から取得します。UKG Pro Workforce Management が発行するリフレッシュトークンの有効期限は7日間です。リフレッシュトークン自体の期限切れによってトークンの更新に失敗した場合、ドライバーは User/Password の認証情報で再認証し、新しいアクセストークンを取得する必要があります。

UKG Pro WFM をクエリするSQL 文の作成

UKG Pro WFM にはSQL でデータアクセスが可能です。Employees エンティティからのデータを読み出します。 

sql = "SELECT PersonNumber, UserName FROM Employees WHERE PersonId = '12345'"

UKG Pro WFM データのETL 処理

DataFrame に格納されたクエリ結果を使って、petl でETL（抽出・変換・ロード）パイプラインを組みます。この例では、UKG Pro WFM のデータ を取得して、UserName カラムでデータをソートして、CSV ファイルにデータをロードします。 

table1 = etl.fromdb(cnxn,sql)

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

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

CData Python Connector for API を使えば、データベースを扱う場合と同感覚で、UKG Pro WFM のデータ を扱うことができ、petl のようなETL パッケージから直接データにアクセスが可能になります。

おわりに

UKG Pro WFM Python Connector の30日の無償トライアル をぜひダウンロードして、UKG Pro WFM のデータ への接続をPython アプリやスクリプトから簡単に作成しましょう。


フルソースコード

import petl as etl
import pandas as pd
import cdata.api as mod

cnxn = mod.connect("Profile=C:\profiles\UKGProWFM.apip;AuthScheme=OAuthPassword;ProfileSettings='Host=yourcompany.mykronos.com;User=your_username;Password=your_password;';OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;")

sql = "SELECT PersonNumber, UserName FROM Employees WHERE PersonId = '12345'"

table1 = etl.fromdb(cnxn,sql)

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

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

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

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

UKG Pro WFM に接続

この記事の内容

関連記事