File - rename a file
Search form
Description - Renames a file specified in the file source
Runtime Class - com.ibi.agents.XDPFFileOpsAgent
Parameter Groups
Parameter Type Description * Name: string Originating file to be operated on. Relative or absolute file paths are supported explicitly or through a SREG or XPath expression evaluated using the incoming document
* Search Type: string Interpret the file name using the following search pattern.
Select from one of the following options:
- None {none} - No file selection pattern
- DOS Expression {dos} - File selection pattern is DOS like (contains only '*' and '?' wild cards)
- Regular Expression {regex} - File selection pattern is full Java Regular Expression
* - denotes required
Parameter Type Description Name: string Destination file to be operated on. Wild cards accepted. Required except for delete, size, exists
* - denotes required
Parameter Type Description Is Directory: boolean Specifies whether file target is a directory. Assumes file if not specified.
Create Directory boolean Create directory if it doesn't exist.
* - denotes required
Parameter Type Description Retry integer If non-zero, will retry the operation n times at one-second intervals
* - denotes required
Parameter Type Description * Out Document string Document returned by operation (bad input defaults to result)
Select from one of the following options:
- Result {result} - Return results of the operation; will be status document if operation is not prepend or append.
- Status {status} - Return status document
- Original {original} - Return the document passed in
* Action on Failure string Whether input document or status document returned on failure
Select from one of the following options:
- Input {input} - Return status document on error
- Status {status} - Return status document on error
* - denotes required
Output Events
Runtime Class - com.ibi.agents.XDPFFileOpsAgent
Parameter Groups
Parameter Type Description * Name: string Originating file to be operated on. Relative or absolute file paths are supported explicitly or through a SREG or XPath expression evaluated using the incoming document
* Search Type: string Interpret the file name using the following search pattern.
Select from one of the following options:
- None {none} - No file selection pattern
- DOS Expression {dos} - File selection pattern is DOS like (contains only '*' and '?' wild cards)
- Regular Expression {regex} - File selection pattern is full Java Regular Expression
* - denotes required
Parameter Type Description Name: string Destination file to be operated on. Wild cards accepted. Required except for delete, size, exists
* - denotes required
Parameter Type Description Is Directory: boolean Specifies whether file target is a directory. Assumes file if not specified.
Create Directory boolean Create directory if it doesn't exist.
* - denotes required
Parameter Type Description Retry integer If non-zero, will retry the operation n times at one-second intervals
* - denotes required
Parameter Type Description * Out Document string Document returned by operation (bad input defaults to result)
Select from one of the following options:
- Result {result} - Return results of the operation; will be status document if operation is not prepend or append.
- Status {status} - Return status document
- Original {original} - Return the document passed in
* Action on Failure string Whether input document or status document returned on failure
Select from one of the following options:
- Input {input} - Return status document on error
- Status {status} - Return status document on error
* - denotes required
Output Events
Parameter Groups
| Parameter | Type | Description | |
|---|---|---|---|
| * | Name: | string | Originating file to be operated on. Relative or absolute file paths are supported explicitly or through a SREG or XPath expression evaluated using the incoming document | * | Search Type: | string | Interpret the file name using the following search pattern.
Select from one of the following options:
|
* - denotes required
| Parameter | Type | Description | |
|---|---|---|---|
| Name: | string | Destination file to be operated on. Wild cards accepted. Required except for delete, size, exists |
* - denotes required
| Parameter | Type | Description | |
|---|---|---|---|
| Is Directory: | boolean | Specifies whether file target is a directory. Assumes file if not specified. | Create Directory | boolean | Create directory if it doesn't exist. |
* - denotes required
| Parameter | Type | Description | |
|---|---|---|---|
| Retry | integer | If non-zero, will retry the operation n times at one-second intervals |
* - denotes required
| Parameter | Type | Description | |
|---|---|---|---|
| * | Out Document | string | Document returned by operation (bad input defaults to result)
Select from one of the following options:
|
* | Action on Failure | string | Whether input document or status document returned on failure
Select from one of the following options:
|
* - denotes required
Output Events
| Name | Description |
|---|---|
| OnFailedOperation | Could not perform the operation requested. |
| OnNotFound | The resource was not found. This may or may not be a failure. |
| OnParseError | Could not parse a document. |