How to add Razl support to XM Cloud environment


Overview

Sitecore Razl is used to compare two Sitecore databases side by side, highlighting missing or outdated features. With Razl, it is possible to find missing items and move an entire database or a single item.

Prerequisites

Adding Razl support

To add Razl support to the XM Cloud environment:

  1. Download the Sitecore Razl desktop application package. Unzip and install the application.
  2. Run the Razl Desktop application and register the application.
  3. Follow the steps to create a connection using a package:
    • For the Server URL, enter the URL of your local XM Cloud instance.
    • Click Pick Package Location to open a dialogue that allows you to save the Sitecore package to disk. Download and unzip the package.
  4. Copy the _CMP and bin folders from the Sitecore Package’s files folder and add them to your XM Cloud project repository, in the src/platform folder of your local XM Cloud repository.
     
    Note: do not copy the _CMP and bin folders that are found in the properties folder.
  5. In the src\platform\Platform.csproj file, in the node containing the App_Config includes, add the following nodes:
    <Content Include="bin\HedgehogDevelopment.Razl.Service.dll" />
    <Content Include="_CMP\RazlService.asmx" />
    <Content Include="_CMP\web.config" />
    For example:
  6. If you host your repository on GitHub, deploy your repository using the XM Cloud Deploy app. Alternatively, before linking to the repository, create your XM Cloud project using the Sitecore CLI XM Cloud Plugin.
  7. After the deployment, you can continue with the remaining steps defined in create a connection using a package:
    Graphical user interface, text, application, emailDescription automatically generated 
    Note: If multiple developers are connecting to the same server, make sure the Access GUID is the same for all developers found in the web.config file from _CMP folder that has been added before. 
    A picture containing textDescription automatically generated