Skip to main content

IndexRecordSystemFieldMapping

This page provides generated reference documentation for the IndexRecordSystemFieldMapping data model.

A system field in a index record container

Overview​

PropertySummary
templateProcessDefines a process which delivers a template for the index field.
isFilterableSpecifies, whether a field or filterextension is filterable. Filterable fields will be available for selection by a user.
isLookupFilterFor a column of the lookup component, specifies whether to search for data in it. That is, if a term is entered in the lookup component, it searches for…

templateProcess​

Type: String

Defines a process which delivers a template for the index field.
The process allows to create a composed field using the values of other RecordFields in the document.
The template is generated once before indexing. If the field is multilingual, a template is created for each language of the index. During indexing, the placeholders in the template are filled with the contents of the fields at the specified position of the indexFieldMappings.

NOTE: The indices of the placeholders start at 0, so the actual position is the number viewed in the recordFieldMappings editor minus 1, e.g. #TITLE = 2 (editor) - 1 -> actual index 1.
If the field of the template is multilingual, the entries in the corresponding language are adopted from other multilingual fields. Otherwise, the template will only use the value of the default language.
This option can only be used by single valued fields (isMultiValued == false). If this field is defined as multilingual (isMultiLangauge == true) all other translation settings are ignored.
The locale of the language can be retrieved via vars.get("$local.locale").
var locale = vars.get("$local.locale");
result.string("{0} {1} | " + translate("Phone", locale) + ": {2} | " + translate("Email", local) + ": {3}");
// result (en): "{0} {1} | Phone: {2} | Email: {3}"
// -> Example: "Lisa Sommer | Phone:123 | Email: l.sommer@domain.local"

isFilterable​

Type: Boolean
Default: true

Specifies, whether a field or filterextension is filterable. Filterable fields will be available for selection by a user.

isLookupFilter​

Type: Boolean
Default: true

For a column of the lookup component, specifies whether to search for data in it. That is, if a term is entered in the lookup component, it searches for matches in all columns marked as isFilterable.