binary file reader
Icon |
|
|---|---|
Use When |
Data needs read from a binary file |
Samples |
|
Description |
The Binary File Reader is used to read data from one or more binary based files. The Binary File Reader can read one or more files and pass the data read to downstream components. The file name(s) and path(s) of the file(s) to be read can be specified in the File Path parameter below, or can be specified in the payload of the inbound message. |
Inbound Message Type |
Text Based Message |
Output Message Type |
Binary Based Message |
Control Message Handling |
Input: When a control message is received and 'Run When' is 'PER UNIT OF WORK' start the processing of this component or when any message other than a control is received and 'Run When' is 'PER MESSAGE'. Output: A single control message will be forwarded to downstream components once all files have been processed through this step unless the 'Send Control Message on EOF' property is checked (see below). |
| Name | Description |
|---|---|
Resource |
The file based resource (either local or remote) on which the file to be read resides. |
Whether to forward failed messages and continue processing. This is the name of a linked component to forward the failed messages to. |
|
Get File Name From Message |
If selected, the path and file name to be read will be determined by the payload of the incoming message. This option is used frequently with the File Poller component. If this setting is not selected, the path and file to be read is based on the File Path property below. |
Must Exist |
Whether the file must exist |
File Path |
The relative path and file of the file to be read. The relative path and file are concatenated with the absolute path specified in the File based resource. |
Size / Message (MB) |
TODO: implement if the file is bigger than the allowable message size |
Send Control Message on EOF |
Whether to send a control message at EOF to downstream components for each file read |