JReport Designer で Zendesk ののデータを連携利用

Jerod Johnson
Senior Technology Evangelist

JReport Designer で Zendesk のデータをもとにチャートとレポートを作成。

CData JDBC Driver for Zendesk のデータを使えば、ダッシュボードやレポートから Zendesk をリレーショナルデータベースのように扱い、使い慣れた SQL クエリで Zendesk のデータのライブデータにアクセスできます。この記事では、JReport Designer で Zendesk のデータに JDBC データソースとして接続し、Zendesk のデータのデータをもとにレポートを作成する方法を説明します。

Zendesk ののデータに接続

C:\JReport\Designer\bin\setenv.bat を編集して、JAR ファイルの場所を ADDCLASSPATH 変数に追加します。

...
set ADDCLASSPATH=%JAVAHOME%\lib\tools.jar;C:\Program Files\CData\CData JDBC Driver for Zendesk 2016\lib\cdata.jdbc.zendesk.jar;
...

File メニューから New、Data Source と進み、新しいデータソースを作成します。
表示されるダイアログでデータソース名を入力し（例：CData JDBC Driver for Zendesk）、JDBC を選択して OK をクリックします。
Get JDBC Connection Information ダイアログで、JDBC ドライバーへの接続を設定します。
- Driver: Driver ボックスにチェックが入っていることを確認し、ドライバーのクラス名を入力します。
```
cdata.jdbc.zendesk.ZendeskDriver
```
- URL: JDBC URL を入力します。URL は jdbc:zendesk: から始まり、その後に接続プロパティをセミコロン区切りで記述します。
  Zendesk 接続プロパティの取得・設定方法
  
  Zendesk に接続するには、https://{subdomain}.zendesk.com の形式でURL（Zendesk Support URL）を設定します。接続後、次のセクションの説明に従ってユーザー認証を行います。
  また、TicketMetrics テーブルのアーカイブデータを扱うユーザーは、UseIncrementalAPI プロパティをTrue に設定する必要があります。
  Zendesk への認証
  
  Zendesk は、Zendesk インスタンスの設定に応じて、3種類の認証をサポートします。API トークン認証、OAuth 認証、Basic 認証（レガシー）です。
  
  API トークン認証
  
  API トークン認証を使用する場合は、E メールアドレスとApiToken を指定します。 AuthScheme をAPIToken に、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 接続プロパティの設定も検討してください。これにより返される行数が制限され、レポートやビジュアライゼーションのデザイン時のパフォーマンス向上に役立ちます。
  
  一般的な JDBC URL は次のとおりです。
```
jdbc:zendesk:URL=https://subdomain.zendesk.com;User=my@email.com;Password=test123;
```
- User: 認証に使用するユーザー名です。通常は空白のままにします。
- Password: 認証に使用するパスワードです。通常は空白のままにします。
Add Table ダイアログで、レポートに含めるテーブル（または、このデータソースを使用する今後のレポート用のテーブル）を選択し、Add をクリックします。

テーブルの読み込みが完了したら Done をクリックします。
Catalog Browser で、レポートを作成するためのクエリを作成できます。これはレポート作成前でも作成後でも行えます。データソース（CData JDBC Driver for Zendesk）を展開（）し、Queries を右クリックして Add Query を選択します。
Add Table/View/Query ダイアログで、JDBC URL と Tables を展開（）し、クエリで使用するテーブルを選択して OK をクリックします。
Query Editor ダイアログで、含めるカラムを選択するか、SQL ボタンをクリックして独自のクエリを手動で入力します。例えば次のようになります。
```
SELECT Id, Subject FROM Tickets
```
クエリが構築できたら、OK をクリックして Query Editor ダイアログを閉じます。これで Zendesk のデータを新規または既存のレポートに追加する準備が整いました。

NOTE: クエリが構築できたら、そのクエリをもとに Business View を作成できます。Business View を使用すると、クエリに基づいた Web レポートやライブラリコンポーネントを作成できます。詳しくは、JReport のチュートリアルを参照してください。