Servoy で PingOne 連携Web アプリを構築
Servoy は、迅速なアプリケーション開発およびデプロイメントプラットフォームです。CData JDBC Driver for PingOne と組み合わせることで、リアルタイムのPingOne のデータ と連携するPingOne 接続アプリを構築できます。この記事では、Servoy からPingOne に接続し、PingOne のデータ を表示・検索するシンプルなWeb アプリを構築する方法を説明します。
CData JDBC Driver は、最適化されたデータ処理機能を組み込んでおり、リアルタイムのPingOne のデータ を操作する際に比類のないパフォーマンスを提供します。PingOne に複雑なSQL クエリを発行すると、ドライバーはフィルタや集計などのサポートされているSQL 操作を直接PingOne にプッシュし、サポートされていない操作(多くの場合SQL 関数やJOIN 操作)は組み込みのSQL エンジンを使用してクライアント側で処理します。組み込みの動的メタデータクエリにより、ネイティブのデータ型を使用してPingOne のデータ を操作できます。
Servoy Developer でPingOne に接続
PingOne 連携アプリを構築するには、まずCData JDBC Driver for PingOne を使用してServoy Developer でデータプロバイダーを作成する必要があります。
- JDBC Driver をインストールします。
- JDBC Driver の JAR ファイル(cdata.jdbc.pingone.jar)を、Servoy のインストールディレクトリにある /application_server/drivers/ ディレクトリにコピーします。
- Servoy Developer を開きます。
- Solution Explorer で、Database Server(Resources 配下)を右クリックし、「Connect to existing database」->「empty」を選択します。
- サーバーに名前を付けます。
- クリックして詳細サーバー設定を表示します。
URL を設定します(例:jdbc:pingone:AuthScheme=OAuth;WorkerAppEnvironmentId=eebc33a8-xxxx-4f3a-yyyy-d3e5262fd49e;Region=NA;OAuthClientId=client_id;OAuthClientSecret=client_secret;)
組み込みの接続文字列デザイナー
JDBC URL の構築については、PingOne JDBC Driver に組み込まれている接続文字列デザイナーを使用してください。JAR ファイルをダブルクリックするか、コマンドラインからJAR ファイルを実行します。
java -jar cdata.jdbc.pingone.jar
接続プロパティを入力し、接続文字列をクリップボードにコピーします。
PingOne に接続するには以下のプロパティを設定します。
- Region:自身のPingOne 組織のデータがホスティングされている地域。
- AuthScheme:PingOne に接続する際に使用する認証の種類。
- WorkerAppEnvironmentId (デフォルトのPingOne ドメインを使用する場合に必要)、またはAuthorizationServerURL のいずれかで、下で説明するように設定します。
WorkerAppEnvironmentId の設定
WorkerAppEnvironmentId は、Worker アプリケーションが存在するPingOne 環境のID です。 このパラメータは、環境がデフォルトのPingOne ドメイン(auth.pingone)を利用している場合のみ使用されます。 これは、ヘルプドキュメントのカスタムOAuth アプリケーションの作成で説明するように、PingOne への認証に使用するカスタムOAuth アプリケーションを作成した後に設定します。
はじめに、このプロパティの値を見つけます。
- 自身のPingOne 組織のホームページからナビゲーションサイドバーに移動し、Environments をクリックします。
- OAuth / Worker のカスタムアプリケーションを作成した環境(通常はAdministrators)を見つけ、Manage Environment をクリックします。 環境のホームページが表示されます。
- 環境のホームページのナビゲーションサイドバーで、Applications をクリックします。
- リストから、OAuth またはWorker アプリケーションの詳細を見つけます。
-
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
接続すると、CData 製品 はデフォルトブラウザでPingOne のOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えます。 ドライバーはこれでOAuth プロセスを完了します。
- ドライバーはPingOne からアクセストークンを取得し、それを使ってデータをリクエストします。
- OAuth 値はOAuthSettingsLocation で指定された場所に保存され、接続間で永続化されるようにします。
ドライバーはアクセストークンの期限が切れると自動的にリフレッシュします。
Web アプリケーションやヘッドレスマシン、クライアントクレデンシャルグラントを含むその他のOAuth メソッドについては、ヘルプドキュメントを参照してください。
- 先ほどコピーしたDriver クラスを選択します(例:cdata.jdbc.pingone.PingOneDriver)
PingOne 連携Web アプリの構築
Servoy Developer のリソースでPingOne への接続を設定したら、リアルタイムのPingOne のデータ にアクセスできるアプリを構築する準備が整います。
新しいソリューションの作成
- Server Explorer で「All solutions」を右クリックし、「Create new solution」を選択します。
- ソリューションに名前を付けます。
- 「search」モジュールを含めるチェックボックスを選択します。
- 「Finish」をクリックします。
新しいフォームの作成
「Forms」を右クリックし、「Create new form」を選択します。
- フォームに名前を付けます。
- データソースを選択します。
- タイプ(例:Simple)を設定し、「Finish」をクリックします。
フォームにデータグリッドを追加
- Data Grid コンポーネント(Servoy NG-Grids から)をフォームにドラッグします。
カラムコンポーネントをData Grid にドラッグし、各カラムコンポーネントの「dataprovider」プロパティをPingOne の「テーブル」のカラムに設定します(例:[CData].[Administrators].Users テーブルの Id)。
必要に応じてカラムを追加します。
アプリに検索機能を追加
検索機能を追加するには「svySearch」拡張機能が必要です(新しいソリューションを作成する際にデフォルトで含まれています)。ソリューション作成時に拡張機能を追加しなかった場合や、既存のソリューションを変更する場合は、Modules(ソリューション内)を右クリックし、「Add Module」を選択して検索モジュールを追加できます。「svySearch」を選択し、「OK」をクリックします。
- Text Field コンポーネントをフォームにドラッグします。
- フォームを右クリックし、「Open in Script Editor」を選択します。
- 検索値を保持する新しい変数(JavaScript)を作成します:
var searchText = '';
- フォームに戻り、Text Field のプロパティで:
- 「dataprovider」プロパティを先ほど作成したフォーム変数に設定します。
- ダブルクリックしてonAction イベントのメソッドを追加します。
- クリックして「Form」にメソッドを作成し、メソッドに名前を付け(例:onEnter)、「Create private」をクリックします。
- 「OK & Show」をクリックします。
- JavaScript ファイルに以下のJavaScript を追加して、Servoy フレームワークを使用し、Text Field のテキストに基づいてバインドされたデータを検索する機能を実装します:
var search = scopes.svySearch.createSimpleSearch(foundset).setSearchText(searchText); search.setSearchAllColumns(); search.loadRecords(foundset);
アプリの保存と起動
フォームとJavaScript ファイルを保存し、Run -> Launch NGClient をクリックしてWeb アプリを起動します。
CData JDBC Driver for PingOne の30日間無償トライアルをダウンロードして、Servoy でPingOne 連携アプリの構築を始めましょう。ご不明な点があれば、サポートチームまでお問い合わせください。