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

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

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

CData JDBC ドライバとは？

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

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

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

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

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

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

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

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

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

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

   CData 製品をSugarCRM に認証するには、以下を有効なSugarCRM ユーザー資格情報に設定する必要があります。User：SugarCRM アカウントのユーザー。Password：SugarCRM アカウントのパスワード。

   OAuth consumer key とconsumer secret は、Admin -> OAuth Keys で生成することができます。OAuthClientId にOAuth consumer key を、OAuthClientSecret にconsumer secret　を設定します。

   さらに、SugarCRM への接続を確立するには以下を指定します。URL：'http://{sugar crm instance}.com' の形式で、SugarCRM アカウントに紐付いているURL に設定。Platform：認証中にログインの競合が発生した場合は、SugarCRM UI で作成したプラットフォームのいずれかに設定。

   SugarCRM メタデータの取得は高負荷になる可能性があることに注意してください。メタデータのキャッシュ で説明しているように、メタデータをローカルに格納することをお勧めします。

   組み込みの接続文字列デザイナー

   JDBC URL の作成の補助として、Sugar CRM JDBC Driver に組み込まれている接続文字列デザイナーが使用できます。JAR ファイルをダブルクリックするか、コマンドラインからjar ファイルを実行します。

   java -jar cdata.jdbc.sugarcrm.jar

   接続プロパティを入力し、接続文字列をクリップボードにコピーします。

   一般的な接続文字列：

   jdbc:sugarcrm:User=MyUser;Password=MyPassword;URL=MySugarCRMAccountURL;CacheMetadata=True;
4. 「テスト接続」をクリックして、接続が正しく設定されていることを確認します。
5. 「終了」をクリックします。

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

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

おわりに