PingOne をSSIS 経由でSQL サーバーにバックアップする

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

PingOne 用のCData ADO.NET プロバイダーはPingOne をバックアップ、レポート、フルテキスト検索、分析などを行うアプリケーションに接続します。

ここでは、SQL サーバー SSIS ワークフロー内でPingOne 用のプロバイダーを使用して、PingOne をMicrosoft SQL サーバーデータベースに直接転送する方法を説明します。 以下のアウトラインと同じ手順を、CData ADO.NET データプロバイダーにて使用することで、SSIS 経由でSQL サーバーを直接リモートデータに接続できます。

1. Visual Studio を開き、新しいIntegration サービスプロジェクトを追加します。
2. ツールボックスからControl Flow 画面へ、新しいData Flow タスクを追加します。

3. Data Flow 画面で、ツールボックスから［ADO.NET Source］ と［OLE DB Destination］ を追加します。

4. 新しい接続を追加し、PingOne 2015 用の .NET プロバイダー\CData ADO.NET プロバイダーを選択します。

5. Connection Manager で、PingOne 用に接続の詳細を入力します。下は一般的な接続文字列です。

   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 メソッドについては、ヘルプドキュメントを参照してください。

6. DataReader editor を開き、次のインフォメーションを設定します。

   • ADO.NET 接続マネージャー：Connection Manager のメニューで、先ほど作成した［Data Connection］ を選択します。
   • データアクセスモード：［SQL command］ を選択します。
   • SQL command テキスト：DataReader Source editor で、Component Properties タブを開き、下にあるようなSELECT command を入力します。
     SELECT Id, Username FROM [CData].[Administrators].Users WHERE EmployeeType = 'Contractor'

7. DataReader editor を閉じ、DataReader Source の下の矢印をドラッグして、OLE DB Destination に接続します。

8. OLE DB Destination を開き、Destination Component Editor で次のインフォメーションを入力します。

   • コネクションマネージャー：新しい接続を追加します。接続するサーバーおよびデータベースの情報を入力します。ここでは、SQLExpress は他のマシンで運用中です。
   • データアクセスモード：データアクセスモードを［table or view］ に設定し、データベースに入力するテーブルまたはビューを選択します。

9. Mappings 画面で必要なプロパティを設定します。

10. OLE DB Destination Editor を閉じ、プロジェクトを始動します。SSIS タスクの実行が完了すれば、 PingOne から取得したデータが、データベースに入力されます。