Upgrading SDL Online Editor
Before you upgrade to a newer version of SDL Online Editor, you need to obtain the updated SDL Online Editor deployment kit. You can usually find this kit in the integrations\SDL Online Editor folder of the latest WorldServer distribution kit.
Procedure
- Copy the SDL Online Editor deployment kit to the machine where you want to deploy SDL Online Editor.
- Go to the chef_solo_ue\utils\nuggets folder of the updated SDL Online Editor kit.
- Copy the NUPKG files from that folder to C:\chef\nuggets.
- Back up the Sdl.EditorService.Host.exe.config file (you can find it in C:\Program Files\SDL\Editor Service\bin) and the Sdl.EditorServiceRouter.Host.exe.config file (you can find it in C:\Program Files\SDL\Editor Service Router\bin) to a secure location of your choice.
- Go to C:\chef_solo_ue\environments and open the chef_solo_env.json file with a text editor.
- In the section corresponding to each service, change the value of the
nugetSourceproperty to reflect the latest versions that you copied from the SDL Online Editor kit to C:\chef\nuggets.These sections are:cc_bcmfor the SDL BCM Servicecc_esfor the SDL Editor Servicecc_esrfor the SDL Editor Service Router servicecc_ue
For example,"C:\\Chef\\nuggets\\Sdl.BcmService-4.0.0-b197.nupkg"for the SDL BCM Service,"C:\\Chef\\nuggets\\Sdl.EditorService-1.11.0-b1021.nupkg"for the SDL Editor Service, and so on. - In the section corresponding to each service, change the value of the
versionproperty to reflect the latest versions that you copied from the SDL Online Editor kit to C:\chef\nuggets.For example,"4.0.0-b197"for the SDL BCM Service,"1.11.0-b1021"for the SDL Editor Service, and so on.Important: For each section, the version must be the same both undernugetSourceand underversion. - Save and close the chef_solo_env.json file.
- Start a Windows PowerShell session as an administrator.
- Run the following command:
cd \chef_solo_ue\utils .\script.ps1Note: Do not open the Services window while you run the command. Also, if the command is unsuccessful and certain services appear as disabled, you need to restart your machine and run the command again. - Restore the backed up configuration files to their initial locations (C:\Program Files\SDL\Editor Service\bin for Sdl.EditorService.Host.exe.config and C:\Program Files\SDL\Editor Service Router\bin for Sdl.EditorServiceRouter.Host.exe.config).
- Go to C:\Deployment\ES\Dev and copy the DLL files from that folder to C:\Program Files\SDL\Editor Service\bin. Replace the existing files.
- Restart the SDL Editor Service Router service.
- Restart the SDL Editor Service.
- Restart the SDL BCM Service.
- Verify that the SDL BCM Service is working properly by typing <oe-host>:8080/bcms/health in your browser's address bar, and then pressing Enter:
- If the service is working properly, the status is
UP(<Status>UP</Status>). - If the service is not working properly, the page is not displayed.
Throughout this topic, <oe-host> indicates the name or IP address of the machine on which you want to upgrade SDL Online Editor. - If the service is working properly, the status is
- Verify that the SDL Editor Service is working properly by typing <oe-host>:80/api/es/health in your browser's address bar, and then pressing Enter:
- If the service is working properly, the status in
UP(<Status>UP</Status>). - If the service is not working properly, the status is
DOWN(<Status>DOWN</Status>).
- If the service is working properly, the status in
- Verify that the SDL Editor Service Router service is working properly by typing <oe-host>:90/api/esrouter/health in your browser's address bar, and then pressing Enter:
If the service is working properly, the status is
UP("status":"UP"). - Optional: If any of the services is not working properly, do the following:
- Restart your machine.
- Start the SDL Editor Service Router service.
- Restart the SDL Editor Service.
- Start the SDL BCM Service.
- Verify again by using the links mentioned earlier. For the upgrade to be successful, all the services need to be working properly.