CData BizTalk Adapter for PingOne の Receive Location を構成する

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
CData BizTalk Adapter for PingOne を使用して、BizTalk でPingOne のデータを取得します。Receive Location を使用して SQL コマンドを実行し、PingOne でのアクションを自動化します。

この記事の手順に従って、PingOne のデータに接続し、Static One-Way Receive Location を構成して、シンプルなテスト(PingOne のデータを取得して XML ファイルに書き込む)を実行できます。

Receive Location は SQL コマンドを実行し、結果を含む BizTalk メッセージを作成できます。Updategram コマンドを実行する場合は、Send Port を使用してください。

Receive Port の作成

アプリケーションに Receive Location を追加するには、まず Receive Port を追加する必要があります。Receive Port は複数の Receive Location からデータを受信できます。

  1. まだ行っていない場合は、BizTalk Administration Console でアプリケーションを開きます。
  2. アプリケーション内で、Receive Ports を右クリックし、New -> Static One-Way Receive Port をクリックします。Receive Port Properties ダイアログが表示されます。
  3. Name メニューで、Receive Port の名前を入力します。

Receive Location の作成

Receive Port を作成したら、Receive Location を作成し、PingOne アダプターをトランスポートタイプとして使用するよう構成します。

  1. Receive Locations を右クリックし、New -> One-Way Receive Location をクリックします。
  2. 新しい Receive Location がメンバーとなる適切な Receive Port を選択します。Receive Location Properties ダイアログが表示されます。
  3. Name メニューで、Receive Location の名前を入力します。
  4. Receive Location プロパティで、Transport Type メニューから CData.PingOne を選択します。
  5. Receive pipeline メニューで、デフォルトオプションの PassThruReceive を選択します。

アダプターの構成

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

  1. Receive Location プロパティで、Configure をクリックします。アダプターの Transport Properties ダイアログが表示されます。
  2. SQL Command プロパティに、コマンドを入力します。この例では
    SELECT Id, Username FROM [CData].[Administrators].Users WHERE EmployeeType = 'Contractor'
    を使用します。
利用可能なアダプター構成プロパティについては、"Adapter Configuration" の章を参照してください。

接続文字列の構成

Connection String Options ダイアログで、認証情報やその他の接続プロパティを設定します。

  1. Receive Location プロパティで、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'

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

    AuthorizationServerURL の設定

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

    OAuth でのPingOne への認証

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

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

    OAuth(認可コードグラント)

    AuthSchemeOAuth に設定します。

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

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

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

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

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

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

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

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

  5. Test Connection をクリックして、接続値を確認し接続をテストします。

各種プロパティとその機能の説明については、ヘルプドキュメントを参照してください。

Send Port を使用してデータを XML ファイルに書き込む

これで Static One-Way Receive Location を Send Port と共に使用する準備が整いました。Receive Location が作成した BizTalk メッセージには Send Port を関連付ける必要があります。データをファイルに書き込むには、File Send Port を作成します。

  1. BizTalk Administration コンソールで、Send Ports -> New -> Static One-Way Send Port を右クリックします。
  2. 構成ウィンドウの上部に Send Port の名前を入力し、Type メニューから FILE を選択します。

  3. 宛先フォルダを構成します。これがディスク上にファイルが作成される場所になります。
  4. ファイル名には、マクロを使用してファイルが作成された日付を簡単に識別できます。デフォルトでは %MessageId%.xml が使用されます。ただし、これはランダムに生成された BizTalk ID であるため、ユーザーフレンドリーな名前ではありません。[CData].[Administrators].Users_yyyy-MM-dd.xml 形式のファイルを作成するには、[CData].[Administrators].Users_%Date%.xml と入力します。

    :マクロの詳細については、ヘルプドキュメントの BizTalk Configuration セクションを参照してください。

  5. OK をクリックします。URI フィールドに値が入力されます。
  6. Send Port の構成画面の左側で Filters をクリックします。
  7. 以下のプロパティを設定します:
    Property:メニューから "BTS.InboundTransportLocation" を選択します。
    Operator:メニューから "==" を選択します。
    Value:Receive Location の URI を入力します。URI は Receive Location プロパティに表示されています。

これで、Send Port を使用して Receive Location から送信されたファイルを書き込めます。

Location と Port を Enlist および Enable する

最後のステップは、Send Port を Enlist し、Receive Location を Enable することです。Send Port を右クリックして Enlist をクリックします。次に、Receive Location を右クリックして Enable をクリックします。

:Receive Location は最後に Enable してください。これにより、ファイルが Send Port によって確実に書き込み用にピックアップされます。

トラブルシューティング

エラーが発生しているかどうかを確認するには、Administration Console のナビゲーションツリーで "Event Viewer (Local)" を展開します。Windows Logs を展開し、Applications をクリックします。

ログにはシステム上のすべてのアプリケーションのエラーメッセージが含まれるため、エラーメッセージのソースが "CData BizTalk PingOne Receive Adapter" であることを確認することが重要です。エラーメッセージの詳細から、エラーが発生している理由がわかります。エラーの解決方法については、[email protected]/jp にお問い合わせください。

はじめる準備はできましたか?