Embulk を使用して Zoho CRM ののデータをデータベースにロードする方法

Embulk はオープンソースのバルクデータローダーです。CData JDBC Driver for Zoho CRM と組み合わせることで、Zoho CRM から任意の同期先にデータを簡単にロードできます。この記事では、CData JDBC Driver for Zoho CRM をEmbulk で使用してZoho CRM のデータをMySQL データベースにロードする方法を解説します。

CData JDBC Driver は、最適化されたデータ処理機能を内蔵しており、リアルタイムのZoho CRM のデータに対して比類のないパフォーマンスを発揮します。Zoho CRM に対して複雑なSQL クエリを発行すると、ドライバーはフィルタや集計などのサポートされているSQL 操作を直接Zoho CRM にプッシュし、サポートされていない操作（SQL 関数やJOIN 操作など）は組み込みのSQL エンジンを使用してクライアント側で処理します。

Zoho CRM への JDBC 接続を設定

Embulk でバルクロードジョブを作成する前に、JDBC Driver のJAR ファイルのインストール場所（通常はC:\Program Files\CData\CData JDBC Driver for Zoho CRM\lib）を確認しておきます。

Embulk はJDBC 接続をサポートしているため、Zoho CRM に簡単に接続してSQL クエリを実行できます。バルクロードジョブを作成する前に、Zoho CRM への認証用の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

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

以下は、Zoho CRM への一般的なJDBC 接続文字列です。

jdbc:zohocrm:AuthToken=2ad3b3e719f6bed7368e5e7e26e4f988;

Embulk で Zoho CRM ののデータをロード

CData JDBC Driver をインストールしてJDBC 接続文字列を作成したら、必要なEmbulk プラグインをインストールします。

Embulk の入力・出力プラグインをインストール

1. Embulk にJDBC 入力プラグインをインストールします。
   https://github.com/embulk/embulk-input-jdbc/tree/master/embulk-input-jdbc

embulk gem install embulk-input-jdbc

2. この記事では、同期先データベースとしてMySQL を使用します。出力プラグインを使用して、SQL Server、PostgreSQL、またはGoogle BigQuery を同期先として選択することもできます。
   https://github.com/embulk/embulk-output-jdbc/tree/master/embulk-output-mysql

   embulk gem install embulk-output-mysql
   

入力プラグインと出力プラグインをインストールしたら、Embulk を使用してZoho CRM のデータをMySQL にロードする準備が整いました。

Zoho CRM ののデータをロードするジョブを作成

まず、Embulk で設定ファイルを作成します。ファイル名はzohocrm-mysql.yml のようにします。

1. 入力プラグインのオプションには、CData JDBC Driver for Zoho CRM、ドライバーJAR ファイルへのパス、ドライバークラス（例：cdata.jdbc.zohocrm.ZohoCRMDriver）、および上記のJDBC URL を指定します。
2. 出力プラグインのオプションには、MySQL データベースの値と認証情報を指定します。

設定ファイルのサンプル（zohocrm-mysql.yml）

in:
	type: jdbc
	driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.zohocrm.jar
	driver_class: cdata.jdbc.zohocrm.ZohoCRMDriver
	url: jdbc:zohocrm:AuthToken=2ad3b3e719f6bed7368e5e7e26e4f988;
	table: "Accounts"
out:
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "Accounts"
	mode: insert

ファイルを作成したら、Embulk ジョブを実行します。

embulk run zohocrm-mysql.yml

Embulk ジョブを実行すると、MySQL テーブルにZoho CRM のデータが格納されます。

フィルタリングした Zoho CRM ののデータをロード

テーブルから直接データをロードするだけでなく、カスタムSQL クエリを使用してロードするデータをより詳細に制御できます。また、クエリフィールドのSQL WHERE 句で最終更新カラムを設定することで、増分ロードを実行することもできます。

in:
	type: jdbc
	driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.zohocrm.jar
	driver_class: cdata.jdbc.zohocrm.ZohoCRMDriver
	url: jdbc:zohocrm:AuthToken=2ad3b3e719f6bed7368e5e7e26e4f988;
	query: "SELECT Account_Name, Annual_Revenue FROM Accounts WHERE [RecordId] = 1"
out:
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "Accounts"
	mode: insert

詳細情報と無料トライアル

CData JDBC Driver for Zoho CRM をコネクタとして使用することで、Embulk のデータロードジョブにZoho CRM のデータを統合できます。また、200 を超えるエンタープライズデータソース向けドライバーにより、あらゆるエンタープライズSaaS、ビッグデータ、NoSQL ソースも統合できます。30日間の無料トライアルをダウンロードして、今すぐお試しください。