The FileRead plug-in icon
The
File Read plug-in reads records from an input sequential file (QSAM dataset in
z/OS) and propagates each record as a BLOB message to the "out" terminal.
The input file process is triggered when an "open input file" action
message arrives on the "action" terminal.
The File Read plug-in validates
the action message, opens the required input file (an "opened input file"
status message is propagated to the "status" terminal), reads records from
the file and for each record it propagates a data message to the "out"
terminal. When the end of file is detected, the file is closed and the
process is terminated (a "closed input file" status message is propagated to
the "status" terminal).
If an error condition is detected, an exception message is propagated to
the "failure" terminal (if the "failure" terminal is not wired then an user
exception is thrown to terminate the processing). After an exception is
detected the input file is closed (An exception message is propagated
instead of a "closed input file" status message).
Copies of action and status messages are maintained in the
Environment tree of the message flow.
action |
Input terminal receives the action control messages to open and to close the file. |
failure |
Output terminal to which an exception message is propagated in case that the node detects an error exception. |
out |
Output terminal that data messages are propagated with the contents of the records read from the input file. |
status |
Output terminal that status messages are propagated when the file is opened or closed. |
When this node receives the open file action message on the "action" terminal, the file is opened and records are read until the end of file is detected then the file is closed.
Note:
[M] is a mandatory element and [O] is an optional element.
An exception message is propagated to the "failure" terminal when an error exception is detected by the File Read plug-in node. The following is the format of the exception messages:
All the following properties are on the Default tab
Property |
Default |
Description |
Generate debug data |
None |
This property can have the values of "None", "Performance" or "Full". The "Performance" option generates data to monitor the duration of key activities during the File Read process. The "Full" option generates debugging and trace information. |
Trace Filename |
Path and name of the trace file. If no trace file is specified then the debugging information is sent to the broker's stdout. |
|
Input data encoding | 785 | This value represents the encoding of the numeric fields in the input file. This is a numeric value that describes the encoding of integers, decimal and floating point fields. Refer to the WebSphere MQ documentation for more information. |
Input data CCSID | 500 | This is the coded character set identifier (CCSID) for the text data in the input file. |
Add MQMD to data message | Unchecked | This property indicates if the data messages with the records from the input file require an MQMD header or not. When a message flow is reading messages from an input file and writing them onto an output file, it is STRONGLY recommended to "uncheck" this property to make the process more efficient in the use of memory. |