DbVisualizer でPingOne のデータに連携しクエリを作成

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

CData JDBC Driver for PingOne は、JDBC 標準に準拠し、BI ツールからIDE まで幅広いアプリケーションでPingOne のデータへの接続を提供します。この記事では、DbVisualizer からPingOne のデータに接続する方法、およびtable エディタを使ってPingOne をロード、する方法を説明します。

CData JDBC ドライバとは？

CData JDBC ドライバは、以下の特徴を持ったリアルタイムデータ接続ツールです。

1. PingOne をはじめとする、CRM、MA、グループウェア、広告、会計ツールなど多様な270種類以上のSaaS / DB に対応
2. DBeaver を含む多様なアプリケーション、ツールにPingOne のデータを連携
3. ノーコードでの手軽な接続設定
4. 標準 SQL での柔軟なデータ読み込み・書き込み

CData JDBC ドライバでは、1.データソースとしてPingOne の接続を設定、2.DBeaver 側でJDBC Driver との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。

PingOne のデータの新しいドライバー定義を作成

下記の手順に従い、Driver Manager を使ってDbVisualizer ツールからPingOne のデータに接続します。

1. DbVisualizer で「Tools」->「Driver Manager」をクリックします。
2. 「」ボタンをクリックして新しくドライバーを作成します。
3. テンプレートは「Custom」を選択します。
4. Driver Settings タブで：
   • Name をわかりやすい名前に設定します（例：CData PingOne Driver）。
   • URL Format をjdbc:pingone: に設定します。
   • Driver artifacts and jar files (jars are loaded in order from top) セクションで：
     1. 「」ボタンをクリックして、「Add Files」に進みます。
     2. インストールディレクトリ（C:\Program Files\CData\CData JDBC Driver for PingOne XXXX\）の「lib」フォルダに移動します。
     3. JAR ファイル（cdata.jdbc.PingOne.jar）を選択して「Open」をクリックします。
     
5. Driver Class は自動的に入力されます。もし入力されない場合は、クラス（cdata.jdbc.pingone.PingOneDriver）を選択してください。

JDBC データソースへの接続を定義

「Driver Manager」を終了し、下記の手順に従ってJDBC URL に接続プロパティを入力します。

1. 「Databases」タブで「」ボタンをクリックし、先ほど作成したドライバーを選択します。

2. 「Connection」セクションで以下のオプションを設定します。

   • Database Type：ウィザードオプションを選択した場合は、データベースの種類は自動検出されます。「No Wizard」オプションを選択した場合は、「Database Type」メニューから「Generic」または「Auto Detect」オプションを選択します。
   • Driver Type：先ほど作成したドライバーを選択します。

   • Database URL：完全なJDBC URL を入力します。JDBC URL 構文は、jdbc:pingone: に続けてセミコロン区切りでname-value ペアの接続プロパティを入力します。

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

     組み込みの接続文字列デザイナー

     JDBC URL の作成の補助として、PingOne JDBC Driver に組み込まれている接続文字列デザイナーが使用できます。JAR ファイルをダブルクリックするか、コマンドラインからjar ファイルを実行します。

     java -jar cdata.jdbc.pingone.jar

     接続プロパティを入力し、接続文字列をクリップボードにコピーします。

     

     JDBC URL を構成する際に、Max Rows 接続プロパティを設定することもできます。この設定は返される行数を制限するため、レポートやビジュアライゼーションを作成する際のパフォーマンスが向上します。

     一般的な接続文字列は次のとおりです。

     jdbc:pingone:AuthScheme=OAuth;WorkerAppEnvironmentId=eebc33a8-xxxx-4f3a-yyyy-d3e5262fd49e;Region=NA;OAuthClientId=client_id;OAuthClientSecret=client_secret;InitiateOAuth=GETANDREFRESH
   • NOTE：PingOne は認証にUser やPassword を必要としないため、Database Userid とDatabase Password には任意の値を使用できます。
3. 「Connection」タブで「Connect」をクリックします。

PingOne JDBC Driver が表示するテーブルをブラウズするには、テーブルを右クリックして「Open In New Tab」をクリックします。

SQL クエリの実行には、SQL Commander ツールを使用します。「SQL Commander」->「New SQL Commander」をクリックします。利用可能なメニューから「Database Connection」、「Database」、「Schema」を選択します。

サポートされるSQL についての詳細は、ヘルプドキュメントの「サポートされるSQL」をご覧ください。テーブルに関する情報は「データモデル」をご覧ください。

おわりに