Managed File Transfer User Guide

10.5.3
- 10.5.0
- 10.4.0
- 10.2.3
- 10.2.2 HotFix 1
- 10.2.2
- 10.2.1
- 10.2

Back Next

Write CSV Task

The Write CSV task allows you to specify file and data parameters for translating a RowSet variable into a CSV file.

Field	Definition
Basic Tab
Label	Specify a label for this task.
Input RowSet Variable	Specify the name of a variable of type RowSet which contains data to write to a file. For example, ${variableName}
Output File	Specify the path and file name of a single file to write.
When Output File Exists	Specify the action to take when the output file already exists. The default value is 'rename' which changes the file name to a new name so the existing file remains untouched. Default Value: rename
Field Delimiter	Specify the character to use for separating each field in the generated CSV file. Default Value: comma
Advanced Tab
Maximum Rows	Specify the maximum number of rows to be written to the output file. When this limit is reached, the remaining rows in the input RowSet will be silently skipped.
Encoding	Specify the character encoding of the output file. Default Value: The platform's default file encoding.
Include Column Headings	Specify whether or not to include column headings in the generated CSV file. Default Value: false
Record Delimiter	Specify the character(s) to use for separating each record (or row) in the generated CSV file. Default Value: CRLF
Text Qualifier	Specify the character used to enclose data in each field. Default Value: none
Apply Text Qualifier To	Specify whether the text qualifier (if specified) should be applied to all columns or only to non-numeric columns. By default, the column types are determined from the metadata of the Input RowSet. The column types can also be overridden by defining the nested column elements. Please note that in some cases the text qualifier may be applied to numeric fields if the numeric value is formatted to contain special characters (e.g. comma). Text qualifier is always applied to all column headings (irrespective of the column type) if the column headings are included. Default Value: none
Output Variables Tab
Output File Variable	If desired, specify the name of a variable which will contain the output file. The variable will be of type File and may be used in subsequent tasks that accept File or File List input variables. The variable will be created if it does not exist.
Control Tab
Version	The version of this task.
Log Level	Specify the level of logging to use while executing this task. Valid options are - silent, normal, verbose and debug. Default Value: Inherited from parent Module
Execute Only If	Specify a condition that must be satisfied before this task can be executed. This task will be skipped if the specified condition is not met.
Disabled	Whether or not this task is disabled. Default Value: false
On Error Tab
On Error	Specify the action to take when this task errors out. Valid options are - abort, continue, call:[module] and setVariable:[name]=[value]. For call:[module] replace [module] with the name of the module in the project (e.g. call:ErrorModule). For setVariable:[name]=[value] replace [name] with a variable name and [value] with the variable value (e.g. setVariable:error=true). Default Value: Inherited from parent Module