customMetadataIndexingSettings

Content Platform Tenant Management Help

Version
9.7.x
File Size
4269 KB
Audience
anonymous
Part Number
MK-95HCPH002-19

The customMetadataIndexingSettings data type describes the customMetadataIndexingSettings resource for namespaces.

Properties

The table below describes the properties included in the customMetadataIndexingSettings data type.

Property name Data type Description Notes
contentClasses List

Associates zero, one, or more content classes with the namespace. Valid values are the names of existing content classes.

Content class names are case sensitive.

The set of content classes specified in the request body replaces the set of content classes currently associated with the namespace. To dissociate all content classes from the namespace, specify an empty set.

In XML, element that identifies each content class is name. In JSON, the name in the name/value pair that lists the content classes is name.

fullIndexingEnabled Boolean

Specifies whether the metadata query engine indexes the full text of custom metadata. Valid values are:

true
The metadata query engine indexes the full text of custom metadata.
false
The metadata query engine does not index the full text of custom metadata.

The default is false.

You can set this property to true only while custom metadata indexing is enabled for the namespace.
excludedAnnotations String

Specifies a comma-separated list of the names of annotations to be excluded from indexing by the metadata query engine.

Instead of explicit names, you can use patterns. The wildcard character for pattern matching is the asterisk (*), which matches any number of characters of any type, including none. The asterisk can occur anywhere in the pattern.

Annotation names are case sensitive.

The list of annotation names you specify for this property replaces the current list of annotation names. To remove all annotation names from the list, specify this property with no value.

You can set a value for this property only while custom metadata indexing is enabled for the namespace.

Disabling custom metadata indexing for the namespace automatically deletes the list of excluded annotation for the namespace.

Example

Here’s an XML example of the customMetadataIndexingSettings data type:

<customMetadataIndexingSettings>
    <contentClasses>
         <name>DICOM</name>
         <name>Appointment</name>
    </contentClasses>
    <excludedAnnotations>misc*, email</excludedAnnotations>
    <fullIndexingEnabled>false</fullIndexingEnabled>
</customMetadataIndexingSettings>