To File |
 | ||
|
This documentation page describes a feature of version 3.3 of Iguana. For information on how to configure the To File destination component in version 4.0 or later of Iguana, see To File. | ||
 |
In order to configure the To File destination component described in the Channel Destination Components section of the manual, you must define the following properties:
| Property | Description |
|---|---|
| Full directory path to write files into* | Path of the directory that Iguana will write the message file(s) to. Note that the directory must exist. |
| Archive file prefix* | Prefix that is used to create the file(s). If the messages are to be written to separate files, this precedes the Date Time or Index in the filename. If not, this is the name of the file. |
| Archive file extension* | Extension of the file(s). |
| Write each message to a separate file | If true, each message is put into its own file. The filename is created with the prefix, then either the Date Time or an Index (depending on the value of "Archive file using"), and then the extension. If false, all messages are put into one file. The name of the file is created with the prefix and extension only. |
| Temporary file extension | Extension to use while writing the file. After the file has been completely written and closed, it will be renamed to its final target filename. If no temporary extension is specified, the final target file will be written, with no renaming. If either the temporary or final target file is already present in the output directory, an error will be logged and the channel will be stopped. This option is only valid if "Write each message to a separate file" is selected. |
| Archive file using | If Date Time, the current date time is used to name the files. The time is accurate to three decimal places of the current second. If Integer Index, an Index is used starting at the value of "If using index, start at". This option is only valid if "Write each message to a separate file" is selected. |
| If using index, start at | Index of the next message that will be written to a file. The index is used to name the file by appending it to the prefix. This value is incremented by one every time it is used to name a file. If a file with the same index already exists, an error is generated. This option is only valid if "Archive file using" is set to Integer Index. |
| 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. |