tFileOutputDelimited Standard properties

Delimited

author
Talend Documentation Team
EnrichVersion
6.5
EnrichProdName
Talend Real-Time Big Data Platform
Talend Data Management Platform
Talend MDM Platform
Talend Open Studio for ESB
Talend Open Studio for Big Data
Talend Open Studio for Data Integration
Talend Data Fabric
Talend Open Studio for MDM
Talend Data Integration
Talend Data Services Platform
Talend ESB
Talend Big Data Platform
Talend Big Data
task
Design and Development > Third-party systems > File components (Integration) > Delimited components
Data Quality and Preparation > Third-party systems > File components (Integration) > Delimited components
Data Governance > Third-party systems > File components (Integration) > Delimited components
EnrichPlatform
Talend Studio

These properties are used to configure tFileOutputDelimited running in the Standard Job framework.

The Standard tFileOutputDelimited component belongs to the File family.

The component in this framework is generally available.

Basic settings

Property type

Either Built-In or Repository.

 

Built-In: No property data stored centrally.

 

Repository: Select the repository file where the properties are stored.

Use Output Stream

Select this check box process the data flow of interest. Once you have selected it, the Output Stream field displays and you can type in the data flow of interest.

The data flow to be processed must be added to the flow in order for this component to fetch these data via the corresponding representative variable.

This variable could be already pre-defined in your Studio or provided by the context or the components you are using along with this component; otherwise, you could define it manually and use it according to the design of your Job, for example, using tJava or tJavaFlex.

In order to avoid the inconvenience of hand writing, you could select the variable of interest from the auto-completion list (Ctrl+Space) to fill the current field on condition that this variable has been properly defined.

For further information about how to use a stream, see Scenario 2: Reading data from a remote file in streaming mode.

File name

Name or path to the output file and/or the variable to be used.

This field becomes unavailable once you have selected the Use Output Stream check box.

For further information about how to define and use a variable in a Job, see Talend Studio User Guide.

Row Separator

The separator used to identify the end of a row.

Field Separator

Enter character, string or regular expression to separate fields for the transferred data.

Append

Select this check box to add the new rows at the end of the file.

Include Header

Select this check box to include the column header to the file.

Compress as zip file

Select this check box to compress the output file in zip format.

Schema and Edit schema

A schema is a row description. It defines the number of fields (columns) to Repository. When you create a Spark Job, avoid the reserved word line when naming the fields.

Click Edit schema to make changes to the schema. If the current schema is of the Repository type, three options are available:

  • View schema: choose this option to view the schema only.

  • Change to built-in property: choose this option to change the schema to Built-in for local changes.

  • Update repository connection: choose this option to change the schema stored in the repository and decide whether to propagate the changes to all the Jobs upon completion. If you just want to propagate the changes to the current Job, you can select No upon completion and choose this schema metadata again in the [Repository Content] window.

This component offers the advantage of the dynamic schema feature. This allows you to retrieve unknown columns from source files or to copy batches of columns from a source without mapping each column individually. For further information about dynamic schemas, see Talend Studio User Guide.

This dynamic schema feature is designed for the purpose of retrieving unknown columns of a table and is recommended to be used for this purpose only; it is not recommended for the use of creating tables.

 

Built-In: You create and store the schema locally for this component only. Related topic: see Talend Studio User Guide.

 

Repository: You have already created the schema and stored it in the Repository. You can reuse it in various projects and Job designs. Related topic: see Talend Studio User Guide.

Sync columns

Click to synchronize the output file schema with the input file schema. The Sync function only displays once the Row connection is linked with the output component.

Advanced settings

Advanced separator (for numbers)

Select this check box to change the separator used for numbers. By default, the thousands separator is a comma (,) and the decimal separator is a period (.).

Thousands separator: define separators for thousands.

Decimal separator: define separators for decimals.

CSV options

Select this check box to specify the following CSV parameters:

  • Escape char: enter the escape character between double quotation marks. For example, you need to type in "\\" if the backslash character (\) is used as the escape character.

  • Text enclosure: enter the enclosure character (only one character) between double quotation marks. For example, """ needs to be entered when double quotation marks (") are used as the enclosure character.

Create directory if not exists

This check box is selected by default. It creates the directory that holds the output delimited file, if it does not already exist.

Split output in several files

In case of very big output files, select this check box to divide the output delimited file into several files.

Rows in each output file: set the number of lines in each of the output files.

Custom the flush buffer size

Select this check box to define the number of lines to write before emptying the buffer.

Row Number: set the number of lines to write.

Output in row mode

Select this check box 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 check box is mostly useful when using this component in the multi-thread situation.

Encoding

Select the encoding from the list or select Custom and define it manually. This field is compulsory for database data handling. The supported encodings depend on the JVM that you are using. For more information, see https://docs.oracle.com.

Don't generate empty file

Select this check box if you do not want to generate empty files.

Throw an error if the file already exist

Select this check box to throw an exception if the output file specified in the File Name field on the Basic settings view already exists.

Clear this check box to overwrite the existing file.

tStatCatcher Statistics

Select this check box to gather the Job processing metadata at a Job level as well as at each component level.

Global Variables

Global Variables

NB_LINE: the number of rows read by an input component or transferred to an output component. This is an After variable and it returns an integer.

FILE_NAME: the name of the file being processed. This is a Flow variable and it returns a string.

ERROR_MESSAGE: the error message generated by the component when an error occurs. This is an After variable and it returns a string. This variable functions only if the Die on error check box is cleared, if the component has this check box.

A Flow variable functions during the execution of a component while an After variable functions after the execution of the component.

To fill up a field or expression with a variable, press Ctrl + Space to access the variable list and choose the variable to use from it.

For further information about variables, see Talend Studio User Guide.

Usage

Usage rule

Use this component to write a delimited file and separate fields using a field separator value.

Limitation

Due to license incompatibility, one or more JARs required to use this component are not provided. You can install the missing JARs for this particular component by clicking the Install button on the Component tab view. You can also find out and add all missing JARs easily on the Modules tab in the Integration perspective of your studio. For details, see Installing external modules.