Apache NiFi でDynamics 365 のデータにバッチ操作を実行
Apache NiFi は、データルーティング、変換、およびシステム間連携ロジックを強力かつスケーラブルに構築できるプラットフォームです。CData JDBC Driver for Dynamics 365 と組み合わせることで、NiFi からリアルタイムDynamics 365 のデータを操作できるようになります。この記事では、CSV ファイルからデータを読み取り、Apache NiFi(バージョン1.9.0 以降)でCData JDBC Driver forDynamics 365 のデータを使用してバッチ操作(INSERT/UPDATE/DELETE)を実行する方法を説明します。
最適化されたデータ処理が組み込まれたCData JDBC Driver は、リアルタイムDynamics 365 のデータを扱う上で比類のないパフォーマンスを提供します。Dynamics 365 に複雑なSQL クエリを発行すると、ドライバーはフィルタや集計などのサポートされているSQL 操作をDynamics 365 に直接プッシュし、サポートされていない操作(主にSQL 関数やJOIN 操作)は組み込みSQL エンジンを利用してクライアント側で処理します。組み込みの動的メタデータクエリを使用すると、ネイティブデータ型を使ってDynamics 365 のデータを操作・分析できます。
Dynamics 365 データ連携について
CData は、Microsoft Dynamics 365 のライブデータへのアクセスと統合を簡素化します。お客様は CData の接続機能を以下の目的で活用しています:
- Sales、Customer Service、Finance & Operations、Marketing など、Dynamics 365 エコシステム全体のデータの読み取りと書き込みができます。
- カスタマイズ可能なキャッシュと、インテリジェントなクエリ集約・分離により、Dynamics CRM のネイティブ機能を拡張できます。
- Azure Active Directory、Azure マネージド サービス ID 認証情報、クライアントシークレットまたは証明書を使用した Azure サービスプリンシパルなど、さまざまな方法で Dynamics 365 に安全に認証できます。
- SQL ストアドプロシージャを使用して、Dynamics 365 エンティティを管理できます。エンティティ間の関連付けの一覧表示、作成、削除などが可能です。
CData のお客様は、データをデータウェアハウスにレプリケートしたい場合(他のデータソースと併せて)や、Microsoft エコシステム内のお気に入りのデータツール(Power BI、Excel など)または外部ツール(Tableau、Looker など)からライブ Dynamics 365 データを分析したい場合など、さまざまな理由で当社の Dynamics 365 接続ソリューションを使用しています。
はじめに
JDBC URL の生成
Apache NiFi からDynamics 365 のデータに接続するには、JDBC URL が必要です。
組み込みの接続文字列デザイナー
JDBC URL の作成をサポートするために、Dynamics 365 JDBC Driver に組み込まれている接続文字列デザイナーが使用できます。JAR ファイルをダブルクリックするか、コマンドラインからJAR ファイルを実行します。
java -jar cdata.jdbc.dynamics365.jar
接続プロパティを入力し、接続文字列をクリップボードにコピーします。
Dynamics 365 接続プロパティの取得・設定方法
Microsoft Dynamics 365 への接続
Microsoft Dynamics 365 ドライバーは、以下のMicrosoft Dynamics 365 エディションへの接続をサポートしています。
- CustomerService
- FieldService
- FinOpsOnline (デフォルト)
- FinOpsOnPremise
- HumanResources
- Marketing
- ProjectOperations
- Sales
Notes:
- Supply Chain Management はFinance and Operations と同一です。これらのいずれかに接続するには、Edition をFinOpsOnline またはFinOpsOnPremise のいずれかに設定します。
- Microsoft Dynamics 365 Business Central については、個別のMicrosoft Dynamics 365 Business Central ドライバーを使用してください。
- OrganizationURL:お使いのMicrosoft Dynamics 365 組織のURL。例えば、https://orgcb42e1d0.crm.dynamics.com。
- Edition:上記のエディション一覧に示すとおり。
Microsoft Dynamics 365 への認証
Microsoft Dynamics 365 は、Microsoft Entra ID(Azure AD)、Azure サービスプリンシパル、Azure マネージドID(MSI)を経由する認証をサポートします。これらはすべてOAuth 規格に基づきます。 認証方法の詳細は、ヘルプドキュメントを参照してください。
Apache NiFi でのバッチ操作(INSERT/UPDATE/DELETE)
以下のサンプルフローは、次のNiFi プロセッサに基づいています:
- ListFile - ローカルファイルシステムからファイルリストを取得し、取得した各ファイルにFlowFile を作成します。
- FetchFile - ListFile プロセッサから受け取ったFlowFile のコンテンツを読み取ります。
- PutDatabaseRecord - 指定されたRecordReader を使用して、FetchFile プロセッサからのフローファイルからレコードを入力します。これらのレコードはSQL 文に変換され、単一のトランザクションとして実行されます。
- LogAttribute - 指定されたログレベルでFlowFile の属性を出力します。
完成したフローは以下のようになります:
注意事項
1. CSV ファイルのカラム名は、挿入/更新/削除するデータソーステーブルのレコードのカラム名と一致する必要があります。
2. Apache NiFi バージョン1.9.0 より前のバージョンでは、PutDatabaseRecord プロセッサの Maximum Batch Size プロパティがサポートされていません。
設定
バッチINSERT、UPDATE、またはDELETE を実行するには、NiFi プロセッサを以下のように設定します:
- ListFile プロセッサの設定:Input Directory プロパティを、CSV ファイルを取得するローカルフォルダパスに設定します。 File Filter プロパティを、名前が式に一致するファイルのみを選択する正規表現に設定します。 例:CSV ファイルのフルパスがC:\Users\Public\Documents\InsertNiFi.csv の場合、プロパティは以下の画像のように設定します:
- FetchFile プロセッサの設定 FetchFile プロセッサのプロパティ設定はデフォルト値のままにします:
- PutDatabaseRecord プロセッサの設定
- Record Reader プロパティをCSV Reader Controller Service に設定します。CSV Reader Controller Service を、CSV ファイルの形式に合わせて設定します。
- Statement Type プロパティをINSERT に設定します。
-
Database Connection Pooling Service を、ドライバー設定を保持するDBCPConnection Pool に設定します。ドライバーはBulk API を使用するように設定する必要があります。
プロパティ 値 Database Connection URL jdbc:dynamics365:OrganizationUrl=https://myaccount.operations.dynamics.com/;Edition=Sales; Database Driver Class Name cdata.jdbc.dynamics365.Dynamics365Driver - Catalog Name プロパティを、テーブルが属するカタログの名前に設定します。
- Schema Name プロパティを、テーブルが属するスキーマの名前に設定します。
- Table Name プロパティを、INSERT 先のテーブル名に設定します。
-
Maximum Batch Size プロパティを、単一のバッチに含めるレコードの最大数に設定します。
-
Record Reader プロパティをCSV Reader Controller Service に設定します。CSV Reader Controller Service を、CSV ファイルの形式に合わせて設定します。
- Statement Type プロパティをUPDATE に設定します。
- Database Connection Pooling Service を、ドライバー設定を保持するDBCPConnection Pool に設定します。ドライバーはBulk API を使用するように設定する必要があります。上記と同じDatabase Connection URL 形式を使用します。
- Catalog Name プロパティを、テーブルが属するカタログの名前に設定します。
- Schema Name プロパティを、テーブルが属するスキーマの名前に設定します。
- Table Name プロパティを、UPDATE 対象のテーブル名に設定します。
- Update Keys プロパティを、UPDATE に必要なカラム名に設定します。
-
Maximum Batch Size プロパティを、単一のバッチに含めるレコードの最大数に設定します。
-
Record Reader プロパティをCSV Reader Controller Service に設定します。CSV Reader Controller Service を、CSV ファイルの形式に合わせて設定します。
- Statement Type プロパティをDELETE に設定します。
- Database Connection Pooling Service を、ドライバー設定を保持するDBCPConnection Pool に設定します。ドライバーはBulk API を使用するように設定する必要があります。上記と同じDatabase Connection URL 形式を使用します。
- Catalog Name プロパティを、テーブルが属するカタログの名前に設定します。
- Schema Name プロパティを、テーブルが属するスキーマの名前に設定します。
- Table Name プロパティを、UPDATE 対象のテーブル名に設定します。
- INSERT やUPDATE のStatement Type とは異なり、DELETE 操作ではMaximum Batch Size プロパティは表示されません。ただし、操作は引き続きバッチで処理されます。変更しない場合、バッチあたりの最大レコード数はデフォルト値の2000 です。DELETE 操作で使用するMaximum Batch Size の値を変更するには、Statement Type をINSERT またはUPDATE に変更し、Maximum Batch Size プロパティの値を変更して「Apply Changes」をクリックします。最後に、プロセッサの設定を再度開き、Statement Type をDELETE に戻して「Apply Changes」をクリックします。
-
LogAttribute プロセッサの設定
最後に、LogAttribute プロセッサを設定して、ユースケースに基づいてログに記録または無視する属性とログレベルを指定します。
INSERT 操作
バッチINSERT 操作を実行するには、PutDatabaseRecord プロセッサを以下のように設定します:
UPDATE 操作
バッチUPDATE 操作を実行するには、PutDatabaseRecord プロセッサを以下のように設定します:
DELETE 操作
バッチDELETE 操作を実行するには、PutDatabaseRecord プロセッサを以下のように設定します:
無償トライアルと詳細情報
CData JDBC Driver for Dynamics 365 の30日間無償トライアルをダウンロードして、Apache NiFi でリアルタイムDynamics 365 のデータの操作をはじめましょう。ご不明な点があれば、サポートチームにお問い合わせください。