CData PowerShell Cmdlets for Workday はじめに：インストールから接続まで

Somya Sharma
Somya Sharma
Technical Marketing Engineer
Workday PowerShell Cmdlets のインストール、ライセンス認証、接続設定の完全ガイドです。

このガイドでは、Workday PowerShell Cmdlets の使い方を詳しく解説します。Cmdlet のインストール、初回接続の設定、クエリの実行、そして PowerShell で Workday のデータ を操作するための次のステップをご紹介します。

Workday データ連携について

CData は、Workday のライブデータにアクセスし、統合するための最も簡単な方法を提供します。お客様は CData の接続機能を以下の目的で使用しています：

  • Prism Analytics Data Catalog で作成したテーブルやデータセットにアクセスでき、Workday システムの忠実性を損なうことなく、ネイティブの Workday データハブを操作できます。
  • Workday Reports-as-a-Service にアクセスして、Prism から利用できない部門データセットや、Prism の許容サイズを超えるデータセットのデータを表示できます。
  • WQL、REST、または SOAP でベースデータオブジェクトにアクセスし、より詳細で細かいアクセスを実現できます（ただし、クエリの作成には Workday 管理者や IT の支援が必要な場合があります）。

ユーザーは、Tableau、Power BI、Excel などの分析ツールと Workday を統合し、当社のツールを活用して Workday データをデータベースやデータウェアハウスにレプリケートしています。アクセスは、認証されたユーザーの ID とロールに基づいて、ユーザーレベルで保護されます。

Workday を CData と連携させるための設定についての詳細は、ナレッジベース記事をご覧ください：Comprehensive Workday Connectivity through Workday WQL および Reports-as-a-Service & Workday + CData: Connection & Integration Best Practices


はじめに


インストールとライセンス認証

システム要件

CData PowerShell Cmdlets は、PowerShell が動作するあらゆる環境で実行できます。

Windows

  • Windows 10/11
  • Windows Server 2016 以降
  • PowerShell 5.1 または PowerShell 7 以降

macOS / Linux

  • PowerShell 7 以降
  • 追加のシステムライブラリは不要
  • アーキテクチャ固有のインストーラーは不要

Cmdlet のインストール

CData Cmdlets は PowerShell Gallery から配布されており、プラットフォーム間で簡単かつ一貫したインストールプロセスを実現しています。

インストール手順

  1. 管理者モードで PowerShell を開きます
  2. 以下のコマンドを実行して Cmdlet モジュールをインストールします： 
    Install-Module WorkdayCmdlets -Repository PSGallery -Force

    このコマンドは：

    • 公式の PowerShell Gallery からモジュールをダウンロードします
    • PowerShell 環境にインストールします
    • すべての Cmdlet をすぐに使用できるように登録します

モジュールの確認

インストールを確認するには： 

Get-Module -ListAvailable "*Workday*"

ライセンス認証

Cmdlets は試用版と正規ライセンスの両方の認証に対応しています。

試用版ライセンス

試用版の認証は自動的に行われ、キーは不要です。インストール後すぐに Cmdlet を使用できます。

正規ライセンスの認証

正規ライセンスを購入された場合、CData Orders チームからプロダクトキーを受け取ります。

ライセンスの認証

以下のコマンドを実行します：

Set-ModuleLicense ""

認証が成功すると、確認メッセージが表示されます。

ライセンスに関するよくある質問

ライセンスは複数のマシンで使用できますか？

サブスクリプションプランによります。注文確認メールを確認するか、[email protected] までお問い合わせください。

ライセンスキーを紛失しました。どうすればよいですか？

注文番号を添えて [email protected] までメールでお問い合わせください。

ライセンスを別のマシンに移行できますか？

以下のリンクからライセンス移行リクエストを送信してください：https://www.cdata.com/lic/transfer/

ライセンスはどこで管理できますか？

CData カスタマーポータルにアクセスしてください：https://portal.cdata.com/

接続設定

モジュールがインストールされ、ライセンスが認証されたら、

Connect-Workday cmdlet
を使用して Workday への接続を確立できます。

必要な接続プロパティを取得したら、PowerShell で Workday のデータ にアクセスしてレプリケーションを準備するには、基本的に 4 つのステップがあります。

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 への認証」セクションを参照してください。

Workday のデータ の取得

  1. モジュールをインストールします： 

    Install-Module WorkdayCmdlets

  2. Workday に接続します： 

      $workday = Connect-Workday  -User $User -Password $Password -Tenant $Tenant -BaseURL $BaseURL -ConnectionType $ConnectionType

PowerShell での Workday のデータ のクエリ

接続後、標準 SQL のようなコマンドを使用してデータをクエリできます。

クエリ例：

$results = Select-Workday `
    -Connection $conn `
    -Table "Workers" `
    -Columns "Worker_Reference_WID,Legal_Name_Last_Name" `
    -Where "Worker_Reference_WID != ''"

結果を表示します：

$results

これで PowerShell から Workday のデータ にアクセスできるようになりました。

よくある問題

認証エラー

解決策： ユーザー名、パスワード、セキュリティトークンを確認してください。OAuth アプリケーションの場合、アプリケーションのセキュリティ設定で CData を認可する必要がある場合があります。認可のサポートについては [email protected] までお問い合わせください。

ネットワークまたはプロキシの問題

解決策： ファイアウォール設定とアウトバウンドアクセスを確認してください。ほとんどのクラウドアプリケーションはポート 443 を使用します。

Cmdlet が見つからない

解決策： モジュールがインストールされていることを確認してください - 

Get-Module -ListAvailable "*Workday*"

クエリが遅い

解決策：

  • フィルターを追加してデータセットのサイズを削減してください
  • サポートされている場合は $Limit または $Top プロパティを使用してください
  • 最適化のサポートについては [email protected] までお問い合わせください

接続に関するその他のトラブルシューティングについては、具体的なエラーメッセージを添えて [email protected] までお問い合わせください。

次のステップ

PowerShell Cmdlets のインストール、ライセンス認証、接続設定が完了しました。以下のシナリオを参考に、さらに活用してみてください：

PowerShell記事タイトル
Piping CmdletsPowerShell で Workday のデータ を CSV にパイプする方法
ReplicationPowerShell スクリプトで Workday のデータ を MySQL にレプリケートする

サポート

ご不明な点がございましたら、お気軽にお問い合わせください：

FAQ（PowerShell Cmdlets）

インストールとライセンス

  • Cmdlet のインストールには管理者権限が必要ですか？

    • 必ずしも必要ではありません。

    • Windows PowerShell 5.1（Windows）：管理者権限が推奨されます。特にすべてのユーザー向けにモジュールをインストールする場合に必要です。
    • PowerShell 7 以降（Windows、macOS、Linux）：以下のコマンドを使用することで、管理者権限なしで現在のユーザー向けに Cmdlet をインストールできます： 
      Install-Module WorkdayCmdlets -Scope CurrentUser
  • インストーラーをダウンロードする必要がありますか？

    • CData PowerShell Cmdlets は PowerShell Gallery から配布されています。インストールは以下のコマンドで実行します：

    Install-Module WorkdayCmdlets -Repository PSGallery -Force

接続

  • 同じデータソースの複数のアカウントに接続するにはどうすればよいですか？

    • 異なる認証プロパティを持つ個別の接続オブジェクトを作成します：

    $conn1 = Connect-Workday -User User1 -Password Pwd1
    $conn2 = Connect-Workday -User User2 -Password Pwd2
  • PowerShell Cmdlets には DSN が必要ですか？

    • Cmdlet は ODBC DSN を使用しません。すべての接続プロパティは 

    Connect-Workday
    で直接渡されます。

  • プロキシサーバー経由で接続できますか？

    • 多くの Cmdlet は以下のようなプロキシプロパティをサポートしています：

    • ProxyServer
    • ProxyPort
    • ProxyUser
    • ProxyPassword

    データソース固有のヘルプドキュメントを参照してください。

パフォーマンスとトラブルシューティング

  • クエリが遅いのはなぜですか？

    • よくある原因：

    • フィルターがない（WHERE 句がない）
    • 大量の結果セットを取得している
    • クラウド API からのレイテンシ
    • 増分戦略を使用していない

    以下をお試しください：

    • データをフィルタリングする（-Where パラメータ）
    • 必要なカラムのみを選択する
    • データソースの API スロットリング制限を確認する

    クエリ最適化のサポートについては [email protected] までお問い合わせください。

  • ログを有効にするにはどうすればよいですか？

    • 以下のコマンドでモジュールのログを有効にします：

    Set-ModuleLogging -Path "C:\logs\cdata.log" -Verbosity 3
    CData サポートと連携する際は、ログファイルを安全にアップロードしてください。

  • どのポートを開放する必要がありますか？

    • ほとんどのクラウドアプリケーション（Salesforce、HubSpot、Dynamics、Google API など）は HTTPS（443）を使用します。

    ソースが追加のポートを必要とする場合は、固有のドキュメントを確認するか、[email protected] までお問い合わせください。

  • コンテナ（Docker、Kubernetes）で Cmdlet を使用できますか？

    • コンテナに PowerShell 7 をインストールし、モジュールをインストールします：

    pwsh -Command "Install-Module WorkdayCmdlets -Force"
    その後、通常どおり認証を行います。

一般

  • サポートされているすべての SQL/コマンド操作はどこで確認できますか？

    • 各 Cmdlet にはローカルにインストールされたヘルプドキュメントが含まれており、オンラインでも参照可能です：https://www.cdata.com/powershell/

  • PowerShell Cmdlets はどのくらいの頻度で更新されますか？

    • CData はメジャーアップデートを年次でリリースし、年間を通じて増分アップデートを行います。バージョンの入手可能性については、カスタマーポータルを確認するか、[email protected] までお問い合わせください。

  • コード例はどこで確認できますか？

    • すべての Cmdlet にはヘルプドキュメントに例が含まれており、多くのサービスのオンライン例も提供されています：https://www.cdata.com/powershell/ 例には以下が含まれます：

    • 基本的なクエリ
    • Insert/Update/Delete
    • OAuth フロー
    • ファイル操作
    • API 連携

この FAQ で解決しない場合は、[email protected] までお問い合わせください。

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

Workday Cmdlets の無料トライアルをダウンロードしてお試しください：

 ダウンロード

詳細：

Workday Icon Workday Data Cmdlets お問い合わせ

PowerShell Cmdlets は、Workday へのリアルタイム連携機能を提供します。Cmdlets を使ってデータに直接連携し、DB と同感覚でデータを操作できます。

この記事の内容

関連記事