JReport Designer で Zoho CRM ののデータを連携利用
CData JDBC Driver for Zoho CRM のデータ を使えば、ダッシュボードやレポートから Zoho CRM をリレーショナルデータベースのように扱い、使い慣れた SQL クエリで Zoho CRM のデータ のライブデータにアクセスできます。この記事では、JReport Designer で Zoho CRM のデータ に JDBC データソースとして接続し、Zoho CRM のデータ のデータをもとにレポートを作成する方法を説明します。
Zoho CRM ののデータに接続
- C:\JReport\Designer\bin\setenv.bat を編集して、JAR ファイルの場所を ADDCLASSPATH 変数に追加します。
... set ADDCLASSPATH=%JAVAHOME%\lib\tools.jar;C:\Program Files\CData\CData JDBC Driver for Zoho CRM 2016\lib\cdata.jdbc.zohocrm.jar; ...
- File メニューから New、Data Source と進み、新しいデータソースを作成します。
- 表示されるダイアログでデータソース名を入力し(例:CData JDBC Driver for Zoho CRM)、JDBC を選択して OK をクリックします。
- Get JDBC Connection Information ダイアログで、JDBC ドライバーへの接続を設定します。
- Driver: Driver ボックスにチェックが入っていることを確認し、ドライバーのクラス名を入力します。
cdata.jdbc.zohocrm.ZohoCRMDriver
- URL: JDBC URL を入力します。URL は jdbc:zohocrm: から始まり、その後に接続プロパティをセミコロン区切りで記述します。
Zoho CRM への接続
それでは、Zoho CRM に接続していきましょう。データに接続するには、以下の接続パラメータを設定します。
- Region:Zoho CRM サーバーURL のドメインに関連付けられたリージョン
- Schema:Zoho CRM のバージョン(v2、v2.1、またはv4)。Zoho CRM のバージョンごとに独自のデータモデルがあります
これらのプロパティに加えて、認可時にサンドボックスまたは開発者インスタンスのいずれかを選択した場合は、InstanceType 接続プロパティでも同じ設定を行ってください。
Zoho CRM への認証
Zoho CRM では、データへの認証に2つの方法が用意されています。お使いの環境に応じて適切な方法を選択てください。
デスクトップ経由で自分のローカルデータに認証を行う場合(非ブラウザ接続):CData 製品が提供する埋め込みOAuth アプリケーションを使用
CData 製品はすでにZoho CRM にOAuth アプリケーションとして登録されています。そのため、デスクトップアプリケーションを介したローカルデータへの接続では、自動的に組み込みアプリケーションが使用されます。 OAuth 交換の繰り返しを避け、ローカルデータにアクセスするたびにOAuthAccessToken を手動で設定する手間を省くには、InitiateOAuth をGETANDREFRESH に設定してください。
ネットワーク経由で共有データに認証を行う場合(ブラウザ接続):カスタムOAuth アプリケーションを使用
すべてのOAuth フローで、この認証を有効にするにはAuthScheme をOAuth に設定する必要があります。
より詳細な認証手順については、ヘルプドキュメントの「Zoho CRM への認証」をご確認ください。
組み込みの接続文字列デザイナー
JDBC URL の構築には、Zoho CRM JDBC Driver に組み込まれている接続文字列デザイナーを使用できます。JAR ファイルをダブルクリックするか、コマンドラインから JAR ファイルを実行します。
java -jar cdata.jdbc.zohocrm.jar
接続プロパティを入力し、接続文字列をクリップボードにコピーします。
JDBC URL を設定する際には、Max Rows 接続プロパティの設定も検討してください。これにより返される行数が制限され、レポートやビジュアライゼーションのデザイン時のパフォーマンス向上に役立ちます。
一般的な JDBC URL は次のとおりです。
jdbc:zohocrm:AuthToken=2ad3b3e719f6bed7368e5e7e26e4f988;
- User: 認証に使用するユーザー名です。通常は空白のままにします。
- Password: 認証に使用するパスワードです。通常は空白のままにします。
- Driver: Driver ボックスにチェックが入っていることを確認し、ドライバーのクラス名を入力します。
Add Table ダイアログで、レポートに含めるテーブル(または、このデータソースを使用する今後のレポート用のテーブル)を選択し、Add をクリックします。
テーブルの読み込みが完了したら Done をクリックします。
- Catalog Browser で、レポートを作成するためのクエリを作成できます。これはレポート作成前でも作成後でも行えます。データソース(CData JDBC Driver for Zoho CRM)を展開()し、Queries を右クリックして Add Query を選択します。
- Add Table/View/Query ダイアログで、JDBC URL と Tables を展開()し、クエリで使用するテーブルを選択して OK をクリックします。
- Query Editor ダイアログで、含めるカラムを選択するか、SQL ボタンをクリックして独自のクエリを手動で入力します。例えば次のようになります。
SELECT Account_Name, Annual_Revenue FROM Accounts
クエリが構築できたら、OK をクリックして Query Editor ダイアログを閉じます。これで Zoho CRM のデータ を新規または既存のレポートに追加する準備が整いました。
NOTE: クエリが構築できたら、そのクエリをもとに Business View を作成できます。Business View を使用すると、クエリに基づいた Web レポートやライブラリコンポーネントを作成できます。詳しくは、JReport のチュートリアルを参照してください。
Zoho CRM ののデータをレポートに追加
これで Zoho CRM のデータ を使用したレポートを作成する準備が整いました。
- File メニューから New、Page Report と進んで新しいレポートを作成するか、既存のレポートの Chart Wizard を開きます。
- Query を選択します(または新規作成します。上記を参照)。
- クエリのカラムからチャートの Category と Value を設定し、Finish をクリックします。
- レポートの View タブをクリックして、チャートを表示します。