Anypoint Code Builder を使用した File Connector の設定

新しいインテグレーションプロジェクトの作成

Unresolved include directive in modules/ROOT/pages/file-acb-configuration.adoc - include::connectors::partial$configure-acb-connectors-partial.adoc[]

インテグレーションプロジェクトへのコネクタの追加

Unresolved include directive in modules/ROOT/pages/file-acb-configuration.adoc - include::connectors::partial$configure-acb-connectors-partial.adoc[]

フローのトリガーの設定

トリガー (ソース) は、指定された条件が満たされたときにフローを開始します。次のトリガーのいずれかを File Connector で使用するように設定できます。

On New or Updated File

新規作成または変更されたファイルに対してフローをトリガーする
[HTTP] > [Listener]

設定されたホストとポートで要求を受信するたびにフローを開始する
Scheduler

時間ベースの条件が満たされたときにフローを開始する

詳細は、anypoint-code-builder::acb-component-scheduler.adocを参照してください。

たとえば、On New or Updated トリガーを設定する手順は、次のとおりです。

[On New or Updated] 操作をキャンバスの UI に追加します。
キャンバス UI で [On New or Updated] 操作をクリックします。

[General (一般)] タブで、次の属性を設定します。

属性	説明	必須
Directory (ディレクトリ)	ポーリングされたファイルが配置されるディレクトリ。	いいえ
Recursive (再帰)	選択した場合、サブディレクトリに含まれるファイルを使用します。	いいえ
Matcher (マッチャー)	マッチャーの条件を満たさないファイルに対するイベントを絞り込むために使用するマッチャー。	いいえ
Watermark mode (ウォーターマークモード)	選択した場合、前回ポーリングが実行された後で作成または更新されたファイルのみを選択します。次のオプションがあります。 DISABLED MODIFIED_TIMESTAMP CREATED_TIMESTAMP	いいえ
Time between size check (サイズ確認の時間間隔)	ファイルの読み取り準備ができているかどうかを確認するためのサイズ確認間の待機時間 (ミリ秒)。これにより、ファイルの書き込みが完了してから処理を実行することができます。Mule Runtime は 2 回のサイズ確認を実行し、コールから次のコールまでの指定された時間を待機します。この両方の確認で同じ値が返された場合、ファイルの読み取り準備はできています。	いいえ
Time between size check unit (サイズ確認の時間間隔の単位)	[Time between size check (サイズ確認の時間間隔)] の単位。	いいえ
Scheduling strategy (スケジュール戦略)	時間ベースの条件に基づいてフローの実行をトリガーします。この項目は現在設定 UI で有効になっていません。XML エディターで設定してください。XML でのスケジュール戦略の設定を参照してください。	はい
後処理アクション
Auto delete (自動削除)	選択した場合、各ファイルを処理した後で処理済みのファイルを削除するため、次のポーリングで取得されるすべてのファイルが新規ファイルとみなされます。	いいえ
Move to directory (ディレクトリに移動)	処理された各ファイルの送信先となるディレクトリパス。ファイルを削除しない場合、これは [Auto delete (自動削除)] の代替アクションになります。	いいえ
Rename to (変更後の名前)	ファイルが移動したときにファイルの名前をこの値に変更します。この属性は、[Move To Directory (ディレクトリに移動)] と連携して機能します。この項目を設定しない場合、元のファイル名が保持されます。	いいえ
Apply post action when failed (失敗した場合に事後アクションを適用)	選択した場合、ファイル処理の失敗時にいずれかの事後アクション ([Auto delete (自動削除)] および [Move to directory (ディレクトリに移動)]) を適用します。このオプションを選択解除した場合、失敗したファイルは移動も削除もされません。	いいえ
Overwrite (上書き)	宛先ファイルの名前が同じ場合に対象ファイルを上書きします。	いいえ

属性

説明

必須

Directory (ディレクトリ)

ポーリングされたファイルが配置されるディレクトリ。

いいえ

Recursive (再帰)

選択した場合、サブディレクトリに含まれるファイルを使用します。

いいえ

Matcher (マッチャー)

マッチャーの条件を満たさないファイルに対するイベントを絞り込むために使用するマッチャー。

いいえ

Watermark mode (ウォーターマークモード)

選択した場合、前回ポーリングが実行された後で作成または更新されたファイルのみを選択します。

次のオプションがあります。

DISABLED
MODIFIED_TIMESTAMP
CREATED_TIMESTAMP

いいえ

Time between size check (サイズ確認の時間間隔)

ファイルの読み取り準備ができているかどうかを確認するためのサイズ確認間の待機時間 (ミリ秒)。これにより、ファイルの書き込みが完了してから処理を実行することができます。Mule Runtime は 2 回のサイズ確認を実行し、コールから次のコールまでの指定された時間を待機します。この両方の確認で同じ値が返された場合、ファイルの読み取り準備はできています。

いいえ

Time between size check unit (サイズ確認の時間間隔の単位)

[Time between size check (サイズ確認の時間間隔)] の単位。

いいえ

Scheduling strategy (スケジュール戦略)

時間ベースの条件に基づいてフローの実行をトリガーします。この項目は現在設定 UI で有効になっていません。XML エディターで設定してください。XML でのスケジュール戦略の設定を参照してください。

はい

後処理アクション

Auto delete (自動削除)

選択した場合、各ファイルを処理した後で処理済みのファイルを削除するため、次のポーリングで取得されるすべてのファイルが新規ファイルとみなされます。

いいえ

Move to directory (ディレクトリに移動)

処理された各ファイルの送信先となるディレクトリパス。ファイルを削除しない場合、これは [Auto delete (自動削除)] の代替アクションになります。

いいえ

Rename to (変更後の名前)

ファイルが移動したときにファイルの名前をこの値に変更します。この属性は、[Move To Directory (ディレクトリに移動)] と連携して機能します。この項目を設定しない場合、元のファイル名が保持されます。

いいえ

Apply post action when failed (失敗した場合に事後アクションを適用)

選択した場合、ファイル処理の失敗時にいずれかの事後アクション ([Auto delete (自動削除)] および [Move to directory (ディレクトリに移動)]) を適用します。このオプションを選択解除した場合、失敗したファイルは移動も削除もされません。

いいえ

Overwrite (上書き)

宛先ファイルの名前が同じ場合に対象ファイルを上書きします。

いいえ

プロジェクトへのコンポーネントの追加

Unresolved include directive in modules/ROOT/pages/file-acb-configuration.adoc - include::connectors::partial$configure-acb-connectors-partial.adoc[]

グローバル設定の追加

Unresolved include directive in modules/ROOT/pages/file-acb-configuration.adoc - include::connectors::partial$configure-acb-connectors-partial.adoc[]

コンポーネント属性の設定

Unresolved include directive in modules/ROOT/pages/file-acb-configuration.adoc - include::connectors::partial$configure-acb-connectors-partial.adoc[]

Copy 操作の設定

Copy 操作では、[Source Path (ソースパス)] で指定されたファイルまたはディレクトリを [Target Path (対象パス)] にコピーします。ソースパスには、ファイルまたはディレクトリを指定できます。[Source Path (ソースパス)] がディレクトリを参照している場合、ディレクトリは再帰的にコピーされます。

キャンバス UI で Copy 操作をクリックし、[General (一般)] タブで次の属性を設定します。

Unresolved include directive in modules/ROOT/pages/file-acb-configuration.adoc - include::connectors::partial$acb-config-file-connector-partial.adoc[]
[Advanced (詳細)] タブをクリックして、次の属性を設定します。

Unresolved include directive in modules/ROOT/pages/file-acb-configuration.adoc - include::connectors::partial$acb-config-file-connector-partial.adoc[]

Create Directory 操作の設定

Create Directory 操作では、指定された [Directory path (ディレクトリパス)] にディレクトリを作成します。

キャンバス UI で Create Directory 操作をクリックし、[General (一般)] タブで次の属性を設定します。

属性説明必須

Directory path (ディレクトリパス)

新しいディレクトリのパス名 (例: ~/newFolder)。

はい
[Advanced (詳細)] タブをクリックして、次の属性を設定します。

Unresolved include directive in modules/ROOT/pages/file-acb-configuration.adoc - include::connectors::partial$acb-config-file-connector-partial.adoc[]

属性	説明	必須
Directory path (ディレクトリパス)	新しいディレクトリのパス名 (例: `~/newFolder`)。	はい

Delete 操作の設定

Delete 操作では、ファイルがロックされていない場合、[Directory path (ディレクトリパス)] で指定されたファイルを削除します。この操作では、ディレクトリを削除しません。

キャンバス UI で Delete 操作をクリックし、[General (一般)] タブで次の属性を設定します。

属性説明必須

Directory path (ディレクトリパス)

削除するファイルへのパス。

はい
[Advanced (詳細)] タブをクリックして、次の属性を設定します。

Unresolved include directive in modules/ROOT/pages/file-acb-configuration.adoc - include::connectors::partial$acb-config-file-connector-partial.adoc[]

属性	説明	必須
Directory path (ディレクトリパス)	削除するファイルへのパス。	はい

List 操作の設定

List 操作を使用して、指定された [Directory path (ディレクトリパス)] にあるすべてのファイルのリストを作成します。

キャンバス UI で List 操作をクリックし、[General (一般)] タブで次の属性を設定します。

属性	説明	必須
Directory path (ディレクトリパス)	リストするファイルを含むディレクトリへのパス。	はい
Recursive (再帰)	選択した場合、サブディレクトリのコンテンツも出力にリストされます。	いいえ
File Matching Rules (ファイル一致ルール)	ファイルの受け入れまたは却下で使用する一致条件に基づいて、ファイルを絞り込みます。ファイル一致ルールの例は、「一致条件でのファイルの絞り込み」を参照してください。	いいえ

属性

説明

必須

Directory path (ディレクトリパス)

リストするファイルを含むディレクトリへのパス。

はい

Recursive (再帰)

選択した場合、サブディレクトリのコンテンツも出力にリストされます。

いいえ

File Matching Rules (ファイル一致ルール)

ファイルの受け入れまたは却下で使用する一致条件に基づいて、ファイルを絞り込みます。ファイル一致ルールの例は、「一致条件でのファイルの絞り込み」を参照してください。

いいえ

[Advanced (詳細)] タブをクリックして、次の属性を設定します。

属性	説明	必須
Time between size check (サイズ確認の時間間隔)	ファイルの読み取り準備ができているかどうかを確認するためのサイズ確認間の待機時間 (ミリ秒)。これにより、ファイルの書き込みが完了してから処理を実行することができます。Mule Runtime は 2 回のサイズ確認を実行し、コールから次のコールまでの指定された時間を待機します。この両方の確認で同じ値が返された場合、ファイルの読み取り準備はできています。	いいえ
Time between size check unit (サイズ確認の時間間隔の単位)	[Time between size check (サイズ確認の時間間隔)] の単位。	いいえ
Subset (サブセット)	返されるファイルの数の制限と並び替えを行います。	いいえ
Streaming strategy (ストリーミング戦略)	Mule アプリケーションでのデータストリームのコンシューム方法を設定します。この属性は現在設定 UI で有効になっていません。XML エディターで設定してください。XML でのストリーミング戦略の設定を参照してください。	いいえ
Target Variable (対象変数)	操作の出力が配置される変数の名前。	いいえ
Target Value (対象値)	操作の出力に対して評価される式。この式の結果は対象変数に保存されます。	いいえ
エラーのマッピング	Mule エラー種別をマップするカスタムエラー種別を作成します。マッピングは、アプリケーションのエラーをさらに識別してグループ化するのに役立つ場合があります。この属性は現在設定 UI で有効になっていません。XML エディターで設定してください。Mule Errorsを参照してください。	いいえ
Reconnection strategy (再接続戦略)	Mule アプリケーション内の操作が外部サーバーへの接続に失敗すると、デフォルト動作ではその操作は直ちに失敗し、接続エラーが返されます。デフォルト動作を変更するには、操作の再接続戦略を設定します。この属性は現在設定 UI で有効になっていません。XML エディターで設定してください。「Reconnect (再接続)」、「Reconnect Forever (繰り返し再接続)」、およびXML での再接続戦略の設定を参照してください。	いいえ

属性

説明

必須

Time between size check (サイズ確認の時間間隔)

ファイルの読み取り準備ができているかどうかを確認するためのサイズ確認間の待機時間 (ミリ秒)。これにより、ファイルの書き込みが完了してから処理を実行することができます。Mule Runtime は 2 回のサイズ確認を実行し、コールから次のコールまでの指定された時間を待機します。この両方の確認で同じ値が返された場合、ファイルの読み取り準備はできています。

いいえ

Time between size check unit (サイズ確認の時間間隔の単位)

[Time between size check (サイズ確認の時間間隔)] の単位。

いいえ

Subset (サブセット)

返されるファイルの数の制限と並び替えを行います。

いいえ

Streaming strategy (ストリーミング戦略)

Mule アプリケーションでのデータストリームのコンシューム方法を設定します。この属性は現在設定 UI で有効になっていません。XML エディターで設定してください。XML でのストリーミング戦略の設定を参照してください。

いいえ

Target Variable (対象変数)

操作の出力が配置される変数の名前。

いいえ

Target Value (対象値)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

いいえ

エラーのマッピング

Mule エラー種別をマップするカスタムエラー種別を作成します。マッピングは、アプリケーションのエラーをさらに識別してグループ化するのに役立つ場合があります。この属性は現在設定 UI で有効になっていません。XML エディターで設定してください。Mule Errorsを参照してください。

いいえ

Reconnection strategy (再接続戦略)

Mule アプリケーション内の操作が外部サーバーへの接続に失敗すると、デフォルト動作ではその操作は直ちに失敗し、接続エラーが返されます。デフォルト動作を変更するには、操作の再接続戦略を設定します。この属性は現在設定 UI で有効になっていません。XML エディターで設定してください。「Reconnect (再接続)」、「Reconnect Forever (繰り返し再接続)」、およびXML での再接続戦略の設定を参照してください。

いいえ

Move 操作の設定

Move 操作では、ファイルまたはディレクトリを [Source path (ソースパス)] から [Target Path (対象パス)] に移動します。[Source path (ソースパス)] がディレクトリを参照している場合、ディレクトリは再帰的に移動します。

キャンバス UI で Move 操作をクリックし、[General (一般)] タブで次の属性を設定します。

Unresolved include directive in modules/ROOT/pages/file-acb-configuration.adoc - include::connectors::partial$acb-config-file-connector-partial.adoc[]
[Advanced (詳細)] タブをクリックして、次の属性を設定します。

Unresolved include directive in modules/ROOT/pages/file-acb-configuration.adoc - include::connectors::partial$acb-config-file-connector-partial.adoc[]

Read 操作の設定

Read 操作では、指定されたパスにあるファイルのコンテンツとメタデータを読み取り、ファイルのコンテンツが含まれる入力ストリームをペイロードとするメッセージを返します。メタデータは、メッセージ属性 (Message#getAttributes()) として表される LocalFileAttributes オブジェクトとして表されます。

ファイルの MIME タイプはファイルの拡張子に基づきます。省略可能な [Output MIME type (出力 MIME タイプ)] および [Output encoding (出力エンコード)] パラメーターを使用して、出力エンコードと MIME タイプを強制することができます。

キャンバス UI で Read 操作をクリックし、[General (一般)] タブで次の属性を設定します。

属性説明必須

File Path (ファイルパス)

読み取るファイルへのパス。

はい

属性	説明	必須
File Path (ファイルパス)	読み取るファイルへのパス。	はい

[Advanced (詳細)] タブをクリックして、次の属性を設定します。

属性	説明	必須
Lock (ロック)	選択した場合、この操作によって返される入力ストリームが閉じられるか完全にコンシュームされるまで、ファイルシステムレベルのロックがファイルに配置されます。ロックはホストのファイルシステムにより提供されるため、その動作は、マウントされたドライブと、Mule Runtime が実行されているオペレーティングシステムに応じて変わる可能性があります。	いいえ
Time between size check (サイズ確認の時間間隔)	ファイルの読み取り準備ができているかどうかを確認するためのサイズ確認間の待機時間 (ミリ秒)。これにより、ファイルの書き込みが完了してから処理を実行することができます。Mule Runtime は 2 回のサイズ確認を実行し、コールから次のコールまでの指定された時間を待機します。この両方の確認で同じ値が返された場合、ファイルの読み取り準備はできています。	いいえ
Time between size check unit (サイズ確認の時間間隔の単位)	[Time between size check (サイズ確認の時間間隔)] の単位。	いいえ
Output MIME type (出力 MIME タイプ)	この操作で出力されるペイロードの MIME タイプ。	いいえ
パラメーター	[Output MIME type (出力 MIME タイプ)] 属性の値に追加する 1 つ以上のキー-値ペア。複数のキーと値のペアが許可されます。これらのキー-値ペアを使用すると、データを変数に保存できるため、フロー内の任意のコンポーネントでそのデータを使用できます。	いいえ
Output encoding (出力エンコード)	このコンポーネントで出力されるペイロードのエンコード。	いいえ
Streaming Strategy (ストリーミング戦略)	Mule アプリケーションでのデータストリームのコンシューム方法を設定します。この属性は現在設定 UI で有効になっていません。XML エディターで設定してください。XML でのストリーミング戦略の設定を参照してください。	いいえ
Target Variable (対象変数)	操作の出力が配置される変数の名前。	いいえ
Target Value (対象値)	操作の出力に対して評価される式。この式の結果は対象変数に保存されます。	いいえ
エラーのマッピング	Mule エラー種別をマップするカスタムエラー種別を作成します。マッピングは、アプリケーションのエラーをさらに識別してグループ化するのに役立つ場合があります。この属性は現在設定 UI で有効になっていません。XML エディターで設定してください。Mule Errorsを参照してください。	いいえ
Reconnection strategy (再接続戦略)	Mule アプリケーション内の操作が外部サーバーへの接続に失敗すると、デフォルト動作ではその操作は直ちに失敗し、接続エラーが返されます。デフォルト動作を変更するには、操作の再接続戦略を設定します。この属性は現在設定 UI で有効になっていません。XML エディターで設定してください。「Reconnect (再接続)」、「Reconnect Forever (繰り返し再接続)」、およびXML での再接続戦略の設定を参照してください。	いいえ

属性

説明

必須

Lock (ロック)

選択した場合、この操作によって返される入力ストリームが閉じられるか完全にコンシュームされるまで、ファイルシステムレベルのロックがファイルに配置されます。ロックはホストのファイルシステムにより提供されるため、その動作は、マウントされたドライブと、Mule Runtime が実行されているオペレーティングシステムに応じて変わる可能性があります。

いいえ

Time between size check (サイズ確認の時間間隔)

ファイルの読み取り準備ができているかどうかを確認するためのサイズ確認間の待機時間 (ミリ秒)。これにより、ファイルの書き込みが完了してから処理を実行することができます。Mule Runtime は 2 回のサイズ確認を実行し、コールから次のコールまでの指定された時間を待機します。この両方の確認で同じ値が返された場合、ファイルの読み取り準備はできています。

いいえ

Time between size check unit (サイズ確認の時間間隔の単位)

[Time between size check (サイズ確認の時間間隔)] の単位。

いいえ

Output MIME type (出力 MIME タイプ)

この操作で出力されるペイロードの MIME タイプ。

いいえ

パラメーター

[Output MIME type (出力 MIME タイプ)] 属性の値に追加する 1 つ以上のキー-値ペア。複数のキーと値のペアが許可されます。これらのキー-値ペアを使用すると、データを変数に保存できるため、フロー内の任意のコンポーネントでそのデータを使用できます。

いいえ

Output encoding (出力エンコード)

このコンポーネントで出力されるペイロードのエンコード。

いいえ

Streaming Strategy (ストリーミング戦略)

Mule アプリケーションでのデータストリームのコンシューム方法を設定します。この属性は現在設定 UI で有効になっていません。XML エディターで設定してください。XML でのストリーミング戦略の設定を参照してください。

いいえ

Target Variable (対象変数)

操作の出力が配置される変数の名前。

いいえ

Target Value (対象値)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

いいえ

エラーのマッピング

Mule エラー種別をマップするカスタムエラー種別を作成します。マッピングは、アプリケーションのエラーをさらに識別してグループ化するのに役立つ場合があります。この属性は現在設定 UI で有効になっていません。XML エディターで設定してください。Mule Errorsを参照してください。

いいえ

Reconnection strategy (再接続戦略)

Mule アプリケーション内の操作が外部サーバーへの接続に失敗すると、デフォルト動作ではその操作は直ちに失敗し、接続エラーが返されます。デフォルト動作を変更するには、操作の再接続戦略を設定します。この属性は現在設定 UI で有効になっていません。XML エディターで設定してください。「Reconnect (再接続)」、「Reconnect Forever (繰り返し再接続)」、およびXML での再接続戦略の設定を参照してください。

いいえ

Rename 操作の設定

Rename 操作では、[Path (パス)] 項目で指定されたファイルの名前が to パラメーターで指定された名前に変更されます。to パラメーターにパスセパレーターが含まれている場合、FILE:ILLEGAL_PATH がスローされます。

キャンバス UI で Rename 操作をクリックし、[General (一般)] タブで次の属性を設定します。

属性	説明	必須
Path (パス)	名前変更するファイルへのパス。	はい
New Name (新しい名前)	ファイルの新しい名前。	はい
Overwrite (上書き)	選択した場合、[New Name (新しい名前)] で指定した名前のファイルがすでに存在するときに対象ファイルを上書きします。	いいえ

属性

説明

必須

Path (パス)

名前変更するファイルへのパス。

はい

New Name (新しい名前)

ファイルの新しい名前。

はい

Overwrite (上書き)

選択した場合、[New Name (新しい名前)] で指定した名前のファイルがすでに存在するときに対象ファイルを上書きします。

いいえ

[Advanced (詳細)] タブをクリックして、次の属性を設定します。

Unresolved include directive in modules/ROOT/pages/file-acb-configuration.adoc - include::connectors::partial$acb-config-file-connector-partial.adoc[]

Write 操作の設定

Write 操作では、[Path (パス)] で指定されたファイルにコンテンツを書き込みます。

キャンバス UI で Write 操作をクリックし、[General (一般)] タブで次の属性を設定します。

属性説明必須

属性	説明	必須
Path (パス)	コンテンツの書き込み先であるファイルを含むディレクトリへのパス。	はい
Content (コンテンツ)	ファイルに書き込むコンテンツ。デフォルトは [Content (コンテンツ)] ペイロードです。	いいえ
Create parent directories (親ディレクトリの作成)	選択すると、対象パスまたはその親が存在しない場合に親フォルダーが作成されます。選択解除すると、操作を実行しようとしたときに `FILE:ILLEGAL_PATH` エラーがスローされます。	いいえ

Path (パス)

コンテンツの書き込み先であるファイルを含むディレクトリへのパス。

はい

Content (コンテンツ)

ファイルに書き込むコンテンツ。デフォルトは [Content (コンテンツ)] ペイロードです。

いいえ

Create parent directories (親ディレクトリの作成)

選択すると、対象パスまたはその親が存在しない場合に親フォルダーが作成されます。選択解除すると、操作を実行しようとしたときに FILE:ILLEGAL_PATH エラーがスローされます。

いいえ

[Advanced (詳細)] タブをクリックして、次の属性を設定します。

Unresolved include directive in modules/ROOT/pages/file-acb-configuration.adoc - include::connectors::partial$acb-config-file-connector-partial.adoc[]
Lock を選択すると、この操作によって返される入力ストリームが閉じられるか完全にコンシュームされるまで、ファイルシステムレベルのロックがファイルに配置されます。

XML でのスケジュール戦略の設定

Unresolved include directive in modules/ROOT/pages/file-acb-configuration.adoc - include::connectors::partial$acb-xml-examples.adoc[]

XML での再接続戦略の設定

Unresolved include directive in modules/ROOT/pages/file-acb-configuration.adoc - include::connectors::partial$acb-xml-examples.adoc[]

XML でのストリーミング戦略の設定

ストリーミング戦略を使用して、Mule によるデータストリームの処理方法を設定できます。

Unresolved include directive in modules/ROOT/pages/file-acb-configuration.adoc - include::connectors::partial$acb-xml-examples.adoc[]