This documentation supports the 20.08 version of BMC Helix Platform. 
To view an earlier version, select 20.02 from the Product version menu.

Enabling full-text search in fields

As an application business analyst, you can enable full-text search (FTS) on the required fields in your application. 

You can enable FTS on the following fields:

  • Text fields
  • Attachment fields

The following table lists the tasks required to enable the FTS:

TaskReference
Enable FTS on text or attachment fields.To enable FTS on fields

(Optional) Define the search category for text FTS fields.

When a full-text search is triggered, the search engine references the search category name along with the FTS index.

To add search category name to FTS-enabled fields

(Optional) Define the search relevancy of FTS-enabled fields.

Defining the search relevancy helps in sorting the search results so that the results with the most occurrences of the relevant word or phrase appear at the top. 

To define search relevancy of the FTS-enabled fields

Before you begin

Ensure that you have created a record definition and added the fields for which you want to enable FTS in that record definition. 

Note

Full-text search configuration is not carried forward in a Join record definition.

FTS-enabled fields and their category names are carried forward in an inherited record definition. The application business analyst must define the relevancy of FTS-enabled fields in the inherited record definition.

 To enable FTS on fields

  1. Log in to BMC Helix Innovation Studio and navigate to the Workspace tab. 
  2. Select the application for which you want to use FTS. 
  3. On the Records tab, click the record definition that contains fields for which you want to enable FTS.
  4. In General, click Add/Remove Search Fields.
  5. On the Add/Remove Search Fields dialog box, click Add Search Fields, and complete the following fields:
    • Field—From the list, select the field for which you want to enable FTS.
    • Search Category Name—Enter a search name for the field.
  6. Click Save.

 (Optional) To add a search category name to FTS-enabled fields 

You can add the search category name only to text fields that are FTS-enabled. 

  1. Log in to BMC Helix Innovation Studio and navigate to the Workspace tab. 
  2. On the Records tab, select the record definition in which you have enabled FTS on the fields. 
  3. Select the FTS-enabled field for which you want to add the search category name. 
  4. On the Field Properties  tab, in the DETAILS section, in Search Category Name, type the search term for the selected field.
    For example, If you have selected the Description field, you can add an issue as the search category name. 
  5. Click Save

How search relevancy works for FTS enabled-fields 

After you have enabled FTS on the required fields, you can define the relevancy of the FTS-enabled fields.

You can add the fields that represent the title, system environment, or keyword in the record definition. The default relevancy by the number of occurrences starts with record definition title field (highest), followed by keyword fields, and then environment.

For example, when the end-user performs a search, the search results display the records with the most occurrence of the word or phrase entered in the Title Field (that has the most relevancy), followed by the Keywords Field and the Environment Field

 (Optional) To add the search relevancy for FTS-enabled fields

  1. Log in to BMC Helix Innovation Studio and navigate to the Workspace tab. 
  2. Select the application for which you want to use FTS. 
  3. On the Records tab, click the record definition that has the FTS-enabled fields. 
  4. Navigate to the Record properties > Search
  5. In the Title Field list, select the field that represents the title of the record definition.
    For example, you can select Case Summary because the text entered in this field is more likely to represent the title. 

  6. In the Environment Field list, select the field that represents the computer environment. 
    For example, you can select the Operating System because the text entered in this field is more likely to represent the environment. 
  7. In the Keywords Field list, select the field that represents the search keywords. 
    For example, you can select Description because the text entered in this field is more likely to contain search keywords. 

    Notes

    • You cannot add the same field in more than one relevancy—title, keyword, or environment.
    • If you are unable to see the FTS-enabled fields in the Title, Environment, or Keywords fields, ensure that you have saved the record definition after enabling FTS on the fields.
  8. Click Save

Related topics

Configuring full-text search to refine the search results

Search capabilities for custom applications

Was this page helpful? Yes No Submitting... Thank you

Comments