MySQL Workbench からSugar CRM のデータをクエリする方法

こんにちは！ドライバー周りのヘルプドキュメントを担当している古川です。

ODBC Driver for SugarCRM とSQL Gateway を使用することで、MySQL インターフェースを使ってSugar CRM にクエリを実行できます。この記事では、MySQL Workbench からSugar CRM のデータにSQL クエリを投げてデータを取得する方法をご紹介します。

CData ODBC ドライバとは？

CData ODBC ドライバは、以下のような特徴を持ったリアルタイムデータ連携ソリューションです。

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

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

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

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

未指定の場合は、データソース名（DSN）で必要な接続プロパティの値を指定します。ドライバーのインストールの最後にODBC アドミニストレーターが開きます。Microsoft ODBC データソースアドミニストレーターでDSN を作成及び設定する方法については、ヘルプドキュメントの［はじめに］チャプターを参照してください。

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

SQL Gateway を構成する

Sugar CRM への接続を仮想MySQL データベースとして設定する方法については、SQL Gateway の解説記事 を参照してください。クライアントからのMySQL リクエストを受けるMySQL リモートサービスを構築します。このサービスは、SQL Gateway のUI で構成できます。

MySQL Workbench からSugar CRM をクエリ

以下のステップでは、MySQL Workbench からSQL Gateway で作成された仮想Sugar CRM のデータベースに接続し、Sugar CRM のデータをリアルタイムで操作するための基本的なクエリを発行する方法を説明します。

SQL Gateway を介してSugar CRM に接続

1. MySQL Workbench で、［add a new MySQL connection］をクリックします。
2. 接続（CData SQL Gateway for SugarCRM）に名前を付けます。
3. Hostname、Port、Username のパラメータを設定し、SQL Gateway に接続します。
4. Store in Vault をクリックしてパスワードを設定し、保存します。
5. Test Connection をクリックして接続が正しく構成されていることを確認し、OK をクリックします。

Sugar CRM のデータをクエリしてみる

1. 作成した接続（CData SQL Gateway for SugarCRM）を開きます。
2. ［File］->［New Query Tab］と進みます。
3. SELECT * FROM `CData SugarCRM Sys`.Accounts; のようなSugar CRM のデータを取得するSQL を書いて、実行します。
4. 無事、Sugar CRM のデータが取得できました。

おわりに

MySQL Workbench からリアルタイムSugar CRM のデータにアクセスすることで、MySQL データベースと同じようにSugar CRM をクエリおよび更新できます。CData ODBC Driver for SugarCRM とCData SQL Gateway の30日の無償評価版はこちらです。

CData ODBC ドライバは日本のユーザー向けに、UI の日本語化、ドキュメントの日本語化、日本語でのテクニカルサポートを提供しています。