Skip to content
ExamineX
These docs are for ExamineX 11 · Umbraco 19 (pre-release). For the current release see ExamineX 6–10 · Umbraco 13–18.

Index and field names

Azure Search has some limitations on it’s allowed naming conventions for index and field names. ExamineX will automatically re-format invalid names into valid names.

Generally you won’t have to worry about this because any custom field names defined in Examine will be returned correctly in the search results even though the actual field name in Azure AI Search may be different. This is handled internally by Azure AI Search field mappings. For example, Examine’s own naming conventions for ‘system’ fields are prefixed with double underscores like __NodeId. This field name is invalid in Azure AI Search so is prefixed with x so the end result is x__NodeId.

Index names however are not so transparent since to access an Index in Examine it needs to be by it’s exact name. Therefore if you create a custom index with an invalid name you’ll need to check in the Azure portal to see what ExamineX has named the index. Index names in Azure AI Search must: Start with a letter, use only lowercase letters, digits, or dashes (”-”), and have a limit of 60 characters. ExamineX will automatically transform any provided index name to align to these rules. For example, if you’re custom index name is My Product Index, the resulting name will be my-product-index.

The ExamineX.SiteFriendlyName setting is used to prefix the index names in your Azure AI Search service, so you can use one Azure AI Search service for multiple Umbraco websites. Umbraco Search creates these indexes, and you reference them in your code by these names:

  • Umb_Content (Constants.Search.IndexAliases.DraftContent)
  • Umb_PublishedContent (Constants.Search.IndexAliases.PublishedContent)
  • Umb_Media (Constants.Search.IndexAliases.DraftMedia)
  • Umb_Members (Constants.Search.IndexAliases.DraftMembers)
  • Umb_Elements (Constants.Search.IndexAliases.DraftElements)

As an example, if your Site Friendly name is “Sam’s Adventure Site”, the indexes in your Azure AI Search service would be:

  • sam-s-adventure-site-umb-content
  • sam-s-adventure-site-umb-publishedcontent
  • sam-s-adventure-site-umb-media
  • sam-s-adventure-site-umb-members
  • sam-s-adventure-site-umb-elements

These names are index aliases which point to a physical index that has a timestamp suffix: yyyyMMddHHmmss, for example sam-s-adventure-site-umb-publishedcontent-20240202122515. Each physical index has an indexer with the same name, which ExamineX uses to store the field name mappings. This is used to rebuild indexes with zero downtime. When querying your indexes outside of ExamineX, use the alias name.