File StreamWriter Documentation

Version: 3.0.0

Retrieved: 2025-10-09 15:15:52

File StreamWriter

The module will write text to file(s). Data from incoming messages are appended to the same file until the rotation time expires. The file is then given a name that is a combination of TargetFileName, Extension and a date/time string according to DateFormat. After rotation new data is written to a new file.

This module is designed to be located in the middle of a flow.

Settings

Name Requirements Purpose Default
Source Property Length 1-64 The property that contains the text to write to the file. data
Target Property Length 1-64 The property to write the result to data
Target Path Length 1-256 The folder to write the file into  
Base FileName Length >= 1 The filename ""
File Extension string The file format .txt
Write each entry as a new line in the file bool   true
Header Length 1-256 Any text written here will be written to the file as a header (first line)  
Date Format Length 1-32 The datetime format for the filename yyyyMMddHHmmssfff
Rotation Period int (1 - 60*24*365) The number of minutes to do file rotation on 10
Compression None, Zip, Gzip What compression to use None

Input

There input message must have a Source Property containing the data to write to file.

Output

Note that this module only sends data to the next module(s) in the flow when a file is rotated.

When the file is rotated the next module(s) will be called with the information about the file written to {filename:'/path/filename.extension'} the object is written to the Target Property property. So if the Target Property = datathe result could look like.

{data:{filename:'/somefolder/foo_20171120133455.txt}}

Search Documentation

Destinations

Files