PyCharm でCData ODBC Driver を使ってUKG Pro WFM に接続

古川えりか
古川えりか
コンテンツスペシャリスト
CData ODBC Driver を使用して、ODBC データソースとしてPyCharm からUKG Pro WFM に接続します。



CData ODBC Drivers は、ODBC ドライバーをサポートするあらゆる環境から利用可能です。本記事では、PyCharm からのCData ODBC Driver for API の利用を説明します。CData ODBC Deriver をデータソースとして設定する方法、データソースをクエリして結果を表示するためのPyCharm の簡単なコードを含みます。

はじめに、このチュートリアルではCData ODBC Driver for API とPyCharm が、既にインストールされていることを前提としています。

Pyodbc をプロジェクトに追加

以下のステップに従って、pyodbc モジュールをプロジェクトに追加します。

  1. ［File］->［Settings］とクリックして［project settings］ウィンドウを開きます。
  2. ［Project: YourProjectName］メニューから［Project Interpreter］をクリックします。
  3. pyodbc を追加するため、+ ボタンをクリックしてpyodbc と入力します。
  4. ［Install Package］をクリックしてpyodbc をインストールします。

CData ODBC ドライバとは？

CData ODBC ドライバは、以下のような特徴を持ったリアルタイムデータ連携ソリューションです。

  1. UKG Pro WFM をはじめとする、CRM、MA、会計ツールなど多様なカテゴリの270種類以上のSaaS / オンプレミスデータソースに対応
  2. 多様なアプリケーション、ツールにUKG Pro WFM のデータを連携
  3. ノーコードでの手軽な接続設定
  4. 標準 SQL での柔軟なデータ読み込み・書き込み

CData ODBC ドライバでは、1.データソースとしてUKG Pro WFM の接続を設定、2.PyCharm 側でODBC Driver との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。

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

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

これで、ODBC 接続文字列またはDSN で接続できます。お客様のOS でDSN を作成するためのガイドについては、CData ドライバードキュメントの［はじめに］セクションを参照してください。

まず、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 の認証情報で再認証し、新しいアクセストークンを取得する必要があります。

以下はDSN の構文です。


[CData API Source]
Driver = CData ODBC Driver for API
Description = My Description
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

UKG Pro WFM へのクエリの実行

Cursor をインスタンス化し、Cursor クラスのexecute メソッドを使用してSQL ステートメントを実行します。


import pyodbc

cnxn = pyodbc.connect('DRIVER={CData ODBC Driver for API};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;')
cursor = cnxn.cursor()
cursor.execute("SELECT PersonNumber, UserName FROM Employees WHERE PersonId = '12345'")
rows = cursor.fetchall()
for row in rows:
  print(row.PersonNumber, row.UserName)

CData ODBC Driver を使用してPyCharm でUKG Pro WFM に接続すると、UKG Pro WFM にアクセスできるPython アプリケーションを標準データベースのように構築できるようになります。このチュートリアルに関する質問、コメント、フィードバックがある場合には、[email protected] までご連絡ください。

UKG Pro WFM からPyCharm へのデータ連携には、ぜひCData ODBC ドライバをご利用ください

このようにCData ODBC ドライバと併用することで、270を超えるSaaS、NoSQL データをコーディングなしで扱うことができます。30日の無償評価版が利用できますので、ぜひ自社で使っているクラウドサービスやNoSQL と合わせて活用してみてください。

CData ODBC ドライバは日本のユーザー向けに、UI の日本語化、ドキュメントの日本語化、日本語でのテクニカルサポートを提供しています。

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

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

UKG Pro WFM に接続

この記事の内容

関連記事