File Writer Documentation

Version: 1.0.1

Retrieved: 2025-10-09 15:15:53

File Writer

Writes the content of the source property to a file.

Possible Errors

  • Disk or file system errors
  • Source property not found
  • Invalid filename template

Settings

Name Requirements Purpose Default
Filename String 1-64 in length The file to write to. Supports template syntax. ""
Source Property String 1-64 in length The property containing the input data. data
Target Property String 0-64 in length The property to write the filename to. If left empty, the filename is not sent to the next module.  
Encoding Enum (TextEncoding) The character encoding to use to encode the text if 'source property' is a text or object. UTF8

If the source property is an object, it will be serialized to JSON before writing to the file. If the source property is a string, it will be written as is to the file with the specified encoding. If the source property is a byte array, it will be written as is to the file.

Output

Name Type Description
crosser.success Boolean False if an error occurred when processing the message.
crosser.message String Contains an error message in case the processing fails, otherwise this property is not set.

Example

# Settings:
Source property = data
Filename = "C:\Temp\data_{id}.txt"
Encoding = UTF8

# Input:
{
    "id": 123,
    "data": "Hello World"
}


# Output:
{
    "crosser.success": true
}

# Result:
A file named "data_123.txt" is created in the "C:\Temp" folder with the content "Hello World"

Search Documentation

Destinations

Files