JasperReports Server で SerpApi のレポートを作成

CData JDBC Driver for SerpApi を使用すると、企業全体で SerpApi のデータ へのアクセスを提供できます。この記事では、JasperReports Server にドライバーをデプロイし、SerpApi のデータ のビジネスビューであるレポートドメインに基づいたシンプルなレポートを作成する方法を説明します。

ドライバー JAR のデプロイ

以下の手順に従って、JasperReports Server にドライバー JAR をデプロイします。この手順は SerpApi と JasperReports Server にバンドルされている Tomcat サーバーに固有のものです。Tomcat ではなく JBoss AS 7 を使用している場合は、標準的なプロセスに従って JBoss への SerpApi JDBC Driver のデプロイを行ってください。

1. インストールディレクトリの lib サブフォルダにあるドライバー JAR と .lic ファイルを、JasperReports Server インストールディレクトリ内の apache-tomcat フォルダの lib サブフォルダにコピーします。

2. apache-tomcat -> webapps -> jasperserver-pro -> META-INF に移動し、以下のリソースエントリを context.xml ファイルに追加します。

   
   
   <Resource name="jdbc/api"   auth="Container" type="javax.sql.DataSource" driverClassName="cdata.jdbc.api.APIDriver"  url="jdbc:api:Profile=C:\profiles\SerpAPI.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key_here';" maxActive="20" maxIdle="10" maxWait="-1" factory="com.jaspersoft.jasperserver.tomcat.jndi.JSCommonsBasicDataSourceFactory"/>
   

   JDBC URL（url 属性）に必要な接続プロパティを指定します。

   まず、Profile 接続プロパティをディスク上の SerpAPI プロファイルの場所に設定します（例：C:\profiles\SerpAPI.apip）。次に、ProfileSettings 接続プロパティを SerpAPI の接続文字列に設定します（以下を参照）。

   SerpAPI API プロファイル設定

   SerpAPI では API キー認証を使用します。API キーは以下の手順で取得できます。

   1. https://serpapi.com で SerpAPI アカウントにサインインします。
   2. https://serpapi.com/manage-api-key の「API Key」ページに移動します。
   3. プライベート API キーをコピーします。

   API キーを取得したら、以下の接続プロパティを設定します。

   • AuthScheme：APIKey に設定します。

   ProfileSettings 接続プロパティには、以下を設定します。

   • APIKey：SerpAPI のプライベート API キーに設定します。

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

   JDBC URL の構築には、SerpApi JDBC Driver に組み込まれている接続文字列デザイナーを使用してください。JAR ファイルをダブルクリックするか、コマンドラインから JAR ファイルを実行します。

   
   java -jar cdata.jdbc.api.jar
   

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

   

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

3. jasperserver-pro -> WEB-INF に移動し、以下の参照を web.xml ファイルに追加します。

   
   
     SerpApi のデータ JSP
     jdbc/api
     javax.sql.DataSource
     Container
   
   

4. サーバーを再起動します。

SerpApi JDBC データソースの作成

以下の手順に従って、SerpApi JDBC Driver を JDBC データソースにマッピングします。

1. JasperReports Server にログインし、Create -> Data Source をクリックします。
2. Type メニューで、JNDI Data Source を選択します。
3. Service Name ボックスに、web.xml ファイルのリソース定義で指定した JNDI ルックアップを入力します。この例では、ルックアップは「jdbc/api」です。
4. Save をクリックしてデータソースを作成します。

ドメインの作成

ドメインは、レポート作成者に関連するビジネスビューを提供するメタデータおよびアクセス制御レイヤーです。以下の手順に従って、SerpApi のカラムを選択し、フィルタを適用し、SQL を実行してドメインを作成します。

1. Create -> Domain をクリックします。ドメインの ID を入力し、保存場所を選択します。
2. Data Source セクションで Browse をクリックし、作成した SerpApi データソースを選択します。
3. Domain Design セクションで、Create with Domain Designer をクリックします。
4. テーブルが含まれるスキーマを選択します。
5. Tables タブで、Data Source ペインからテーブルを選択し、矢印をクリックして Selected Tables ペインに追加します。
6. Derived Tables タブでは、SQL クエリに基づいてドメインを定義できます。例えば、

     SELECT Asin, Title FROM AmazonSearch WHERE SearchQuery = 'mechanical keyboard'
     

7. Joins タブでは、結合条件を構築するカラムを選択し、結合タイプを選択することでテーブルを結合できます。
8. Pre-Filters タブでは、カラムをドラッグ＆ドロップして、ドメインを通じて公開されるデータをフィルタする検索条件を定義します。
9. Display タブで、ユーザーに提示されるデータセットに SerpApi データを選択します。
10. OK をクリックして変更を確定し、Submit をクリックしてドメインを作成します。

リアルタイムでデータを探索

ドメインを作成したら、データに接続する準備が整います。以下の手順に従って、Ad Hoc Editor で Ad Hoc ビューを作成します。

1. Create -> Ad Hoc View をクリックします。
2. 表示されるダイアログで、作成した SerpApi ドメインを選択します。
3. Choose Data ページで、ビューで使用するカラムを選択します。Pre-Filters セクションでは、選択したフィールドに基づいてフィルタを作成できます。Display セクションでは、ドメインで表示されるカラム情報を変更できます。
4. ウィザードが完了したら、ビュータイプを選択し、ビューにカラムを追加します。JasperSoft はドライバーのメタデータを使用して、データ型に基づいて利用可能なディメンションとメジャーを検出します。ディメンションとメジャーを Columns ボックスと Rows ボックスにドラッグします。メジャーを右クリックして集計計算を変更できます。Filters セクションで Columns スライダーを目的のデータレベルにドラッグします。
5. ビューの設計中にデータの更新にアクセスするには、設計モードのツールバーでメニュー選択を Sample Data から Full Data に変更します。変更を行うと、JasperSoft Server はドライバーに対して基になる SQL クエリを実行します。
6. ビューを保存します。

リアルタイムレポートの作成

これで、JasperSoft Server でホストされるレポートを作成できます。Ad Hoc Editor から作成するには、Save Ad Hoc View をクリックし、Create Report をクリックします。