tFileOutputXML – Docs for ESB 5.x

Component family

XML or File/Output

Function

tFileOutputXML outputs data to an
XML type of file.

If you have subscribed to one of the Talend solutions with Big Data, you are
able to use this component in a Talend Map/Reduce Job to generate
Map/Reduce code. For further information, see tFileOutputXML in Talend
Map/Reduce Jobs.

Purpose

tFileOutputXML writes an XML file
with separated data value according to a defined schema.

Basic settings

File name

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

Related topic: see Defining variables from the Component view
section in Talend Studio User
Guide

Select this check box if the data from the preceding component is
in XML format.

When this check box is selected, a Column
list appears allowing you to select a Document type column of the schema that
holds the data, and the Row tag
field disappears.

When this check box is selected, in the Advanced settings view, only the check boxes
Create directory if not exists,
Don’t generate empty file,
Trim data, tStatCatcher Statistics and the list
Encoding are available.

Row tag

Specify the tag that will wrap data and structure per row.

Schema and Edit
Schema

A schema is a row description, it defines the number of fields
that will be processed and passed on to the next component. The
schema is either built-in or remote in the Repository.

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

Built-in: The schema will be
created and stored locally for this component only. Related topic:
see Talend Studio User Guide.

Repository: The schema already
exists and is stored in the Repository, hence can be reused in
various projects and job designs. Related topic: see
Talend Studio User
Guide.

If the output is big, you can split the output into several files,
each containing the specified number of rows.

Rows in each output file: Specify
the number of rows in each output file.

Define the output format.

Column: The columns retrieved
from the input schema.

As attribute: select check box
for the column(s) you want to use as attribute(s) of the parent
element in the XML output.

Use schema column name: By
default, this check box is selected for all columns so that the
column labels from the input schema are used as data wrapping tags.
If you want to use a different tag than from the input schema for
any column, clear this check box for that column and specify a tag
label between quotation marks in the Label field.

Use dynamic grouping

Select this check box if you want to dynamically group the output
columns. Click the plus button to add one ore more grouping criteria
in the Group by table.

Column: Select a column you want
to use as a wrapping element for the grouped output rows.

Attribute label: Enter an
attribute label for the group wrapping element, between quotation
marks.

Select this check box to define the number of rows to buffer
before the data is written into the target file and the buffer is
emptied.

Row Number: Specify the number of
rows to buffer.

Select this check box to modify the separators used for numbers:

Thousands separator: define
separators for thousands.

Decimal separator: define
separators for decimals.

Encoding

Select the encoding from the list or select Custom and
define it manually. This field is compulsory for database data handling.

Trim data

Select this check box to remove the spaces at the beginning and at
the end of the text, and merge multiple consecutive spaces into one
within the text.

Global Variables

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.

NB_LINE: the number of rows processed. This is an After
variable and it returns an integer.

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

Use this component to write an XML file with data passed on from
other components using a Row
link.

Log4j

The activity of this component can be logged using the log4j feature. For more information on this feature, see Talend Studio User
Guide.

For more information on the log4j logging levels, see the Apache documentation at http://logging.apache.org/log4j/1.2/apidocs/org/apache/log4j/Level.html.

Component family

MapReduce/Output

Basic settings

Property type

Either Built-in or Repository.

Built-in: No property data stored
centrally.

Click this icon to open a database connection wizard and store the database connection
parameters you set in the component Basic settings
view.

For more information about setting up and storing database connection parameters, see
Talend Studio User Guide.

Repository: reuse properties
stored centrally under the Hadoop
Cluster node of the Repository tree.

The fields that come after are pre-filled in using the fetched
data.

For further information about the Hadoop
Cluster node, see the Getting Started Guide.

Row tag

Specify the tag that will wrap data and structure per row.

Schema and Edit
Schema

A schema is a row description, it defines the number of fields
that will be processed and passed on to the next component. The
schema is either built-in or remote in the Repository.

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

Built-in: The schema will be
created and stored locally for this component only. Related topic:
see Talend Studio User Guide.

Repository: The schema already
exists and is stored in the Repository, hence can be reused in
various projects and job flowcharts. Related topic: see
Talend Studio User
Guide.

Folder

Browse to, or enter the directory in HDFS where the data you need to use is.

This path must point to a folder rather than a file, because a
Talend Map/Reduce
Job need to write in its target folder not only the final result but
also multiple part- files
generated in performing Map/Reduce computations.

Note that you need
to ensure you have properly configured the connection to the Hadoop
distribution to be used in the Hadoop
configuration tab in the Run view.

Action

Select an operation for writing data:

Create: Creates a file and write
data in it.

Overwrite: Overwrites the file
existing in the directory specified in the Folder field.

Define the output format.

Column: The columns retrieved
from the input schema.

As attribute: select check box
for the column(s) you want to use as attribute(s) of the parent
element in the XML output.

Use schema column name: By
default, this check box is selected for all columns so that the
column labels from the input schema are used as data wrapping tags.
If you want to use a different tag than from the input schema for
any column, clear this check box for that column and specify a tag
label between quotation marks in the Label field.

Use dynamic grouping

Select this check box if you want to dynamically group the output
columns. Click the plus button to add one ore more grouping criteria
in the Group by table.

Column: Select a column you want
to use as a wrapping element for the grouped output rows.

Attribute label: Enter an
attribute label for the group wrapping element, between quotation
marks.

Encoding

Select the encoding from the list or select Custom and
define it manually. This field is compulsory for database data handling.

Global Variables

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

In a Talend Map/Reduce Job, it is used as an end component and requires
a transformation component as input link. The other components used along with it must be
Map/Reduce components, too. They generate native Map/Reduce code that can be executed
directly in Hadoop.

Once a Map/Reduce Job is opened in the workspace, tFileOutputXML as well as the MapReduce
family appears in the Palette of
the Studio.

Note that in this documentation, unless otherwise explicitly stated, a scenario presents
only Standard Jobs, that is to say traditional Talend data
integration Jobs, and non Map/Reduce Jobs.

Hadoop Connection

You need to use the Hadoop Configuration tab in the
Run view to define the connection to a given Hadoop
distribution for the whole Job.

This connection is effective on a per-Job basis.