# tSynonymOutput Creates a Lucene index and feeds it with entries and the related synonyms it receives. tSynonymOutput creates synonym indexes that some components like tStandardizeRow or tSynonymSearch can refer to when processing data. For further information about how to access and manage the words and the reference entries (documents) of an existing synonym index using the synonym index editor, see [Using the synonym index editor](https://help.qlik.com/talend/r/en-US/8.0/studio-user-guide/using-synonym-index-editor). For further information about available synonym indexes, see [Data synonym dictionaries](https://help.qlik.com/talend/r/Lfrx8uSM~Ud8zWd9BsWB5g/btg5jctOg_g2f_EBmyRgzA). This component is not shipped with your Talend Studio by default. You need to install it using the Feature Manager. For more information, see [Installing features using the Feature Manager](https://help.qlik.com/talend/r/en-US/8.0/studio-user-guide/install-features-to-talend-studio). ## 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 | Properties | Description | | --- | --- | | Schema and Edit
schema | | | 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. | | Operations | 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. | | Entry | 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. | | Synonyms | 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 | Properties | Description | | --- | --- | | tStatCatcher Statistics | Select this check box to collect log data at the Job and the
component levels. | ## Global Variables | Variables | Description | | --- | --- | | 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 checkbox is
cleared, if the component has this checkbox.

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](https://help.qlik.com/talend/r/en-US/8.0/studio-user-guide/contexts-and-variables). | ## Usage | Usage guidance | Description | | --- | --- | | **Usage rule** | This component needs incoming data from the preceding component
for creating or updating indexes. | | Connections | 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](https://help.qlik.com/talend/r/en-US/8.0/studio-user-guide/using-connections-in-job). | **Related concepts** * [Creating a synonym index for city names](https://help.qlik.com/talend/en-US/components/8.0/synonym-index/tsynonymoutput-tfileinputdelimited-tlogrow-tlogrow-creating-synonym-index-for-city-names-standard-component-enterprise-in-this) * [Creating a synonym index for people names using tMap](https://help.qlik.com/talend/en-US/components/8.0/synonym-index/tsynonymoutput-tfileinputdelimited-tmap-tlogrow-creating-synonym-index-for-people-names-using-tmap-standard-component-enterprise-in-this) * [Searching a given index for matched reference entries](https://help.qlik.com/talend/en-US/components/8.0/synonym-index/tsynonymsearch-tsynonymoutput-tlogrow-tfixedflowinput-searching-given-index-for-matched-reference-entries-standard-component-enterprise-in-this)