This documentation supports the 20.02 version of BMC Helix Platform.

To view the documentation for the current version, select 20.08 from the Product version menu.

Configuring full-text search to refine the search results

After the application business analyst has enabled full-text search on fields, as an administrator, you can configure additional FTS settings to refine the search results.

This topic provides the list of FTS settings that you can configure and provides the configuration steps. 

 FTS configuration settings and their descriptions

The following table describes the FTS configuration settings in BMC Helix Innovation Studio and provides example values for each setting:

Configuration setting name

Description

Values

Full-Text-Case-Option

Indicates whether full-text searching is case sensitive. This setting affects all the FTS-enabled fields. Changes to this setting trigger an automatic re-indexing.

0—Case sensitive (default)

1not case sensitive

Full-Text-Collection-Directory

Provides the location of the directory where the FTS index files are stored.

Default location: <install directory>/arsystem/tenant/<tenant name> /ftsconfiguration/collection

Full-Text-Configuration-Directory

Provides the location of the directory where the FTS configuration files are stored.

Example, configuration files for the words-to-ignore and synonyms list.

Default location: <install directory>/arsystem/tenant/<tenant name> /ftsconfiguration/conf

Full-Text-Disable-Indexing

Indicates whether the FTS server processes pending indexing tasks.


F— Do not disable indexing (Default).

T—Disable indexing. Pending indexing tasks are processed after indexing is enabled.

Full-Text-Disable-Searching

Indicates whether the BMC Helix Platform server uses the full-text search engine.

F— Use the full-text search engine (Default value).

T—Disable the full-text search engine.

Note: The database search capability continues to work even after the full-text search engine is disabled.

Full-Text-Exclude-ListContains the extensions of files that must be excluded from the full-text search.

Example: .pdf, .xml, .png, and so on.

Full-Text-Ignore-Word-ListContains words to be ignored during FTS. Search results will not contain the words that are added in this list.

Articles (a, an, the), prepositions (in, on, from, front, besides), and so on.

Press Enter to add a new word in this list.

Full-Text-Indexer-Log-FileGives the location of the directory where the FTS index log files are stored.Default location: <install directory>/arsystem/tenant/<tenant name>/db
Full-Text-Match-Option

Indicates how the FTS server modifies search queries.

0—Force leading and trailing wildcards.

1—Ignore leading and force trailing wildcards.

2—Ignore leading wildcards.

3—Remove leading and trailing wildcards.

4—Leave query unchanged (Default value).

Full-Text-Synonyms

Contains synonyms so that when the end-user searches for any of these words, resources related to its synonyms also appear in the search results. 


PC workstation laptop desktop computer

slow sluggish

bright shiny

Type a word followed by its synonyms separated by a space. Press Enter to add a new list of synonyms. 

MFS-Environment-Field-Weight

Defines the relevancy weight for the Environment field. This setting relates to the fields for which the application business analyst has defined the relevancy when Enabling full-text search capabilities in your application.

Default value: 1


MFS-Keywords-Field-WeightDefines the relevancy weight for the Keyword field. This setting relates to the fields for which the application business analyst has defined the relevancy when Enabling full-text search capabilities in your application.

Default value: 2


MFS-Title-Field-WeightDefines the relevancy weight for the Title field. This setting relates to the fields for which the application business analyst has defined the relevancy when Enabling full-text search capabilities in your application.

Default value: 4


Full-Text-ReindexInitiates the re-indexing of all FTS-enabled fields.

0Re-indexing is not performed. (Default)

1Starts re-indexing.

To configure FTS settings 

  1. Log in to BMC Helix Innovation Studio and navigate to the Administration tab.
  2. Select Configure My Server > Centralized Configuration Settings > Centralized Tenant Configuration, as shown in the following image:

    • To configure a new setting, click Add Setting
    • To edit a setting, select the checkbox that corresponds to the setting you want to edit and click Edit.
  3. From the Setting Name list, select the FTS setting to be configured. 
  4. In the Setting Value, provide the appropriate value for the selected setting. 
  5. Click Save

Note

In a server group, if you configure the settings on one server, the configuration settings get updated in all other servers in the server group.

Related topic

Enabling full-text search in fields

Search capabilities for custom applications

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

Comments