FTP - download a file
Search form
Description - Transfers a local file or directly to a FTP site.
Runtime Class - com.ibi.agents.XDNFTPDirectFileTransfer
Configuration
This action requires a Generics Configuration as well as the following required parameters.
Parameter Groups
Parameter Type Description Directory: string FTP site directory to be used if File Name is not an absolute path.
* File Name: string File to be downloaded from FTP site.
* - denotes required
Parameter Type Description * Directory: string Local directory to download the remote file to.
* - denotes required
Parameter Type Description * Transfer Mode: string Ascii mode transfers files as 'text', binary mode transfers files as raw data.
Select from one of the following options:
- ascii - Transfer in character mode
- binary - Transfer in binary mode
* - denotes required
Parameter Type Description Delete Source: boolean Delete source after uploading to FTP server
* Output Document: string Document returned by object
Select from one of the following options:
- Status Document {status} - Returns a status document
- Input Document {original} - Returns the input document of the object.
* Return on Failure: string Document returned by object on execution 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.XDNFTPDirectFileTransfer
Configuration
This action requires a Generics Configuration as well as the following required parameters.
Parameter Groups
Parameter Type Description Directory: string FTP site directory to be used if File Name is not an absolute path.
* File Name: string File to be downloaded from FTP site.
* - denotes required
Parameter Type Description * Directory: string Local directory to download the remote file to.
* - denotes required
Parameter Type Description * Transfer Mode: string Ascii mode transfers files as 'text', binary mode transfers files as raw data.
Select from one of the following options:
- ascii - Transfer in character mode
- binary - Transfer in binary mode
* - denotes required
Parameter Type Description Delete Source: boolean Delete source after uploading to FTP server
* Output Document: string Document returned by object
Select from one of the following options:
- Status Document {status} - Returns a status document
- Input Document {original} - Returns the input document of the object.
* Return on Failure: string Document returned by object on execution 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
Configuration
This action requires a Generics Configuration as well as the following required parameters.Parameter Groups
| Parameter | Type | Description | |
|---|---|---|---|
| Directory: | string | FTP site directory to be used if File Name is not an absolute path. | * | File Name: | string | File to be downloaded from FTP site. |
* - denotes required
| Parameter | Type | Description | |
|---|---|---|---|
| * | Directory: | string | Local directory to download the remote file to. |
* - denotes required
| Parameter | Type | Description | * | Transfer Mode: | string | Ascii mode transfers files as 'text', binary mode transfers files as raw data.
Select from one of the following options:
|
|---|
* - denotes required
| Parameter | Type | Description | |
|---|---|---|---|
| Delete Source: | boolean | Delete source after uploading to FTP server | * | Output Document: | string | Document returned by object
Select from one of the following options:
|
* | Return on Failure: | string | Document returned by object on execution failure.
Select from one of the following options:
|
* - denotes required
Output Events
| Name | Description |
|---|---|
| OnParseError | Could not parse a document. |
| OnFailConnection | Could not connect to the external system. |
| OnFailSecurity | Could not operate due to a security violation. |
| OnFailedOperation | Could not perform the operation requested. |