AdditionalSearchTerms Property

Article
02/26/2024

Version: Available or changed with runtime version 3.0.

Specifies search terms (words and phrases) for the page. In addition to the page caption, the terms are used by the search feature in the Web client and mobile apps. Separate terms with a comma.

Applies to

Page
Report

Parameters

Locked
Type: Boolean
If true the AdditionalSearchTerms is locked and should not be translated.

Comment
Type: Text
Descriptive text for the AdditionalSearchTerms, for example, with regards to translation.

MaxLength
Type: Integer
Sets the maximum length of the specific AdditionalSearchTerms.

Property Values

Value	Description
`<term>`	The search word or phrase, which can consist of letters, numbers and special characters. Separate each term by a comma.

Syntax

AdditionalSearchTerms = '<term>[,<term>]';

Or, with parameters:

AdditionalSearchTerms = '<term>[,<term>]'[, Locked = true|false][, Comment = '<instructions for translation>'][, MaxLength = <number of characters, like 20>];

Remarks

For Business Central on-premises, the Business Central Web Server configuration file (navsettings.json) includes a setting called UseAdditionalSearchTerms that enables or disables the use of additional search terms by the Tell me. For more information, see Configuring Business Central Web Server Instances.

Dependent Properties

The UsageCategory property must be set to a value other than None in order for the page to be searchable by Tell me.

Example

The following code snippet uses the AdditionalSearchTerms property to add two search terms, product and merchandise, to a list page whose caption is Items.

page 50100 MyItems
{
    PageType = List;
    ApplicationArea = All;
    SourceTable = Item;
    UsageCategory = Lists;
    Caption = 'Items';
    AdditionalSearchTerms = 'product, merchandise';
    ...
}