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

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

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

はじめに

---

Dynamics CRM への JDBC 接続を設定

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

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

Dynamics CRM 接続プロパティの取得・設定方法

Dynamics CRM では、インスタンスごとに接続文字列の設定が必要です。 Authentication セクションでは、有効なDynamics CRM のUser、Password の入力、およびDynamics CRM Server Organization root のURL を設定します。さらに、CRMVersion プロパティに、'CRM2011+' もしくは'CRMOnline' を設定します。IFD コンフィグレーションもサポートされていますので、InternetFacingDeployment をTRUE に設定してください。

また、Security Token Service（STS）、もしくはAD FS エンドポイントをSTSURL プロパティに設定することもできます。 この値はGetSTSUrl ストアドプロシージャで取得できます。 Office 365 ユーザーはデフォルトSTS URL にCRMVersion の設定だけで接続することができます。

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

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

java -jar cdata.jdbc.dynamicscrm.jar

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

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

jdbc:dynamicscrm:User=myuseraccount;Password=mypassword;URL=https://myOrg.crm.dynamics.com/;CRM Version=CRM Online;

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

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

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

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

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

in:
	type: jdbc
	driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.dynamicscrm.jar
	driver_class: cdata.jdbc.dynamicscrm.DynamicsCRMDriver
	url: jdbc:dynamicscrm:User=myuseraccount;Password=mypassword;URL=https://myOrg.crm.dynamics.com/;CRM Version=CRM Online;
	table: "Account"
out:
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "Account"
	mode: insert

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

embulk run dynamicscrm-mysql.yml

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

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

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

in:
	type: jdbc
	driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.dynamicscrm.jar
	driver_class: cdata.jdbc.dynamicscrm.DynamicsCRMDriver
	url: jdbc:dynamicscrm:User=myuseraccount;Password=mypassword;URL=https://myOrg.crm.dynamics.com/;CRM Version=CRM Online;
	query: "SELECT FirstName, NumberOfEmployees FROM Account WHERE [RecordId] = 1"
out:
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "Account"
	mode: insert

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

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