JReport Designer でZendesk のデータを連携

JReport Designer でZendesk に連携するチャートとレポートを作成します。

加藤龍彦
デジタルマーケティング
最終更新日：2022-10-10

この記事で実現できるZendesk 連携のシナリオ

CData

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

CData JDBC Driver for Zendesk を使用すると、Zendesk がリレーショナルデータベースであるかのようにダッシュボードやレポートからリアルタイムデータにアクセスでき、使い慣れたSQL クエリを使用してZendesk] をクエリできます。ここでは、JDBC データソースとしてZendesk に連携し、JReport Designer で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］をクリックします。
［JDBC Connection Information］ダイアログで、JDBC ドライバーへの接続を構成します。
- Driver:［Driver］ボックスにチェックがついていることを確認し、ドライバーのクラスの名前を入力します。 cdata.jdbc.zendesk.ZendeskDriver
- URL:jdbc:zendesk: から始まり、その後にセミコロンで区切られた接続プロパティのリストが続くJDBC 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 を指定します。 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;[email protected];Password=test123;InitiateOAuth=GETANDREFRESH
- User:認証に使用するユーザー名は、通常空白のままにします。
- Password:User と同様に認証に使用するパスワードも、通常は空白のままにします。
［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 のチュートリアルを参照してください。