Apache NiFi でWorkday のデータにバッチ操作を実行

Apache NiFi は、データルーティング、変換、およびシステム間連携ロジックを強力かつスケーラブルに構築できるプラットフォームです。CData JDBC Driver for Workday と組み合わせることで、NiFi からリアルタイムWorkday のデータを操作できるようになります。この記事では、CSV ファイルからデータを読み取り、Apache NiFi（バージョン1.9.0 以降）でCData JDBC Driver forWorkday のデータを使用してバッチ操作（INSERT/UPDATE/DELETE）を実行する方法を説明します。

最適化されたデータ処理が組み込まれたCData JDBC Driver は、リアルタイムWorkday のデータを扱う上で比類のないパフォーマンスを提供します。Workday に複雑なSQL クエリを発行すると、ドライバーはフィルタや集計などのサポートされているSQL 操作をWorkday に直接プッシュし、サポートされていない操作（主にSQL 関数やJOIN 操作）は組み込みSQL エンジンを利用してクライアント側で処理します。組み込みの動的メタデータクエリを使用すると、ネイティブデータ型を使ってWorkday のデータを操作・分析できます。

はじめに

---

JDBC URL の生成

Apache NiFi からWorkday のデータに接続するには、JDBC URL が必要です。

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

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

		java -jar cdata.jdbc.workday.jar
	

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

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

ここでは、4つのWorkday API の接続パラメータを設定する方法、およびTenant とBaseURL を取得する方法について説明します。必要なAPI のパラメータが設定され、カスタムOAuth および / またはAzure AD API クライアントを作成したら、接続の準備は完了です。

接続の前提条件

API / 前提条件 / 接続パラメータ
WQL / WQL サービスを有効化（下記参照） / ConnectionType： WQL
Reports as a Service / カタログレポートの設定（ヘルプドキュメントの「データアクセスのファインチューニング」参照） / ConnectionType： Reports
REST / 自動で有効化 / ConnectionType： REST
SOAP / 自動で有効化 / ヘルプドキュメントのWorkday SOAP API への認証を参照

BaseURL およびTenant の取得

BaseURL およびTenant プロパティを取得するため、Workday にログインしてView API Clients を検索します。 この画面では、Workday はBaseURL とTenant の両方を含むURL であるWorkday REST API Endpoint を表示します。

REST API Endpoint のフォーマットは、 https://domain.com//mycompany です。ここで、

• https://domain.com（URL のサブディレクトリと会社名の前の部分）はBaseURL です。
• mycompany（URL の最後のスラッシュの後の部分）はTenant です。

例えば、REST API エンドポイントがhttps://wd3-impl-services1.workday.com/ccx/api/v1/mycompany の場合、 BaseURL はhttps://wd3-impl-services1.workday.com であり、Tenant はmycompany です。

WQL サービスを有効化

Workday WQL API を介して接続するには、はじめにWQL Service を有効にする必要があります。

1. Workday を開きます。
2. 検索バーにView Domain と入力します。
3. プロンプトにWorkday Query Language と入力します。
4. Allowed Security Group Types のいずれかに、接続するユーザーが含まれていることを確認します。

Workday への認証

Basic 認証以外のほとんどのWorkday 接続では、認証のためにOAuth ベースのカスタムAPI クライアントアプリケーションを作成する必要があります。これには、ユーザーがAzure AD 資格情報を介して接続するエンタープライズインストールも含まれます。 Workday への認証につての詳細は、ヘルプドキュメントの「Workday への認証」セクションを参照してください。

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 プロセッサを以下のように設定します：

1. ListFile プロセッサの設定：Input Directory プロパティを、CSV ファイルを取得するローカルフォルダパスに設定します。 File Filter プロパティを、名前が式に一致するファイルのみを選択する正規表現に設定します。 例：CSV ファイルのフルパスがC:\Users\Public\Documents\InsertNiFi.csv の場合、プロパティは以下の画像のように設定します：

2. FetchFile プロセッサの設定
FetchFile プロセッサのプロパティ設定はデフォルト値のままにします：
3. PutDatabaseRecord プロセッサの設定

INSERT 操作

バッチINSERT 操作を実行するには、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:workday:User=myuser;Password=mypassword;Tenant=mycompany_gm1;BaseURL=https://wd3-impl-services1.workday.com;ConnectionType=WQL;
  Database Driver Class Name	cdata.jdbc.workday.WorkdayDriver

• Catalog Name プロパティを、テーブルが属するカタログの名前に設定します。
• Schema Name プロパティを、テーブルが属するスキーマの名前に設定します。
• Table Name プロパティを、INSERT 先のテーブル名に設定します。
• Maximum Batch Size プロパティを、単一のバッチに含めるレコードの最大数に設定します。

UPDATE 操作

バッチUPDATE 操作を実行するには、PutDatabaseRecord プロセッサを以下のように設定します：

• 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 プロパティを、単一のバッチに含めるレコードの最大数に設定します。

DELETE 操作

バッチDELETE 操作を実行するには、PutDatabaseRecord プロセッサを以下のように設定します：

• 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」をクリックします。

4. LogAttribute プロセッサの設定

   最後に、LogAttribute プロセッサを設定して、ユースケースに基づいてログに記録または無視する属性とログレベルを指定します。

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

CData JDBC Driver for Workday の30日間無償トライアルをダウンロードして、Apache NiFi でリアルタイムWorkday のデータの操作をはじめましょう。ご不明な点があれば、サポートチームにお問い合わせください。