Sitecore Commerce 10 Initial Release – Step by step Install Guide on your machine

This is a summary of my experience with the Sitecore Experience Commerce 10.0 Initial Release (aka Sitecore XC 10.0.0) installation on my machine. I’ve had much experience in the following ones:

So I decided to go only with:

XC Installation Guide for On Premise (Thanks Sitecore team!)

I do hope that this blog post is helpful for your journey as well.

Note: personally, I wanted to use my own install directory rather than the default one

Setup Prerequisites

Please refer to the Sitecore Experience Commerce Compatibility Table for the software and version prerequisites:

Step-by-step guide

install the ones below if you have not yet
- a fresh Sitecore XP 10.0 Initial Release instance , let’s say storefront100.local and storefront100.xconnect.local (xConnect site)
- download and install ASP.NET Core Runtime 3.1.6 (or later) Hosting Bundle (Note: don’t forget to restart the OS)
- download and install Redis 3.0.504 or later
rebuild the Link databases for the master and core databases if not yet:
- on the Sitecore Launchpad, click Control Panel, and in the Database section, click Rebuild Link Databases
- select the master and core databases and then click Rebuild
rebuild the search indexes if not yet:
- on the Sitecore Launchpad, click Control Panel, and in the Indexing section, click Indexing manager
- in the Indexing Manager dialog box, click Select all, and then click Rebuild
ensure that Experience Analytics is working properly
- Note: if there is any error
  - option 1: you will have to solve it before installing XC by opening the Sitecore log and then having a look at the error messages (normally, they’re certificate issues)
  - option 2: you may want to disable xDB and then fix the error later after installing XC successfully
create a new folder D:\sc100_com_install
download MSBuild Microsoft Visual Studio Web targets (available from Nuget) then extract the Web targets package, copy the tools\VSToolsPath\Web\Microsoft.Web.XmlTransform.dll file into D:\sc100_com_install
download Sitecore PowerShell Extensions 6.0 for Sitecore 10.0 and put it into D:\sc100_com_install
download Sitecore Experience Accelerator 10.0 and put it into D:\sc100_com_install
download and unzip Packages for On Premise WDP 2020.08-6.0.238 then put it into D:\sc100_com_install
unzip D:\sc100_com_install\SIF.Sitecore.Commerce.5.0.49.zip and then rename D:\sc100_com_install\SIF.Sitecore.Commerce.5.0.49.zip to D:\sc100_com_install\SIF for a better practice
override the following files in order to inject the custom install directory of Commerce’s sites
- open raw and then copy / paste Master_SingleServer.json into D:\sc100_com_install\SIF\Configuration\Commerce
- open raw and then copy / paste CommerceEngine.json into D:\sc100_com_install\SIF\Configuration\Commerce\CommerceEngine
- open raw and then copy / paste CommerceEngine.Instance.Deploy.json into D:\sc100_com_install\SIF\Configuration\Commerce\CommerceEngine
- (optional) download + unzip Configuration.zip and then copy / paste all to D:\sc100_com_install\SIF
download sc100_com_install.ps1 and put it into D:\sc100_com_install\SIF then open it to correct the following parameters if necessary
- $ScInstallDirectory
- $SiteNamePrefix
- $SiteHostHeaderName
- $SitecoreDbServer
  - ensure using double back slash if any
- $SqlUser
- $SqlPass
- $SolrUrl
- $SolrRoot
- $SolrService
- $CommerceEngineConnectClientSecret: refer to Step 13 below
  - deployment fails if you don’t provide a qualified value for this parameter
(optional) create a secret client certificate
- refer to 2.3. Create a secret client certificate (Page 12) in XC Installation Guide for On Premise
- Note: you can download the above PowerShell script and then
- open Windows PowerShell
- note the generated client script and then replace the value of $CommerceEngineConnectClientSecret
(optional) correct the SitecoreUserName and SitecoreUserPassword of your Sitecore XP 10.0 instance if you’re using others rather than the default ones
(optional) you can specify any local account (note: it will be created automatically if non-existent) to be set up for the various application pools that are created as part of the deployment
let’s install it
- Note: ensure that there is NO custom AllowedCorsOriginsGroup in D:\sc100_com_install\SIF\IdentityServer\Sitecore.Commerce.IdentityServer.Host.xml (they’re added automatically in prior installations) by reverting Sitecore.Commerce.IdentityServer.Host.xml
- launch PowerShell as an administrator
- change directory to D:\sc100_com_install\SIF
- execute .\sc100_com_install
- hopefully there is nothing can stop the installation process now
open a browser then navigate to https://storefront100.local/, you would see the default page of Sitecore website. That’s because we don’t use the default host name sxa.storefront.com so we need to correct it via Sitecore
- log into https://storefront100.local/sitecore/
- access SXA Site Manager application
- open Storefront site and then update Host Name to storefront100.local and Database to master
- (optional) uncheck the checkbox Cache Html and select Yes for Disable Browser Caching for a better practice
- refresh https://storefront100.local/ and then add some products, you would see something like this
DO NOT forget to perform Post-Installation Steps
- follow Post-Installation Steps (from Page 17) in XC Installation Guide for On Premise

The recommendation

We can remove the modules completed from D:\sc100_com_install\SIF\Configuration\Commerce\Master_SingleServer.json and re-do Step 16 if there is something wrong (especially for Note: some known issues below) so that we are able to save a lot of time

Likewise the following one in the installation guide:

How to uninstall it?

open D:\sc100_com_install\SIF\sc100_com_install.ps1 and uncomment the line 295 + comment out the line 292 then save it
Note: DO NOT FORGET to restore D:\sc100_com_install\SIF\Configuration\Commerce\Master_SingleServer.json if you already edited it for removing the modules completed via the install operations
open Windows PowerShell (run as administrator)
change directory to D:\sc100_com_install\SIF
execute .\sc100_com_install
hopefully, it runs well and cleans everything up

Note: some known issues

The MERGE statement attempted to UPDATE or DELETE the same row more than once
- my suggestion is to remove all prior modules completed + Module-HabitatImages task itself (in this case) from D:\sc100_com_install\SIF\Configuration\Commerce\Master_SingleServer.json and re-do Step 16
HTTP Error 500.21 – Internal Server Error
- Handler “aspNetCore” has a bad module “AspNetCoreModuleV2” in its module list
- my suggestion: install Asp.Net Core Runtime 2.2 Hosting Bundle
- and then ensure that there is a IIS module “AspNetCoreModuleV2”, otherwise we will have to register a new one manually
  1. Name: AspNetCoreModuleV2
  2. Path: %ProgramFiles%\IIS\Asp.Net Core Module\V2\aspnetcorev2.dll