FTP - read a file
Search form
Description - Embeds a specified binary, XML, JSON or text file in the input document
Runtime Class - com.ibi.agents.XDNPFFTPReadAgent
Configuration
This action requires a Generics Configuration as well as the following required parameters.
Parameter Groups
Parameter Type Description * File Name: string File to be read.
* Format: string Format of the input data
Select from one of the following options:
- Flat {flat} - File must not be parsed.
- XML {xml} - The file is an XML document.
- JSON {json} - The file is a JSON document.
* - 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
* Delete After Read: boolean Whether to delete the file after the read
* - denotes required
Parameter Type Description Encoding: string Character set encoding to be performed on input. Base 64 is required for flat binary data
Select from one of the following options:
- Asis - Encoding as set by listener.
- base64 - Base 64; creates a Base 64 encoded string that can be used in an XML document.
* Embed: boolean Whether to embed the data from the read operation into the input document
Tag: string Name of the node to wrap the data read in flat format.
Parent Tag: string Where in the input document the input data should be embedded
* - denotes required
Parameter Type Description * FTP Namespace: string This prefix is given to any register this connector creates. ie ftp.read, sftp.read, etc.
* - denotes required
Parameter Type Description Action 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.XDNPFFTPReadAgent
Configuration
This action requires a Generics Configuration as well as the following required parameters.
Parameter Groups
Parameter Type Description * File Name: string File to be read.
* Format: string Format of the input data
Select from one of the following options:
- Flat {flat} - File must not be parsed.
- XML {xml} - The file is an XML document.
- JSON {json} - The file is a JSON document.
* - 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
* Delete After Read: boolean Whether to delete the file after the read
* - denotes required
Parameter Type Description Encoding: string Character set encoding to be performed on input. Base 64 is required for flat binary data
Select from one of the following options:
- Asis - Encoding as set by listener.
- base64 - Base 64; creates a Base 64 encoded string that can be used in an XML document.
* Embed: boolean Whether to embed the data from the read operation into the input document
Tag: string Name of the node to wrap the data read in flat format.
Parent Tag: string Where in the input document the input data should be embedded
* - denotes required
Parameter Type Description * FTP Namespace: string This prefix is given to any register this connector creates. ie ftp.read, sftp.read, etc.
* - denotes required
Parameter Type Description Action 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 | |
|---|---|---|---|
| * | File Name: | string | File to be read. | * | Format: | string | Format of the input data
Select from one of the following options:
|
* - 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:
|
* | Delete After Read: | boolean | Whether to delete the file after the read |
* - denotes required
| Parameter | Type | Description | |
|---|---|---|---|
| Encoding: | string | Character set encoding to be performed on input. Base 64 is required for flat binary data
Select from one of the following options:
|
* | Embed: | boolean | Whether to embed the data from the read operation into the input document | Tag: | string | Name of the node to wrap the data read in flat format. | Parent Tag: | string | Where in the input document the input data should be embedded |
* - denotes required
| Parameter | Type | Description | |
|---|---|---|---|
| * | FTP Namespace: | string | This prefix is given to any register this connector creates. ie ftp.read, sftp.read, etc. |
* - denotes required
| Parameter | Type | Description | |
|---|---|---|---|
| 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. |
| OnFailConnection | Could not connect to the external system. |
| OnFailSecurity | Could not operate due to a security violation. |