IDOL Community Component 12.13

# Highlight Fields

When you run a `Query`, `Suggest`, or `SuggestOnText` action, you can highlight sentences or words in the results that are related to the terms in the query (or the terms in the text or document that you are suggesting on).

The IDOL Content component checks which fields highlighting applies to and then highlights all sentences or words that are based on the terms in the results that it returns.

To set up highlight fields

1. Open the IDOL Content component configuration file in a text editor.

2. List a highlighting process in the `[FieldProcessing]` section. For example:

       [FieldProcessing]
       0=MyFirstProcess
       1=HighlightFields

3. Create a section for each process that you listed, and in each section, create a property for the process (you define the property later by setting one or more applicable configuration parameters). Identify the fields that you want to associate with the process.

   NOTE: The properties that you create must not have the same name as the processes.

   For example:

       [MyFirstProcess]
       Property=MyProperty
       PropertyFieldCSVs=*/MyField,*/MyOtherField

       [HighlightFields]
       Property=Highlight
       PropertyFieldCSVs=*/DRETITLE,*/DRECONTENT

4. Create a section for the property in which you set the `HighlightingType` parameter to `True`. This enables the highlighting of all matched terms that are contained in the associated `PropertyFieldCSVs` fields. For example:

       [Highlight]
       HighlightType=True

5. Save and close the configuration file.

6. Restart the IDOL Content component for your changes to take effect.

NOTE: To use document highlighting with the IDOL View component, you must also specify the IDOL Content component host and port in the `[Server]` section of the IDOL View component configuration file.

© Copyright 2022 Micro Focus or one of its affiliates
Version 12.13 | Last updated October 2022

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to swpdl.idoldocsfeedback@microfocus.com.

We appreciate your feedback!

Product: IDOL IDOL Community Component 12.13

Topic Title: Highlight Fields