Documentation Center

Configuring Moderation Web service end points

Configure the end points of the Moderation Web Service to give the Content Manager access to this Web service to retrieve and store comments and ratings. If you want to aggregate comments and ratings from multiple Content Delivery instances, you can configure multiple end points.

Procedure

  1. On the Content Manager server machine, access %TRIDION_HOME% (defaults to C:\Program Files (x86)\Tridion\). From there, navigate to the subfolder web\WebUI\Models\UGC\Configuration\ and open the DataSources.xml file you find there in a plain-text or XML editor.
  2. In this location, find the <DataSource> element and set the value of the subelements as follows:
    <Key>
    A number that uniquely identifies the Moderation Web Service end point.
    <Match>
    A regular expression that specifies which items in Content Manager should use this data source. If you use only one data source, leave this element set to its default value, which is ^(ugc:|oe:|tcm:)+. But if the Moderation Web Service only provides access to comments and ratings for items from, say, a Publication with ID 14, change the string to (tcm:0-14-1$)|(tcm:14-\d*$)|(tcm:14-\d*-64$)|(oe:14-\d*-196616$)|(ugc:).
    <Url>
    The URL of the Moderation Web Service.
    <TimeOut> (optional, defaults to 100000)
    The time (in milliseconds) after which Content Manager considers the Content Delivery Web service to be unreachable. For example, a value of 4000 creates a 4-second timeout limit.
    <Threshold> (optional, defaults to 0)
    Set this number to the same value as the value of the CommentScoreMinimumThreshold element in the User Generated Content configuration file cd_ugc_conf.xml. In this DataSources.xml file, the value is used to change the visualization of the comment score in various parts of the Content Manager Explorer GUI: a comment score that is equal to or lower than this Threshold value is colored red; all other comment scores are colored black.
    <RatingMinimum> (optional, defaults to 0)
    The lowest rating that a visitor can give to a Component or Page (can be any integer, including negative numbers).
    <RatingMaximum> (optional, defaults to 5)
    The highest rating that a visitor can give to a Component or Page (can be any integer, including negative numbers).
    <OAuthEnabled> (optional, defaults to false)
    Set this element to the value true if you have configured authentication for the Moderation Web Service.
    <Locale> (optional)
    The locale used by Content Delivery, in the format ll-cc, where ll is the language and cc is the country. For example, en-us.
    <ClientId> (optional)
    If you authenticate access to the Web service, the ID of a client account listed in the Web service configuration file cd_webservice_conf.xml. Leave this element empty if not in use.
    <ClientSecret> (optional)
    If you authenticate access to the Web service, the password of the client account specified under <ClientId>. Leave this element empty if not in use.
    <EventSystemClientId> (optional)
    If you authenticate access to the Web service, the ID of a client account listed in the Web service configuration file cd_webservice_conf.xml. Leave this element empty if not in use. This ID is used for cases in which the Event System triggers a Web service call, for example, when the deletion of a Page or Component triggers the deletion of its associated Comments and Ratings. The value of this element can be the same as the value of ClientId.
    <EventSystemClientSecret> (optional)
    If you authenticate access to the Web service, the password of the client account specified under <EventSystemClientId>. Leave this element empty if not in use. This password is used for cases in which the Event System triggers a Web service call. The value of this element can be the same as the value of ClientSecret.
    <AccessTokenUrl> (optional)
    If you authenticate access to the Web service, the URL of your access token. Leave this element empty if not in use.
  3. If you want to configure additional instances of the Moderation Web Service for the purpose of aggregating comments and ratings from multiple Web sites, add a new <DataSource> and specify its parameters.
  4. Save and close DataSources.xml.
  5. Restart IIS.