Upgrading Retail SDK extension to latest

In the past couple of months, there have been a lot requests for upgrading Retail from one version to another.

In this post, I will be describing how to upgrade RetailSDK from one version to another. For this exercise I am upgrading from 10.0.18 to 10.0.20.

  • Ensure that your current dev branch for 10.0.18 has been mapped to your local.
  • Get latest and ensure that there are no pending changes. 
  • Apply 10.0.20 update package to the environment.
  • Navigate to https://lcs.dynamics.com/
  • Select the environment that you need to update
  • Choose Maintain > Apply Updates
  • Select the 10.0.20 service package released by Microsoft.
  • Choose Apply
This will kick-off the update process once complete you will be notified via email or you can refresh the page to view progress and details.

Retail SDK 10.0.20 package
To get the RetailSDK 10.0.20 package, navigate to the K drive (referred to as SourceRepo)  for an LCS demo box. This may differ depending on the environment. Sometimes it is in the C drive.

Identify and navigate to the RetailSDK\Update folder. This folder contains all the update packages.

The latest package can be identified by the date modified field.



This folder is the latest 10.0.20 RetailSDK package that has been applied to the environment through LCS. As a best practice you can rename this folder before copying to ensure that you do not get errors in relation to the path name being too long. 

Once you have identified the correct folder, you can copy and add this folder to your source control. The Microsoft-version file displays the current version for the RetailSDK package.

As an example you can add this to your source control titled as either RetailSDKMirror-10.0.20 or RetailSDKMirror-10.0.886.48

This will ensure that you have a copy of the clean RetailSDK version for 10.0.20.


You should now be able to convert your RetailSDK 10.0.20 Mirror folder to branch if you have not done already and create a new branch of this which will represent your Retail SDK 10.0.20 Dev branch.

Once branching is complete and all changes are checked in to source control, we can begin with merge from the 10.0.18 branch to 10.0.20 branch.

First you will need to determine which files need to be merged. Ideally these are the files that usually have modifications and need to be merged.

RetailSDK\
Assets\
CommerceRuntime.Ext.config
CommerceRuntime.MPOSOffline.Ext.config
RetailProxy.MPOSOffline.ext.config
BuildTools\
Customization.settings
Packages\
RetailServer\
Code\
web.config
Pos\
Extensions\
extensions.json

Other than the above files you would need to locate any CRT or POS customizations.

CRT customizations are usually on the root folder, for example, RetailSDK\CRTExtensions.
POS customizations are located within the RetailSDK\POS\Extensions folder. The enabled extensions are usually defined within the RetailSDK\POS\Extensions\extensions.json file. You can use this as guidance to determine which files are required for merge.

Once you have identified the customizations you can proceed to merge the changes as per the source control guidelines. 

Compile and test all your customizations and ensure that there are no issues.




Comments

Popular posts from this blog

D365FO - Create a multi-select lookup in batch jobs

Generate and download a csv file using X++

Creating a batch job with query based filter in D365 back-office