Replacing the UGC Moderation web service web application with a standalone UGC Moderation Service microservice

The UGC Moderation web service is now called the UGC Moderation service.

Procedure

  1. From the WEB-INF/classes/ subdirectory of your Java/JSP web application, copy all files to a backup location.
  2. On the SDL Tridion Sites installation media, access Content Delivery\roles\ugc\service-moderation\.
  3. Copy the standalone\ folder in this location, including its files and subfolders, to a location of your choice, and rename it to moderationservice.
  4. Go to the config\ subfolder.
  5. 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.
  6. Open your new Storage Layer configuration file, cd_storage_conf.xml, for editing.
  7. Find the ConfigRepository element and ensure that the following attributes have correct values:
    ServiceUri
    This attribute must be set to the Discovery Service URL. If your Discovery Service runs on the same machine as this service, and on a default port, the value is already correct.
    TokenServiceUrl
    This attribute must be set to the Token Service URL. If your Token Service runs on the same machine as this service, and on a default port, the value is already correct.
  8. In your backed-up copy of the cd_storage_conf.xml, find the Storage element that configures the connection to the UGC database, and copy that element to your new cd_storage_conf.xml. Additionally, if you have previously modified the ObjectCache element, also reapply those customizations, as found in the backed-up file, to the new file.
  9. Only if you modified your logback.xml file, merge the contents of your backed-up logback.xml file with the new file by the same name.
  10. If you have previously modified the file cd_webservice_conf.xml, copy the section called <OData>, with all of its contents, to your clipboard.
  11. In cd_storage_conf.xml, find the <OData> section and replace it with the copied code.
  12. Save and close cd_storage_conf.xml.
  13. If you have previously modified the UGC configuration file, cd_ugc_conf.xml, compare it to your new cd_ugc_conf.xml, and reapply your customizations to the new file (except for ODataEndpoint).
  14. Open the Ambient Data Framework configuration file, cd_ambient_conf.xml, and do one of the following:
    • If you are not using OAuth authentication, set the OAuthEnabled attribute of the Security element to false, and set the Enabled attribute of the Rules also to false.
    • If you are using OAuth authentication, from your backed-up cd_webservice_conf.xml file, copy the SharedSecret element content over the value of SharedSecret in your new cd_ambient_conf.xml.
  15. Save and close cd_ambient_conf.xml.
  16. From the backed-up file cd_webservice_conf.xml, copy the sections called <AuthenticationServer> and <Accounts>, with all of their contents, and merge them with the same sections in the cd_ambient_conf.xml of your Discovery Service.
  17. Restore the rest of your backed-up configuration files (but not the schemas\ subfolder) to the configuration location of the microservice.
  18. Proceed by installing the UGC Moderation Service standalone microservice.