File Write

The File Write action appends data to the end of a file and returns the number of bytes written.

  • In Strings mode, the data is written and then a line terminator is added.
  • In Binary mode, the file is written read as one big binary variable.

Parameter descriptions

Parameter Description
File Names The options are:
  • Static - The File Name parameter becomes available to specify the file name in the Staging Browser area to write.
  • Dynamic - The Input tab File Name parameter becomes available to specify the file name.
File Name Available when File Names is Static.
You can enter the file name or select Browse. You must enter the entire file path and file name. If you select Browse, the Staging Browser window appears.
Write Mode The options are:
  • Strings — When selected, New Line Delimiter, Max Characters Per Line and Max Lines parameters become available.

  • In Strings mode, the runtime writes the data and then adds a CRLF (Line Feed 0x0A hexadecimal, 10 in decimal) or CR (Carriage Return 0x0D hexadecimal, 13 in decimal) as the line terminator depending on the runtime platform.
  • Binary — When selected, the runtime writes the data as bytes with no line or record terminator.
Append to File The options are:
  • True — Append to the file if it exists. If the file does not exist, create a new file.
  • False — Overwrite the original file if it exists. If the file does not exist, create a new file.
New Line Delimiter Available when Write Mode is Strings.
The options are:
CR — Carriage return. The carriage return code (0x0D) is inserted as the new line delimiter after each string. This is normally used for a UNIX-based platform.
CRLF — Carriage return line feed. The line feed code (0x0A) is inserted as the new line delimiter after each string. This is normally used for a Windows platform.
Max Characters Per Line Available when Write Mode is Strings.
The maximum number of characters to write . The maximum value is 2147483647.
Max Lines Available when Write Mode is Strings.
The maximum number of lines to write. The maximum value is 2147483647.

Input tab (Static and Strings)

When the Static and Strings options are used:


Parameter Description
String Array
The string array with the lines to write.
Number of Lines The number of lines (number of array elements) to write.

Input tab (Static and Binary)

When the Static and Binary options are used:


Parameter Description
Binary Buffer The BINARY variable with the bytes to write
Binary Length The number of bytes to write.

Input tab (Dynamic and Strings)

When the Dynamic and Strings options are used:


Parameter Description
File Name The file in the Staging Browser area to write. This can be a constant or a variable. If specified in a variable, the file name can change during run time.
String Array
The string array with the lines to write.
Number of Lines The number of lines (number of array elements) to write.

Input tab (Dynamic and Binary)

When the Dynamic and Binary options are used:


Parameter Description
File Name
The file in the Staging Browser area to read. This can be a constant or a variable. If specified in a variable, the file name can change during run time.
Binary Buffer The BINARY variable with the bytes to write
Binary Length The number of bytes to write.