Enable Commerce Search v3 in production

  • Updated

After you successfully test the Commerce Search v3 functionality in your Optimizely Configured Commerce sandbox environment, follow these steps to upgrade production.

Prerequisities

Follow the steps given in Commerce Search v3 prerequisites.

Production steps

Perform the following steps in production:

  1. Review custom extensions.
  2. Integrate with Optimizely Data Platform (ODP).
  3. Create integration jobs to sync user events and historical orders.
  4. Update the search configuration:

    1. Set the Search Indexer Name to Commerce Search v3. Do not yet update the Search Provider Name to Commerce Search v3; use the current Search Provider.

    2. Perform a full index rebuild and confirm it completes successfully.
      • If the rebuild fails or logs show errors or warnings, troubleshoot the issues or contact Optimizely Commerce Support.
      • If unresolved, revert the Search Indexer to the previously used version (v1 or v2) and do not proceed to the next step until the issues are resolved.
      • If the rebuild is successful, run a few additional rebuilds to ensure stability, and wait at least 12 hours before proceeding to the next step.

    3. Ensure the Search Provider Name is correctly set to Commerce Search v3.

    4. Verify that the Autocomplete setting is enabled in the updated Search Provider configuration.
    5. Replicate any other settings and search parameters that were validated in Sandbox and are required in the Production environment.
  5. Revert the Search Provider and Indexer to the previously used version if you encounter issues with the new Search Provider in production. Investigate and resolve the problems, or reach out to Optimizely Support for assistance.

Known issues

Catalog branch switching and search errors

Optimizely has identified a known issue with catalog branch switching when you index products to a new branch. Shortly after a full index rebuild, searches on the newly indexed catalog branch may temporarily fail due to unsynchronized attributes. This results in temporary downtime for storefront product searches and browsing, which can impact the storefront searches.

You should take the following actions to mitigate this issue:

  1. Disable the Catalog Branch Switching setting until the issue is resolved. This is currently under investigation with Google.
    While disabled, products are indexed and served from the same default branch, ensuring consistent search behavior.
  2. Archive or deactivate products rather than delete them. Permanently deleted products that were previously indexed remain as stale entries on the default branch and may still display in search results. If products are sourced from an ERP system, you may need to update the refresh jobs to deactivate products that have been deleted in the ERP.
  3. Avoid changing product types (such as from Primary to Variant), as these changes prevent products from being indexed correctly.
  4. Work with Optimizely Support to eliminate stale products with a branch switch and catalog reingestion. This involves a few manual steps to ensure a smooth transition without production downtime.