Template

Written By Devin O'Neill ()

Updated at April 23rd, 2025

Summary

This section is used to review and create a new template for the clients.

Navigation: Products > User Generated Content > Ratings & Reviews

Click on Add Ratings & Reviews template and enter the name of the template. It will display a popup to add a new template as shown in the following image.

Select the template type as required.

Ratings & Reviews template displays the template name, template display type, and actions.

  • Template Name: Name of the template
  • Template Display type: Select the template type which is displayed.
  • Actions: This action attribute includes the Edit Template and Edit.

Edit Template: Edit the template as required.

Edit: Click to edit the following fields.

  1. Add Fields: Whenever the user wants to create the template instead of copying from the source site, i.e. includes default Site(template) or Current Site (template) to Destination Current Site(Template).
  2. UI Settings: User Interface settings helps help users to take the key decisions like moderation, enable or disable, and sorting reviews, etc.
  3. POP Settings: Using the Popup Settings, users are able to Enable or disable the reviews, ratings, moderation notifications, active inline error messages, etc.
  4. Email Settings: This setting section is used to manage the different emails which are going to be sent from the R&R module to the specific client as per the requirements.
  5. Other Settings: The user is able to set the settings to either enable or disable using this functionality.
  6. SDK Settings: This setting section is used to customize the widgets for the SDK setup.

1. Add Fields:

This section is used to add or manage the different fields related to the template.

  • Field Name: Enter the name for the new field.
  • Validation: Select the validation type from the dropdown list i.e. Email, Date, Numeric,
    Alphanumeric, etc.
  • Enabled Field: Select ON/OFF toggle to enable or disable the field.
  • Required: To make this field compulsory on the Review Submission Form, then enable
    this attribute. If enabled, then provide the error message.
    E.g. Field name is compulsory.
  1. Error Message: Displays the error message.
  2. Add to comment: Enable this setting to add this field to the R&R reports.
  3. Map Review Details: Select the drop-down list of database column names in which users want to store the field data.
  4. Field Type: Select the type of fields in a drop-down list, such as text box, text area, radio button, etc. Selecting a particular field opens an “Advanced Field Settings” option, which is explained below.

Click on the Save button and select the Next.

2.UI Settings

User Interface settings help users take the key decisions like moderation, enable or disable, and sorting reviews, etc.

Field

 

Description

 
Do you want the admin to reply? Enable this to display admin replies to review.
Admin Reply Title This attribute is used to set the title for the admin's reply, which will be displayed whenever the admin replies to the user's review of the curation report.
Read More Link Enable/Disable to display a preview of the review with a link as you read more.
Rating Summary Enable/Disable to display the rating summary on the PDP.
Display Review Stats Enable/Disable. Turn on the review statistics.
Do you want to enable helpful functionality? Enable/Disabled to helpful functionality.
Enable Image Moderation Enable this setting attribute to provide the curation facility to the site admin. After activating this attribute, added review attachments(image or video) will be listed in the curation report first and after approval from the site admin, the submitted review attachments(image or video) will be displayed on the e-commerce site.
Enable Non-Rating Field on average Enable/Disabled the non-rating field on average.
Hide Review Statistic Zero Count Rating Value Enable/Disabled the zero count rating value. 
How many reviews are to be displayed per page? Enter number of reviews should be displayed per page
Set up reviews Spam Limit Enter the number of spam limit on reviews
Do you want to enable the sorting option for reviews?

Choose any one of the following options

  • Submission Date: Select the date for submission of the reviews
  • Approval Date: Use to approve the reviews if it meets the user criteria
  • Highest Rated: If you select the Highest Rated option, it displays the Select Field for Sorting field to select from the drop-down list.
Select Date Format Pattern Type

Choose any one of the following options

  • Numerical:
  • Textual:
Additional Settings Optional

Click on the Save button and select Next.

3.Popup Settings

Using the Popup Settings, users are able to enable or disable the reviews, ratings, moderation notifications, active inline error messages, etc.

  • Rating Help-Text: Display a hint to the user when hovering over the rating such as good,
    average, worst, etc.
  • Enable Comments: This allows the users to give comments
  • Require Preview: Enable this button to provide a preview for the user before submitting
    the review.
  • Half-Rating: Allow users to select a half rating such as 2.5 out of 5.

Additional Settings

  • Review moderation: Enable this setting attribute to provide the curation facility for the site
    admin. After activating this attribute, submitted reviews will be listed in the curation report first and after approval from the site admin, the submitted reviews will be displayed on
    the e-commerce site.
  • Review notifications: Enable or disable the review notification emails.
  • Email From: Enter an email address(es) that will be displayed to the end-user when he
    will receive the review email.
  • Email From Name: Enter the name which will be displayed to the end-user when he receives
    the admin's reply email.
  • Before Approval Subject: When the review is submitted, an email will be sent to the user.
    This attribute is used to write the subject for that email.
  • After Approval Subject: When the review is approved by the admin, an email will be sent
    to the user. This attribute is used to write the subject for that email.
  • Activate Custom Validation: Enable this setting to set the custom validation message for WAR.
  • Enable Pros/Cons Inline Editing: Enable or disable a hint to the user when hovering over the rating such as good, average, worst, etc.
  • Activate Inline Error Message: Use this setting to display the error message along with the fields.
  • Submit Button Text: Set the text to display on the submit button.
  • Preview Button: Set the text to display on the preview button.

Click on Save and select the Next button to move Email Settings.

4.Email Settings

This setting section is used to manage the different emails which are going to be sent from
the R&R module for the specific client as per the requirements. The following image shows the
email setting section.

  • Enable Alerts Mail Settings: Select ON/OFF , if you select ON, it enables the Review Alerts Settings and Review Assign Email Settings.
  1. Review Alerts Settings

Each attribute is explained in detail.

  • Alert Type: Select the alert type from the drop-down list i.e. Sentiment Score /Star Ratings/ Keyword
  • Product Category: Add the product category for which we want to set the
    review alert.
  • Schedule Day: Select the day from the dropdown list on which the client wants to receive the specific review alert email.
  • Schedule Time (Hrs): Select the time at which the client wants to receive the specific review alert email.
  • From Email: Add an email address, which will be displayed in the From section of the review alert email.
  • Reply Email: Add an email address, to which the admin can send the reply for review alert email.
  • Send Alert To: Add the client’s email address at which the client wants to receive the review alert email.
  • Email Subject: Add the specific subject for review alert email.

After setting all these setting attributes, click on Save the button, what creates the new review alert & it will be displayed in the review alert list, as shown in the following image.

  1. Review Assign Email Setting
    • Status: Select ON/OFF
    • Email Subject: Add the subject to the email
    • From Email: Need to add an email address, which will be displayed in the “from” section of review alert email.
    • From Name: Add the specific subject for the review alert email.
    • Include Review: Add an email address, to which the admin can be sent the reply to the review alert email.

Click on Save and select the Next button to move Other Settings.

5.Other Settings

Users are able to set the settings to either enable or disable it using this functionality.

Field Description
Cache Management
Flush CDN Cache Click on the 'Flush CDN' button, to flush the CDN Cache.
Create Configure Cache Click on this button to create the current client’s R&R module configuration cache.
Clear Configure Cache Click on the 'Delete Configure Cache' button, to clear the current client’s R&R module configuration cache.
Enable Review Caching Enable this setting to fetch reviews and ratings from the cache.
JWT Settings
Enable JWT Authentication Enable or disable JWT Authentication.
JWT Algorithm Enter Algorithm for API, E.g. HS256.
JWT Secret Key Click on the 'Generate Secret Key' button to generate the Secret key.
Loyalty Settings
Loyalty Integration Use this setting to integrate the ratings & reviews with customer loyalty.
Loyalty Type Select loyalty type, i.e. Default or Customize.
R&R Syndication
Enable Partner Syndication Enable or disable partner syndication.
Activate Syndicate Site

Enable or disable to activate syndicate site.

Activate syndicate site flag enabled then added to syndicate site:

Syndicate from site Enter syndicate from site id.
Template Id Enter template id.
Keyword Cloud
Enable Keyword Cloud Use this setting to enable or disable the Keyword cloud.
Enable Keyword Search Use this setting to enable or disable the keyword search.
Enable Google Sentiment Enable or disable Google sentiment.
Sentiment Score Set a number of sentiment scores.
Keyword Search Limit Set a number of search limits.
Keyword Cloud Limit Set a number of keywords cloud limit.
Keyword Source Select a keyword source, either keyword from reviews or default keywords.
Highlight Option Select the highlight option, either Word or sentence.
Login Settings
Login Integration Use this setting to integrate ratings & reviews with social login
Login Type

Select whether the login form will be shown in the popup or if the user will be redirected to the login page.

Popup

Redirect URL

WAR URL Set the URL for the review page.
Login Page URL Set the URL for the login page.
Sentiment
Sentiment Range The select range for sentiment
Badge Settings
Enable Reviewer Type Enable the reviewer type from another set to add the extra column in the Curation Report having the label Change Verify Buyer Type. And from the dropdown list, Admin can change the reviewer type.
Enable Badges

Enabled or disabled badge settings

#Click on Add New button to create a badge --->

Badge Name Enter badge name.
Badge Type Select badge type.
Badge image URL Enter badge image URL.
Range Select the minimum and maximum range to provide a badge to a user.
Status Enabled or disabled to a badge.
Report Settings
Enable Review Translation Enable or disable to review the translation.

Click on Save and select the Next button to move to SDK Settings.

6.SDK Settings

This setting section is used to customize the widgets for the SDK setup.

SDK Configuration Settings

  • Terms and Condition Label: Set the label for the Terms & Condition link.
  • Terms & Condition Label Link: Set the redirection link for the Terms & Condition by
    which it will redirect to the particular client page.
  • Review Guidelines Label: Set the label for the Review Guidelines link.
  • Review Guidelines Link: Set the redirection link for the Review Guidelines by which it
    will be redirected to the particular client page.
  • Write a review Submit Button Label: Set the label for the Write a review Submit Button.
  • Write a review Submit Button Text: Set the text for the Write a review Submit Button.
  • Preview Button Label: Set the label for the Preview Button.
  • Preview Button Text: Set the text for the Preview Button.
  • Thank You Pop-up Message: After writing the reviews in an email, when the user clicks
    on the submit button, it will redirect the user to the Thank you page. Set the redirection URL
    For that, thank you pop up in this attribute.

Manage SDK Field Settings

Users are manually able to create the SDK Fields as required.