OData SDK for PHP を使ってWorkday のデータを取得

CData Connect AI はWorkday のデータをWeb サービスとして公開します。 この記事の手順を実行することで、Workday のデータをPHP オブジェクトとして扱うことができるようになります。

CData Connect AI はWorkday のデータへのクラウドベースのOData インターフェースを提供し、ODataPHP SDK からWorkday のデータへのリアルタイム連携を実現します。

Connect AI を構成

ODataPHP SDK でWorkday のデータを操作するには、Connect AI からWorkday に接続し、コネクションにユーザーアクセスを提供してWorkday のデータのOData エンドポイントを作成する必要があります。

Workday に接続したら、目的のテーブルのOData エンドポイントを作成します。

（オプション）新しいConnect AI ユーザーの追加

必要であれば、Connect AI 経由でWorkday に接続するユーザーを作成します。

1. 「Users」ページに移動し、 Invite Users をクリックします。
2. 新しいユーザーのE メールアドレスを入力して、 Send をクリックしてユーザーを招待します。
3. 「Users」ページからユーザーを確認および編集できます。

パーソナルアクセストークンの追加

OAuth 認証をサポートしていないサービス、アプリケーション、プラットフォーム、またはフレームワークから接続する場合は、認証に使用するパーソナルアクセストークン（PAT）を作成できます。きめ細かなアクセス管理を行うために、サービスごとに個別のPAT を作成するのがベストプラクティスです。

1. Connect AI アプリの右上にあるユーザー名をクリックし、「User Profile」をクリックします。
2. 「User Profile」ページで「Access Token」セクションにスクロールし、 Create PAT をクリックします。
3. PAT の名前を入力して Create をクリックします。
4. パーソナルアクセストークンは作成時にしか表示されないため、必ずコピーして安全に保存してください。

Connect AI からWorkday に接続

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

1. Connect AI にログインし、 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. Create & Test をクリックします。
5. 「Add Workday Connection」ページの「Permissions」タブに移動し、ユーザーベースのアクセス許可を更新します。

Connect AI にWorkday OData エンドポイントを追加する

Workday に接続したら、目的のテーブルのOData エンドポイントを作成します。

1. OData ページに移動し、 Add をクリックして新しいOData エンドポイントを作成します。
2. Workday 接続（例：Workday1）を選択し、Next をクリックします。
3. 使用するテーブルを選択し、「Confirm」をクリックします。

コネクションとOData エンドポイントを設定したら、ODataPHP SDK からWorkday のデータに接続できます。

1. まずは、ODataPHP SDK を使用してCData Connect AI が公開したWeb サービスに接続するプロキシクラスを作成します。

   URI 部分を書き換えて、次のようなコマンドを実行してください。

   php C:\PHPLib\ODataphp\PHPDataSvcUtil.php /uri=https://your-server:8032/api.rsc/@your-personal-access-token/ /out=C:\PHPLib\ODataphp\WorkdayEntities.php
   	    

   このコマンドは、OData エンドポイントが返すメタデータからクラスを定義して、指定したフォルダにクラスの定義を出力します。

   CData Connect AI およびOData SDK for PHP は、どちらもフォームとWindows 認証をサポートします。CData Connect AI はOData エンドポイントへのアクセスが認可されたユーザーの認証に、パーソナルアクセストークンを使用します。パーソナルアクセストークンはHTTP Basic 認証の際に渡したり、OData URL に付加することで使用できます。

   認証済みのユーザーは、CData Connect AI の管理コンソールのUsers セクションで設定できます。

2. これで、PHP のオブジェクト指向インターフェースを使ってWorkday のデータにアクセスできます。以下のコードはWorkers テーブルのレコードを作成してリアルタイムデータを取得し、新しく作成したレコードを表示します。

   require_once 'WorkdayEntities.php';
   try{
     $svc = new CDataAPI();
     $workers = new Workers();
     $workers->Legal_Name_Last_Name = 'Morgan';
     $svc->AddToWorkers($workers);
     $svc->SetSaveChangesOptions(SaveChangesOptions::None);
     $svc->SaveChanges();
     $response = $svc->workers()->Execute();
     foreach($response->Result as $workers)
       echo $workers->Worker_Reference_WID."";
   } catch (Exception $e) {    //CData Connect AI からのエラーをキャッチ
     echo $e->getError(), "\n";
   }