Upgrading to new Sitecore Module Version


How to upgrade from Sitecore Module v1.3 to v1.4

SearchStax released the latest version of its SearchStax for Sitecore package which contains several new features and bug fixes. If you are still using SearchStax for Sitecore 1.3 you should think about upgrading it in order to leverage all this. This document shows how you can upgrade from a previous version to 1.4.

Start by downloading the new package version from here

There are a few changes in the structure of the SearchStax configuration files between versions 1.3 and 1.4, so before going ahead and installing it using the Sitecore Installation Wizard you need to save a backup of your current files for the following:

  • \App_Config\Modules\SearchStax\SearchStax.Cloud.config
  • \App_Config\Modules\SearchStax\SearchStax.Connector.Provider.config

Keep those files in a separate folder and install the new 1.4 package using Sitecore Installation Wizard.

Make sure you select “Yes to all” when asked to overwrite files:

And make sure you select “Overwrite” when asked to overwrite Sitecore items:

Once the installation is done, you don’t need to open the configuration page to configure the search index cores. Instead, open the App_Config\Modules\SearchStax folder and you should see the following files:

You can delete the SearchStax.Connector.Provider.config.disabled. After this, get your backed up files and replace both SearchStax.Connector.Provider.config and SearchStax.Cloud.config by your files. Open both files using an editor and let’s change their content to match the structure expected by the new version of the package.

SearchStax.Connector.Provider.config

For each configured SearchStax index you have, find the following line:

  • <param desc=”name”>$(id)</param>

And change the node value from $(id) to the index core name you want to use (example: SearchStax-Index-Core). Please note that this value must be lowercased, so if it has some capital letters change them to small letters:

  • <param desc=”name”>searchstax-index-core</param>

Find the computed field RenderedContent and change the returnType from “string” to “text”.

Find the computed field ResultTitle and change the returnType from “string” to “text”.

Find the computed field HasPersonalization and remove the entire <field> node from the list of computed fields.

SearchStax.Cloud.config

For each configured SearchStax index you have, find its <cloud> node and add the following line as a child node:

  • <AnalyticsEndpoint>ANALYTICS_URL_HERE</AnalyticsEndpoint>

Make sure you replace the token ANALYTICS_URL_HERE for the right analytics URL value for your index core. This value can be easily found on https://searchstudio.searchstax.com/apps-management:

Rebuild Index

Since you’ve changed the return type of some computed fields, it’s mandatory that you perform a full index rebuild operation to update this on SearchStax side. This can be done using the Sitecore Indexing Manager. Make sure you publish your website before rebuilding your index, since SearchStax targets the web database:

Update Field Mapping on SearchStax

In case your Search App is using one of the computed fields we’ve changed the return type, you need to update them on SearchStax too. Make sure you replace the old Solr fields (suffixed with _s) by the new Solr fields (suffixed with _t) on both Results Configuration (https://searchstudio.searchstax.com/search-configuration) and Relevance Modeling for each search model you may have.

Sitecore Experience Accelerator

In case you are using SXA, please make sure you also upgrade the SearchStax for Sitecore SXA package from 1.3 to 1.4.

Download it using the following link and use the Sitecore Installation Wizard to install it.

Make sure you select “Yes to all” when asked to overwrite files:

And make sure you select “Overwrite” when asked to overwrite Sitecore items:

In case you already have SXA search pages using the SearchStax SXA rendering, you need to make sure it has a data source item. Create an item using /sitecore/templates/Feature/SearchStax SXA/SearchStax Settings templateand set it as the data source of your rendering:

Publish everything to web and you should be able to use your SXA search pages without any further change.