file util
Icon |
|
|---|---|
Use When |
Files need to be renamed, copied, moved or deleted |
Samples |
|
Description |
The File Util component provides a sets of file utilities that can be used to manipulate files at the operating system level including copying, renaming, moving or deleting. |
Inbound Message Type |
Any Message Type |
Output Message Type |
Text Based Message |
Control Message Handling |
Input: When a control message is received and 'Run When' is 'PER UNIT OF WORK' start the processing of this component or when any message other than a control is received and 'Run When' is not 'PER UNIT OF WORK'. Output: A single control message will be forwarded to downstream components once the file utility action chosen has completed and the result text message forwarded. |
| Name | Description |
|---|---|
Resource |
The source file based resource (either local or remote) on which the source file(s) to be manipulated reside |
Whether to forward failed messages and continue processing. This is the name of a linked component to forward the failed messages to. |
|
Action |
Either Copy, Rename, Move, Delete or Touch. Copy will copy the file, move will move the file, delete will delete the file, and touch will update the files last updated date/time. |
Source Relative Path |
The path and file name of the source file(s) to be manipulated. Wildcard character (*) can be used. |
Target Relative Path |
The target path used to write files if the Action is Copy, Move, or Rename. This path will be appended to the path of specified Resource be specified as a path only, and the target file names will be derived from the source file names. |
Target File Name |
The name to use for the target file. If not set, the original name will be used. |
Get File Name From Message |
Whether to get input file name from the payload of inbound messages or from the Source Path parameter. If selected, source file names come from the payload of inbound messages |
Overwrite |
Whether the operation should permit the overwrite of a file |
Append To Name |
A text string that will be appended to the end of each target file name (before the extension). |