Replacing the UGC Community web service web application with a standalone UGC Community Service microservice
The UGC Community web service is now called the UGC Community service.
Procedure
- From the WEB-INF/classes/ subdirectory of your Java/JSP web application, copy all files to a backup location.
- On the SDL Tridion Sites installation media, access Content Delivery\roles\ugc\service-community\.
- Copy the standalone\ folder in this location, including its files and subfolders, to a location of your choice, and rename it to communityservice.
- Go to the config\ subfolder.
- 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.
- Open your new Storage Layer configuration file, cd_storage_conf.xml, for editing.
- Find the
ConfigRepositoryelement 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.
- In your backed-up copy of the cd_storage_conf.xml, find the
Storageelement 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 theObjectCacheelement, also reapply those customizations, as found in the backed-up file, to the new file. - 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.
- If you have previously modified the file cd_webservice_conf.xml, copy the section called
<OData>, with all of its contents, to your clipboard. - In cd_storage_conf.xml, find the
<OData>section and replace it with the copied code. - Save and close cd_storage_conf.xml.
- 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). - 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
OAuthEnabledattribute of theSecurityelement tofalse, and set theEnabledattribute of theRulesalso tofalse. - If you are using OAuth authentication, from your backed-up cd_webservice_conf.xml file, copy the
SharedSecretelement content over the value ofSharedSecretin your new cd_ambient_conf.xml.
- If you are not using OAuth authentication, set the
- Save and close cd_ambient_conf.xml.
- 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. - Restore the rest of your backed-up configuration files (but not the schemas\ subfolder) to the configuration location of the microservice.
- Proceed by installing the UGC Community Service standalone microservice.
- Installing the UGC Community service as a microservice
Run the appropriate microservice installation PowerShell or Unix script to install and run the standalone microservice.