Skip to content
Last update: April 11, 2024

Manage Search Index

To open search index details:

  1. Click Search Index in the main menu.
  2. The next blade displays:

    • The managed record types:

      • Members: Users or entities that have access to the platform.
      • Content files: Any type of digital content stored within the platform.
      • Product: The goods or services offered for sale within the Virto Commerce platform.
      • Category: Similar characteristics used to organize and classify products within the platform.
      • Customer order: Transactions where customers purchase products or services from the platform.
    • The search provider for each record type:

      • Elastic App Search.
      • Elasticsearch 8.
      • Lucene.
      • Elasticsearch.
      • Azure Cognitive Search.
      • Algolia.


      You can tailor the search provider per document type to optimize search performance and functionality.

    • Last indexed date, record count, and scope if specified by the user:

    Search index

Build Search Index

To build search index:

  1. Check the required record types from the list.
  2. Click Build index in the top toolbar.
  3. In the popup window, choose how you want to update the search index. There are two options available:

    • Build: Index all data without recreating.
    • Delete and build: Delete the existing search index and build a new one from scratch.


    No search results will be available until the build process is over.

The next blade displays the result of indexation:

Indexation result

Blue-Green Indexing


The blue-green indexing is only supported by the ElasticSearch module.
Readmore Elastic Search module

After you choose Delete and build when building search index:

  1. A new backup index is generated for the chosen document type.
  2. The indexing operations are carried out on this backup index.
  3. Throughout the full indexing process, the existing index remains unaffected, allowing uninterrupted search operations.
  4. Once the reindexing is complete, a swap occurs: the backup index becomes active, while the previous index transitions to a backup role.

To revert to the previous index, use the Swap indices feature:

  1. Click Show backup indices in the top toolbar.

    Backup indices

  2. Click on the three dots to the left of the required document type.

  3. Select Swap indices in the popup menu.
  4. Click Hide backup indices in the top toolbar.

    Three dots

The roles of the backup and active indices have been exchanged.

Implementation Details

Elasticsearch implements blue-green indexing using Elasticsearch aliases. Search provider implementations use two aliases to distinguish one index role from the other: active and backup. The full index alias is built as scope name + document type name + alias name; for example, an active index alias for the Members index using the default scope will be default-member-active.

Each time you start the Delete and build process, the Elasticsearch index provider looks for an existing backup index by the backup alias, for example, default-member-backup, and deletes it if it is found. After that, when the reidnexing process starts, a new backup index is created with the `backup' alias. However, an actual index name is created dynamically: this is a special alphanumeric token suffix added to the end of the index name. The only way to tell which index is active is to look at its alias. After the indexing process is complete, the active and backup indices swap aliases, i.e. the active index becomes the backup index, and vice versa.

Kibana index alias