File Read

The File Read action reads a specified number of strings (lines) or bytes from a file in the Staging Browser area. The data is stored as strings (lines) or bytes in a destination variable.
In Strings mode, the file is read into strings as indicated by the line terminator.
In Binary mode, the file is 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 read.
  • 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.
Read Mode The three options are:
  • Strings - When selected, Max Characters Per Line and Max Lines become available.

    In Strings mode, the runtime treats Line Feed (0x0A hexadecimal, 10 in decimal) and Carriage Return (0x0D hexadecimal, 13 in decimal) as the line terminator depending on the runtime platform.
  • Binary - When selected, Max Byte Length becomes available.
  • ASCII - When select, the following screen should be seen:
Max Characters Per Line The maximum number of characters in a line to read. The maximum value is 2147483647.
Max Lines The maximum number of lines in the file to read. The maximum value is 2147483647.
Max Byte Length The maximum number of bytes in the file to read. The maximum value is 2147483647.

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 read. This can be a constant or a variable. If specified in a variable, the file name can change during run time.

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.

Output tab (Strings)

When the Strings option is used (for both Static and Dynamic):


Parameter Description
String Array The string array where the read lines are returned.
Number of Lines The number of lines that were read. This value will not be larger than the Max Lines parameter.

Output tab (Binary)

When the Binary option is used (for both Static and Dynamic):


Parameter Description
Binary Buffer The variable where the read bytes are returned.
Binary Length The number of bytes that were read. This value will not be larger than the Max Byte Length parameter.