Skip to main content Skip to complementary content

tSynonymOutput Standard properties

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

The Standard tSynonymOutput component belongs to the Data Quality family.

The component in this framework is available in Talend Data Management Platform, Talend Big Data Platform, Talend Real-Time Big Data Platform, Talend Data Services Platform, and in Talend Data Fabric.

Basic settings

Schema and Edit schema

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


Built-in: The schema will be created and stored locally for this component only. For more information about a component schema in its Basic settings tab, see Basic settings tab.


Repository: The schema already exists and is stored in the Repository, hence can be reused in various projects and Job designs. For more information about a component schema in its Basic settings tab, see Basic settings tab.

Index path

Type in or browse to the location where you want to create and store the synonym index. If the specified directory does not exist, the component will create it.


Select the index operation to be performed in directory given in the Index path field.

(Delete and) initialize an index: creates a new index and then fills it with the entries and the corresponding synonyms; if an index already exists, deletes it before creating a new one.

Insert new documents: inserts new entries and synonyms into the given existing index. Duplicates are not inserted.

Update existing documents and insert if not existing: updates existing entries and synonyms, and adds new ones to the given index.

Delete existing documents: deletes the entries with their synonyms if the same entries are identified in the incoming data flow from the preceding component.


Select the column you need to insert to create the entries of the given index. These entries are used as reference to any associated synonyms to be inserted alongside in this given index.


Select the column you need to insert to create the synonyms corresponding to different index entries.

Synonym separator

Type in the separator to be used to separate the synonyms of each index entry. By default, this separator is |.

Advanced settings

tStatCatcher Statistics

Select this check box to collect log data at the Job and the component levels.

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.

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 more information about variables, see Using contexts and variables.


Usage rule

This component needs incoming data from the preceding component for creating or updating indexes.


Outgoing links (from this component to another):

Row: Main; Reject

Trigger: Run if; On Component Ok; On Component Error.

Incoming links (from one component to this one):

Row: Main; Reject

For further information regarding connections, see Using connections in a Job.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!