Property description

The settings property switches on the behavior of a search area — whether it searches in attribute values, which specialized search it represents, and how much context appears around a search result.

Minimal JSON

{
  "key": ""
}
{
  "key": "form",
  "searchIndexKey": "recipe_tutorial_index",
  "iconKey": "core_default_search",
  "settings": [
    {
      "key": "is_fulltext_search"
    },
    {
      "key": "result_text_lines_before",
      "value": 2
    },
    {
      "key": "result_text_lines_after",
      "value": 1
    }
  ],
  "template": {}
}

Nested properties

PropertyDescriptionValuesMandatory
keyUnique key of the setting.string*Yes
valueValue of the setting. Type depends on the setting — see supported key values. For boolean settings, the default is true.boolean, integer, or stringNo

Supported key values

Search behavior

NameData TypeUsage
is_fulltext_searchbooleanSearches in attribute values and highlights the matched text in the result. Special characters in the search term are escaped, so terms containing brackets or asterisks are searched literally. In this mode the object name is not highlighted — the highlight appears in the result text instead.
replace_synonymsbooleanDetermines whether looking up synonyms or acronyms in this search area returns the original object. Requires a relation type with the following features:
  • Relation type: Feature
  • has_synonym: is_relation_type_synonym_of
  • has_acronym: is_relation_type_acronym_of
Tip

Highlighting works on attributes indexed as text. An attribute type carrying the is_search_type_term feature is indexed as an exact-match term instead, so its value is neither highlighted nor searched word by word — see attribute type search features.

Search area type

Each of these marks the search area as a specialized search. Set at most one per search area.

NameData TypeUsage
is_add_relation_search_formbooleanMarks the search area used by the dialog for adding a relation between objects.
is_all_object_search_formbooleanMarks the search area over the all-object index. Package installation resolves the default search index from this form.
is_codelist_search_formbooleanCode list search area — results are grouped by code list.
is_default_object_search_formbooleanMarks the default object search area, used when object types are mapped to a search index.
is_file_script_search_formbooleanScript search area — searches in scripts and offers folder facets.
is_model_changes_search_formbooleanData model changes search area — results are grouped by model.
is_sample_data_formbooleanSample data search area — row-level data grouped to one result per table.
is_tokenizer_definition_formbooleanMarks the search area over the index that holds tokenizer definitions.

Result text

NameData TypeUsage
result_text_lines_afterintegerNumber of text lines shown after the highlighted term in a search result.
result_text_lines_beforeintegerNumber of text lines shown before the highlighted term in a search result.
Warning

Starting from version 2026.2, these values are no longer in the search form template as resultTextLinesBefore and resultTextLinesAfter. Existing packages are migrated automatically; new packages should set them here.