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

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
CData JDBC Driver をJasperReports Server にデプロイして、レポートや組み込み分析などから Spotify データにリアルタイムでアクセスできます。

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

ドライバー JAR のデプロイ

以下の手順に従って、JasperReports Server にドライバー JAR をデプロイします。この手順は Spotify と JasperReports Server にバンドルされている Tomcat サーバーに固有のものです。Tomcat ではなく JBoss AS 7 を使用している場合は、標準的なプロセスに従って JBoss への Spotify 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\Spotify.apip;AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackURL=http://localhost:33333;" maxActive="20" maxIdle="10" maxWait="-1" factory="com.jaspersoft.jasperserver.tomcat.jndi.JSCommonsBasicDataSourceFactory"/>

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

    OAuth 認証の設定

    Spotify は認証に OAuth 2.0 を使用します。クライアント認証情報を取得するには、Spotify Developer Dashboard でアプリケーションを作成する必要があります。

    Spotify アプリケーションのセットアップ

    1. Spotify Developer Dashboard にアクセスします。
    2. Spotify アカウントでログインして Create app をクリックします。
    3. アプリ名、説明を入力し、Redirect URI を設定します（デスクトップアプリケーションの場合は 
      http://localhost:33333
      など）。
    4. アプリ設定から Client ID と Client Secret をコピーします。

    接続プロパティ

    以下の接続プロパティを設定して接続を確立してください：

    • AuthScheme：OAuth に設定します。
    • InitiateOAuth：GETANDREFRESH に設定します。InitiateOAuth を使うと、OAuthAccessToken を取得するプロセスを管理できます。
    • OAuthClientId：Spotify アプリケーションの Client ID に設定します。
    • OAuthClientSecret：Spotify アプリケーションの Client Secret に設定します。
    • Scope：必要な OAuth スコープ（スペース区切り）に設定します。デフォルトには、このプロファイルのテーブルに必要なすべての読み取りスコープが含まれます。
    • CallbackURL：Spotify アプリケーションで設定したリダイレクト URI に設定します（例：http://localhost:33333）。

    接続文字列の例

    Profile=C:\profiles\Spotify.apip;AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackURL=http://localhost:33333;

    利用可能な OAuth スコープ

    • user-read-private：ユーザーのサブスクリプション詳細と露骨なコンテンツ設定への読み取りアクセス。
    • user-read-email：ユーザーのメールアドレスへの読み取りアクセス。
    • user-library-read：ユーザーが保存したトラック、アルバム、エピソード、ショー、オーディオブックへの読み取りアクセス。
    • playlist-read-private：ユーザーの非公開プレイリストへの読み取りアクセス。
    • playlist-read-collaborative：ユーザーがフォローしているコラボレーティブプレイリストへの読み取りアクセス。
    • user-follow-read：現在のユーザーがフォローしているアーティストの一覧への読み取りアクセス。
    • user-read-playback-state：ユーザーのプレーヤー状態（デバイス、現在のトラック、再生位置）への読み取りアクセス。
    • user-read-currently-playing：ユーザーが現在再生中のコンテンツへの読み取りアクセス。
    • user-read-playback-history：ユーザーが最近再生したトラックへの読み取りアクセス。
    • user-top-read：ユーザーのトップアーティストとトラックへの読み取りアクセス。

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

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

    java -jar cdata.jdbc.api.jar

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

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

  3. jasperserver-pro -> WEB-INF に移動し、以下の参照を web.xml ファイルに追加します。 
    
  Spotify のデータ JSP
  jdbc/api
  javax.sql.DataSource
  Container
  4. サーバーを再起動します。

Spotify JDBC データソースの作成

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

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

ドメインの作成

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

  1. Create -> Domain をクリックします。ドメインの ID を入力し、保存場所を選択します。
  2. Data Source セクションで Browse をクリックし、作成した Spotify データソースを選択します。
  3. Domain Design セクションで、Create with Domain Designer をクリックします。
  4. テーブルが含まれるスキーマを選択します。
  5. Tables タブで、Data Source ペインからテーブルを選択し、矢印をクリックして Selected Tables ペインに追加します。
  6. Derived Tables タブでは、SQL クエリに基づいてドメインを定義できます。例えば、 
      SELECT ,  FROM Albums WHERE Id = '4aawyAB9vmqN3uQ7FjRGTy'
  7. Joins タブでは、結合条件を構築するカラムを選択し、結合タイプを選択することでテーブルを結合できます。
  8. Pre-Filters タブでは、カラムをドラッグ＆ドロップして、ドメインを通じて公開されるデータをフィルタする検索条件を定義します。
  9. Display タブで、ユーザーに提示されるデータセットに Spotify データを選択します。
  10. OK をクリックして変更を確定し、Submit をクリックしてドメインを作成します。

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

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

  1. Create -> Ad Hoc View をクリックします。
  2. 表示されるダイアログで、作成した Spotify ドメインを選択します。
  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 をクリックします。

はじめる準備はできましたか？

API Driver で Spotify のライブデータに接続

Spotify に接続

この記事の内容

関連記事