Skip to content
Last update: April 11, 2024

Indexing via Platform Manager

To initiate the indexing process:

  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

  3. Check the required record types from the list.

  4. Click Build index in the top toolbar.
  5. 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.

    Readmore Blue-Green Indexing


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

The next blade displays the result of indexation:

Indexation result

Viewing Index Document

The Platform Manager allows you to preview index document data without writing any code:

  1. Click Catalog in the main menu.
  2. In the next blade, select the required store, then select the required product.
  3. In the product blade, click on the index widget.
  4. In the next blade you can preview a raw JSON data being used for the document that is stored in the index storage.

Viewing index document

Incremental Index Updates

Virto Commerce can update search indexes incrementally in the background by tracking entity changes and injecting changed entities into the index.

Various modules have their own jobs and settings. For example, the Catalog module has two types for incremental indexing:

  • Event-based: Indexing is triggered when a product gets changed.
  • Time-based: A background job checks and re-indexes modified objects every X minutes (5 by default). This type is disabled by default.

To disable/ enable event-based indexing:

  1. Click Settings in the main menu.
  2. In the next blade, type Search to find settings related to the module.
  3. Select Enable event-based indexing for the required module.
  4. In the next blade, switch the option to off or on.
  5. Click Save in the top toolbar to save the changes.

Enabling event-based indexing

Your settings have been saved.