search (package settings)

Property description

The search property in the settings section of a package configures the global search settings for the entire package.

{ "isSearchable": true }

Property	Description	Values	Mandatory
`isSearchable`	Determines whether objects and attributes in this package are included in search results.	boolean	Yes
`applicationKey`	Key of the application the search settings apply to.	string	No
`attributeTypeKey`	Key of the attribute the search settings apply to.	string	No
`boost`	An advanced feature that specifies the boost score used for ordering.	double	No
`description`	Description of the property.	string	No
`functionKey`	Key of the import function, which defines what is imported into the search and in what way. Supported values are: mr_object_import_func, mr_object_file_import_func, mr_space_import_func, model_changes_index_func, codelist_import_func, sample_data_import_func	string	No
`indexKey`	Key of the ElasticSearch index to which the application will be imported. See supported `indexKey` values.	string	No
`objectTypeKey`	Key of the object type the search settings apply to.	string	No
`searchAttachments`	Determines whether attachments are searchable.	boolean	No
`spacePath`	Space path including subspaces. For example, the current space is S2 and its parent space is S1, then `spacePath` will be S1/S2.	string	No
`tagKey`	Search import mode. See supported `tagKey` values.	string	No

Value	Description
`#all_object_search_index`	Indexes all objects. Used when adding relations, creating links, or embedding text into another object.
`#codelist_search_index`	Indexes code list keys and values for search.
`#codelist_search_index_desc_cs`	Indexes Czech-language descriptions of code list entries for search.
`#codelist_search_index_desc_en`	Indexes English-language descriptions of code list entries for search.
`#codelist_search_index_desc_fr`	Indexes French-language descriptions of code list entries for search.
`#file_script_search_index`	Indexes the content of uploaded files and scripts to make them searchable.
`#model_changes_search_index`	Indexes changes to models (conceptual, logical, semantic) to support search and change tracking.
`#object_search_index`	Indexes objects for default object search (by name) and for full-text search (in object content).
`#sample_data_search_index`	Indexes sample datasets linked to objects, attributes, or reports for search.

Tip

Make sure to use the hash symbol (#) for the package to look for the key globally and not only in the same package.

Value	Description
`import_file`	Object attachments are imported.
`import_model_changes`	DataDictionary ModelChanges are imported.
`import_no_attributes`	Objects are imported without their attributes.
`import_object`	Objects are imported based on the ImportFunction.
`import_space`	Imports space details to be able find it in search.
`no_import`	Objects are not imported.