binary file writer
Icon |
|
|---|---|
Use When |
Data needs written to a binary based file |
Samples |
|
Description |
The Binary File Writer is used to write data to a binary based file. The Binary File Writer can write to one output file either locally or to a remote destination. |
Inbound Message Type |
Binary Based Message |
Output Message Type |
Text Based Message |
Control Message Handling |
Input: Binary messages are processed as they are received, then once a control message or unit of work boundary is received a current write status text message is forwarded. Output: A single control message will be forwarded to downstream components once all messages have been processed through this step. |
| Name | Description |
|---|---|
Resource |
The file based resource (either local or remote) on which the file will be written. |
Whether to forward failed messages and continue processing. This is the name of a linked component to forward the failed messages to. |
|
Path and File |
The relative path and file of the file to be written. The relative path and file are concatenated with the absolute path specified in the File based resource |
Must Exist |
Requires the file to exist prior to writing |
Append |
Add input data to the end of an existing file |
Get File Name From Message |
If selected, the path and file name to be written will be determined by the payload of the incoming message. If this setting is not selected, the path and file to be read is based on the File Path property. |
Param Name For Msg Based File Name |
If 'Get File Name From Message' property is checked, this is the name of parameter to pull the filename from. |