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

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

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

Act CRM への JDBC 接続を設定

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

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

Authentication セクションのUser とPassword プロパティに、有効なAct! ユーザー資格情報を設定する必要があります。認証値に加えて、以下も参照してください。

• Act! Premium への接続

  認証値に加えて、Act! へのURL も設定が必要です。例：https://eup1-iis-04.eu.hosted.act.com/。

  さらに、接続するActDatabase を指定する必要があります。これは、ご自分のアカウントの「About Act! Premium」メニューのページ右上にある「?」で確認することができます。表示されたウィンドウの「Database Name」を使用します。

• Act! Premium Cloud への接続

  Act! Premium Cloud アカウントに接続するには、ActCloudName プロパティも指定する必要があります。このプロパティはCloud アカウントのURL アドレスで確認できます。例：https://eup1-iis-04.eu.hosted.act.com/ActCloudName/。

ActCRM メタデータの取得は高負荷になる可能性があることに注意してください。CacheMetadata プロパティを設定して、メタデータをローカルに格納することをお勧めします。

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

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

java -jar cdata.jdbc.actcrm.jar

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

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

jdbc:actcrm:URL=https://myActCRMserver.com;User=myUser;Password=myPassword;ActDatabase=MyDB;

Embulk で Act 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 を使用してAct CRM のデータをMySQL にロードする準備が整いました。

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

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

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

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

in:
	type: jdbc
	driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.actcrm.jar
	driver_class: cdata.jdbc.actcrm.ActCRMDriver
	url: jdbc:actcrm:URL=https://myActCRMserver.com;User=myUser;Password=myPassword;ActDatabase=MyDB;
	table: "Activities"
out:
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "Activities"
	mode: insert

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

embulk run actcrm-mysql.yml

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

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

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

in:
	type: jdbc
	driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.actcrm.jar
	driver_class: cdata.jdbc.actcrm.ActCRMDriver
	url: jdbc:actcrm:URL=https://myActCRMserver.com;User=myUser;Password=myPassword;ActDatabase=MyDB;
	query: "SELECT ActivityDisplayName, Subject FROM Activities WHERE [RecordId] = 1"
out:
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "Activities"
	mode: insert

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

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