tWriteXMLField Standard properties - 7.3

XML

EnrichVersion
Cloud
7.3
EnrichProdName
Talend Big Data
Talend Big Data Platform
Talend Data Fabric
Talend Data Integration
Talend Data Management Platform
Talend Data Services Platform
Talend ESB
Talend MDM Platform
Talend Open Studio for Big Data
Talend Open Studio for Data Integration
Talend Open Studio for ESB
Talend Real-Time Big Data Platform
EnrichPlatform
Talend Studio
task
Data Governance > Third-party systems > XML components
Data Quality and Preparation > Third-party systems > XML components
Design and Development > Third-party systems > XML components

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

The Standard tWriteXMLField component belongs to the XML family.

The component in this framework is available in all Talend products.

Basic settings

Output Column

Select the destination field in the output component where you want to write the XML structure.

Configure XML Tree

Opens the interface that supports the creation of the XML structure you want to write in a field. For more information about the interface, see Defining the XML tree.

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:

  • 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.

 

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

 

Repository: You already created the schema and stored it in the Repository, hence can be reused in various projects and job flowcharts. 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 input component.

Group by

Define the aggregation set, the columns you want to use to regroup the data.

Advanced settings

Remove the XML declaration

Select this check box if you do not want to include the XML header.

Create empty element if needed

This check box is selected by default. If the Related Column in the XML tree editor has null values, or if no column is associated with the XML node, this option creates an open/close tag in the expected place.

Ignore service attributes for empty elements

Select this option to prevent the component from generating an XML node if the input node is null but has service attributes (such as @type, @class, and @array).

This option is available when the Create empty element if needed option is not selected.

Note: This option is available only if you have installed the R2020-04 Studio Monthly update or a later one delivered by Talend. For more information, check with your administrator.

Expand Empty Element if needed(for dom4j)

Select this option to allow a null element to appear in the form of tag pair, e.g. <element></element>. Otherwise, such an element appears as a solo tag, e.g. <element/>. For more information about XML tags, see http://www.tizag.com/xmlTutorial/xmltag.php.

Note: To use this option, you must select the Dom4J generation mode. Available when Create empty element if needed is selected.

Create associated XSD file

If one of the XML elements is defined as a Namespace element, this option will create the corresponding XSD file.

Note: To use this option, you must select the Dom4J generation mode.

Advanced separator (for number)

Select this check box if you want to modify the separators used by default for numbers.

Thousands separator: enter between brackets the separators to use for thousands.

Decimal separator: enter between brackets the separators to use for decimals.

Generation mode

Select the appropriate generation mode according to your memory availability. The available modes are:

  • Slow and memory-consuming (Dom4j)
    Note: This option allows you to use dom4j to process the XML files of high complexity.
  • Fast with low memory consumption

Encoding

Select the encoding type in the list or select Custom and define it manually. This field is compulsory when working with databases.

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

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 read by an input component or transferred to an output component. 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

Usage rule

This component can be used as intermediate step in a data flow.