Jaspersoft Studio からHubDB データに接続する方法

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

この記事では、CData JDBC Driver for HubDB を使ってHubDB の連携機能を持つJaspersoft Studio の基本的な帳票をテーブルやチャートで作成する方法を説明します。レポートを実行するたびに、チャートおよびテーブルはリアルタイムデータを表示します。JasperSoft のウィザードを使って、レポートエレメントを埋めるSQL クエリをいくつかビルドします。ドライバーは、リレーショナルデータベースへのデータのコピー処理をスキップする間、標準SQL を利用可能にします。代わりに、クエリは基になるHubDB API に直接実行されます。

JDBC データソースとしてHubDB データに接続

Jaspersoft Studio で、［Data Adapter］ウィザードを使ってJDBC データソースに接続できます。下記の手順に従って、プロジェクトからHubDB に接続します。HubDB データアダプターをワークスペースに追加します。

1. ［Repository Explorer］で［Data Apters］ノードを右クリックし、［Create Data Adapter］をクリックします。
2. ［Database JDBC Connection］を選択します。
3. ユーザーフレンドリーなドライバー名を入力します。
4. ［Driver Classpath］タブで［Add］をクリックします。ダイアログが表示されたら、インストールディレクトリの［lib］サブフォルダにナビゲートします。ドライバーのJAR を選択します。
5. ［Database Location］タブでは、以下の情報が必要です：
   • JDBC Driver：JDBC driver のクラス名cdata.jdbc.hubdb.HubDBDriver を入力。

   • JDBC URL：JDBC URL に必要な接続プロパティを入力。接続プロパティは、セミコロン区切りでname-value ペアを入力する必要があります。HubDB の一般的なJDBC URL は次のとおりです：

     jdbc:hubdb:AuthScheme=OAuth;OAuthClientID=MyOAuthClientID;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:33333;

     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を取得したプライベートアプリケーショントークンに設定します。

HubDB データ で帳票を作成

HubDB のデータアダプターを作成したら、HubDB データをJasperReports に追加できます。このセクションでは同梱されているテンプレートの一つをHubDB データに連携させる方法について説明します。

1. ［File］>［New Jasper Report］をクリックします。テンプレートを選択し、親プロジェクトを選択して、帳票に名前を入力します。
2. ［Data Adapter］ウィザードで、先のセクションで作成したデータアダプターを選択します。
3. ［Diagram］タブでは、クエリを視覚的にビルドできます：テーブルをボックスにドラッグしお好みのカラムをクリックします。カスタムクエリも入力可能です。例： SELECT * FROM NorthwindProducts
4. データセットに含めたいフィールドを選択します。

［Preview］タブでは、最新のHubDB を使ったものと同じ帳票を見ることができます。

チャートを追加

下記の手順に従って、HubDB のチャートを既存の帳票に追加します。棒グラフを、先のセクションで作成した帳票テンプレートの最後に追加します。

1. ［Design］タブをクリックします。
2. ［Outline］ビューで、帳票のルートノードを右クリックし［Create Dataset］をクリックします。
3. データセット名を入力し、オプションをクリックして接続またはデータソースから新しいデータセットを作成します。
4. ［Data Adapter］メニューで、最初のセクションで作成した［Data Adapter］を選択します。
5. 次のクエリを入力します：
   SELECT PartitionKey, Name FROM NorthwindProducts WHERE Id = '1'
6. データセットに必要なフィールドを選択します。この例ではすべてのフィールドを使います。
7. カラムでグループ化する手順はスキップします。HubDB API はGROUP BY のステートメントをサポートしていません。

データセットを追加したら、下記の手順に従ってチャートを作成します。

1. ［Outline］ビューの［Summary］ノードをクリックします。［Properties］ビューで高さを400ピクセルに設定します。サマリーバンドが帳票の最後にプリントされます。
2. チャートを［Palette］からsummary にドラッグします。Chart ウィザードが表示されます。
3. チャートの種類を選択します。この例では棒グラフを使います。
4. ［Dataset］メニューで、チャート用に作成したデータセットを選択します。
5. ［Dataset］タブで、オプションを選択してマスター帳票と同じ接続を使用します。Chart ウィザードは接続パラメータを入力し、メニューセレクションを［Use Another Connection］に変更します。
6. ［Series］メニューの隣にあるボタンをクリックし、デフォルトシリーズを削除します。［Add］をクリックします。
7. ［Expression Editor］が表示されたら、カラムをダブルクリックして各カラム値に新しいシリーズを作成します。例：PartitionKey。シリーズをPartitionKey に設定した場合、PartitionKey ごとに新しい棒グラフが作成されます。
8. ［Value］ボックスの隣にあるボタンをクリックし、チャートのmeasures 用に［Expression Editor］を開きます。カラムをダブルクリックしてy 軸に追加します。例：Name。
9. ［Label］ボックスの隣にあるボタンをクリックし、チャートのdimensions 用に［Expression Editor］を開きます。カラムをダブルクリックしてx 軸に追加します。例：PartitionKey。
10. この例ではカテゴリを使用しないため、［Category］ボックスに空の文字列 "" を入力します。

チャートを作成したら基本的なフォーマットを行い、サブレポートをレポートに未使用スペースなくシームレスに追加できるようにします。

1. チャートを右クリックして［Size to Container］>［Fit Both］をクリックします。
2. メインレポートでサブレポートを右クリックして［Size to Container］>［Fit Both］をクリックします。

プレビューする前に帳票への変更を保存します。チャートが帳票の最後のページに表示されます。