Upgrading S4S

Owned by Karl Tompson
Last updated: Mar 02, 2023
2 min read

S4S is built against specific versions of Sitecore libraries. When upgrading Sitecore versions you should upgrade to the matching S4S release. We also periodically release S4S updates with fixes and new features.

Identifying the correct S4S version

The beginning of the second part of the S4S build number matches the Sitecore major version. For example:

  • S4S 2.1031.XXXXX for Sitecore 10.3

  • S4S 2.1021.XXXXX for Sitecore 10.2

Changes and prerequisites

Accompanying the S4S zip file is an S4S <version> Upgrade ReadMe.txt file. This will have details of any specific changes between versions that may need consideration.

There is also a ReadMe.txt file in the root directory of the installation zip. This includes any instructions specific to the release being installed. While you’re there, check out ReleaseNotes.txt to see what changes are included.

If you are using analytics functionality and making a major Sitecore version upgrade, you may also need to update the Salesforce package. Check which version is required.

Backup

Always back up your previous installation! Aside from a full backup, it can also be handy to have copies of customized configuration on hand for comparison:

  • /App_Config/Modules/S4S/*.config files

  • Sitecore database nodes can also be temporarily copied prior to update if you’ve made customizations:

    • /sitecore/system/Modules/S4S

Installation

Upgrades use the same installation process as a fresh install, but take care to avoid overwriting your customizations.

Install the package zip from the Sitecore Installation Wizard. If you want to be extra cautious, you can step through each component during upgrades rather than choosing a “to all” option.

The Sitecore installation can be repeated as many times as you like. If not sure about overwriting something you can choose to Skip, then come back and install it again later if needed.

Files

The following files should always be overwritten:

  • /bin.*.dll

  • /sitecore/admin/*

  • /sitecore/shell/*

We also recommend moving or copying config files prior to installation, and installing all new files. Compare the old and new after installing and make any changes required to ensure that your customizations are intact, and any new settings are present.

Database items

Sitecore will overwrite entire nodes of database items if you choose the Overwrite option at installation. This includes any custom children even if not present in the package.

We recommend using the Merge > Merge option for database items. This will generally avoid accidental deletion of child items not included in the package (like form wizard mappings!) and overwrite items that are part of the base install.

  • The most likely locations for customizations will be in the master database under /sitecore/system/Modules/S4S. This includes form wizard mappings and analytics facet customizations.

  • Other locations and core database items are less likely to have custom changes.

  • If your Sitecore installation uses multiple languages, you may have published alternate language versions or enabled fallback for some items. These changes may need to be re-applied after installation.

xConnect models

If you’re using xDB, don’t forget to copy in the updated xConnect model files.

CD/CM

For Sitecore installations with a separate CD instance, some additional files will likely need to be copied over.