FTP - rename a file
Search form
Description - Rename a file on a remote FTP site
Runtime Class - com.ibi.agents.XDNPFFTPOpsAgent
Configuration
This action requires a Generics Configuration as well as the following required parameters.
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
* - denotes required
Parameter Type Description * Directory: boolean File (to) references a directory, if it is unclear whether path names a directory or a filename, the Service Manager will assume the path names a file.
Name: string Destination file to be operated on. Wild cards accepted. Required except for delete, size, exists
* - denotes required
Parameter Type Description Create Directory: boolean Create directory if it doesn't exist.
* - 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 - The resulting document from the file operations
- status - A status document describing the result of the operation
- original - The original input document arriving at this agent/service
Return on Failure: string Whether input document or status document returned on failure
Select from one of the following options:
- iWay Status Document {status} - Replace input with standard iWay status document
- Original Input Document {input} - Output of node is original document
* - denotes required
Output Events
Runtime Class - com.ibi.agents.XDNPFFTPOpsAgent
Configuration
This action requires a Generics Configuration as well as the following required parameters.
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
* - denotes required
Parameter Type Description * Directory: boolean File (to) references a directory, if it is unclear whether path names a directory or a filename, the Service Manager will assume the path names a file.
Name: string Destination file to be operated on. Wild cards accepted. Required except for delete, size, exists
* - denotes required
Parameter Type Description Create Directory: boolean Create directory if it doesn't exist.
* - 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 - The resulting document from the file operations
- status - A status document describing the result of the operation
- original - The original input document arriving at this agent/service
Return on Failure: string Whether input document or status document returned on failure
Select from one of the following options:
- iWay Status Document {status} - Replace input with standard iWay status document
- Original Input Document {input} - Output of node is original document
* - denotes required
Output Events
Configuration
This action requires a Generics Configuration as well as the following required parameters.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 |
* - denotes required
| Parameter | Type | Description | |
|---|---|---|---|
| * | Directory: | boolean | File (to) references a directory, if it is unclear whether path names a directory or a filename, the Service Manager will assume the path names a file. | Name: | string | Destination file to be operated on. Wild cards accepted. Required except for delete, size, exists |
* - denotes required
| Parameter | Type | Description | |
|---|---|---|---|
| Create Directory: | boolean | Create directory if it doesn't exist. |
* - 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. |
| OnFailConnection | Could not connect to the external system. |
| OnFailSecurity | Could not operate due to a security violation. |
| OnNotFound | The resource was not found and this is considered an error. |