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

こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。

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

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

Connect Cloud を構成

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

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

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

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

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

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

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

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

Connect Cloud からSAP SuccessFactors に接続

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

1. Connect Cloud にログインし、 Add Connection をクリックします。
2. 「Add Connection」パネルから「SAP SuccessFactors」を選択します。
3. 必要な認証プロパティを入力し、SAP SuccessFactors に接続します。

   Basic 認証またはOAuth with SAML アサーションを使用して、SAP SuccessFactors に認証できます。

   Basic 認証

   SAP SuccessFactors に正常に認証するには、次のプロパティの値を指定する必要があります。プロバイダーは、Cookie を使用してSAP SuccessFactors によって開かれたセッションを再利用することに注意してください。つまり、セッションを開く最初のリクエストでのみクレデンシャルが使用されます。その後、SAP SuccessFactors から返されたCookie が認証に使用されます。

   • Url: Success Factors をホストするサーバーのURL に設定。一部のサーバーがリストされています。SAP support documentation（外部リンク）。
   • User: アカウントのユーザー名に設定。
   • Password: アカウントのパスワードに設定。
   • CompanyId: 会社の一意の識別子に設定。

   OAuth 認証

   アクセストークンを取得するために使用される、次のプロパティの値を指定する必要があります。

   • Url: Success Factors をホストするサーバーのURL に設定。一部のサーバーがリストされています。SAP support documentation（外部リンク）。
   • User: アカウントのユーザー名に設定。
   • CompanyId: 会社の一意の識別子に設定。
   • OAuthClientId: API Center で生成されたAPI Key に設定。
   • OAuthClientSecret: SAML アサーションの署名に使用されるX.509 プライベートキー。プライベートキーは、「Registering your OAuth Client Application」でダウンロードした証明書に記載されています。
   • InitiateOAuth: GETANDREFRESH に設定。
   
4. Create & Test をクリックします。
5. 「Add SAP SuccessFactors Connection」ページの「Permissions」タブに移動し、ユーザーベースのアクセス許可を更新します。

Connect Cloud にSAP SuccessFactors OData エンドポイントを追加する

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

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

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

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

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

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

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

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

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

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

   require_once 'SAPSuccessFactorsEntities.php'; try{ $svc = new CDataAPI(); $extaddressinfo = new ExtAddressInfo(); $extaddressinfo->city = 'Springfield'; $svc->AddToExtAddressInfo($extaddressinfo); $svc->SetSaveChangesOptions(SaveChangesOptions::None); $svc->SaveChanges(); $response = $svc->extaddressinfo()->Execute(); foreach($response->Result as $extaddressinfo) echo $extaddressinfo->address1."
"; } catch (Exception $e) { //CData Connect Cloud からのエラーをキャッチ echo $e->getError(), "\n"; }