File - read a file from disk
Search form
Description - Embeds a specified binary, xml or text file in the input document
Runtime Class - com.ibi.agents.XDPFFileReadAgent
Parameter Groups
Parameter Type Description * File Name: string Source file to be read.
* Format: string Format of the source file
Select from one of the following options:
- Flat {flat}
- XML {xml}
- JSON {json}
- Stream {stream}
* - 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:
- cp037
- ISO-8859-1
- ISO-8859-8
- SJIS
- UNICODE
- UTF-8
- UTF8
* Base64 Encode: boolean Base64 encode the read in document when embedding
* - denotes required
Parameter Type Description * 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 The tag in the input document where the data should be embedded.
* - 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 * Delete File Source: boolean Whether to delete the file read on a successful read.
* - denotes required
Output Events
Runtime Class - com.ibi.agents.XDPFFileReadAgent
Parameter Groups
Parameter Type Description * File Name: string Source file to be read.
* Format: string Format of the source file
Select from one of the following options:
- Flat {flat}
- XML {xml}
- JSON {json}
- Stream {stream}
* - 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:
- cp037
- ISO-8859-1
- ISO-8859-8
- SJIS
- UNICODE
- UTF-8
- UTF8
* Base64 Encode: boolean Base64 encode the read in document when embedding
* - denotes required
Parameter Type Description * 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 The tag in the input document where the data should be embedded.
* - 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 * Delete File Source: boolean Whether to delete the file read on a successful read.
* - denotes required
Output Events
Parameter Groups
| Parameter | Type | Description | |
|---|---|---|---|
| * | File Name: | string | Source file to be read. | * | Format: | string | Format of the source file
Select from one of the following options:
|
* - 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:
|
* | Base64 Encode: | boolean | Base64 encode the read in document when embedding |
* - denotes required
| Parameter | Type | Description | |
|---|---|---|---|
| * | 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 | The tag in the input document where the data should be embedded. |
* - 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 | |
|---|---|---|---|
| * | Delete File Source: | boolean | Whether to delete the file read on a successful read. |
* - denotes required
Output Events
| Name | Description |
|---|---|
| OnNotFound | The resource was not found. This may or may not be a failure. |
| OnParseError | Could not parse a document. |
| OnFailedOperation | Could not perform the operation requested. |