各製品の資料を入手。
詳細はこちら →
製品をチェック
ETL ツールのEmbulk を使ってSuiteCRM のデータをDB にロードする方法
OSS のETL ツールEmbulk のJDBC Plugin を使って、SuiteCRM のデータを簡単にDB に同期する方法をご紹介します。
最終更新日：2023-10-13
この記事で実現できるSuiteCRM 連携のシナリオ
こんにちは！リードエンジニアの杉本です。
Embulk は、大量のデータをDB、クラウドデータストア、DWH にロードできるオープンソースETL ツールです。近頃のトレンドでは1社で複数のオンプレアプリやSaaS を使っており、データ分析にはETL ツールを使ってデータを丸ごとDB/DWH にロードしてから、分析や可視化をすることが主流になっています。Embulk にはいろいろなプラグインがあり、多様なInput とOutput 処理をサポートしています。この記事では、Embulk のJDBC Input Plugin と CData Driver for SuiteCRM を使って、SuiteCRM のデータを簡単にDB にロードする方法をご紹介します。この例ではロード先のDB にはMySQL を使います。
Embulk でSuiteCRM のデータをロード
- CData JDBC Driver for SuiteCRM をEmbulk と同じマシンにインストールします。CData JDBC ドライバは30日間の無償トライアルが利用できるので、サイドバーからお気軽にダウンロードしてご利用ください。
-
以下のパスにJDBC Driver がインストールされます。後ほどこのパスを使います。
C:\Program Files\CData\CData JDBC Driver for SuiteCRM 2019J\lib\cdata.jdbc.suitecrm.jar 次に、EmbulkとCData JDBC Driverをつなぎこむための、JDBC Input Plugin をインストールします。以下のリンクからダウンロードできます。
https://github.com/embulk/embulk-input-jdbc/tree/master/embulk-input-jdbcインストール用のコマンドはこちら：
embulk gem install embulk-input-jdbc今回はロード先DB としてMySQL を使います。ほかにもSQL Server、PostgreSQL、Google BigQuery などを使うことも可能です。ロードに必要な以下のプラグインをインストールしましょう。
https://github.com/embulk/embulk-output-jdbc/tree/master/embulk-output-mysqlコマンドはこちら。
embulk gem install embulk-output-mysql- config ファイルを作成し、SuiteCRM -> MySQL のジョブを作成します。suitecrm-mysql.yml というファイル名で、以下の内容で作成しました。
- JDBC URL の内容は、ご利用の環境や資格情報を入力してください。
次の接続プロパティを設定すると、V4.1 API 経由でSuiteCRM データに接続できます。
- Schema：suitecrmv4 に設定。
- Url：SuiteCRM アプリケーションに紐づいているURL（例：http://suite.crm.com）に設定。
- User：SuiteCRM に紐づいているユーザーに設定。
- Password：SuiteCRM に紐づいているパスワードに設定。
SuiteCRM メタデータの取得は高負荷になる可能性があることに注意してください。メタデータのキャッシュ で説明しているように、メタデータをローカルに格納することをお勧めします。
- テーブル名は取得したいテーブル名を入れます。
- これで準備完了です。あとは「embulk run」で実行するだけです。
- 実行後MySQL Workbenchからテーブルを確認してみると、データが取得できているはずです。
in:
type: jdbc
driver_path: C:\Program Files\CData\CData JDBC Driver for SuiteCRM 2025J\lib\cdata.jdbc.suitecrm.jar
driver_class: cdata.jdbc.suitecrm.SuiteCRMDriver
url: jdbc:suitecrm:URL=http://mySuiteCRM.com;User=myUser;Password=myPassword;
table: "Accounts"
out:
type: mysql
host: localhost
database: DatabaseName
user: UserId
password: UserPassword
table: "Accounts"
mode: insert
embulk run suitecrm-mysql.yml
クエリ条件でフィルタリングしたデータのロード
ちなみに、上記の例ではテーブル名を直接指定しましたが、以下のようにSQL クエリを書いてもいいです。 WHERE 句で作成日や修正日を指定すれば、最新のデータだけを対象にすることも可能です。
in:
type: jdbc
driver_path: C:\Program Files\CData\CData JDBC Driver for SuiteCRM 2019J\lib\cdata.jdbc.suitecrm.jar
driver_class: cdata.jdbc.suitecrm.SuiteCRMDriver
url: jdbc:suitecrm:URL=http://mySuiteCRM.com;User=myUser;Password=myPassword;
query: "SELECT Name, Industry FROM Accounts WHERE [RecordId] = 1"
out:
type: mysql
host: localhost
database: DatabaseName
user: UserId
password: UserPassword
table: "Accounts"
mode: insert
おわりに
CData JDBC Driver for SuiteCRM をEmbulk で使うことで、SuiteCRM と連携して簡単にデータを取得できます。ぜひ、30日の無償評価版をお試しください。
関連コンテンツ
