File - move a file
Search form
Description - Move a file from source to target
Runtime Class - com.ibi.agents.XDPFFileOpsAgent
Parameter Groups
Parameter Type Description * File Name: string Source file to move.
* 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 * File Name: string Destination of the moved file.
* - denotes required
Parameter Type Description Is Directory: boolean Specifies whether file target is a directory. Assumes file if not specified.
Create Directory: boolean Creates 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 Document {result} - Returns the results of the operation.
- Status Document {status} - Returns a status document
- Original Document {original} - Return the document passed in
* Return on Failure: string Whether input document or status document returned on failure
Select from one of the following options:
- Input Document {input} - Return status document on error
- Status Document {status} - Return status document on error
* - denotes required
Output Events
Runtime Class - com.ibi.agents.XDPFFileOpsAgent
Parameter Groups
Parameter Type Description * File Name: string Source file to move.
* 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 * File Name: string Destination of the moved file.
* - denotes required
Parameter Type Description Is Directory: boolean Specifies whether file target is a directory. Assumes file if not specified.
Create Directory: boolean Creates 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 Document {result} - Returns the results of the operation.
- Status Document {status} - Returns a status document
- Original Document {original} - Return the document passed in
* Return on Failure: string Whether input document or status document returned on failure
Select from one of the following options:
- Input Document {input} - Return status document on error
- Status Document {status} - Return status document on error
* - denotes required
Output Events
Parameter Groups
| Parameter | Type | Description | |
|---|---|---|---|
| * | File Name: | string | Source file to move. | * | Search Type: | string | Interpret the file name using the following search pattern.
Select from one of the following options:
|
* - denotes required
| Parameter | Type | Description | |
|---|---|---|---|
| * | File Name: | string | Destination of the moved file. |
* - denotes required
| Parameter | Type | Description | |
|---|---|---|---|
| Is Directory: | boolean | Specifies whether file target is a directory. Assumes file if not specified. | Create Directory: | boolean | Creates 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:
|
* | Return 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. |