FTP - write a file
Search form
Description - Writes a file to a FTP site.
Runtime Class - com.ibi.agents.XDNFTPEmitAgent
Configuration
This action requires a Generics Configuration as well as the following required parameters.
Parameter Groups
Parameter Type Description Type: string Input from the document (default) or from an external source (MFT use)
Select from one of the following options:
- Input Document {document} - Data sent is the input document
- External File {external} - Data sent is from external media
- Stream {stream} - Data sent is carried in the flow via a stream document
File Expression string If input source is 'External File' specify the file name here.
* File Pattern string Output file pattern (* = timestamp) ie. *.XML,*.txt etc. Note: *.* is unsupported
* - denotes required
Parameter Type Description * Transfer Mode: string When files are transferred in ASCII mode, the transferred data is expected to contain only character formatted text. BINARY mode refers to transferring files as a binary stream of data. Where ASCII mode may use special control characters to format data, BINARY mode transmits the raw bytes of the file being transferred. In this way, the file is transferred in its exact original form.
Select from one of the following options:
- ascii - Transfer in character mode
- binary - Transfer in binary mode
Behavior When Target File Exists: string If file exists on FTP server, what should we do? "append" means that input will be added to the end of the existing file.For "restart", if server supports REST and SIZE commands, we determine size of the file on the server, then send REST command with current file size. The input data is then sent starting at this position.
Select from one of the following options:
- Overwrite {overwrite}
- Append {append}
- Resume {resume}
- Fail {fail}
Allow Zero Byte Transfers: boolean Allows the FTP sender to transmit zero byte sources to server.
Retry Interval: string Retry interval in seconds (allows for xxhxxmxxs format) Omit or use 0 for no retry
* - denotes required
Parameter Type Description On Start: string The SITE command to issue before the transfer of data
On Success: string The SITE command to issue after the successful transfer of data
On Error: string The SITE command to issue if the transfer of data fails
* - denotes required
Parameter Type Description Document Output: string 'status': status document will be the out document. 'input': in document will become the out document.
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.XDNFTPEmitAgent
Configuration
This action requires a Generics Configuration as well as the following required parameters.
Parameter Groups
Parameter Type Description Type: string Input from the document (default) or from an external source (MFT use)
Select from one of the following options:
- Input Document {document} - Data sent is the input document
- External File {external} - Data sent is from external media
- Stream {stream} - Data sent is carried in the flow via a stream document
File Expression string If input source is 'External File' specify the file name here.
* File Pattern string Output file pattern (* = timestamp) ie. *.XML,*.txt etc. Note: *.* is unsupported
* - denotes required
Parameter Type Description * Transfer Mode: string When files are transferred in ASCII mode, the transferred data is expected to contain only character formatted text. BINARY mode refers to transferring files as a binary stream of data. Where ASCII mode may use special control characters to format data, BINARY mode transmits the raw bytes of the file being transferred. In this way, the file is transferred in its exact original form.
Select from one of the following options:
- ascii - Transfer in character mode
- binary - Transfer in binary mode
Behavior When Target File Exists: string If file exists on FTP server, what should we do? "append" means that input will be added to the end of the existing file.For "restart", if server supports REST and SIZE commands, we determine size of the file on the server, then send REST command with current file size. The input data is then sent starting at this position.
Select from one of the following options:
- Overwrite {overwrite}
- Append {append}
- Resume {resume}
- Fail {fail}
Allow Zero Byte Transfers: boolean Allows the FTP sender to transmit zero byte sources to server.
Retry Interval: string Retry interval in seconds (allows for xxhxxmxxs format) Omit or use 0 for no retry
* - denotes required
Parameter Type Description On Start: string The SITE command to issue before the transfer of data
On Success: string The SITE command to issue after the successful transfer of data
On Error: string The SITE command to issue if the transfer of data fails
* - denotes required
Parameter Type Description Document Output: string 'status': status document will be the out document. 'input': in document will become the out document.
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 | |
|---|---|---|---|
| Type: | string | Input from the document (default) or from an external source (MFT use)
Select from one of the following options:
|
File Expression | string | If input source is 'External File' specify the file name here. | * | File Pattern | string | Output file pattern (* = timestamp) ie. *.XML,*.txt etc. Note: *.* is unsupported |
* - denotes required
| Parameter | Type | Description | |
|---|---|---|---|
| * | Transfer Mode: | string | When files are transferred in ASCII mode, the transferred data is expected to contain only character formatted text. BINARY mode refers to transferring files as a binary stream of data. Where ASCII mode may use special control characters to format data, BINARY mode transmits the raw bytes of the file being transferred. In this way, the file is transferred in its exact original form.
Select from one of the following options:
|
Behavior When Target File Exists: | string | If file exists on FTP server, what should we do? "append" means that input will be added to the end of the existing file.For "restart", if server supports REST and SIZE commands, we determine size of the file on the server, then send REST command with current file size. The input data is then sent starting at this position.
Select from one of the following options:
|
Allow Zero Byte Transfers: | boolean | Allows the FTP sender to transmit zero byte sources to server. | Retry Interval: | string | Retry interval in seconds (allows for xxhxxmxxs format) Omit or use 0 for no retry |
* - denotes required
| Parameter | Type | Description | |
|---|---|---|---|
| On Start: | string | The SITE command to issue before the transfer of data | On Success: | string | The SITE command to issue after the successful transfer of data | On Error: | string | The SITE command to issue if the transfer of data fails |
* - denotes required
| Parameter | Type | Description | |
|---|---|---|---|
| Document Output: | string | 'status': status document will be the out document. 'input': in document will become the out document.
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. |
| fail_duplicate | Operation failed due to duplicate resource and and this is considered an error. |