Skip to content

Searchcollection

Class: metadata

Search collections allow you to create and edit groups of documents and objects that users can search at the same time as expanded searches.

Learn about Search Collections in Vault Help.

Attribute	Metadata	Description
`label`	Type: String Max length: 60	UI-friendly string in the Vault's base language.
`active`	Type: Boolean	Indicates whether the component is active.
`description`	Type: String Max length: 255	A description of the collection which users see when they click the question mark (?) icon on the expanded search results page.

Searchcollectionsection

Attribute	Metadata	Description
`label`	Type: String Max length: 60	UI-friendly string in the Vault's base language.
`active`	Type: Boolean	Indicates whether the component is active.
`document_type`	Type: Component	The document type to include in the collection.
`include_on_tab`	Type: Boolean	If `true`, allows expanded searches on the collection in the related tab, if one is available for the selected object.
`object`	Type: Component	The object to include in the collection.
`object_relationships`	Type: String Max length: 1500 Multi-value	Relationships to objects in the collection. Each value must include a valid inbound relationship. You can configure object relationships from Admin > Configuration > Objects > {Object} > Relationships.
`object_type`	Type: Component Multi-value	The object type to filter on, if object types are enabled for the selected `object`.
`tab_assignments`	Type: String Max length: 255 Multi-value	If `include_on_tab` is `true` and the `object` has more than one tab available, specifies the tabs where users can access the collection.
`vql_criteria`	Type: String Max length: 1500	A Criteria VQL expression that defines the search scope of this collection.

Supported Operations

Operation	Support
Create
Recreate
Alter	^*
Drop
Rename
Describe
Generate Recreate
Queryable

Notes:

Alter: MDL Operation may not be supported for some multi-value attributes.