Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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.

...

Expand
titleSTEP 2: Setup the component configurations & the quickstart guide
Screen Shot 2024-08-02 at 2.56.33 PM.png

Any field marked with red asterisk is required, otherwise the default value inside the config.json will take its place.

FIELD NAME

Description

DEFAULT VALUE

DestinationDirectory*

Defines where the destination folder will be placed

[EMPTY]

OutputFileMask

Defines the name of the files as well as the extension

output_%Y_%m_%d_%H_%M_%S.txt

OneFilePerMessage

Specifies whether each message will have its own file

false

OutputEncoding

Defines the encoding that is used in the output file - if left empty, it will default to either Western (ISO-8859-1) or Western (Windows-1252) depending on the OS

[EMPTY]

Escape8BitCharacters

Specifies whether to escape non-ASCII characters

false

UseTempFiles

Specifies whether to use temporary files while writing

true


Quickstart

If you want one file for all messages

Screen Shot 2024-08-12 at 2.28.27 PM.png

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…)

Screen Shot 2024-08-12 at 2.31.10 PM.png

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.

Screen Shot 2024-08-12 at 2.31.28 PM.png

...