Cognos BI でPingOne のデータを使ってデータビジュアライゼーションを作成

こんにちは！ドライバー周りのヘルプドキュメントを担当している古川です。

CData ODBC Driver for PingOne を使って、PingOne のデータをドラッグアンドドロップ スタイルのCognos Report Studio に連携できます。この記事では、データビジュアライゼーションをSQL を書かずに作成するグラフィカルアプローチと、PingOne がサポートする任意のSQL クエリを実行する方法の両方について説明します。

CData ODBC ドライバとは？

CData ODBC ドライバは、以下のような特徴を持った製品です。

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

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

CData ODBC ドライバのインストールとPingOne への接続設定

まずは、本記事右側のサイドバーからPingOne ODBC Driver の無償トライアルをダウンロード・インストールしてください。30日間無償で、製品版の全機能が使用できます。

下記の手順に従って、［Cognos Administration］ツールのライブ PingOne に接続を確立します。この接続はCognos BI 全体で使えます。このドライバーを使って、すべてのユーザーは一貫したデータおよびメタデータ：リアルタイムPingOne を利用できます。

1. 接続プロパティの指定がまだの場合は、ODBC DSN （データソース名）で行います。Microsoft ODBC データソースアドミニストレーターを使ってODBC DSN を作成および設定できます。

   64ビット版のマシンからCognos を実行している場合は、32ビット版ODBC データソースアドミニストレーターを起動する必要があります。以下のコマンドで開くことができます：

   C:\Windows\sysWOW64\odbcad32.exe

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

   Microsoft ODBC データソースアドミニストレーターで必要なプロパティを設定する方法は、ヘルプドキュメントの「はじめに」をご参照ください。

2. ［Cognos Administration］を開いて新しいデータソースを追加します。［Data Source Connections］をクリックして［ODBC］オプションを選択したら、システムDSN とユーザーフレンドリーな名前を入力します。Click Retrieve Objects and choose the CData PingOne database object.

   

Data Visualizations をレポートに追加

これで、［Source Explorer］からレポートオブジェクトにカラムをドラッグアンドドロップしてCognos Report Studio のPingOne のデータ にレポートを作成できます。以下では、最新データを表示するチャートを持つシンプルなレポートを作成する方法を説明します。

レポートをビルドすると、Cognos Report Studio はSQL クエリを生成して実行をドライバーに依存します。ドライバーはクエリをPingOne API へのリクエストに変換します。ドライバーはリアルタイムPingOne へのクエリの実行を基になるAPI に依存します。

アグリゲートに基づきチャートを作成

［Source Explorer］からオブジェクトのdimentions にカラムをドラッグアンドドロップするだけで、Cognos レポートオブジェクトとしてPingOne のデータを使うことができます。チャートのSeries dimension のカラムは自動的にグループ化されます。

さらにCognos は、measure dimesion のロジカルなデフォルトアグリゲート関数をデータタイプに基づいて設定します。この例では、デフォルトをオーバーライドしています。［Data Items］タブの Username カラムをクリックしてAggregate Function プロパティを Not Applicableに設定します。Rollup Aggregate Function プロパティは Automatic に設定する必要があります。

Query オブジェクトをSQL に変換

必要なクエリを把握している、あるいは生成されたクエリを調整したい場合は、query オブジェクトをSQL ステートメントに変換します。クエリがSQL に変換されると、UI コントロールはquery オブジェクトで利用できなくなります。下記の手順に従って、ユーザー定義のSQL でチャートを埋めます。

Cognos はユーザー定義クエリの実行をドライバーに依存します。ドライバーのSQL エンジンを使うと、キャッシュデータのコピーがないためクエリは常に最新の結果を返します。

1. ［Query Explorer］の上にカーソルを置き、［Queries］フォルダをクリックしてレポートにquery オブジェクトを表示します。

2. 自動生成されたクエリを編集したい場合は、Generated SQL プロパティにあるquery オブジェクトのボタンをクリックします。ダイアログが表示されたら、［Convert］をクリックします。

   新たにSQL ステートメントを入力したい場合は、query オブジェクトと一緒にSQL オブジェクトをドロップします。

3. SQL オブジェクトのプロパティを編集：SQL プロパティでPingOne のデータソースを選択してSQL Syntax プロパティをNative に設定します。

4. SQL プロパティのボタンをクリックし、ダイアログが表示されたらSQL クエリを入力します。この例では以下のクエリを使います：

   SELECT Id, Username FROM [CData].[Administrators].Users WHERE EmployeeType = 'Contractor'

5. query オブジェクトのプロパティを編集：Processing プロパティを［Limited Local］に設定します。この値はquery オブジェクトをSQL に変換するために必要です。

   

クエリ結果をチャートで使用

これで［Data Items］タブのオブジェクトとしてSQL クエリ結果にアクセスできるようになりました。下記の手順に従って、クエリ結果を使ってチャートを作成します；例えば、[CData].[Administrators].Users テーブルからUsername を各Id へ。

1. ［Page Explorer］ 上にカーソルを置きpage オブジェクトをクリックしてページに戻ります。
2. 円グラフをツールボックスからワークスペース上にドラッグします。
3. チャートのプロパティで、Query プロパティに先ほど作成したクエリの名前を設定します。
4. ［Data Items］タブをクリックしてカラムをx およびy 軸上にドラッグします。この例ではId カラムをSeries (pie slices) ボックスに、Username カラムをDefault Measure ボックスにドラッグします。

5. Default Measure (Username 値) のデフォルトのプロパティを編集します：［Aggregate Function］ボックスで "Not Applicable" オプションを選択します。

レポートを実行してクエリ結果を追加します。