Website Development Company in Singapore
⟵ Resources

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

Monitor abstract design

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:

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

  1. install the ones below if you have not yet 😀
  2. 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
    • Sitecore 9 Control Panel
  3. 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
    • Sitecore 9 CP select Indexing Manager
  4. 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
  5. create a new folder D:\sc100_com_install
  6. 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
  7. download Sitecore PowerShell Extensions 6.0 for Sitecore 10.0 and put it into D:\sc100_com_install
  8. download Sitecore Experience Accelerator 10.0 and put it into D:\sc100_com_install
  9. download and unzip Packages for On Premise WDP 2020.08-6.0.238 then put it into D:\sc100_com_install
  10. 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
  11. 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
    • Code comparison part 1
    • open raw and then copy / paste CommerceEngine.json into D:\sc100_com_install\SIF\Configuration\Commerce\CommerceEngine
    • Code comparison part 2
    • open raw and then copy / paste CommerceEngine.Instance.Deploy.json into D:\sc100_com_install\SIF\Configuration\Commerce\CommerceEngine
    • Code comparison part 3
    • (optional) download + unzip  Configuration.zip and then copy / paste all to D:\sc100_com_install\SIF
  12. 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
      • Highlighting double slashes
    • $SqlUser
    • $SqlPass
    • $SolrUrl
    • $SolrRoot
    • $SolrService
    • $CommerceEngineConnectClientSecret: refer to Step 13 below
      • deployment fails if you don’t provide a qualified value for this parameter
      • Provide a value for $CommerceEngineConnectClientSecret
  13. (optional) create a secret client certificate
  14. (optional) correct the SitecoreUserName and SitecoreUserPassword of your Sitecore XP 10.0 instance if you’re using others rather than the default ones
    • Checking the string variables
  15. (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
    • Using $Env:COMPUTERNAME
  16. 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
    • Installation of sc100
    • hopefully there is nothing can stop the installation process now
  17. 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
    • Access SXA Site Manager
    • open Storefront site and then update Host Name to storefront100.local and Database to master
    • Open Storefront site and update Host Name and Database
    • (optional) uncheck the checkbox Cache Html and select Yes for Disable Browser Caching for a better practice
    • Uncheck Cache Html and select Yes for Disable Browser Caching
    • refresh https://storefront100.local/ and then add some products, you would see something like this
    • Refresh storefront100.local
  18. DO NOT forget to perform Post-Installation Steps

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 Smiling emoji

Likewise the following one in the installation guide:

Remove a reference to a module

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
  • Uninstalling the application
  • 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
  • DO NOT FORGET to restore
  • open Windows PowerShell (run as administrator)
  • change directory to D:\sc100_com_install\SIF
  • execute .\sc100_com_install
  • Executing sc100_com_install
  • hopefully, it runs well and cleans everything up

Note: some known issues

  1. The MERGE statement attempted to UPDATE or DELETE the same row more than once
    • Webdeploy issues
    • 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
  2. HTTP Error 500.21 – Internal Server Error
    • Error 500.21 Internal server error
    • Handler “aspNetCore” has a bad module “AspNetCoreModuleV2” in its module list
    • Handler aspNetCore error
    • 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
    • Ensure module “AspNetCoreModuleV2” is available

Got issues?

Please send your issues (with screenshots if possible) to viet.hoang.sitecore@gmail.com so that I can understand your problem and suggest the solution.

Happy Sitecore Commerce 10.0 Installation!

This article originally appeared on Walking on clouds (https://buoctrenmay.com/).

Websparks’ First Sustainability Report for 2023

Sitecore XP 10.4 Initial Release – Installation – SIF Way

How to install Sitecore Commerce 9 Update 2 on the machine has an existing XC 9.0.X

Portfolios

Resources

Contact Us

Website Development Company in Singapore white logo
LowCarbonSG Logo
Terms & Conditions | Privacy Policy | Accessibility Statement

Apply Now!

Upload Resume (with a 2mb maximum file size)
Accepted file types: doc, docx, pdf, xps, Max. file size: 2 MB.
This field is for validation purposes and should be left unchanged.