FineReport で Zendesk のデータ を利用する
CData JDBC Driver for Zendesk は、JDBC 標準を完全に実装しており、さまざまなBI、レポート、ETL ツール、カスタムアプリケーションに Zendesk のデータ への接続を提供します。この記事では、FineReport で Zendesk のデータ をJDBC データソースとして設定し、レポートデザイナーで Zendesk のデータ をテーブルとして表示する方法を説明します。
Zendesk のデータ のJDBC データソースをセットアップする
以下の手順に従って、FineReport のデータベース接続として Zendesk のデータ を設定します。
- CData JDBC Driver for Zendesk のインストールディレクトリにあるlib フォルダから、cdata.jdbc.zendesk.jar ファイルをFineReport のインストールディレクトリにあるlib フォルダにコピーします。cdata.jdbc.zendesk.lic ファイルも同様にコピーしてください。
- ServerタブからDefine Data Connectionを選択し、クリックして新しい接続を追加してJDBCをクリックします。
続いて、ウィンドウでデータ接続の定義を設定します。
- Database: Others
- JDBC Driver: cdata.jdbc.zendesk.ZendeskDriver
-
URL: セミコロン区切りの接続プロパティを使用した標準のJDBC 接続文字列を入力します。
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 の管理画面で以下の設定を行います。
- Token アクセスを有効にします。
- Admin -> Channels-> API で、API トークンを管理します。一度にアクティブにできるトークンは1つだけです。トークンを削除すると、そのトークンは永久に無効化されます。
その他の認証方法についてはヘルプドキュメントを参照してください。
組み込みの接続文字列デザイナー
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; - Connection pool attributesをクリックし、Test before getting connectionsをNoに設定します。
Test connectionをクリックして、接続が正しく設定されていることを確認します。これで、Zendesk への接続を設定し、FineReport のデータソースとして使用できるようになります。
レポートデザイナーで Zendesk のデータ を選択する
- クリックして新しいテンプレートデータセットを追加し、DB queryを選択してデータベースクエリウィンドウを開きます。
- ドロップダウンリストから、作成したJDBC 接続を選択します。
- 左ペインにZendesk のエンティティがテーブルとして表示されます。
- ロードするZendesk のデータ のテーブルとカラムに対してSELECT 文を記述します。
- プレビューをクリックすると、データがテーブルとして表示されます。
このように簡単な手順で、FineReport で Zendesk をJDBC データソースとして利用できるようになります。