Upgrading the (Session-enabled) Content Service
The Content Service or Session-enabled Content Service provides interaction between the website and the Content Porter microservices.
Before you begin
If you are using Digital Experience Accelerator (DXA) to build your website, you need to install support for the DXA data model, which is provided by the DXA Model Extension to the (Session-enabled) Content Service. When upgrading the (Session-enabled) Content Service, you must also upgrade the DXA Model Extension to the same version. Refer to the DXA documentation for installation instructions and list of compatible versions.
Procedure
- If the server on which this microservice is installed is a Windows machine, uninstall the Windows service by doing the following:
- On the server, open a Powershell command prompt.
- Access the bin\ subfolder of the microservice root folder.
- Run the script called uninstallService.ps1. (If you are running the service on a different default HTTP port than the default, add a
server.portparameter and set it to your custom port number.)
- On the server on which this microservice is installed, do one of the following:
- If your microservice runs as a standalone microservice, navigate to the configuration location of the microservice.
- If you are upgrading from SDL Web 8.5, and if your microservice runs as a (now discontinued) deprecated Java/JSP web application-based microservice, navigate to the WEB-INF/classes/ subdirectory of the web application.
- Back up the contents of this folder to a safe location.
- Back up any custom microservice extensions you have created to a safe location.
- On your SDL Tridion Sites 9.1 installation media, navigate to the folder Content Delivery\roles\.
- Do one of the following:
- If you are upgrading the Session-enabled Content Service, navigate to the session\service\ subfolder.
- If you are upgrading the regular Content Service, navigate to the content\ subfolder.
- Navigate to the standalone\ subfolder.
- Delete all files and subfolders from the microservice location or, if you are upgrading from SDL Web 8.5 and your microservice ran as a web application, from the web application location.
- Do one of the following:
- If your microservice runs as a standalone microservice, copy the contents of the installation media folder, including subfolders, to your installed microservice location.
- If you are upgrading from SDL Web 8.5, and if you were running a (now discontinued) Java/JSP web application-based microservice, migrate to a standalone microservice by copying the contents of the installation media folder, including subfolders, to a location of your choice.
- If you have previously made changes to the application.properties file that you backed up, compare your backed-up application.properties file to the new one you just copied, and reapply your customizations to the new file.
- If you have previously made changes to the cd_ambient_conf.xml file that you backed up, compare your backed-up cd_ambient_conf.xml file to the new one you just copied, and reapply your customizations to the new file.
- Restore the rest of your backed-up configuration files (but not the schemas\ subfolder) to the configuration location of the microservice.
- If you are upgrading from SDL Tridion Sites 9 and if one of your microservice extensions is the DXA model extension, follow the instructions in the SDL DXA 2.2 documentation to learn how to add the new DXA model extension to the microservice during installation. Do not restore the old DXA model extension in the next step.
- Restore any backed-up custom microservice extensions to your microservice.
- If the server on which this microservice is installed is a Windows machine, install the Windows service by doing the following:
- On the server, open a Powershell command prompt.
- Access the bin\ subfolder of the microservice root folder.
- Type installService.ps1 but do not press Enter yet.
- Alternatively, if this microservice is installed on a non-Windows machine, open a console, go to the bin/ subdirectory and type the name of the start script in the but do not press Enter yet.
- If you are using the Add-on service, add the string
-Daddonserviceurl=URL, where URL is the URL of the Add-on service. Alternatively, you can define an environment variable calledaddonserviceon this machine, and set it to the URL of the Add-on service. - If your Add-on service is secured, add a number of additional environment variables as needed.
- If you are running your service on a different default HTTP port than the default, add
server.port=PORT, where PORT is the custom port on which you run the service. - Press Enter to run the script.