Documentation Center

Upgrading the UGC Moderation Service

The UGC Moderation Service lets moderators manage comments and ratings. The UGC feature is deprecated as of SDL Tridion Sites 9.1.

Procedure

  1. If the server on which this microservice is installed is a Windows machine, uninstall the Windows service by doing the following:
    1. On the server, open a Powershell command prompt.
    2. Access the bin\ subfolder of the microservice root folder.
    3. Run the script called uninstallService.ps1. (If you are running the service on a different default HTTP port than the default, add a server.port parameter and set it to your custom port number.)
  2. 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.
  3. Back up the contents of this folder to a safe location.
  4. Back up any custom microservice extensions you have created to a safe location.
  5. 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.
  6. On your SDL Tridion Sites 9.5 installation media, navigate to the folder Content Delivery\roles\.
  7. Navigate to the ugc\service-moderation\ subfolder.
  8. Navigate to the standalone\ subfolder.
  9. 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.
  10. For each of your configuration files, do one of the folllowing:
    • If you have previously made changes to the file that you backed up, compare your backed-up version to the new version you just copied to the configuration location of the microservice, and merge your old file into the new file.
    • Alternatively, if you have not changed your backed-up file, ignore it and use the new file instead.
  11. In your configuration folder, in the Storage Layer configuration file, cd_storage_conf.xml, add the following element as the first subelement of the root Configuration element:
    <Namespace default="${namespaceprefix:-tcm}"/>
  12. Additionally, in the Storage element that refers to your UGC database, add a NamespaceServiceBean attribute and set it to the value UGCNamespaceService.
  13. Restore any backed-up custom microservice extensions to your microservice.
  14. If the server on which this microservice is installed is a Windows machine, install the Windows service by doing the following:
    1. On the server, open a Powershell command prompt.
    2. Access the bin\ subfolder of the microservice root folder.
    3. Run the script called installService.ps1.
    On a non-Windows machine, simply run the start script in the bin/ subdirectory.