Component-specific settings

Function/parameter	Description	Mandatory?
USESTREAM	Set this parameter to `true` to allow specifying the output target of the data flow using the `STREAMNAME` parameter. By default, this parameter is set to `false`. A data stream is implemented via a variable pre-defined in your Studio or provided by the context or certain components you are using along with this component, such as tFileList, tJava, or tJavaFlex.	Yes to specify the output target by a data stream
STREAMNAME	Use this parameter to specify the data stream that represents the output target of the data flow.	Yes when `USESTREAM` set to `true`
FILENAME	Use this parameter to specify the path and name of the target file. This parameter works only when the `USESTREAM` parameter is not present or is set to `false`.	Yes to specify the output target by a file name
ROWSEPARATOR	Use this parameter to specify the separator used to identify the end of a row.	No
FIELDSEPARATOR	Use this parameter to specify a character, string or regular expression to separate fields for the transferred data.	No
OS_LINE_SEPARATOR_AS_ROW_SEPARATOR	Set this parameter to `true` to use the Operating System defined line separator as the row separator when the CSV row separator is set to CR, LF, or CRLF. By default, this parameter is set to `true`. This parameter works only when the `CSV_OPTION` parameter is set to `true`.	No
APPEND	Set this parameter to `true` to add the new rows at the end of the file. By default, this parameter is set to `false`. This parameter works only when the `USESTREAM` is not present or is set to `false`.	No
INCLUDEHEADER	Set this parameter to `true` to include the column header in the output file. By default, this parameter is set to `false`. This parameter does not work when the `USESTREAM` is set to `true`.	No
COMPRESS	Set this parameter to `true` to compress the output file in zip format. By default, this parameter is set to `false`. This parameter does not work when the `APPEND` is set to `true`.	No
ADVANCED_SEPARATOR	Set this parameter to `true` to change the thousands and decimal separators used for numbers. By default, the thousands separator is a comma (,) and the decimal separator is a period (.). By default, this parameter is set to `false`.	No
THOUSANDS_SEPARATOR	Use this parameter to specify the thousands separator. This parameter works only when the `ADVANCED_SEPARATOR` parameter is set to `true`.	No
DECIMAL_SEPARATOR	Use this parameter to specify the decimal separator. This parameter works only when the `ADVANCED_SEPARATOR` parameter is set to `true`.	No
CSV_OPTION	Set this parameter to `true` to include CSV specific parameters such as `ESCAPE_CHAR` char and `TEXT_ENCLOSURE`. By default, this parameter is set to `false`.	No
ESCAPE_CHAR	Use this parameter to specify the escape character to escape metacharacters if the specified file is a standard CSV file. This parameter works only when the `CSV_OPTION` parameter is set to `true`.	No
TEXT_ENCLOSURE	Use this parameter to specify the text enclosure if the specified file is a standard CSV file. This parameter works only when the `CSV_OPTION` parameter is set to `true`.	No
CSVROWSEPARATOR	Use this parameter to specify the CSV specific row separator. This parameter works only when the `CSV_OPTION` parameter is set to `true`.	No
CREATE	Set this parameter to `false` if you do not want to create the specified output directory if it does not already exist. By default, this parameter is set to `true`. This parameter works only when the `USESTREAM` is not present or is set to `false`.	No
SPLIT	Set this parameter to `true` to divide the output delimited file into multiple files. By default, this parameter is set to `false`. This parameter works only when the `USESTREAM` is not present or is set to `false`.	No
SPLIT_EVERY	Use this parameter to specify the number of lines in each of the output files. This parameter works only when the `SPLIT` parameter is set to `true`. The default value is 1000.	No
FLUSHONROW	Set this parameter to `true` to empty the buffer once the number of lines in the buffer reaches the value of the `FLUSHONROW_NUM` parameter. By default, this parameter is set to `false`.	No
FLUSHONROW_NUM	Define the number of lines to write before emptying the buffer. This parameter works only when the `FLUSHONROW` parameter is set to `true`. The default value is 1.	No
ROW_MODE	Set this parameter to `true` to ensure atomicity of the flush so that each row of data can remain consistent as a set and incomplete rows of data are never written to a file. This option is mostly useful when using this component in the multi-thread situation. By default, this parameter is set to `false`.	No
ENCODING	Use this parameter to specify the encoding of the file. The default value is `\"ISO-8859-15\"`.	No
ENCODING:ENCODING_TYPE	Set this parameter according to the `ENCODING` value: `ISO-8859-15` if the `ENCODING` value is `\"ISO-8859-15\"`. `UTF-8` if the `ENCODING` value is `\"UTF-8\"`. `CUSTOM` if `ENCODING` has another value. The default value is `ISO-8859-15`.	No
DELETE_EMPTYFILE	Set this parameter to `true` if you do not want to generate empty files. By default, this parameter is set to `false`. This parameter works only when the `USESTREAM` is not present or is set to `false`.	No
FILE_EXIST_EXCEPTION	Set this parameter to `true` to throw an exception if the specified output file already exists. This parameter works only when the `USESTREAM` parameter is not present or is set to `false`. By default, this parameter is set to `false`.	No
TSTATCATCHER_STATS	Set this parameter to `true` to gather the processing metadata at the Job level as well as at each component level. By default, this parameter is set to `false`.	No
LABEL	Use this parameter to specify a text label for the component.	No

USESTREAM

Set this parameter to true to allow specifying the output target of the data flow using the STREAMNAME parameter.

By default, this parameter is set to false.

A data stream is implemented via a variable pre-defined in your Studio or provided by the context or certain components you are using along with this component, such as tFileList, tJava, or tJavaFlex.

Yes to specify the output target by a data stream

STREAMNAME

Use this parameter to specify the data stream that represents the output target of the data flow.

Yes when USESTREAM set to true

FILENAME

Use this parameter to specify the path and name of the target file.

This parameter works only when the USESTREAM parameter is not present or is set to false.

Yes to specify the output target by a file name

ROWSEPARATOR

Use this parameter to specify the separator used to identify the end of a row.

No

FIELDSEPARATOR

Use this parameter to specify a character, string or regular expression to separate fields for the transferred data.

No

OS_LINE_SEPARATOR_AS_ROW_SEPARATOR

Set this parameter to true to use the Operating System defined line separator as the row separator when the CSV row separator is set to CR, LF, or CRLF.

By default, this parameter is set to true.

This parameter works only when the CSV_OPTION parameter is set to true.

No

APPEND

Set this parameter to true to add the new rows at the end of the file.

By default, this parameter is set to false.

This parameter works only when the USESTREAM is not present or is set to false.

No

INCLUDEHEADER

Set this parameter to true to include the column header in the output file.

By default, this parameter is set to false.

This parameter does not work when the USESTREAM is set to true.

No

COMPRESS

Set this parameter to true to compress the output file in zip format.

By default, this parameter is set to false.

This parameter does not work when the APPEND is set to true.

No

ADVANCED_SEPARATOR

Set this parameter to true to change the thousands and decimal separators used for numbers. By default, the thousands separator is a comma (,) and the decimal separator is a period (.).

By default, this parameter is set to false.

No

THOUSANDS_SEPARATOR

Use this parameter to specify the thousands separator.

This parameter works only when the ADVANCED_SEPARATOR parameter is set to true.

No

DECIMAL_SEPARATOR

Use this parameter to specify the decimal separator.

This parameter works only when the ADVANCED_SEPARATOR parameter is set to true.

No

CSV_OPTION

Set this parameter to true to include CSV specific parameters such as ESCAPE_CHAR char and TEXT_ENCLOSURE.

By default, this parameter is set to false.

No

ESCAPE_CHAR

Use this parameter to specify the escape character to escape metacharacters if the specified file is a standard CSV file.

This parameter works only when the CSV_OPTION parameter is set to true.

No

TEXT_ENCLOSURE

Use this parameter to specify the text enclosure if the specified file is a standard CSV file.

This parameter works only when the CSV_OPTION parameter is set to true.

No

CSVROWSEPARATOR

Use this parameter to specify the CSV specific row separator.

This parameter works only when the CSV_OPTION parameter is set to true.

No

CREATE

Set this parameter to false if you do not want to create the specified output directory if it does not already exist.

By default, this parameter is set to true.

This parameter works only when the USESTREAM is not present or is set to false.

No

SPLIT

Set this parameter to true to divide the output delimited file into multiple files.

By default, this parameter is set to false.

This parameter works only when the USESTREAM is not present or is set to false.

No

SPLIT_EVERY

Use this parameter to specify the number of lines in each of the output files.

This parameter works only when the SPLIT parameter is set to true. The default value is 1000.

No

FLUSHONROW

Set this parameter to true to empty the buffer once the number of lines in the buffer reaches the value of the FLUSHONROW_NUM parameter.

By default, this parameter is set to false.

No

FLUSHONROW_NUM

Define the number of lines to write before emptying the buffer.

This parameter works only when the FLUSHONROW parameter is set to true. The default value is 1.

No

ROW_MODE

Set this parameter to true to ensure atomicity of the flush so that each row of data can remain consistent as a set and incomplete rows of data are never written to a file.

This option is mostly useful when using this component in the multi-thread situation.

By default, this parameter is set to false.

No

ENCODING

Use this parameter to specify the encoding of the file.

The default value is \"ISO-8859-15\".

No

ENCODING:ENCODING_TYPE

Set this parameter according to the ENCODING value:

ISO-8859-15 if the ENCODING value is \"ISO-8859-15\".
UTF-8 if the ENCODING value is \"UTF-8\".
CUSTOM if ENCODING has another value.

The default value is ISO-8859-15.

No

DELETE_EMPTYFILE

Set this parameter to true if you do not want to generate empty files.

By default, this parameter is set to false.

This parameter works only when the USESTREAM is not present or is set to false.

No

FILE_EXIST_EXCEPTION

Set this parameter to true to throw an exception if the specified output file already exists.

This parameter works only when the USESTREAM parameter is not present or is set to false.

By default, this parameter is set to false.

No

TSTATCATCHER_STATS

Set this parameter to true to gather the processing metadata at the Job level as well as at each component level.

By default, this parameter is set to false.

No

LABEL

Use this parameter to specify a text label for the component.

No

Component-specific settings - 7.2

Talend Job Script Reference Guide