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

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

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

CData ODBC ドライバとは？

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

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

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

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

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

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

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

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

   C:\Windows\sysWOW64\odbcad32.exe

   HubDBデータソースへの接続には、パブリックHubSpotアプリケーションを使用したOAuth認証とプライベートアプリケーショントークンを使用した認証の2つの方法があります。

   カスタムOAuthアプリを使用する

   すべてのOAuthフローでAuthSchemeを"OAuth"に設定する必要があります。特定の認証ニーズ（デスクトップアプリケーション、Webアプリケーション、ヘッドレスマシン）に必要な接続プロパティについては、ヘルプドキュメントを確認してください。

   アプリケーションを登録し、OAuthクライアント認証情報を取得するには、以下の手順を実行してください。

   1. HubSpotアプリ開発者アカウントにログインします。
      • アプリ開発者アカウントである必要があります。標準のHubSpotアカウントではパブリックアプリを作成できません。
   2. 開発者アカウントのホームページで、アプリタブをクリックします。
   3. アプリを作成をクリックします。
   4. アプリ情報タブで、ユーザーが接続する際に表示される値を入力し、必要に応じて変更します。これらの値には、パブリックアプリケーション名、アプリケーションロゴ、アプリケーションの説明が含まれます。
   5. 認証タブで、「リダイレクトURL」ボックスにコールバックURLを入力します。
      • デスクトップアプリケーションを作成する場合は、http://localhost:33333のようなローカルにアクセス可能なURLに設定します。
      • Webアプリケーションを作成する場合は、ユーザーがアプリケーションを承認した際にリダイレクトされる信頼できるURLに設定します。
   6. アプリを作成をクリックします。HubSpotがアプリケーションとそれに関連する認証情報を生成します。
   7. 認証タブで、クライアントIDとクライアントシークレットを確認します。これらは後でドライバーを設定する際に使用します。

   8. スコープの下で、アプリケーションの意図する機能に必要なスコープを選択します。

      テーブルにアクセスするには、最低限以下のスコープが必要です：

      • hubdb
      • oauth
      • crm.objects.owners.read
   9. 変更を保存をクリックします。
   10. 統合に必要な機能にアクセスできる本番ポータルにアプリケーションをインストールします。
       • 「インストールURL（OAuth）」の下で、完全なURLをコピーをクリックして、アプリケーションのインストールURLをコピーします。
       • コピーしたリンクをブラウザで開きます。アプリケーションをインストールする標準アカウントを選択します。
       • アプリを接続をクリックします。結果のタブは閉じて構いません。

   プライベートアプリを使用する

   HubSpotプライベートアプリケーショントークンを使用して接続するには、AuthSchemeプロパティを"PrivateApp"に設定します。

   以下の手順に従ってプライベートアプリケーショントークンを生成できます：

   1. HubDBアカウントで、メインナビゲーションバーの設定アイコン（歯車）をクリックします。
   2. 左サイドバーメニューで、統合 > プライベートアプリに移動します。
   3. プライベートアプリを作成をクリックします。
   4. 基本情報タブで、アプリケーションの詳細（名前、ロゴ、説明）を設定します。
   5. スコープタブで、プライベートアプリケーションがアクセスできるようにしたい各スコープに対して読み取りまたは書き込みを選択します。
   6. テーブルにアクセスするには、最低限hubdbとcrm.objects.owners.readが必要です。
   7. アプリケーションの設定が完了したら、右上のアプリを作成をクリックします。
   8. アプリケーションのアクセストークンに関する情報を確認し、作成を続行をクリックし、その後トークンを表示をクリックします。
   9. コピーをクリックして、プライベートアプリケーショントークンをコピーします。

   接続するには、PrivateAppTokenを取得したプライベートアプリケーショントークンに設定します。

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

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

Data Visualizations をレポートに追加

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

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

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

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

さらにCognos は、measure dimesion のロジカルなデフォルトアグリゲート関数をデータタイプに基づいて設定します。この例では、デフォルトをオーバーライドしています。［Data Items］タブの Name カラムをクリックして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 プロパティでHubDB データソースを選択してSQL Syntax プロパティをNative に設定します。

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

   SELECT PartitionKey, Name FROM NorthwindProducts WHERE Id = '1'

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

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

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

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

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

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