OData SDK for PHP を使ってRaisers Edge NXT のデータを取得
CData Connect AI はRaisers Edge NXT のデータをWeb サービスとして公開します。 この記事の手順を実行することで、Raisers Edge NXT のデータをPHP オブジェクトとして扱うことができるようになります。
CData Connect AI はRaisers Edge NXT のデータへのクラウドベースのOData インターフェースを提供し、ODataPHP SDK からRaisers Edge NXT のデータへのリアルタイム連携を実現します。
Connect AI を構成
ODataPHP SDK でRaisers Edge NXT のデータを操作するには、Connect AI からRaisers Edge NXT に接続し、コネクションにユーザーアクセスを提供してRaisers Edge NXT のデータのOData エンドポイントを作成する必要があります。
Raisers Edge NXT に接続したら、目的のテーブルのOData エンドポイントを作成します。
(オプション)新しいConnect AI ユーザーの追加
必要であれば、Connect AI 経由でRaisers Edge NXT に接続するユーザーを作成します。
- 「Users」ページに移動し、 Invite Users をクリックします。
- 新しいユーザーのE メールアドレスを入力して、 Send をクリックしてユーザーを招待します。
- 「Users」ページからユーザーを確認および編集できます。
パーソナルアクセストークンの追加
OAuth 認証をサポートしていないサービス、アプリケーション、プラットフォーム、またはフレームワークから接続する場合は、認証に使用するパーソナルアクセストークン(PAT)を作成できます。きめ細かなアクセス管理を行うために、サービスごとに個別のPAT を作成するのがベストプラクティスです。
- Connect AI アプリの右上にあるユーザー名をクリックし、「User Profile」をクリックします。
- 「User Profile」ページで「Access Token」セクションにスクロールし、 Create PAT をクリックします。
- PAT の名前を入力して Create をクリックします。
- パーソナルアクセストークンは作成時にしか表示されないため、必ずコピーして安全に保存してください。
Connect AI からRaisers Edge NXT に接続
CData Connect AI では、簡単なクリック操作ベースのインターフェースでデータソースに接続できます。
- Connect AI にログインし、 Add Connection をクリックします。
- 「Add Connection」パネルから「Raisers Edge NXT」を選択します。
-
必要な認証プロパティを入力し、Raisers Edge NXT に接続します。
BlackBaud Raiser's Edge NXT 接続プロパティの取得・設定方法
接続設定の前に、BlackBaud Raiser's Edge NXT Profile にあるSubscriptionKey を取得しておいてください。
BlackBaud Raiser's Edge NXT への認証(OAuth)
BlackBaud Raiser's Edge NXT は、OAuth 認証規格を使用します。すべてのフローにおいて、以下の設定が必要です。
- AuthScheme をOAuth に設定
- SubscriptionKey をお使いのSubscription Key に設定
- 認可アカウントでBlackBaud Raiser's Edge NXT を有効にし、結果を取得
この設定ののち、続けてOAuth 設定を行います。設定方法は、ヘルプドキュメント の「OAuth」セクションを参照してください。
- Create & Test をクリックします。
- 「Add Raisers Edge NXT Connection」ページの「Permissions」タブに移動し、ユーザーベースのアクセス許可を更新します。
Connect AI にRaisers Edge NXT OData エンドポイントを追加する
Raisers Edge NXT に接続したら、目的のテーブルのOData エンドポイントを作成します。
- OData ページに移動し、 Add をクリックして新しいOData エンドポイントを作成します。
- Raisers Edge NXT 接続(例:RaiserEdgeNXT1)を選択し、Next をクリックします。
- 使用するテーブルを選択し、「Confirm」をクリックします。
コネクションとOData エンドポイントを設定したら、ODataPHP SDK からRaisers Edge NXT のデータに接続できます。
-
まずは、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\RaiserEdgeNXTEntities.php
このコマンドは、OData エンドポイントが返すメタデータからクラスを定義して、指定したフォルダにクラスの定義を出力します。
CData Connect AI およびOData SDK for PHP は、どちらもフォームとWindows 認証をサポートします。CData Connect AI はOData エンドポイントへのアクセスが認可されたユーザーの認証に、パーソナルアクセストークンを使用します。パーソナルアクセストークンはHTTP Basic 認証の際に渡したり、OData URL に付加することで使用できます。
認証済みのユーザーは、CData Connect AI の管理コンソールのUsers セクションで設定できます。
-
これで、PHP のオブジェクト指向インターフェースを使ってRaisers Edge NXT のデータにアクセスできます。以下のコードはConstituents テーブルのレコードを作成してリアルタイムデータを取得し、新しく作成したレコードを表示します。
require_once 'RaiserEdgeNXTEntities.php'; try{ $svc = new CDataAPI(); $constituents = new Constituents(); $constituents->Type = 'Home'; $svc->AddToConstituents($constituents); $svc->SetSaveChangesOptions(SaveChangesOptions::None); $svc->SaveChanges(); $response = $svc->constituents()->Execute(); foreach($response->Result as $constituents) echo $constituents->Id.""; } catch (Exception $e) { //CData Connect AI からのエラーをキャッチ echo $e->getError(), "\n"; }