CData PingOne BizTalk Adapter に一方向送信ポートを構成

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

ここでは、CData BizTalk Adapter for PingOne を使用して静的な一方向送信ポートを作成、構成、テストする手順を説明します。静的な一方向送信ポートを使用することで、アップデートグラム、SQL コマンド、ストアドプロシージャを実行できます。送信ポートは、 返答データを持たない PingOne のデータ変更の操作に役立ちます。通常、これはDELETE またはUPDATE のSQL コマンドか、アップデートグラムですが、場合によっては、ストアドプロシージャになります。

SELECT コマンドの実行や、作成したレコードId の取得のような、応答するアクションをトリガーする場合は、要請応答送信ポートを使用します。

一方向送信ポートを作成し実行する

静的な一方向送信ポートを作成し、PingOne アダプタをトランスポートタイプとして使用するように構成します。

1. 未実行の場合、BizTalk 管理コンソールでBizTalk アプリケーションを開きます。
2. BizTalk アプリのノードで、［Send Ports］を右クリックし、［New］->［Static One-Way Send Port］を選択します。送信ポートプロパティのダイアログが表示されます。
3. ［Name］メニューで、送信ポートの名前を入力します。
4. ［Type］メニューで、CData.PingOne を選択します。
5. ［Send Pipeline］メニューで、デフォルトオプションの［PassThruTransmit］を選択します。

アダプタを構成する

［Transport Properties］ダイアログで、アダプタが実行するコマンドを定義します。

1. 送信ポートのプロパティで、［Configure］ボタンをクリックします。CData.PingOne トランスポートプロパティのダイアログが表示されます。
2. ［CommandType］プロパティで、実行したいコマンドタイプを選択します。
3. SQL コマンドを実行したい場合は、［SQL Command］のボックスにコマンドを入力してください。

PingOne への接続を構成する

Connection String Options ダイアログで、PingOne への接続に必要な資格情報とその他のプロパティを設定します。

1. 送信ポートのプロパティダイアログで［Configure］をクリックすると、アダプタのプロパティダイアログが表示されます。
2. ［Connection String］プロパティのボタンをクリックします。
3. ［Connection String］プロパティのボックスをクリックします。［Connection String Options］ダイアログが表示されます。
4. 接続プロパティを入力します。下は一般的な接続文字列です。

   AuthScheme=OAuth;WorkerAppEnvironmentId=eebc33a8-xxxx-4f3a-yyyy-d3e5262fd49e;Region=NA;OAuthClientId=client_id;OAuthClientSecret=client_secret;

   PingOne に接続するには以下のプロパティを設定します。

   • Region：自身のPingOne 組織のデータがホスティングされている地域。
   • AuthScheme：PingOne に接続する際に使用する認証の種類。
   • WorkerAppEnvironmentId （デフォルトのPingOne ドメインを使用する場合に必要）、またはAuthorizationServerURL のいずれかで、下で説明するように設定します。

   WorkerAppEnvironmentId の設定

   WorkerAppEnvironmentId は、Worker アプリケーションが存在するPingOne 環境のID です。 このパラメータは、環境がデフォルトのPingOne ドメイン（auth.pingone）を利用している場合のみ使用されます。 これは、ヘルプドキュメントのカスタムOAuth アプリケーションの作成で説明するように、PingOne への認証に使用するカスタムOAuth アプリケーションを作成した後に設定します。

   はじめに、このプロパティの値を見つけます。

   1. 自身のPingOne 組織のホームページからナビゲーションサイドバーに移動し、Environments をクリックします。
   2. OAuth / Worker のカスタムアプリケーションを作成した環境（通常はAdministrators）を見つけ、Manage Environment をクリックします。 環境のホームページが表示されます。
   3. 環境のホームページのナビゲーションサイドバーで、Applications をクリックします。
   4. リストから、OAuth またはWorker アプリケーションの詳細を見つけます。
   5. Environment ID フィールドの値をコピーします。 以下の例に似たものになるはずです：
      WorkerAppEnvironmentId='11e96fc7-aa4d-4a60-8196-9acf91424eca'

   次に、WorkerAppEnvironmentId をEnvironment ID フィールドの値に設定します。

   AuthorizationServerURL の設定

   AuthorizationServerURL は、お使いのアプリケーションが配置されている環境のPingOne 認可サーバーのベースURL です。 このプロパティは、PingOne プラットフォームAPI ドキュメントで説明されているように、環境にカスタムドメインを設定した場合にのみ使用されます。 Custom Domains を参照してください。

   OAuth でのPingOne への認証

   PingOne はOAuth とOAuthClient 認証の両方をサポートしています。 上述の設定手順に加え、OAuth またはOAuthCliet 認証をサポートするために、さらに2つの手順を完了する必要があります。

   • ヘルプドキュメントのカスタムOAuth アプリケーションの作成で説明するように、カスタムOAuth アプリケーションを作成して設定します。
   • ドライバーがデータモデル内のエンティティにアクセスできるようにするには、ヘルプドキュメントのAdministrator Roles での説明のとおり、使用するアドミンユーザー / ワーカーアプリケーションに対して正しいロールを設定していることを確認してください。
   • 以下のサブセクションで説明されているように、選択した認証スキームと認証フローに適切なプロパティを設定します。

   OAuth（認可コードグラント）

   AuthScheme をOAuth に設定します。

   デスクトップアプリケーション

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

   以下を設定して、接続してください。

   • InitiateOAuth：GETANDREFRESH。繰り返しOAuth の交換を行ったり、手動でOAuthAccessToken を設定する必要をなくすには、InitiateOAuth を使用します。
   • OAuthClientId：カスタムOAuth アプリケーションを作成した際に取得したClient ID。
   • OAuthClientSecret：カスタムOAuth アプリケーションを作成した際に取得したClient Secret。
   • CallbackURL：カスタムOAuth アプリケーションの登録時に定義したリダイレクトURI。例：https://localhost:3333

   接続すると、本製品 はデフォルトブラウザでPingOne のOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えます。 ドライバーはこれでOAuth プロセスを完了します。

   1. ドライバーはPingOne からアクセストークンを取得し、それを使ってデータをリクエストします。
   2. OAuth 値はOAuthSettingsLocation で指定された場所に保存され、接続間で永続化されるようにします。

   ドライバーはアクセストークンの期限が切れると自動的にリフレッシュします。

   Web アプリケーションやヘッドレスマシン、クライアントクレデンシャルグラントを含むその他のOAuth メソッドについては、ヘルプドキュメントを参照してください。

5. ［Test Connection］をクリックして値を確認し、接続を確認します。

接続に成功し、アダプターが実行するコマンドを定義することで、送信ポートを使用できるようになります。アプリケーションで一方向送信ポートを使用する例については、次のセクションを参照してください。アプリケーションはファイルに含まれているアップデートグラムコマンドを読み取り、送信ポートを使用してコマンドを実行します。

この例ではフィルターを利用して、アップデートグラムを含むメッセージを受信場所から送信ポートに移動します。フィルターについてのより詳しい説明は次のセクションを参照してください。

フィルターを作成し、アプリケーションを介してBizTalk メッセージをルーティングする

送信ポートを必要なメッセージに関連付けるには、その送信ポートのプロパティの［Filters］セクションでフィルタールールを作成します。条件に一致するメッセージは、送信ポートにルーティングされます。受信場所でのフィルタリングに関しては、次の例を参照してください。

例：一方向送信ポートでアップデートグラムを実行する

このセクションでは、一方向送信ポートをアプリケーションで使用する方法について説明します。アプリケーションはファイルに含まれているアップデートグラムコマンドを読み取り、コマンドを実行します。

1. 一方向受信場所はアップデートグラムを含むXML ドキュメントをピックアップします。
2. 受信場所は、コマンドの結果を含むBizTalk メッセージを作成します。
3. 一方向送信ポートは、受信場所のURI をフィルタリングします。ドキュメントは一方向送信ポートにルーティングされます。
4. 送信ポートは、アップデートグラムコマンドを実行します。

前の例と同様に次のステップでは、ファイルからアップデートグラムを読み取るための受信場所を設定し、送信ポートを使用してコマンドを実行する方法を説明します。

1. 静的な一方向の受信場所を作成、構成します。転送タイプのファイルを使用します。「CData BizTalk Adapter for PingOne の受信場所を作成、構成する」と同じ手順に従います。
2. 静的な一方向送信ポートを作成します。
3. 送信ポートのプロパティで、［Filters］をクリックします。
4. 空のプロパティで、次の値を設定します。

   プロパティ

   メニューから BTS.InboundTransportLocation を選択します。

   値

   新しく作成された一方向受信場所のURI を入力します。