Skip to main content Skip to complementary content

tSynonymSearch Standard properties

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

The Standard tSynonymSearch 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 (columns) to be processed and passed on to the next component. When you create a Spark Job, avoid the reserved word line when naming the fields.

Default columns are provided in the schema of this component in order to present the matching details between the input data and the reference entries.

For further information about the default schema columns, see Default schema columns.

Click Sync columns to retrieve the schema from the previous component connected in the Job.

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 and store the schema locally for this component only.


Repository: You have already created the schema and stored it in the Repository. You can reuse it in various projects and Job designs.

Limit of each group

Type in a number to indicate the maximum display of the reference entries matched to each group of the input data. Each row of input data is recognized as one group by this component.

If the entries count exceeds the indicated limit, this component displays the ones scored the highest. For further information about the scores used on the matched entries, see Default schema columns.

Columns to search

Complete this table to provide parameters used to match the input data and the reference entries in a given index.

The columns to be completed are:

- Input column: select the column(s) of interest from the input data schema.

- Reference output column: select the column(s) from the output data schema to present the matched reference entries found in the given synonym index.

- Index path: enter the path to the index you need to search. The value must be enclosed in double quotation marks.

- Search mode: select the search mode you want to use to match input strings against index strings. For further information about available search modes, see Search modes for Index rules.

- Score threshold (available for all modes): set a numerical value above 0.0 by which you want to filter the results. Set the threshold to 0.0 to disable the filter.

The score value is returned by the Lucene engine and can be anything above 0. The higher the score is, the higher is the similarity of the match. Use the threshold to remove low scoring matches from the output results. There is no easy way to decide about a good threshold value. It will depend on the input data and the indexed data.

- Max edits (based on the Levenshtein algorithm and available for the Match all fuzzy and Match any fuzzy modes): select an edit distance, 1 or 2, from the list. Any terms within the edit distance from the input data are matched. With a max edit distance 2, for example, you can have up to 2 insertions, deletions, or substitutions

Fuzzy match gains much in performance with Max edits for fuzzy match.

Information noteNote:

Jobs migrated in Talend Studio from older releases run correctly, but results might be slightly different because Max edits for fuzzy match is now used in place of Minimum similarity for fuzzy match.

- Word distance (available for the Match partial mode): select from the list the maximum number of words allowed to come inside a sequence of words that may be found in the index, default value is 1.

- Limit: type in a number to indicate the maximum reference entries to be matched to each record of the corresponding input column you have selected.

Advanced settings

tStatCatcher Statistics

Select this check box to gather the Job processing metadata at the 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.

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.


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!