Workday のデータにPythonで接続する方法｜CData Connect AI SDK

CData Connect AI Python SDK を使うと、標準的なDB-API 2.0のPythonコードでWorkday のデータをそのまま読み書きできます。プログラミング不要の他ツールと異なり、pandasやpetlなど既存のPythonエコシステムにそのまま組み込めます。パッケージのインストールからクエリ実行まで3ステップで完了します。

CData Connect AI Python SDK（cdata-connect-ai）は DB-API 2.0（PEP 249）に準拠したクライアントで、標準的な Python のデータベースコードでリアルタイムのWorkday のデータを取得・操作できます。接続まわりは Connect AI が引き受けてくれるので、パッケージを1つインストールしてパーソナルアクセストークンで認証するだけで、Workday（および Connect AI に接続済みのその他すべてのソース）にクエリを実行できます。しかも sqlite3 や psycopg2 といったライブラリでおなじみの connect() / cursor() / fetchall() という同じパターンをそのまま使えます。

この記事では、Connect AI で Workday に接続し、パーソナルアクセストークンを生成して SDK をインストールし、リアルタイムのWorkday のデータを読み取る（対応している場合は書き込む）までの流れをご紹介します。

事前準備

• CData Connect AI のアカウント
• Python 3.8 以降
• 有効な認証情報を持つアクティブな Workday アカウント

はじめに

---

Connect AI で Workday に接続する方法は？

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

1. Connect AI にログインし、Sources をクリックして、 Add Connection をクリックします

2. 「Add Connection」パネルから「Workday」を選択します

3. Workday に接続するために必要な認証プロパティを入力します。

   Workday 接続プロパティの取得・設定方法

   ここでは、4つのWorkday API の接続パラメータを設定する方法、およびTenant とBaseURL を取得する方法について説明します。必要なAPI のパラメータが設定され、カスタムOAuth および / またはAzure AD API クライアントを作成したら、接続の準備は完了です。

   接続の前提条件

   API / 前提条件 / 接続パラメータ
   WQL / WQL サービスを有効化（下記参照） / ConnectionType： WQL
   Reports as a Service / カタログレポートの設定（ヘルプドキュメントの「データアクセスのファインチューニング」参照） / ConnectionType： Reports
   REST / 自動で有効化 / ConnectionType： REST
   SOAP / 自動で有効化 / ヘルプドキュメントのWorkday SOAP API への認証を参照

   BaseURL およびTenant の取得

   BaseURL およびTenant プロパティを取得するため、Workday にログインしてView API Clients を検索します。 この画面では、Workday はBaseURL とTenant の両方を含むURL であるWorkday REST API Endpoint を表示します。

   REST API Endpoint のフォーマットは、 https://domain.com//mycompany です。ここで、
   

   • https://domain.com（URL のサブディレクトリと会社名の前の部分）はBaseURL です。
   • mycompany（URL の最後のスラッシュの後の部分）はTenant です。

   例えば、REST API エンドポイントがhttps://wd3-impl-services1.workday.com/ccx/api/v1/mycompany の場合、 BaseURL はhttps://wd3-impl-services1.workday.com であり、Tenant はmycompany です。

   WQL サービスを有効化

   Workday WQL API を介して接続するには、はじめにWQL Service を有効にする必要があります。
   1. Workday を開きます。
   2. 検索バーにView Domain と入力します。
   3. プロンプトにWorkday Query Language と入力します。
   4. Allowed Security Group Types のいずれかに、接続するユーザーが含まれていることを確認します。

   Workday への認証

   Basic 認証以外のほとんどのWorkday 接続では、認証のためにOAuth ベースのカスタムAPI クライアントアプリケーションを作成する必要があります。これには、ユーザーがAzure AD 資格情報を介して接続するエンタープライズインストールも含まれます。 Workday への認証につての詳細は、ヘルプドキュメントの「Workday への認証」セクションを参照してください。

   

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

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

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

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

SDK をインストールする

pip を使って PyPI から SDK をインストールします。

pip install cdata-connect-ai

接続して最初のクエリを実行する

アカウントのメールアドレスと PAT で接続したら、sys_tables にクエリを実行して、接続済みのソース全体で利用可能なテーブルを確認してみましょう。Connect AI の識別子は <Connection>.<Schema>.<Table> という3つの部分で構成されており、接続名はデフォルトでソース名（例：Workday1）になります。

import cdata_connect_ai

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

# Discover what's available across your connected sources
cur.execute("SELECT CatalogName, SchemaName, TableName FROM sys_tables LIMIT 25")

for row in cur.fetchall():
    print(row)

結果から任意のテーブルを選び、直接クエリを実行してみましょう。

cur.execute(
    "SELECT Worker_Reference_WID, Legal_Name_Last_Name "
    "FROM [Workday1].[Workday].[Workers] "
    "LIMIT 10"
)

for row in cur.fetchall():
    print(row)

Workday に書き込む

データソースと接続の権限が許可していれば、同じカーソルで INSERT、UPDATE、DELETE ステートメントも実行できます。フィルタ付きの読み取りとまったく同じように、pyformat（%(name)s）パラメータで値をバインドし、影響を受けた行数は cursor.rowcount で確認できます。

# Insert a new record
cur.execute(
    "INSERT INTO [Workday1].[Workday].[Workers] (Worker_Reference_WID) "
    "VALUES (%(newvalue)s)",
    {"newvalue": "Example value"},
)
print(f"Rows inserted: {cur.rowcount}")

# Update existing records
cur.execute(
    "UPDATE [Workday1].[Workday].[Workers] "
    "SET Legal_Name_Last_Name = %(newvalue)s "
    "WHERE Legal_Name_Last_Name = 'Morgan'",
    {"newvalue": "Updated value"},
)
print(f"Rows updated: {cur.rowcount}")

conn.close()

注意：書き込み可能なソースであっても、読み取り専用の PAT や接続権限では書き込み操作は拒否されます。同じパラメータ化のパターンは、DELETE ステートメントや cursor.callproc() によるストアドプロシージャの実行にも使えます。

これがワークフローのすべてです。パッケージが1つ、PAT、そして標準的な DB-API 呼び出しだけ。SDK は通常の DB-API 接続を返すので、Python のデータエコシステムのほかのツールにもそのまま組み込めます。ここから先は、この同じ接続を使って、Workday のデータを pandas に読み込んだり、petl で ETL パイプラインを構築したり、Dash の Web アプリを動かしたりできます。

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

これで、CData Connect AI Python SDK を通じて Python からリアルタイムのWorkday のデータをクエリできるようになりました。Workday（および数百種類のその他のデータソース）への接続について詳しくは、Connect AI のページをご覧ください。

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

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