Skip to main content Skip to complementary content

Using the synonym index editor

Talend Studio provides a Synonym Index editor where you can have access to the Lucene index files. You can find these files in the root directory of Talend Studio in the following path /addons/data/synonym. This editor displays the entries and their related synonyms and provides you with several management icons.

For more information about the available data synonym dictionaries, see Overview of the available indexes.

You can also create such index files using the tSynonymOutput component.

Information noteNote: If the indexes were created with version 7.2 or lower, you need to update them. The location of the migration procedure depends on the Talend Studio installation:
  • With the installer: /addons/scripts/Lucene_Migration_Tool/README.md
  • With no installer: in the license email, click the link in Migration tool for Lucene Indexes from version 4 to version 8.

The icons on top of the synonym index editor give you access to some basic management options that you can carry on the listed documents. The same management options are also accessible via a right-click on any of the listed documents.

Accessing the synonym index and search indexes

Before you begin

You have selected the Profiling perspective in Talend Studio.

Procedure

  1. Select Window > Show View from the menu bar.
    The Show View dialog box is displayed.
  2. Do one of the following:
    • Expand the Profiling folder and then select Synonym Index, or,
    • Start typing synonym index in the dynamic filter field, the list will display the name of the editor you are looking for.
    Filter field from the Show view... dialog box.
  3. Select Synonym Index and click Open to close the dialog box.
    The Synonym Index editor is displayed.
    Overview of the Synonym Index editor.
  4. Click the browse... tab and browse to the index files in the Talend Studio root directory, or to those generated by the tSynonymOutput component.
    Information noteNote: If the shared mode is enabled, the path to the addons folder has changed to C:/Users/user-account/studio-path/addons/.... For more information, see Shared mode for Talend Studio in the Talend Installation Guide.
    Information noteNote: If the indexes were created with version 7.2 or lower, you cannot browse to the index files. You need to update them. The location of the migration procedure depends on the Talend Studio installation:
    • With the installer: /addons/scripts/Lucene_Migration_Tool/README.md
    • With no installer: in the license email, click the link in Migration tool for Lucene Indexes from version 4 to version 8.
  5. Click OK to close the search dialog box.
    All the documents (words) and their related synonyms are displayed in the editor, sorted alphabetically. Expand any document to see its related synonyms.
    Information noteNote: The number of words listed in the Synonym Index editor is set to 20 by default. You can configure this parameter in Window > Preferences > Talend > Profiling > Synonym Index View.
  6. To search for any word and its synonyms:
    • Enter the word in the Synonym Index Search field and then click search; or
    • Press the Enter key.
    Search feature in the Synonym Index editor.

    You must type in the complete word in the search field, otherwise nothing will be displayed in the editor.

Editing a document

Procedure

To edit the documents listed in the synonym index editor, either:

  1. Click Edit all documents on top of the editor.
    A red x is displayed next to each document.
    Cross icon in the Synonym Index editor.
  2. If necessary, click the red x next to the document/synonym you want to delete.

Or,

  1. Right-click a document from the list and select Edit. A dialog box is displayed.
  2. Click the [+] or [x] buttons to add or delete a synonym respectively.
  3. Click OK to close the dialog box.
    The document is modified accordingly in the document list in the synonym editor.
  4. Click the save icon on top of the editor to save your changes.

Inserting a new document

Procedure

  1. Click Insert a new document on top of the editor. A dialog box is displayed.
  2. In the Word field, enter a name for the new document (word).
  3. Click the [+] button to add a line where you can type a synonym for the new word.
  4. Click OK to close the dialog box.
    The new document is created and listed in the synonym editor.
  5. Click the save icon on top of the editor to save your changes.

Deleting one or several documents

Procedure

  1. In the synonym index editor, select the documents you want to delete.
  2. Click Delete selected documents on top of the editor.
    A dialog box is displayed listing the selected documents.
  3. Click OK to close the dialog box.
    The selected documents are removed from the synonym index editor.
  4. Click the save icon on top of the editor to save your changes.

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 – please let us know!