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

CData Connect Cloud を使えば、OData を使ってADP のデータにアクセスできます。CData Connect Cloud とOData PHP SDK を利用することで、ADP のエンティティをPHP で取得して、オブジェクトとしてモデル化できます。

加藤龍彦
デジタルマーケティング

最終更新日:2022-11-25

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

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

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

Connect Cloud アカウントの取得

以下のステップを実行するには、CData Connect Cloud のアカウントが必要になります。こちらから製品の詳しい情報とアカウント作成、30日間無償トライアルのご利用を開始できますので、ぜひご利用ください。


Connect Cloud を構成

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

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

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

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

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

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

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

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

Connect Cloud からADP に接続

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

  1. Connect Cloud にログインし、 Add Connection をクリックします。 コネクションの追加
  2. 「Add Connection」パネルから「ADP」を選択します。 データソースの選択
  3. 必要な認証プロパティを入力し、ADP に接続します。

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

    接続を確立する前に、ADP に連絡してOAuth アプリとそれに関連するクレデンシャルを提供してもらう必要があります。 これらのクレデンシャルはADP からのみ取得が可能で、直接取得することはできません。

    ADP への接続

    次のプロパティを指定してADP に接続します。

    • OAuthClientId:ADP より提供されたアプリのクライアントId に設定。
    • OAuthClientSecret:ADP より提供されたアプリのクライアントシークレットに設定。
    • SSLClientCert:ADP より提供された証明書に設定。
    • SSLClientCertPassword:証明書のパスワードに設定。
    • UseUAT:CData 製品はデフォルトで、本番環境にリクエストを行います。開発者アカウントを使用している場合は、UseUAT をtrue に設定します。
    • RowScanDepth:テーブルで利用可能なカスタムフィールドカラムをスキャンする行数の最大値。デフォルト値は100に設定されています。大きい値を設定すると、パフォーマンスが低下する場合があります。
    接続の設定(Salesforce の表示)
  4. Create & Test をクリックします。
  5. 「Add ADP Connection」ページの「Permissions」タブに移動し、ユーザーベースのアクセス許可を更新します。 権限を更新

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

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

  1. OData ページに移動し、 Add をクリックして新しいOData エンドポイントを作成します。
  2. ADP 接続(例:ADP1)を選択し、Next をクリックします。
  3. 使用するテーブルを選択し、「Confirm」をクリックします。 テーブルを選択(Salesforce の例)

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

  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\ADPEntities.php

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

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

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

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

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

関連コンテンツ

トライアル・お問い合わせ

30日間無償トライアルで、CData のリアルタイムデータ連携をフルにお試しいただけます。記事や製品についてのご質問があればお気軽にお問い合わせください。