From File |
 | ||
|
This documentation page describes a feature of version 3.3 of Iguana. For information on how to configure the From File source component in version 4.0 or later of Iguana, see From File. | ||
 |
In order to configure the From File source component described in the Channel Source Components section of the manual, the properties described in the table below must be defined.
Note that this component performs some basic checks to ensure that the format of the message(s) in the file are correct (e.g. it checks that each segment ends with a 0x0D character). If the component detects any invalid characters such as \x0A embedded in the message, Iguana will throw an invalid HL7 message error. For more information about removing 0x0A characters from your messages, see Screening 0x0A (Linefeed) Characters.
 | ||
| Iguana reads messages from the From File component in the order that they were written to in the directory (i.e. Iguana will always process the oldest messages first). | ||
 |
| Property | Description |
|---|---|
| Full directory path to read files from* | The path of the directory to read the input files from. The directory must exist. |
| Poll time (milliseconds)* | When no files are present in the read directory, this is the number of milliseconds Iguana waits before checking for new files. |
| File extension of files to read* | The file extension(s) of the input files (e.g. txt, hl7). Separate multiple extensions by a comma. To read in all files, enter '*'. To read in files with no extension, enter '<none>'. |
| Treat file as arbitrary input | Sets whether Iguana will accept messages not in HL7 format. If selected, Iguana assumes one message per input file and the file will be accepted as binary data. With MySQL, there is a file size limit of approximately 64KB when the destination component is a message filter; this restriction can be raised to 1MB if the text fields in the database tables are changed to 'longtext' types. Also note that the maximum message size for each arbitrary file being read must be 15MB or smaller by default. Any arbitrary file greater than this file size will result in an error, and Iguana will start processing the next file. |
| Batch segments list (e.g. FHS,BHS,FTS,BTS) | A list of the batch segments expected in the input messages. These segments are ignored. Separate multiple segments by commas. |
| Segment delimiter | This character will be used to delimit the segments of the messages when sent to the destination component. |
| Message delimiter | This character will be used to delimit the messages when sent to the destination component. |
| Hex representation of a special EOF character (e.g. 0x00, 0x1A): | The character that represents the end of the file when reading the input file(s). This character must be the last character in the input file. During parsing this character is ignored, preventing errors from occurring. |
| Full directory path to move error files into* | The path of the directory to move a file to if it is too large or contains invalid batch HL7 syntax as determined by the From File HL7 batch reading logic. If the directory does not exist, it will be created. |
| Full directory path to move processed files into* | The path of the directory to move files to if the message was processed successfully by the From File component. If an error occurs in the destination component and not in the From File component, the files will still be moved here. If the directory does not exist, it will be created. |
| Automatically purge error logs older than | Specify when error logs are stale and can be deleted. If this value is 0, then error logs will never be automatically purged. |