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

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

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

Connect AI を構成

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

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

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

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

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 からSAP SuccessFactors に接続

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

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

   SAP SuccessFactorsへの接続

   それでは、SAP SuccessFactors に接続していきましょう。CData 製品は、デフォルトで有効になっているOData API を介してSAP SuccessFactors と通信します。追加の権限が必要な場合は、SAP サポートサイトをご確認ください。

   認証方法として、Azure AD 認証、SAP IAS 認証、OAuth 認証（推奨）、Basic 認証（非推奨）のいずれかを使用してSAP SuccessFactors に認証できます。

   必要な接続プロパティ

   選択したAuthScheme に関わらず、SAP SuccessFactors 環境を識別するために以下の接続プロパティを設定しましょう。

   • URL：SuccessFactors をホストするサーバーのURL
   • CompanyId：SAP SuccessFactors テナントに割り当てられた一意の識別子。この値はAPI 認証に必要で、組織固有のものです

   OAuth 認証

   SAP SuccessFactors では、OAuth 認証を2種類のグラント種別でサポートしています。

   • SAP SuccessFactors LMS インスタンスのクライアントグラント種別
   • SAML-2 Bearer グラント種別

   OAuth 認証を有効にするには、すべてのOAuth フローでカスタムOAuth アプリケーションを作成し、適切なプロパティを設定する必要があります。

   デスクトップアプリケーションでカスタムOAuth アプリケーションの資格情報を使用して認証するには、OAuth アクセストークンを取得し、更新する必要があります。これらを設定すると、接続の準備が整います。

   OAuth アクセストークンの取得およびリフレッシュ

   以下のプロパティを設定してください。

   • InitiateOAuth：GETANDREFRESH。OAuthAccessToken を自動的に取得およびリフレッシュするために使用します
   • OAuthClientId：アプリケーションの登録時に割り当てられたクライアントId
   • CallbackURL：カスタムOAuth アプリケーションの登録時に定義されたリダイレクトURI
   • OAuthClientSecret （クライアントグラント種別のみ）：アプリケーションの登録時に割り当てられたクライアントシークレット
   • PrivateKey （SAML-2 Bearer グラント種別のみ）：カスタムOAuth アプリケーションの作成時にダウンロードした秘密鍵証明書のパス、またはその証明書のbase64 でエンコードされた内容

   接続すると、CData 製品がデフォルトブラウザでSAP SuccessFactors のOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えてください。

   アプリケーションにアクセス許可を与えると、CData 製品がOAuth プロセスを完了します。

   1. CData 製品がSAP SuccessFactors からアクセストークンを取得し、それを使ってデータをリクエストします
   2. OAuth 値はOAuthSettingsLocation で指定されたパスに保存されます。これらの値は接続間で永続化されます

   アクセストークンの期限が切れた際は、CData 製品が自動でアクセストークンをリフレッシュします。

   カスタムOAuth アプリケーションの作成やその他の認証方法については、 href="/kb/help/" target="_blank">ヘルプドキュメントの「はじめに」をご確認ください。

   
4. Create & Test をクリックします。
5. 「Add SAP SuccessFactors Connection」ページの「Permissions」タブに移動し、ユーザーベースのアクセス許可を更新します。

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

   認証済みのユーザーは、CData Connect AI の管理コンソールの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 AI からのエラーをキャッチ
     echo $e->getError(), "\n";
   }