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

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

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

ドライバー JAR のデプロイ

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

  1. インストールディレクトリの lib サブフォルダにあるドライバー JAR と .lic ファイルを、JasperReports Server インストールディレクトリ内の apache-tomcat フォルダの lib サブフォルダにコピーします。
  2. apache-tomcat -> webapps -> jasperserver-pro -> META-INF に移動し、以下のリソースエントリを context.xml ファイルに追加します。

    
    <Resource name="jdbc/zendesk"   auth="Container" type="javax.sql.DataSource" driverClassName="cdata.jdbc.zendesk.ZendeskDriver"  url="jdbc:zendesk:URL=https://subdomain.zendesk.com;User=my@email.com;Password=test123;" maxActive="20" maxIdle="10" maxWait="-1" factory="com.jaspersoft.jasperserver.tomcat.jndi.JSCommonsBasicDataSourceFactory"/>
    

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

    Zendesk 接続プロパティの取得・設定方法

    Zendesk に接続するには、https://{subdomain}.zendesk.com の形式でURL(Zendesk Support URL)を設定します。接続後、次のセクションの説明に従ってユーザー認証を行います。

    また、TicketMetrics テーブルのアーカイブデータを扱うユーザーは、UseIncrementalAPI プロパティをTrue に設定する必要があります。

    Zendesk への認証

    Zendesk は、Zendesk インスタンスの設定に応じて、3種類の認証をサポートします。API トークン認証、OAuth 認証、Basic 認証(レガシー)です。

    API トークン認証

    API トークン認証を使用する場合は、E メールアドレスとApiToken を指定します。 AuthSchemeAPIToken に、User をE メールアドレスに設定し、Zendesk Support の管理画面で以下の設定を行います。

    1. Token アクセスを有効にします。
    2. Admin -> Channels-> API で、API トークンを管理します。一度にアクティブにできるトークンは1つだけです。トークンを削除すると、そのトークンは永久に無効化されます。
    最後に、APIToken をアクティブなAPI トークンに設定します。

    その他の認証方法についてはヘルプドキュメントを参照してください。

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

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

    java -jar cdata.jdbc.zendesk.jar
    

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

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

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

Zendesk JDBC データソースの作成

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

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

ドメインの作成

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

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

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

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

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

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

Zendesk Driver の無料トライアルをダウンロードしてお試しください:

 ダウンロード

詳細:

Zendesk Icon Zendesk JDBC Driver お問い合わせ

簡単にJava アプリケーションからZendesk のTickets、Groups、Users、Schedules への連携を実装。