Introduction
The To File component is a destination component that writes incoming data to a file or multiple files as needed. It serves to expand on the File Writer component with additional configurations and settings.
This adapter can be easily modified to add additional functionality or to fulfil extra requirements.
Running the Component
| Info |
|---|
The below steps assume the correct user permissions are in place to read/write files. |
| Expand | ||
|---|---|---|
| ||
Using the + Component button+COMPONENT, import the To File component. |
| Expand | ||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||
 Any field Fields marked with red is an asterisk* are required, otherwise the default value inside the default values defined in config.json will take its place. FIELD NAMEare used:
QuickstartIf you want one file for all messages  If you want one file for all the messages that came in a second/minute/hour/day/month/year You can remove the timestamp masks to match your needs here (S = seconds, M = minutes and so on…)  If you want one file for every message Timestamp masks still get their values replaced with the current time but will not save multiple messages in one file. 
|
| Expand | ||
|---|---|---|
| ||
Start the component. Once messages arrive to the componentinbound messages are processed, check the defined destination directory to see your newly created file(s). |
Additional Details
...
Example Configurations
| Expand | ||
|---|---|---|
| Expand | ||
| ||
| ||
Is the directory where the file(s) will be stored. The adapter will attempt to create it if it does not exist. | ||
| ||
If you want one file for all messages:
While the value “output_%Y_%m_%d_%H_%M_%S.txt” will have masks replaced with timestamps as follows:
This OutputFileMask value will result in multiple files being created depending on when the data arrived. For example, if 2 bits of data arrived at 2024/12/30 at 16:45:55. They will be written to the same exact same file with the name “output_2024_12_30_16_45_55.txt” (unless the OneFilePerMessage field is set to true). If another bit came a second later, it will create a new file “output_2024_12_30_16_45_56.txt” and so on. You can add and remove masks as you please, but the smallest unit will determine how often a new file is created/a roll-over happens. So essentially, you can organize the data by the second/minute/hour/day/month/year (or millisecond) they arrived in. | ||
| Expand | ||
| ||
This field is only used if you would like to put every single message that came in into its own file. If the OutputFileMask is “output.txt” then the files generated will be
 The OutputFileMask will behave differently depending if OneFilePerMessage is set to true:
|
...
8-Bit Unicode
...
| Expand | ||
|---|---|---|
| ||
Used to indicate the type of encoding that you would like your data to be converted to (from UTF-8 by default), list of available encoding to convert can be found below. |
| Expand | ||
|---|---|---|
| ||
When set to true, it will append “.tmp” to files currently being written until the component is done writing to them. It will only remove the .tmp extension when a new file is written in. |
| Expand | ||
|---|---|---|
| ||
When writing messages out, non-ASCII characters, like accented characters, can be escaped. E.g., "é" would be sent as "\XE9\" (in Latin-1 or Windows-1252) or "\XC3\\XA9\" (in UTF-8). |
Supported Encodings
...
Encoding Name
...
Code
...
Chinese (Big 5 HKSCS)
...
BIG5-HKSCS
...
Chinese (GB 18030)
...
GB18030
...
Chinese (GB 2312)
...
GB2312
...
Chinese (GBK)
...
GBK
...
Japanese (ISO-2022-JP)
...
ISO-2022-JP
...
Korean (ISO-2022-KR)
...
ISO-2022-KR
...
Western (ISO-8859-1)
...
ISO-8859-1
...
Central European (ISO-8859-2)
...
ISO-8859-2
...
South European (ISO-8859-3)
...
ISO-8859-3
...
Central European (ISO-8859-4)
...
ISO-8859-4
...
Cyrillic (ISO-8859-5)
...
ISO-8859-5
...
Arabic (ISO-8859-6)
...
ISO-8859-6
...
Greek (ISO-8859-7)
...
ISO-8859-7
...
Hebrew (ISO-8859-8)
...
ISO-8859-8
...
Turkish (ISO-8859-9)
...
ISO-8859-9
...
Western (Windows-1252)
...
Windows-1252
...
Chinese (Big 5)
...
big5
...
Japanese (EUC-JP)
...
eucJP
...
Japanese (Shift JIS)
...
sjis
| |
If you want one file for every message:
 |
| Expand | ||
|---|---|---|
| ||
If you want one file for all the messages that came in the same second/minute/hour/day/month/year:
 The OutputFileMask is both the format of the outbound file names as well as can be used to determine when a new file is created. You can modify a mask as required, but the smallest unit will determine how often a new file is created/a roll-over happens. This allows you to organize data by the second/minute/hour/day/month/year (or millisecond) it arrived in.
|