Removing the Sample Projects from the Sitecore Experience Commerce 9 Update 2 SDK

In this post, we will look at how to remove the sample projects from the Sitecore Experience Commerce 9.0.2 (Sitecore.Commerce.Engine.SDK.2.2.72).

Unlike previous versions, the SDK for 9 update 2 has been cleaned up a little bit. I want to remove Plugin.Sample.AdventureWorks, Plugin.Sample.Customers.CsMigration, Plugin.Sample.Customers.Upgrade, Plugin.Sample.Habitat and Plugin.Sample.Upgrade. For now, I want to keep Plugin.Sample.Payments.Braintree.

I posted some useful links at the bottom of this blog post. First extract Sitecore.Commerce.Engine.SDK.2.2.72.zip and make a copy of the extracted source.

Rename your solution and build to make sure the solution builds. Add the following NuGet packages to the Commerce Engine project: Sitecore.Commerce.Plugin.Coupons Sitecore.Commerce.Plugin.Journaling Sitecore.Commerce.Plugin.SQL Sitecore.Commerce.Plugin.Tax

Next, go through all your configs and find where the sample projects were used and remove the config elements.

Your authoring configuration changes (PlugIn.Habitat.CommerceAuthoring-1.0.0.json):

1. 
   
   1. //{
   2. // "$type": "Plugin.Sample.Customers.CsMigration.ProfilesSqlPolicy, Plugin.Sample.Customers.CsMigration",
   3. // "Server": ".",
   4. // "Database": "SXAStorefrontSite_profiles",
   5. // "TrustedConnection": true,
   6. // "UserName": "",
   7. // "Password": ""
   8. //},
   9. //{
   10. // "$type": "Plugin.Sample.Customers.CsMigration.ProfilePropertiesMappingPolicy, Plugin.Sample.Customers.CsMigration",
   11. // "UserProperties": {
   12. // "GeneralInfo.language": "Language",
   13. // "GeneralInfo.tel_number": "PhoneNumber"
   14. // },
   15. // "AddressProperties": {
   16. // "ProfileSystem.user_id_changed_by": "ChangedBy"
   17. // }
   18. //},

Global.json file changes:

1. 
   
   1. //{
   2. // "$type": "Plugin.Sample.Customers.CsMigration.ProfilesSqlPolicy, Plugin.Sample.Customers.CsMigration",
   3. // "Server": ".",
   4. // "Database": "SXAStorefrontSite_profiles",
   5. // "TrustedConnection": true,
   6. // "UserName": "",
   7. // "Password": ""
   8. //},
   9. //{
   10. // "$type": "Plugin.Sample.Customers.CsMigration.ProfilePropertiesMappingPolicy, Plugin.Sample.Customers.CsMigration",
   11. // "UserProperties": {
   12. // "GeneralInfo.language": "Language",
   13. // "GeneralInfo.tel_number": "PhoneNumber"
   14. // },
   15. // "AddressProperties": {
   16. // "ProfileSystem.user_id_changed_by": "ChangedBy"
   17. // }
   18. //},
   19. //{
   20. // "$type": "Plugin.Sample.Upgrade.MigrationPolicy, Plugin.Sample.Upgrade",
   21. // "DefaultEnvironmentName": "AdventureWorksAuthoring",
   22. // "SqlPolicySetName": "SqlPolicySet",
   23. // "ReviewOnly": false,
   24. // "ListsToMigrate": {
   25. // "*orders*": null,
   26. // "carts": null,
   27. // "giftcards": null,
   28. // "order-*-salesactivity": null,
   29. // "completedrmas": null,
   30. // "journalentries*": null,
   31. // "coupons": null,
   32. // "entitlements": null,
   33. // "managedlists": null,
   34. // "pricebooks*": null,
   35. // "pricecards": null,
   36. // "privatecoupongroups": null,
   37. // "promotionbooks*": null,
   38. // "promotions": null,
   39. // "promotions-*-coupons": null,
   40. // "promotion-*-publiccoupons": null,
   41. // "promotion-*-privatecoupongroups": null,
   42. // "promotion-*-unallocatedcoupons": null,
   43. // "salesactivities": null,
   44. // "settledsalesactivities": null,
   45. // "sellableitems": 0
   46. // }
   47. //},
   48. //{
   49. // "$type": "Plugin.Sample.Upgrade.MigrationSqlPolicy, Plugin.Sample.Upgrade",
   50. // "ArtifactStoreId": "6BE385F1-93DC-4299-9DD4-934F6BA42EAA",
   51. // "SourceStoreSqlPolicy": {
   52. // "$type": "Sitecore.Commerce.Plugin.SQL.EntityStoreSqlPolicy, Sitecore.Commerce.Plugin.SQL",
   53. // "PolicyId": "Global",
   54. // "AllowAdmin": true,
   55. // "Database": "SitecoreCommerce_Global",
   56. // "EffectiveDate": "0001-01-01T00:00:00",
   57. // "IsVisible": false,
   58. // "Password": "",
   59. // "Server": "",
   60. // "TrustedConnection": true,
   61. // "UserName": "",
   62. // "View": "EntityStoreSqlPolicy"
   63. // }
   64. //},

Remove projects from the solution and remove the project references from the Commerce Engine solution.

Rebuild and deploy your commerce engine. Once that is done, Bootstrap and Initialize.

Here is a modified version of the deployment script based on the Habitat Home Commerce PowerShell script:

1. 
   
   1. Param(
   2. [string]$siteName = "sxa.storefront.com",
   3. [string]$engineHostName = "localhost",
   4. [string]$identityServerHost = "localhost:5050",
   5. [switch]$Initialize,
   6. [switch]$Bootstrap,
   7. [switch]$SkipPublish,
   8. [string]$webRoot = "C:inetpubwwwroot",
   9. [string]$engineSuffix = "Sc9",
   10. [string[]] $engines = @("Authoring", "Minions", "Ops", "Shops"),
   11. [string]$BizFxPathName = "SitecoreBizFx",
   12. [string]$IdentityServerPathName = "SitecoreIdentityServer",
   13. [string]$CommerceOpsPort = "5000",
   14. [string]$adminUser = "admin",
   15. [string]$adminPassword = "b",
   16. [string]$certificateName = "sxa.storefront.com",
   17. [string]$solutionFolder = (get-item $PWD).parent.fullname,
   18. [string]$publishFolder = (Join-Path $solutionFolder "publishTemp"),
   19. [string]$engineSolutionPath = (Join-Path $solutionFolder "YOUR SOLUTION NAME INCLUSE .sln")
   20. )
   21.  
   22. Function Start-CommerceEngineCompile ( [string] $basePublishPath = $(Join-Path $publishFolder "engine") ) {
   23. if (Test-Path $publishFolder) {
   24. Remove-Item $publishFolder -Recurse -Force
   25. }
   26. Write-Host ("Compiling and Publishing Engine to {0}" -f $basePublishPath) -ForegroundColor Green
   27.  
   28. dotnet publish $engineSolutionPath -o $basePublishPath
   29. }
   30. Function Start-CommerceEnginePepare ( [string] $basePublishPath = $(Join-Path $publishFolder "engine") ) {
   31. 
       
   32. $certPrefix = "CN="
   33. $fullCertificateName = $certPrefix + $certificateName
   34.  
   35. $thumbprint = Get-ChildItem -path cert:LocalMachinemy | Where-Object {$_.Subject -like $fullCertificateName} | Select-Object Thumbprint
   36. Write-Host $thumbprint
   37. $pathToGlobalJson = $(Join-Path -Path $basePublishPath -ChildPath "wwwrootbootstrapGlobal.json")
   38. 
       
   39. $global = Get-Content $pathToGlobalJson -Raw | ConvertFrom-Json
   40. #Write-Host $global $siteName $adminUser $adminPassword
   41. $global.Policies.'$values'[5].Host = $siteName
   42. $global.Policies.'$values'[5].UserName = $adminUser
   43. $global.Policies.'$values'[5].Password = $adminPassword
   44. $global | ConvertTo-Json -Depth 10 -Compress | set-Content $pathToGlobalJson
   45. $pathToJson = $(Join-Path -Path $basePublishPath -ChildPath "wwwrootconfig.json")
   46.  
   47. $config = Get-Content $pathToJson -Raw | ConvertFrom-Json
   48. 
       
   49. $certificateNode = $config.Certificates.Certificates[0]
   50. $certificateNode.Thumbprint = $thumbprint.Thumbprint
   51. $config | ConvertTo-Json -Depth 10 -Compress | set-content $pathToJson
   52.  
   53. # Modify PlugIn.Content.PolicySet
   54. $pathToContentPolicySet = $(Join-Path -Path $basePublishPath -ChildPath "wwwrootdataenvironmentsPlugIn.Content.PolicySet-1.0.0.json")
   55. $contentPolicySet = Get-Content $pathToContentPolicySet -Raw | ConvertFrom-Json
   56. $contentPolicySet.Policies.'$values'[0].Host = $siteName
   57. $contentPolicySet.Policies.'$values'[0].username = $adminUser
   58. $contentPolicySet.Policies.'$values'[0].password = $adminPassword
   59. $contentPolicySet | ConvertTo-Json -Depth 10 -Compress | Set-Content $pathToContentPolicySet
   60.  
   61.  
   62. foreach ($engine in $engines) {
   63. Write-Host ("Customizing configuration values for {0}" -f $engine) -ForegroundColor Green
   64. $engineFullName = ("Commerce{0}" -f $engine)
   65. $environmentName = ("Habitat{0}" -f $engine)
   66. 
       
   67. $enginePath = Join-Path $publishFolder $engineFullName
   68. Copy-Item $basePublishPath $enginePath -Recurse -Force
   69.  
   70. $pathToJson = $(Join-Path -Path $enginePath -ChildPath "wwwrootconfig.json")
   71. $config = Get-Content $pathToJson -Raw | ConvertFrom-Json
   72. $appSettings = $config.AppSettings
   73.  
   74. $appSettings.EnvironmentName = $environmentName
   75. $config | ConvertTo-Json -Depth 10 -Compress | set-content $pathToJson
   76.  
   77. }
   78.  
   79. Write-Host "Modifying Identity Server configuration" -ForegroundColor Green
   80. # Modify IdentityServer AppSettings based on new engine hostname
   81. $idServerJson = $([System.IO.Path]::Combine($webRoot, $IdentityServerPathName, "wwwrootappSettings.json"))
   82. $idServerSettings = Get-Content $idServerJson -Raw | ConvertFrom-Json
   83. $client = $idServerSettings.AppSettings.Clients | Where-Object {$_.ClientId -eq "CommerceBusinessTools"}
   84. 
       
   85. $client.RedirectUris = @(("https://{0}:4200" -f $engineHostName), ("https://{0}:4200/?" -f $engineHostName))
   86. $client.PostLogoutRedirectUris = @(("https://{0}:4200" -f $engineHostName), ("https://{0}:4200/?" -f $engineHostName))
   87. $client.AllowedCorsOrigins = @(("https://{0}:4200/" -f $engineHostName), ("https://{0}:4200" -f $engineHostName))
   88.  
   89. $idServerSettings | ConvertTo-Json -Depth 10 -Compress | set-content $idServerJson
   90.  
   91. Write-Host "Modifying BizFx (Business Tools) configuration" -ForegroundColor Green
   92. #Modify BizFx to match new hostname
   93. $bizFxJson = $([System.IO.Path]::Combine($webRoot, $BizFxPathName, "assetsconfig.json"))
   94. $bizFxSettings = Get-Content $bizFxJson -Raw | ConvertFrom-Json
   95. $bizFxSettings.BizFxUri = ("https://{0}:4200" -f $engineHostName)
   96. $bizFxSettings.IdentityServerUri = ("https://{0}" -f $identityServerHost)
   97. $bizFxSettings.EngineUri = ("https://{0}:5000" -f $engineHostName)
   98. $bizFxSettings | ConvertTo-Json -Depth 10 -Compress | set-content $bizFxJson
   99.  
   100. }
   101. Function Publish-CommerceEngine {
   102. Write-Host ("Deploying Commerce Engine") -ForegroundColor Green
   103. IISRESET /STOP
   104.  
   105. foreach ($engine in $engines) {
   106. $engineFullName = ("Commerce{0}" -f $engine)
   107. $enginePath = Join-Path $publishFolder $engineFullName
   108. 
        
   109. if ($engineSuffix.length -gt 0) {
   110. $engineWebRoot = Join-Path $webRoot $($engineFullName + "_" + $engineSuffix)
   111. }
   112. else {
   113. $engineWebRoot = [System.IO.Path]::Combine($webRoot, $engineFullName)
   114. }
   115. Write-Host ("Copying to {0}" -f $engineWebRoot) -ForegroundColor Green
   116. $engineWebRootBackup = ("{0}_backup" -f $engineWebRoot)
   117.  
   118. if (Test-Path $engineWebRootBackup -PathType Container) {
   119. Remove-Item $engineWebRootBackup -Recurse -Force
   120. }
   121.  
   122. Rename-Item $engineWebRoot -NewName $engineWebRootBackup
   123. Get-ChildItem $engineWebRoot -Recurse | ForEach-Object {Remove-Item $_.FullName -Recurse}
   124. Copy-Item -Path "$enginePath" -Destination $engineWebRoot -Container -Recurse -Force
   125. }
   126.  
   127.  
   128. IISRESET /START
   129.  
   130. Start-Sleep 10
   131. }
   132. Function Get-IdServerToken {
   133. $UrlIdentityServerGetToken = ("https://{0}/connect/token" -f $identityServerHost)
   134.  
   135. $headers = New-Object "System.Collections.Generic.Dictionary[[String],[String]]"
   136. $headers.Add("Content-Type", 'application/x-www-form-urlencoded')
   137. $headers.Add("Accept", 'application/json')
   138.  
   139. $body = @{
   140. password = "$adminPassword"
   141. grant_type = 'password'
   142. username = ("sitecore{0}" -f $adminUser)
   143. client_id = 'postman-api'
   144. scope = 'openid EngineAPI postman_api'
   145. }
   146. Write-Host "Getting Identity Token From Sitecore.IdentityServer" -ForegroundColor Green
   147. $response = Invoke-RestMethod $UrlIdentityServerGetToken -Method Post -Body $body -Headers $headers
   148.  
   149. $sitecoreIdToken = "Bearer {0}" -f $response.access_token
   150.  
   151. $global:sitecoreIdToken = $sitecoreIdToken
   152. Write-Host $global:sitecoreIdToken
   153. }
   154.  
   155. Function BootStrapCommerceServices {
   156.  
   157. $UrlCommerceShopsServicesBootstrap = ("https://{0}:{1}/commerceops/Bootstrap()" -f $engineHostName, $CommerceOpsPort)
   158. Write-Host "BootStrapping Commerce Services: $($urlCommerceShopsServicesBootstrap)" -ForegroundColor Green
   159. $headers = New-Object "System.Collections.Generic.Dictionary[[String],[String]]"
   160. $headers.Add("Authorization", $global:sitecoreIdToken)
   161. Invoke-RestMethod $UrlCommerceShopsServicesBootstrap -TimeoutSec 1200 -Method PUT -Headers $headers
   162. Write-Host "Commerce Services BootStrapping completed" -ForegroundColor Green
   163. }
   164.  
   165. if ($DeployOnly) {
   166.  
   167. }
   168. if (!($SkipPublish)) {
   169. Start-CommerceEngineCompile
   170. Start-CommerceEnginePepare
   171. Publish-CommerceEngine
   172. }
   173. if ($Bootstrap -or $Initialize) {
   174. Get-IdServerToken
   175. }
   176.  
   177. if ($Bootstrap) {
   178. BootStrapCommerceServices
   179. }
   180.  

If you have any questions or concerns, please get in touch with me. (@akshaysura13 on Twitter or on Slack).

References:

Decoupling the Sample Plugins from the Sitecore Commerce 9 SDK Setting up a new Sitecore Experience Commerce Environment