DBeaver からZoho CRM のデータに連携して可視化する方法とは？

CData JDBC Driver for ZohoCRM は、IDE からBI ツールまで、サードパーティーツールからZoho CRM のデータの読み書きを可能にするJDBC 標準を提供します。本記事では、DBeaver のウィザードを使ってZoho CRM のデータに接続し、GUI 上でデータを参照する方法を紹介します。

CData JDBC ドライバとは？

CData JDBC ドライバは、以下の特徴を持ったリアルタイムデータ接続ツールです。

1. Zoho CRM をはじめとする、CRM、MA、グループウェア、広告、会計ツールなど多様な270種類以上のSaaS / DB に対応
2. DBeaver を含む多様なアプリケーション、ツールにZoho CRM のデータを連携
3. ノーコードでの手軽な接続設定
4. 標準 SQL での柔軟なデータ読み込み・書き込み

CData JDBC ドライバでは、1.データソースとしてZoho CRM の接続を設定、2.DBeaver 側でJDBC Driver との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。

CData JDBC ドライバのインストールとZoho CRM への接続設定

まずは、本記事右側のサイドバーからZohoCRM JDBC Driver の無償トライアルをダウンロード・インストールしてください。30日間無償で、製品版の全機能が使用できます。

次に、以下の手順でDBeaver にドライバーのJAR ファイルをロードします。

1. DBeaver アプリケーションを開き、「データベース」メニューの「ドライバーマネジャー」オプションを選択します。「新規」をクリックして「新しいドライバを作成する」フォームを開きます。
2. 設定タブで：
   • ドライバ名をわかりやすい名前に設定します（例：CData JDBC Driver for Zoho CRM）。
   • クラス名をJDBC ドライバーのクラス名「cdata.jdbc.zohocrm.ZohoCRMDriver」に設定します。
   • URL テンプレートをjdbc:zohocrm: に設定します。
   
3. ライブラリタブで「ファイルを追加」をクリックし、インストールディレクトリ（C:\Program Files\CData\CData JDBC Driver for Zoho CRM XXXX\）の「lib」フォルダに移動してJAR ファイル（cdata.jdbc.ZohoCRM.jar）を選択します。

Zoho CRM のデータの接続を作成

以下の手順で、認証情報およびその他の必要な接続プロパティを追加します。

1. 「データベース」メニューで、「新しい接続」をクリックします。
2. 表示される「新しい接続を作成する」 ウィザードで、先ほど作成したドライバー（例：CData JDBC Driver for Zoho CRM）を選択し、「次へ >」をクリックします。
3. 設定ウィザードの一般タブで、以下を参考に必要な接続プロパティを使用してJDBC URL を設定します。

   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:zohocrm:AuthToken=2ad3b3e719f6bed7368e5e7e26e4f988;
   

   
4. 「テスト接続」をクリックして、接続が正しく設定されていることを確認します。
5. 「終了」をクリックします。

Zoho CRM のデータにクエリを実行

これで、接続できたことで公開されたテーブルのデータにクエリを実行できるようになりました。テーブルを右クリックし、「ビュー表」をクリックします。「データ」タブでデータを確認できます。

おわりに