Sitecore Consultant. Sitecore MVP 2021 - 2023
It looks like in docker compose file for buyer and seller node version configured are old.
Update the following in docker-compose.yml. At the time of writing this blog the node version is 18.13.0. See here for latest- https://hub.docker.com/_/node
This should resolve the error.
30 total views
Follow these steps to install Sitecore Commerce 10.3 On Premise. To successfully install refer to Installation Guide provided by Sitecore.
Before installing Sitecore Commerce install Sitecore XP 10.3. See this blog to install Sitecore XP 10.3 using SIF. Say the XP site name is- xp103.sc
Hosting Environment Requirements/ Download and Install following software-
IMPORTANT – As per the release notes –
The deployment of SXA has been removed from the Commerce installation, and instead installed as a Platform pre-requisite before installing Commerce packages.
Sitecore PowerShell Extension for Sitecore on your local Sitecore instance if not already
Sitecore Experience Accelerator on your local Sitecore instance if not already
Also Commerce Ops service is removed from deployment configuration this will reduce deployment time and hosting cost.
Before starting the installation ensure XP 10.2 instance is working and indexed. If not indexed rebuild all search indexes-
Download Sitecore Experience Commerce 10.3
Step-by-step installation process-
1. Create a installation folder for XC – xcinstall for e.g.- C:\SCInstallation\103\xc103
2. Copy and extract Sitecore.Commerce.WDP.2022.12-9.0.82.zip file to C:\SCInstallation\103\xc103
3. Extract Web Platform Transfomer nuget package and copy Microsoft.Web.XmlTransform.dll to C:\SCInstallation\103\xc103
4. Extract SIF.Sitecore.Commerce.8.0.14.zip to C:\SCInstallation\103\xc103 folder. Rename this to SIF
Installation folder structure should look like this-
Open Deploy-Sitecore-Commerce.ps1 file in SIF folder to update the following-
12. Create Commerce Engine Connect Client Secret for the Sitecore Identity Server
$bytes = New-Object Byte[] 32
$rand = [System.Security.Cryptography.RandomNumberGenerator]::Create()
$rand.GetBytes($bytes)
$rand.Dispose()
$newClientSecret = [System.Convert]::ToBase64String($bytes)
echo $newClientSecret
13. [Optional] Update Sitecore domain or keep it default
14. Update other DB related settings
15. Update SOLR details-
Execute .\Deploy-Sitecore-Commerce.ps1
.\Deploy-Sitecore-Commerce.ps1Storefront-
Business Tools-
Highly recommended to install commerce on fresh VM or machine that don’t have previously installed Sitecore Commerce to avoid any errors during isntallation. If not then below are few of the errors you might see during installation.
Errors-
00007 10:12:17 ERROR CtxMsg.Error.ContentPathAlreadyExists: Text=Content path ‘/sitecore/Commerce/Commerce Control Panel’ already exists.
00038 10:12:17 ERROR Management.block.getitembypath: Sitecore Item Service Get item failed, Item /sitecore/Commerce/Commerce Control Panel/Commerce Engine Settings/Commerce Terms/System Messages/ContentPathAlreadyExists not found.
Solution- see here – https://robearlam.com/blog/CtxMsg-Error-ContentPathAlreadyExists-error
40 total views
This article explains usage of extended properties in OrderCloud-
https://ordercloud.io/knowledge-base/extended-properties
But it doesn’t tell about how to index the extended properties to get the search results.
This blog post helps to setup the XP Indices feature already available with the OrderCloud and search such properties.
This example shows extended properties for Categories for which first Catalog needs to setup
1. Create Catalog from Portal (Assume Marketplace is already created)-
Navigate to Product Catalogs => Catalog => Select an operation “Create a new catalog”
Use below JSON or fill in form to create catalog
{
"ID": "0001",
"Active": true,
"Name": "HabitatMaster",
"Description": "HabitatMaster"
}Catalog will be created with 201 status
2. Create Catagories from Portal with reference to Catalog Id created previously-
Navigate to Product Catalogs => Categories=> Select an operation “Create a new category”
Use below JSON to create catqagory for Catalog “0001” with the extended property “DisplayType” as “Text”
{
"ID": "0001-CategoryDisplayText",
"Active": true,
"Name": "CategoryDisplayText",
"Description": "CategoryDisplayText",
"xp": {
"DisplayType": "Text"
}
}Likewise create another catagory with DisplayType Image as per below JSON-
{
"ID": "0001-CategoryDisplayImage",
"Active": true,
"Name": "CategoryDisplayImage",
"Description": "CategoryDisplayImage",
"xp": {
"DisplayType": "Image"
}
}3. Search Category with newly created extended property i.e. DisplayType
First search all categories with Catalog Id “0001”. Following results will be shown-
Now lets try and search with extended properties i.e. Catalog Id “0001” and DisplayType as Text. For this use “Add Filter” option and key as “xp.DisplayType” and Filter Value as “Text”.
This request wont show any results and hence Xp Indices needs to created for Category
4. Create XP Indices
Navigate to Seller => Xp Indices
Indexable resources Catagory “Add Index” => “xp.DisplayType” and Save Changes
Now search the Catagories same as in Step 3 with Filter option and this time you should be able to see the results-
Part 1 using offline Azure resource and Part 1 using online Azure resources gives a walkthrough on setting Sitecore Ordercloud Headstart pre-requisites. While Part 2 helps setup middleware.
Part 3 helps setup Seller UI App
In this blog will setup Buyer UI
Step 1- Setup the Buyer UI project
If you have followed earlier steps to setup Seller UI App you must have already installed node js.
Open the BuyerUI project in Visual Studio Code (prefered) from /src/UI/Buyer folder
Step 2 – Change configuration defaultbuyer-test.json
Navigate to \src\UI\Buyer\src\assets\appConfigs\defaultbuyer-test.json
Update the clientID to your Marketplace Buyer UI client ID
Update baseUrl e.g.:- http://localhost:4300
Update middlewareUrl. If you are in local update this to – https://localhost:5001
Update translateBlobUrl e.g.:- http://127.0.0.1:10000/devstoreaccount1/ngx-translate/i18n/
Step 3 – Change configuration environment.local.ts
Update the useLocalMiddleware to true if this is locally setup
Update localMiddlewareURL to https://localhost:5001
Update localBuyerApiClient, same as in the previous step
Step 4 – Run the Buyer UI application
RUN – from the visual studio terminal or powershell
npm installnp run startThis should compile successfully and ;listen to 4300 port
Headstart Buyer application- http://localhost:4300
Follow these steps to install Sitecore Commerce 10.2 On Premise. To successfully install refer to Installation Guide provided by Sitecore.
Before installing Sitecore Commerce install Sitecore XP 10.2. See this blog to install Sitecore XP 10.2 using SIF. Say the XP site name is- xp0.sc
Hosting Environment Requirements/ Download and Install following software-
IMPORTANT – As per the release notes –
The deployment of SXA has been removed from the Commerce installation, and instead installed as a Platform pre-requisite before installing Commerce packages.
Install Powershell Extension for Sitecore – Download Sitecore PowerShell Extension for Sitecore
Install Sitecore Experiemce Accelerator 10.2.0 – Download Sitecore Experience Accelerator 10.2.0
Also Commerce Ops service is removed from deployment configuration this will reduce deployment time and hosting cost.
Before starting the installation ensure XP 10.2 instance is working and indexed. If not indexed rebuild all search indexes-
Download Sitecore Experience Commerce 10.2
Step-by-step installation process-
2. Copy and extract Sitecore.Commerce.WDP.2021.11-8.0.218.zip file to c:\scinstallation\xc folder
3. Copy Sitecore Experience Accelerator 10.2.0 rev. 04247.zip file c:\scinstallation\xc folder
4. Copy Sitecore.PowerShell.Extensions-6.3 – IAR.zip file to c:\scinstallation\xc folder
5. Extract Web Platform Transfomer nuget package and copy Microsoft.Web.XmlTransform.dll to c:\scinstallation\xc folder
6. Extract SIF.Sitecore.Commerce.7.0.37 to c:\scinstallation\xc folder. Rename this to SIF
7. Folder structure should look like this-
8. Install Sitecore.PowerShell.Extensions-6.3 – IAR.zip package in your earlier installed Sitecore instance
9. Install Sitecore Experience Accelerator 10.2.0 rev. 04247.zip pakcagein your earlier installed Sitecore instance
11. Open Deploy-Sitecore-Commerce.ps1 file in SIF folder to update the following-
12. Create Commerce Engine Connect Client Secret for the Sitecore Identity Server
$bytes = New-Object Byte[] 32
$rand = [System.Security.Cryptography.RandomNumberGenerator]::Create()
$rand.GetBytes($bytes)
$rand.Dispose()
$newClientSecret = [System.Convert]::ToBase64String($bytes)
echo $newClientSecret
13. [Optional] Update Sitecore domain or keep it default
14. Update other DB related settings
15. Update SOLR details-
Execute Deploy-Sitecore-Commerce.ps1 script to install commerce
IMPORTANT – After deployment is complete Disable TLS 1.3 over TCP for all the sites and all bindings
Errors-
Error -The remote server returned an error: (400) Bad Request. on GetIdServerToken
Resolution – Check your admin credentials if correctly configured in installation script.
Error – Commerce roles site not reachable
Resolution- Check if the SSL certificate for Comerce Engine is in Trusted Root Certification Authorities. If not copy the relevant certs to same.
Sitecore Commerce installation package comes with Sitecore Business Tools SDK.
If you are planning to custommise Business Tools you might have to setup the development environment for Business Tools. You can find more information on how to setup the development environment here
For each version of Sitecore Commerce you need to install the specific version of Business Tools in you development environment.
See below the compatibility table for Business Tools with Sitecore commerce-
Package for the same can be found here
If you see this error whilst installing Sitecore 9.0.2 the issue might be due to multiple certificates been issues.
In this case delete both certificates listed –
Get-ChildItem Cert:\LocalMachine\Root\<<Thumbprint>> | Remove-Item
Try the installation again
ERROR-
SOLUTION-
Check and remove – DO_NOT_TRUST_SitecoreRootCert if its expired from Local Computer and Current User.
Also remove the same form the dis mainly from C:\certificates
ERROR-
SOLUTION-
If you want to get started and create a custom plugin for XC 9.3 here is the post for same First Steps | Sitecore Commerce Development | Create a Custom Plugin
There are few updates on how the plugins are created in XC 10.
Sitecore Commerce 10 SDK does not include Visual Studio Extension (VSIX) package for creating a plugin project.
Let’s get started and look into the steps to create a new plugin in Sitecore Commerce 10. If you have already set up your commerce development environment, please skip to step 2
Step 1 – Setup developer environment
Create a developer environment for Sitecore Commerce to run the engine from Visual Studio, can be either VS 2017 or 2019. Follow this blog post for same Setup development environment for Sitecore Commerce 10 Engine
Step 2: Download Sitecore.Commerce.Plugin.Template from Nuget Feed
3. Install Sitecore Commerce Plugin Template Nuget Package
dotnet new -i .\Sitecore.Commerce.Plugin.Template.6.0.4.nupkg
4. Create a new Sitecore Commerce Plugin Project
As we have a plugin project template we should be able create a new plugin project.
Execute following command in Powershell. Navigate to the solution src folder-
dotnet new pluginsample -o Sitecore.Commerce.Plugin.SampleTest
New plugin project is created with the project name specified in command.
Include the project in Customer.Sample.Solution and compile.
Notice even though the command has project name “Sitecore.Commerce.Plugin.SampleTest” the actual project is created as “Sitecore.Commerce.Plugin.Sample”. You will have to rename this unfortunately as per your requirement.
Sharding is horizontal partitioning of data in database. It is the process of breaking up large tables into smaller chunks.
Storing rows of the same table in multiple database nodes
In this blog post will see how to split the Commerce Entities table having same structure but store custom entity data in a separate table that helps to split the load that a CommerceEntities table might take if the horizontal partition is not done.
Why partioning of tables is required?
Sitecore Commerce entity data are store in following tables-
Any custom entity been created without sharding will store data by default in tables mentioned above.
What if that data increases, there might be a performance hit once the data start expanding over months and years.
Also it wont be good idea to put the multiple custom entity data into a single table. As this might give a performance hit whilst indexing table. So, if you know data might increase over the time it is better to have it saved in a separate table as it can be a boon to high-volume data.
Partitioning data using sharding policy
I assume you know how extend Sitecore Commerce entities. Consider we have a “Organization” entity. Business Tools helps in capturing details of Organization i.e. CRUD operations. When the entity is been saved it has to be saved in different table.
This driven by the sharding policies in Commerce.
Follow these steps to enable sharding of custom entity-
Sharding Policies
The Commerce Engine implements database sharding for Commerce entity and list tables, and provides 2 types of sharding policies. One is for the operation against Commerce entities i.e. EntityShardingPolicy, and other on the Commerce lists i.e. ListShardingPolicy.
Configuration for sharding policy is kept in PlugIn.SQL.Sharding.PolicySet-1.0.0.json file and can be found in data\Environments folder of the Authoring and Shops instance.
As per Sitecore documentation sharding policies has expressions and multiple expression values can be configured based on this the table of the entity is identified to read and perform write operations. This is a bit contrary statement as the table name defined in policies are passed to the stored procedure based on this the data in table is written and read.
Below sharding policy mentions 2 tables-
OrganizationsLists for managing and reading lists of Organizations
OrganizationsEntities for managing and reading Organization entities
{
"$type": "Sitecore.Commerce.Plugin.SQL.ListShardingPolicy, Sitecore.Commerce.Plugin.SQL",
"Expressions": {
"$type": "System.Collections.Generic.List1[[System.String, mscorlib]], mscorlib",
"$values":
[
"^List-Organization.*?$"
]
},
"TableName": "OrganizationsLists"
}, {
"$type": "Sitecore.Commerce.Plugin.SQL.EntityShardingPolicy, Sitecore.Commerce.Plugin.SQL",
"Expressions": {
"$type": "System.Collections.Generic.List1[[System.String, mscorlib]], mscorlib",
"$values":
[
"^Entity-Organization.?$",
"^Organization-.?$"
]
},
"TableName": "OrganizationsEntities"
}Database
To save data in different tables create Entities, Entity and Lists table prefixed with entity name in SitecoreCommerce_SharedEnvironments database
Follow same for CommerceEntity table to create OrganizationsEntity and CommerceLists to create OrganizationsLists
So there are 3 tables created so far-
Once you have your plugin to perform CRUD operations on Organizations entity you should be able to see the data been inserted in OrganizationEntities, OrganizationLists and OrganizationsEntity table instead of CommerceEntities and there related tables.
Business Tools is extensible using pluggable framework and can extend a UI using Entity Views. Although Business Tools offers a rich set of controls you might want to create your own custom control for the best business experience.
For this you need to first setup the development environment for business tools. Once the environment is setup you should be ready to develop custom control/customize the business tools.
Prerequisites
NPM configuration to have NPM Packages from Sitecore public feed
Sitecore BizFx SDK relies on NPM packages available on the Sitecore official public feed for NPM packages.
Open Poswershell as Administrator
Execute these 2 commands in powershell
npm config set @speak:registry=https://sitecore.myget.org/F/sc-npm-packages/npm/
npm config set @sitecore:registry=https://sitecore.myget.org/F/sc-npm-packages/npm/This will add following line to–
C:\Users\[your user]\.npmrc
[Optional] – you may check if this lines are added
@speak:registry=https://sitecore.myget.org/F/sc-npm-packages/npm/@sitecore:registry=https://sitecore.myget.org/F/sc-npm-packages/npm/
Setup and Install SPEAK and BizFx packages for development solution
Copy Sitecore.BizFX.SDK.4.0.8 folder to your development folder and extract the SDK zip file to folder e.g. c:\BizFXDevelopment\SitecoreBizFx
Copy below files to the folder SDK was extracted. You should find this files from the Sitecore XC release package.
Execute the following commands where the above files were copied
npm install speak-icon-fonts-1.1.0.tgz
npm install speak-ng-bcl-2.0.0-r00116.tgz
npm install speak-styling-1.0.0-r00110.tgz
npm install @sitecore/bizfx
Run npm install. This should install required npm modules and add a folder node_modules
npm installSetup the business tools config.json with your deployment configuration
Once the npm installed successfully open config.json file located in src\assets folder
Update the config to the same as the BizFx site instance except for BizFxUri. Note BizFxUri points to http in below config
{
"EnvironmentName": "HabitatAuthoring",
"EngineUri": "https://localhost:5000",
"IdentityServerUri": "https://xp10.IdentityServer",
"BizFxUri": "http://localhost:4200",
"Language": "en",
"ContentLanguage": "en",
"Currency": "USD",
"ShopName": "CommerceEngineDefaultStorefront",
"LanguageCookieName": "selectedLanguage",
"ContentLanguageCookieName": "selectedContentLanguage",
"EnvironmentCookieName": "selectedEnvironment",
"AutoCompleteTimeout_ms": 300,
"AccessTokenUpdateInterval_ms": 300000
}Run the development environment
Important!
Stop the SitecoreBizFx site as the site listens to 4200 port. Next step will help listen the site from the extracted SDK folder.
Execute following Powershell command –
ng server
Open browser on http://localhost:4200/ this should ask to enter the Sitecore client credentials, once provided it will throw an error
This site can’t provide a secure connection
The reason this error occurs the identity server is not configure to server BizFx site on http
Update the Sitecore Identity Server Configuration
Open the Sitecore.Commerce.Identity ServiceHost.xml from the installed Identity Server instance \wwwroot\Config\production
Add http://localhost:4200 to AllowedCorsOriginGroup1
<AllowedCorsOrigins>
<AllowedCorsOriginsGroup1>http://localhost:4200</AllowedCorsOriginsGroup1>
</AllowedCorsOrigins>
Update Commerce Engine configuration
Run Business tool from development environment
Open browser on http://localhost:4200/
Business tools running on http and in developer mode.
References –
Stay tuned next blog will walk through on how to create a new custom control/component in Business Tools
