Object index

Content Platform Tenant Management Help

File Size
4269 KB
Part Number

To support object-based queries, HCP maintains an index of objects in the repository. This index is based on object paths, system metadata, custom metadata that’s well formed XML, and ACLs.

Namespace indexing

Indexing is enabled on a per-namespace basis. If a namespace is not indexed, object-based queries do not return results for objects in the namespace.

HCP periodically checks indexable namespaces for new objects and for objects with metadata that has changed since the last check. When it finds new or changed information, it updates the index. The amount of time HCP takes to update the index depends on the amount of information to be indexed. New or changed information is not reflected in the results of object-based queries until the information is indexed.

Indexing of custom metadata can be configured in these ways:

  • Specific content properties can be indexed.
  • Specific annotations can be excluded from being indexed. An annotation is a discrete unit of custom metadata
  • Custom metadata contents can be optionally indexed for full-text searching.

If indexing of custom metadata is enabled for a namespace, these rules determine whether custom metadata is indexed for an object:

  • The custom metadata must be well-formed XML
  • The custom metadata must be smaller than one MB.
  • The object must have an index setting of true.
  • If custom metadata is not indexed for an object, object-based queries that are based on custom metadata do not return results for that object.

Content properties

A content property is a named construct used to extract an element or attribute value from custom metadata that's well-formed XML. Each content property has a data type that determines how the property values are treated when indexing and searching.

A content property is defined as either single-valued or multivalued. A multivalued property can extract the values of multiple occurrences of the same element or attribute from the XML.

The XML below shows XML elements with multiple occurrences of two elements, date and rank within the element WeeklyRank.

        <date> dd/MM/yyyy </date>
        <rank> (rank) </rank>
        <date> dd/MM/yyyy </date>
        <rank> (rank) </rank>
        <date> dd/MM/yyyy </date>
        <rank> (rank) </rank>

If the WeekyRank object property specifies the record/weeklyRank/rank entry in the XML, the property is multivalued.