Using Reviews and Reviews Summary (Display) using-reviews-and-reviews-summary-display
The Reviews component is a composite of Comments and Rating components ready for use.
The Reviews Summary (Display) component provides a summary of an active or closed instance of a Reviews component for display elsewhere on the site.
Adding a Review to a Page adding-a-review-to-a-page
To add a Reviews component to a page in author mode, use the component browser to locate Communities / Reviews and drag it into place on a page, such as a position relative to the feature for users to review.
For necessary information, visit Communities Components Basics.
When the required client-side libraries are included, this is how the Reviews component appears.
Configuring Reviews configuring-reviews
Select the placed Reviews component so you can access and select the Configure icon which opens the edit dialog.
Under the Allowed Ratings tab, specify the complete list of ratings to be shown to members. The first rating should be an overall/general rating, as it is the rating which provides the average rating for the Review Summary (Display) component. The next two ratings in the default configuration should be given a different title, other than “Subrating 1” or “Subrating 2”.
-
Allowed Ratings
A list of ratings from which a member can choose.
Use the up arrow, down arrow and delete buttons to modify the visible selections.
Click Add Item to add another rating choice.
Under the Required Ratings tab, reenter items from the list of Allowed Ratings that are required for rating. If an item is only specified on the Allowed Ratings tab, it may be left unmarked when submitted by the member.
On the website, required ratings are marked with an asterisk. If an item is required and left unmarked, a message is displayed to the member, and the submission is denied until all required ratings are marked.
-
Required Ratings
A subset of allowed ratings, indicating which ratings are required.
Use the up arrow, down arrow and delete buttons to modify the visible selections.
Click Add Item to add another response choice.
Under the Reviews tab, specify how reviews are handled.
-
Allow Replies
If checked, allow replies to reviews. Default is unchecked.
-
Closed
If checked, the review is closed to new reviews and replies. Default is unchecked.
-
Allow File Uploads
If checked, allow file attachments to be uploaded for the review. Default is unchecked.
-
Max File Size
Relevant only if Allow File Uploads is checked. This field limits the size (in bytes) of an uploaded file. Default is 10 MB.
-
Max Message Length
Maximum number of characters that may be entered into the text box. Default is 4096 characters.
-
Allowed File Types
Relevant only if Allow File Uploads is checked. A comma-separated list of file extensions with the “dot” separator. For example, .jpg, .jpeg, .png, .doc, .docx, .pdf. If any file types are specified, then those not specified are not allowed. Default is none specified such that all file types are allowed.
-
Rich Text Editor
If checked, posts may be entered with markup. Default is unchecked.
-
Allow Voting
If checked, include the Voting feature for a topic. Default is unchecked.
Under the User Moderation tab, specify how the posted reviews are managed. For more information, see Moderating User Generated Content.
-
Pre-Moderation
If checked, reviews must be approved before they appear on a publish site. Default is unchecked.
-
Delete Reviews
If checked, the member who posted the review can delete it. Default is unchecked.
-
Deny Reviews
If checked, allow moderators to deny reviews. Default is unchecked.
-
Close / Reopen Reviews
If checked, allow moderators to close and reopen reviews. Default is unchecked.
-
Flag Reviews
If checked, allow members to flag reviews as inappropriate. Default is unchecked.
-
Flag Reason List
If checked, allow members to choose, from a drop-down list, their reason for flagging a review as inappropriate. Default is unchecked.
-
Custom Flag Reason
If checked, allow members to enter their own reason for flagging a review as inappropriate. Default is unchecked.
-
Moderation Threshold
Enter the number of times a review has to be flagged by members before moderators are notified. Default is one time (1).
-
Flagging Limit
Enter the number of times a review has to be flagged before it is hidden from public view. This number must be greater than or equal to the Moderation Threshold. Default is 5.
Adding a Review Summary (Display) to a Page adding-a-review-summary-display-to-a-page
To add a Reviews Summary (Display) component to a page in author mode, locate the component
Communities / Reviews Summary (Display)
And drag it into place on a page where a summary of an active or closed review is to be displayed.
For necessary information, visit Communities Components Basics.
When the required client-side libraries are included, this is how the Reviews Summary (Display)component appears.
Configuring Reviews Summary (Display) configuring-reviews-summary-display
Select the placed Reviews Summary (Display) component so you can access and select the Configure icon which opens the edit dialog.
Under the Review Summary tab
-
Review PathEnter or browse to the placed instance of the
reviewscomponent so you can summarize, for example, if added to the Web Page of the Geometrixx Engage site, the path would be:/content/sites/engage/en/page/jcr:content/content/primary/reviews -
Include histogramIf checked, include the display of a bar graph indicating how many star ratings there are in the reviews being summarized. Default is unchecked.
Changing to a Custom Review Type changing-to-a-custom-review-type
The Reviews component uses the Comment System.
By changing the Comment Resource Type, the comment system no longer generates an instance of a comment using the default, but rather one that has been customized (extended) by developers.
When the custom resource types are known, enter Design Mode and double-click the placed Comments component to open a dialog with an additional tab.
Under the Resource Types tab, specify the custom resourceType for new instances of the Comments or Voting components:
-
Comment Resource Type
Navigate to the resourceType of an extended
commentcomponent (single comment) in /apps. For example,/apps/social/commons/components/hbs/comments/comment.This resource identifies the resourceType of the UGC created when a visitor posts a comment.
-
Voting Resource Type
Navigate to the resourceType of an extended
votingcomponent in /apps. For example,/apps/social/components/hbs/voting.This resource identifies the resource type of the UGC created when a visitor posts a vote.
-
Comment System Resource Type
Navigate to the resourceType of an extended
commentscomponent (Comment System) in /apps. Leave blank unless the page template dynamically includes the Comment System in the underlying script instead of being added to the page as a resource (comments node). Learn more by reading about the{{include}}helper.
Site Visitor Experience site-visitor-experience
Moderators and Administrators moderators-and-administrators
When the signed in user has moderator or administrator privileges, they are able to perform the moderation tasks permitted by the configuration of the component, regardless of who authored the review.
Members members
When the site visitor is signed in, depending on the configuration, they may:
- Post a new review
- Edit their own review
- Delete their own review
- Flag others’ review comments
Only one rating per member is allowed. The member may change their rating at any time.
Anonymous anonymous
Site visitors who are not signed in may only read posted reviews, translate them if supported, but may not add a rating or a review, nor flag others’ review comments.
Additional Information additional-information
More information may be found on the Review Essentials page for developers.
For moderation of posted comments, see Moderating User Generated Content.
For translation of posted comments, see Translating User Generated Content.