Setup Sitecore Commerce Business Tools Development Environment

Business Tools is extensible using the pluggable framework and allows you to extend UI using Entity Views. Though, 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 Business Tools development environment. Once the environment is setup you can develop custom controls/customize the business tools.

Prerequisites

1. An instance of Commerce Engine deployed in the development environment. Learn how to do it
2. Install Node.js Javascript runtime
3. Install Angular CLI tool – npm install -g @angular/cli
4. 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.
   1. Open Powershell as Administrator
   2. 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.

1. speak-icon-fonts-1.1.0.tgz
2. speak-ng-bcl-2.0.0-r00116.tgz
3. speak-styling-1.0.0-r00110.tgz

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 install

Setup 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 to the site from the extracted SDK folder.

Execute following Powershell command –

ng server

The Identity Server Configuration

If you now open http://localhost:4200/ and provide Sitecore Client credentials, you will get the following error –

This site can’t provide a secure connection

The reason this error occurs the identity server is not configured 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

• Open config.json from wwwroot folder in CommerceAuthoring site

• Update AllowedOrigins in AppSettings to have http://localhost:4200

• Since the config is changed need to bootstrap so the changes are applied to authoring site
• Restart IIS. Optionally you may just restart Commerce Authoring site

Run Business tool from the development environment

Open browser on http://localhost:4200/

Business tools running on HTTP and in developer mode.

In the next post, I am going to show how to create a custom control in BizFx.