Overview

This toolkit element provides top-level control to the search-indexing of metadata, entities, and associations.

Format

{
	"display": string,
	"searchIndex": {
        "entityFilter":string, // (regex applied to entity indexes, plus starts with "+" or "-" to indicate inclusion/exclusion, defaults to include-only)
        "assocFilter":string, // (regex applied to new-line separated entity indexes in associations, starts with "+" or "-" to indicate inclusion/exclusion, defaults to include-only)
        "entityGeoFilter":string, // (regex applied to entity indexes if the entity has geo, starts with "+" or "-" to indicate inclusion/exclusion, defaults to include-only)
        "assocGeoFilter":string, // (regex applied to new-line separated entity indexes in associations with geo, starts with "+" or "-" to indicate inclusion/exclusion, defaults to include-only)
        "fieldList": [ string ], // (comma-separated list of doc fields, starts with "+" or "-" to indicate inclusion/exclusion, defaults to include-only)
        "metadataFieldList": [ string ],   // (comma-separated list of doc fields, starts with "+" or "-" to indicate inclusion/exclusion, defaults to include-only)
	}
}

Description

The following table describes the parameters of the search index settings configuration.

Parameter	Description
entityFilter	(regex applied to entity indexes, plus starts with "+" or "-" to indicate inclusion/exclusion, defaults to include-only)
assocFilter	(regex applied to new-line separated entity indexes in associations, starts with "+" or "-" to indicate inclusion/exclusion, defaults to include-only)
entityGeoFilter	(regex applied to entity indexes if the entity has geo, starts with "+" or "-" to indicate inclusion/exclusion, defaults to include-only)
assocGeoFilter	(regex applied to new-line separated entity indexes in associations with geo, starts with "+" or "-" to indicate inclusion/exclusion, defaults to include-only)
fieldList	(comma-separated list of doc fields, starts with "+" or "-" to indicate inclusion/exclusion, defaults to include-only)
metadataFieldList	(comma-separated list of doc fields, starts with "+" or "-" to indicate inclusion/exclusion, defaults to include-only)

Examples

Indexing Metadata

The source example indicates how to include all discovered metadata values into the search index. The string encompasses all returned values.

},        {
            "searchIndex": {
                "metadataFieldList": ""
            }
        }
    ]
}

Footnotes:

Legacy documentation:

Source configuration objects under "searchIndexSettings"