26 Working with the Reviews Widgets

This chapter provides a quick reference for moderating the reviews posted to your site by visitors, configuring the visitor permissions and appearance settings for the Reviews widget, and deploying the Reviews widget (and all related widgets) to a web page with either dynamic (default) or custom settings.

This chapter contains the following sections:

26.1 Overview

Figure 26-1 Reviews Menu

Description of Figure 26-1 follows
Description of "Figure 26-1 Reviews Menu"

The Reviews menu (shown in Figure 26-1) is used to work with the Reviews widget and all of its related widgets (Reviews Summary, Links to Topics, Reviews Average Rating, Top Ranked Reviews, Recently Reviewed, and Most Reviewed). The Reviews menu provides you with options to moderate the reviews that visitors post to the pages of your website, configure visitor permissions and appearance settings for the Reviews widget, and deploy the Reviews widget and all related widgets (with either default or custom settings) to a web page.

The instructions in this section are written as a quick reference and it is assumed you are already logged in to the Community interface. If you need instructions for logging in, see Section 24.1, "Logging In."

26.2 Moderating Reviews

This section is for users assigned the Moderator role. Moderators can access and moderate the reviews posted to the website in the following ways:

26.2.1 Moderating All Reviews

To access the "All Reviews" screen (shown in Figure 26-2), select Reviews from the menu bar, then select Moderate, and then select All Reviews. The "All Reviews" screen is used to moderate all reviews posted to the pages of your website. The reviews are listed in the order they were posted (most recent to least recent). You can sort the reviews in this list by either the visitor who posted the review or the date the review was posted.

Figure 26-2 'All Reviews' Screen

Description of Figure 26-2 follows
Description of "Figure 26-2 'All Reviews' Screen"

Table 26-1 Moderating All Reviews

Action Instructions

Approve visitors' reviews

  1. In the menu bar, select Reviews, then select Moderate, and then select All Reviews.

  2. Point to the review you wish to approve.

  3. In the menu that appears, select Approve.

    The approved review is displayed on the website.

Delete visitors' reviews

  1. In the menu bar, select Reviews, then select Moderate, and then select All Reviews.

  2. Point to the review you wish to delete.

  3. In the menu that appears, select Delete.

  4. In the confirmation box, click OK.

    The review is removed from the Community interface and from the web page to which it was posted.

Mark a review as inappropriate

  1. In the menu bar, select Reviews, then select Moderate, and then select All Reviews.

  2. Point to the review that contains inappropriate or inaccurate content.

  3. In the menu that appears, select Mark Inappropriate.

    The status of the review changes to Inappropriate and the review is not displayed on the web page. Marking the review as inappropriate indicates to other moderators that the review must be modified before being displayed on the website.

Note: Reviews can be marked as inappropriate either manually or through auto moderation. For information about configuring automatic moderation, see Chapter 30, "Configuring Community Widget Settings."

Modify a review

  1. In the menu bar, select Reviews, then select Moderate, and then select All Reviews.

  2. Point to the review you wish to modify.

  3. In the menu that appears, select Edit.

    The "Edit Review" screen is displayed.

  1. In the "Review" field, make the desired changes to the content.

  2. Click Save.

    The modified review is displayed in the Community interface and on the web page to which it was posted.

Note: If manual moderation is enabled (Section 30.2.5, "Working with the Moderation Screen"), manually approve the review you modified to display it on the web page.

Add an authenticated visitor to the "Visitor Whitelist"

  1. In the menu bar, select Reviews, then select Moderate, and then select All Reviews.

  2. Point to a review posted by the authenticated visitor you wish to add to the whitelist.

  3. In the menu that appears, click Whitelist Author.

    The "Visitor Whitelist" screen opens, and the visitor's name is displayed in the list of whitelisted visitors.

Note: For more information about the "Visitor Whitelist," see Section 30.2.4, "Working with the Visitor Whitelist Screen."

Add a visitor to the "Visitor Blacklist"

  1. In the menu bar, select Reviews, then select Moderate, and then select All Reviews.

  2. Point to a review posted by the visitor you wish to add to the blacklist.

  3. In the menu that appears, click Blacklist Author.

    The "Visitor Blacklist" screen opens. If the visitor is authenticated, the visitor's user name is displayed in the list of blacklisted visitors. If the visitor is anonymous, the visitor's IP address is displayed in the list of blacklisted visitors.

Note: For more information about the "Visitor Blacklist," see Section 30.2.3, "Working with the Visitor Blacklist Screen."

Search for a review containing specific content

  1. In the menu bar, select Reviews, then select Moderate, and then select All Reviews.

  2. In the "Search" field, enter the criteria you wish to search for.

  3. Click the magnifying glass icon.

    Only reviews containing the specified search criteria are listed in the "All Reviews" screen.

Identify a flagged review

A review that is flagged on the website will appear in the "All Reviews" screen with Flagged posted next to its Approved status.

View a topic on the website

  1. In the menu bar, select Reviews, then select Moderate, and then select All Reviews.

  2. In the list of reviews, navigate to the review that is posted to the desired topic.

  3. Click the View Topic Page icon.

    The web page opens displaying the topic, the deployed Reviews widget, and the reviews visitors posted to the page.

View all reviews posted by a specific visitor

  1. In the menu bar, select Reviews, then select Moderate, and then select All Reviews.

  2. In the list of reviews, navigate to the review that is posted by the desired authenticated visitor.

  3. Click the visitor's name.

    The "User Reviews" screen opens and displays only the reviews posted by the selected visitor.

Note: For information about moderating reviews by user, see Section 26.2.3, "Moderating Reviews by User".

View all reviews posted to a specific topic

  1. In the menu bar, select Reviews, then select Moderate, and then select All Reviews.

  2. In the list of reviews, navigate to the review that is posted to the desired topic.

  3. Click the name of the topic.

    The "All Reviews" screen opens and displays only the reviews posted to the selected topic.

Note: For information about moderating reviews by topic, see Section 26.2.2, "Moderating Reviews by Topic".

26.2.2 Moderating Reviews by Topic

To access the "Reviews by Topic" screen, select Reviews from the menu bar, then select Moderate, and then select Reviews by Topic. The "Reviews by Topic" screen is used to sort all reviews that have been posted to the pages of your website by the title of the topic (web page) to which the reviews are posted. The average rating given to each topic is listed in the Average Rating column, located to the right of the corresponding topic. When you select the title of a topic from this screen, the All Reviews screen opens and displays only the reviews posted to that topic (as shown in Figure 26-3).

Figure 26-3 'Reviews by Topic' Screen

Description of Figure 26-3 follows
Description of "Figure 26-3 'Reviews by Topic' Screen"

Table 26-2 Moderating Reviews by Topic

Action Instructions

Filter topics by category

  1. In the menu bar, select Reviews, then select Moderate, and then select Reviews by Topic.

  2. In the "Filter" panel, select the checkbox(es) of the desired resource type(s).

    The web pages (topics) with Reviews widgets of the selected resource type(s) are the only web pages listed in the "Reviews by Topic" screen.

  3. Select the name of the topic whose reviews you wish to view.

    The "All Reviews" screen opens and displays only the reviews posted to the topic you selected.

Note: The resource types (topic types) available in the "Filter" panel are dynamically modified by the current category file (Section 26.3.1, "Reconfiguring the Reviews Widgets' Appearance Settings"). "Others" refers to Reviews widgets (and topics) that do not belong to a resource type.

Approve visitors' reviews

  1. In the menu bar, select Reviews, then select Moderate, and then select Reviews by Topic.

  2. In the "Reviews by Topic" screen, select the topic whose reviews you wish to moderate.

  3. In the "All Reviews" screen for the topic you selected, point to the review you wish to approve.

  4. In the menu that appears, select Approve.

    The approved review is displayed on the website.

Delete visitors' reviews

  1. In the menu bar, select Reviews, then select Moderate, and then select Reviews by Topic.

  2. In the Reviews by Topic screen, select the topic whose reviews you wish to moderate.

  3. In the All Reviews screen for the topic you selected, point to the review you wish to delete.

  4. In the menu that appears, select Delete.

  5. In the confirmation box, click OK.

    The review is removed from the Community interface and from the web page to which it was posted.

Mark a review as inappropriate

  1. In the menu bar, select Reviews, then select Moderate, and then select Reviews by Topic.

  2. In the "Reviews by Topic" screen, select the topic whose reviews you wish to moderate.

  3. In the "All Reviews" screen for the topic you selected, point to the review that contains inappropriate or inaccurate content.

  4. In the menu that appears, select Mark Inappropriate.

    The status of the review changes to Inappropriate and the review is not displayed on the web page. Marking the review as inappropriate indicates to other moderators that the review must be modified before being displayed on the website.

Note: Reviews can be marked as inappropriate either manually or through auto moderation. For information about configuring automatic moderation, see Chapter 30, "Configuring Community Widget Settings."

Modify a review

  1. In the menu bar, select Reviews, then select Moderate, and then select Reviews by Topic.

  2. In the "Reviews by Topic" screen, select the topic whose reviews you wish to moderate.

  3. In the "All Reviews" screen for the topic you selected, point to the review you wish to modify.

  4. In the menu that appears, select Edit.

    The "Edit Review" screen is displayed.

  1. In the "Review" field, make the desired changes to the content.

  2. Click Save.

    The modified review is displayed in the Community interface and on the web page to which it was posted.

Note: If manual moderation is enabled (Section 30.2.5, "Working with the Moderation Screen"), manually approve the review you modified to display it on the web page.

Add an authenticated visitor to the "Visitor Whitelist"

  1. In the menu bar, select Reviews, then select Moderate, and then select Reviews by Topic.

  2. In the "Reviews by Topic" screen, select the topic whose reviews you wish to moderate.

  3. In the "All Reviews" screen for the topic you selected, point to a review posted by the authenticated visitor you wish to add to the whitelist.

  4. In the menu that appears, click Whitelist Author.

    The "Visitor Whitelist" screen opens, and the visitor's name is displayed in the list of whitelisted visitors.

Note: For more information about the Visitor Whitelist, see Section 30.2.4, "Working with the Visitor Whitelist Screen."

Add a visitor to the "Visitor Blacklist"

  1. In the menu bar, select Reviews, then select Moderate, and then select Reviews by Topic.

  2. In the "Reviews by Topic" screen, select the topic whose reviews you wish to moderate.

  3. In the "All Reviews" screen for the topic you selected, point to a review posted by the visitor you wish to add to the blacklist.

  4. In the menu that appears, click Blacklist Author.

    The "Visitor Blacklist" screen opens. If the visitor is authenticated, the visitor's user name is displayed in the list of blacklisted visitors. If the visitor is anonymous, the visitor's IP address is displayed in the list of blacklisted visitors.

Note: For more information about the Visitor Blacklist, see Section 30.2.3, "Working with the Visitor Blacklist Screen."

Search for a specific topic

  1. In the menu bar, select Reviews, then select Moderate, and then select Reviews by Topic.

  2. In the "Search" field, enter the title of the topic you wish to search for.

  3. Click the magnifying glass icon.

    Only topics containing the requested search criteria are listed in the "Reviews by Topic" screen.

Enable or disable the reviews widget deployed on a given topic (web page)

  1. In the menu bar, select Reviews, then select Moderate, and then select Reviews by Topic.

  2. In the list of topics, point to the topic whose reviews widget you wish to either enable or disable.

    Note: You cannot enable a topic's Reviews widget if one of the following is true: The Reviews widget was closed automatically due to the settings in the "Reviewing Auto Disable" section of the "Reviews Appearance" screen, or the Reviews widget was deployed with a "Post Status" of Closed (set from the "Reviews Deployment" screen).

  3. Enable or disable the reviews widget. If you wish to allow visitors to post reviews to the selected topic, in the context menu select Allow Posting. If you wish to disable the reviews widget deployed on a selected topic, in the context menu select Close Posting.

    If you selected Allow Posting, visitors can post reviews to the selected topic. If you selected Close Posting, visitors cannot post reviews to the selected topic.

Note: You can use the "Posting Filter" to filter the topics displayed in the "Reviews by Topic" list by the status of the reviews widget deployed on the topic. For example, if you select Allowed in the "Posting Filter" section, then only topics that allow visitor to post reviews will be displayed in the list and vice versa.

Identify a flagged review

  1. In the menu bar, select Reviews, then select Moderate, and then select Reviews by Topic.

  2. In the "Reviews by Topic" screen, select the topic whose reviews you wish to view.

  3. In the list of reviews, identify any flagged reviews.

    A review that is flagged on the website will appear in the list of reviews with Flagged posted next to its Approved status.

View a topic on the website

  1. In the menu bar, select Reviews, then select Moderate, and then select Reviews by Topic.

  2. In the "Reviews by Topic" screen, navigate to the desired topic.

  3. Click the View Topic Page icon.

    The web page opens displaying the topic, the deployed Reviews widget, and the reviews visitors posted to the page.

View all reviews posted by a specific visitor

  1. In the menu bar, select Reviews, then select Moderate, and then select Reviews by Topic.

  2. In the "Reviews by Topic" screen, navigate to and click the name of the topic to which the desired visitor posted a review.

  3. In the "All Reviews" screen for the topic you selected, navigate to the review posted by the desired visitor and click the visitor's name (located to the right of the visitor's review).

    The "User Reviews" screen opens and displays all of the reviews posted by the selected visitor.

Note: For more information about moderating reviews by user, see Section 26.2.3, "Moderating Reviews by User."

26.2.3 Moderating Reviews by User

The "Reviews by User" screen is used to sort all posted reviews by the names of the visitors who posted them. When you select a visitor's name in this screen, the User Reviews screen opens and displays the reviews the selected visitor posted along with the visitor's user name, profile picture, and e-mail address (if available), as shown in Figure 26-4.

Figure 26-4 'Reviews by User' Screen

Description of Figure 26-4 follows
Description of "Figure 26-4 'Reviews by User' Screen"

Table 26-3 Moderating Reviews by User

Action Instructions

Approve visitors' reviews

  1. In the menu bar, select Reviews, then select Moderate, and then select Reviews by User.

  2. In the "Reviews by User" screen, select the name of the visitor whose reviews you wish to moderate.

  3. In the "User Reviews" screen, point to the review you wish to approve.

  4. In the menu that appears, select Approve.

    The approved review is displayed on the website.

Delete visitors' reviews

  1. In the menu bar, select Reviews, then select Moderate, and then select Reviews by User.

  2. In the "Reviews by User" screen, select the name of the visitor whose reviews you wish to moderate.

  3. In the "User Reviews" screen, point to the review you wish to delete.

  4. In the menu that appears, select Delete.

  5. In the confirmation box, click OK.

    The review is removed from the Community interface and from the web page to which it was posted.

Mark a review as inappropriate

  1. In the menu bar, select Reviews, then select Moderate, and then select Reviews by User.

  2. In the "Reviews by User" screen, select the name of the visitor whose reviews you wish to moderate.

  3. In the "User Reviews" screen, point to the review that contains inappropriate or inaccurate content.

  4. In the menu that appears, select Mark Inappropriate.

    The status of the review changes to Inappropriate. Marking the review as inappropriate indicates to other moderators that the review must by modified before being displayed on the website.

Note: Reviews can be marked as inappropriate either manually or through auto moderation. For information about configuring automatic moderation, see Chapter 30, "Configuring Community Widget Settings."

Modify a review

  1. In the menu bar, select Reviews, then select Moderate, and then select Reviews by User.

  2. In the "Reviews by User" screen, select the name of the visitor whose reviews you wish to moderate.

  3. In the "User Reviews" screen, point to the review you wish to modify.

  4. In the menu that appears, select Edit.

    The "Edit Review" screen is displayed.

  5. In the "Review" field, make the desired changes to the content.

  6. Click Save.

    The modified review is displayed in the Community interface and on the web page to which it was posted.

Note: If manual moderation is enabled (Section 30.2.5, "Working with the Moderation Screen"), manually approve the review to display it on the web page.

Add an authenticated visitor to the "Visitor Whitelist"

If you know which authenticated visitor you want to add to the whitelist, do the following:

  1. In the menu bar, select Reviews, then select Moderate, and then select Reviews by User.

  2. In the "Reviews by User" screen, point to the visitor's name.

  3. In the menu that appears, click Whitelist Author.

    The "Visitor Whitelist" screen opens, and the visitor's name is displayed in the list of whitelisted visitors.

If you wish to view the reviews posted by the visitor before adding that visitor to the whitelist, do the following:

  1. In the menu bar, select Reviews, then select Moderate, and then select Reviews by User.

  2. In the "Reviews by User" screen, select the name of the visitor whose reviews you wish to view.

  3. In the "User Reviews" screen, point to any of the reviews displayed in the list.

  4. In the menu that appears, select Whitelist Author.

    The "Visitor Whitelist" screen opens, and the visitor's name is displayed in the list of whitelisted visitors.

Note: For more information about the Visitor Whitelist, see Section 30.2.4, "Working with the Visitor Whitelist Screen."

Add an authenticated visitor to the "Visitor Blacklist"

If you know which visitor you want to add to the blacklist, do the following:

  1. In the menu bar, select Reviews, then select Moderate, and then select Reviews by User.

  2. In the "Reviews by User" screen, point to the visitor's name.

  3. In the menu that appears, click Blacklist Author.

    The "Visitor Blacklist" screen opens, and the visitor's name is displayed in the list of blacklisted visitors.

If you wish to view the reviews posted by the visitor before adding the visitor to the blacklist, do the following:

  1. In the menu bar, select Reviews, then select Moderate, and then select Reviews by User.

  2. In the "Reviews by User" screen, select the name of the visitor whose reviews you wish to view.

  3. In the "User Reviews" screen, point to any of the reviews displayed in the list.

  4. In the menu that appears, select Blacklist Author.

    The "Visitor Blacklist" screen opens, and the visitor's name is displayed in the list of blacklisted visitors.

Note: For more information about the Visitor Blacklist, see Section 30.2.3, "Working with the Visitor Blacklist Screen."

Search for a specific visitor

  1. In the menu bar, select Reviews, then select Moderate, and then select Reviews by User.

  2. In the "Search" field, enter the name of the visitor you wish to search for.

  3. Click the magnifying glass icon.

    Only visitor names that match the specified search criteria are listed in the "Reviews by User" screen.

Identify a flagged review

  1. In the menu bar, select Reviews, then select Moderate, and then select Reviews by User.

  2. In the "Reviews by User" screen, select the name of the visitor whose reviews you wish to view.

  3. In the "User Reviews" screen, identify any flagged reviews:

    A review that is flagged on the website will appear in the list of reviews with Flagged posted next to its Approved status.

View a topic on the website

  1. In the menu bar, select Reviews, then select Moderate, and then select Reviews by User.

  2. In the "Reviews by User" screen, select the name of the visitor whose review is posted to the desired topic.

  3. In the "User Reviews" screen, navigate to the desired review.

  4. Click the View Topic Page icon.

    The web page opens displaying the topic, the deployed Reviews widget, and the reviews visitors posted to the page.

View all the reviews posted to a specific topic

  1. In the menu bar, select Reviews, then select Moderate, and then select Review by User.

  2. In the "Reviews by User" screen, select the name of a visitor who posted a review to the desired topic.

  3. In the "User Reviews" screen, navigate to the review posted to the desired topic, and click the name of the topic (located under the visitor's review).

    The "All Reviews" screen for the topic you selected opens and displays all of the reviews posted to that topic.

Note: For more information about moderating reviews by topic, see Section 26.2.2, "Moderating Reviews by Topic."

26.3 Reconfiguring the Reviews Widget's Default Settings

Default settings are a widget's saved appearance and permission settings. Users assigned the Designer role can modify the default appearance of the Reviews widget by selecting Reviews, Configure, and then Appearance in the menu bar. Users assigned the Moderator role can reconfigure the default reviewing permissions by selecting Reviews, Configure, and then Permissions in the menu bar. Once the permissions and appearance settings are saved, the system dynamically updates the Reviews widget's default tags in the Community interface and on pages where tags with default settings are deployed.

You can reconfigure the default settings of the Reviews widget in the following ways:

26.3.1 Reconfiguring the Reviews Widgets' Appearance Settings

To access the "Reviews Appearance" screen (shown in Figure 26-5), select Reviews from the menu bar, then select Configure, and then select Appearance. This screen is used to reconfigure the Reviews widget's color schema, sort order, and other display properties.

Figure 26-5 'Reviews Appearance' Screen

Description of Figure 26-5 follows
Description of "Figure 26-5 'Reviews Appearance' Screen"

Table 26-4 Reconfiguring the Reviews Widget's Appearance Settings

Section Field Description

General

Show Reviews

Select either Display or Do not Display to specify whether approved reviews are displayed to site visitors.

General

Review Type

Select the type of review your deployment supports. Select either:

  • Full review – Supports a review field with a title field and rating capabilities which allows visitors to write a review, include a title for their review, and submit a rating with their review.

  • Brief review – Supports a review field with rating capabilities which allows visitors to write a review and submit a rating with their review.

General

Pagination

Specify the number of approved reviews that will be displayed on a given page at one time.

General

Display Order

Select one of the following to specify the order in which approved reviews will be displayed on a given page:

  • Newest at the top – Displays the most recently posted reviews at the top of the list of reviews.

  • Oldest at the top – Displays the oldest reviews at the top of the list of reviews.

  • Least ranked at the top – Displays the reviews that site visitors rank the least (or have not ranked) at the top of the list of reviews.

  • Most ranked at the top – Displays the reviews that site visitors frequently rank at the top of the list of reviews.

General

Review Submit Box

Specify whether the review field will be displayed At the top or At the bottom of the list of reviews on a given page.

General

Review Ranking

Specify whether site visitors can rank individual reviews as Helpful or Not Helpful. Select one of the following:

  • Enabled for all visitors – All visitors (authenticated and anonymous) can rank the reviews posted to a web page.

  • Enabled for registered visitors – Only authenticated visitors can rank the reviews posted to a web page.

  • Disabled – Individual reviews cannot be ranked.

General

Skin

Select Default to use the default color schema for the Reviews widget, or select Custom to upload your own CSS file.

General

Upload Custom CSS

If you selected the Custom option in the Skin field, use the Browse button to select a cascading style sheet (CSS) that will control the appearance of the Reviews widget.

General

Login Bar Required

Select either Yes or No to specify whether a Login Bar widget tag will be embedded in and deployed with the Reviews widget tag.

Note: If you select No, you can still deploy a standalone Login Bar widget tag on the same page as the Reviews widget (for instructions, see Section 28.3, "Deploying a Login Bar Widget Tag").

Reviewing Auto Disable

Max Number of Reviews Allowed

Use the drop-down menu to select the maximum number of reviews that can be posted to a given web page. Once the maximum number of reviews is reached, site visitors cannot post reviews to that particular web page.

Note: You can also enter the maximum number of reviews that can be posted to a given web page (for example, to specify 50 as the maximum number of reviews, enter 50 into this field).

Reviewing Auto Disable

Accept Reviews Until

Use the drop-down menu to select the number of days reviews can be posted to a given web page. Once the specified number of days is reached, site visitors cannot post reviews to that particular web page.

Note: You can also enter the maximum number of days reviews can be posted to a given web page (for example, to specify 30 as the maximum number of days reviews can be posted, enter 30 into this field).

Review Body

Max Length

Select either 450 characters or 900 characters to set the review field size.

Review Body

Type

Select the type of text that can be entered into the review field. Select either:

  • Plain text – Visitors can only enter text into the review field.

  • HTML with blocked JS – Visitors can enter text and basic HTML tags into the review field.

  • HTML and Media with blocked JS – Visitors can enter text, basic HTML tags, videos, and so on into the review field.

Help and Disclaimer

Show Help Text

Select either Display or Do not display to specify whether help text will be displayed to visitors.

Help and Disclaimer

Help Text

If you selected Display in the Show Help Text field, enter the help text you wish to display to visitors. When the Reviews widget is deployed, the help text is displayed above the reviews submit box.

Note: This field supports plain text and basic HTML tags. You can use HTML tags to control the appearance of your help text.

Help and Disclaimer

Show Disclaimer Text

Select either Display or Do not display to specify whether a disclaimer will be displayed to visitors.

Help and Disclaimer

Disclaimer Text

If you selected Display in the Show Disclaimer Text field, enter the disclaimer text you wish to display to visitors. When the Reviews widget is deployed, the disclaimer is displayed beneath the reviews submit box.

Note: This field supports plain text and basic HTML tags. You can use HTML tags to control the appearance of your disclaimer.

Topic Categories

Upload Categories

Use the Browse button to upload the desired category file, which will dynamically modify the resource types available from:

Note: The category file must be in .txt format, the resource types listed in the file must be in a key=value structure, only an English alphanumeric string is permitted for the key in the key=value pairs, each resource type listed in the file must be on its own line, and the size of the file you are uploading can be no more than 100MB.

26.3.2 Reconfiguring the Reviews Widgets' Permissions Settings

To access the "Reviewer Permissions" screen (shown in Figure 26-6), select Reviews from the menu bar, then select Configure, and then select Permissions. This screen is used to display or hide the review field and set visitors' permissions to review.

Figure 26-6 'Reviewer Permissions' Screen

Description of Figure 26-6 follows
Description of "Figure 26-6 'Reviewer Permissions' Screen"

Table 26-5 Reconfiguring Reviewing Permissions for Site Visitors

Section Field

Reviewing Enabled

  • Yes configures the widget to display a review field.

  • No hides the review field, but displays only approved reviews, if the widget was previously enabled.

Who Can Review?

Available only if the widget is configured to display a review field:

  • Anonymous users can review grants reviewing permissions to all site visitors.

    Available only if anonymous visitors can review:

    User must enter a name requires anonymous visitors to specify a name when posting a review.

    User must enter an email address requires anonymous visitors to specify an email address when posting a review.

    User must enter a verification code requires anonymous visitors to enter the letters and/or numbers of a CAPTCHA image before they can post a review.

    Note: By default, the User must enter a verification code option is greyed out (not available). For information about enabling this option, see the Oracle Fusion Middleware WebCenter Sites Developer's Guide.

    Restrict user to one review per topic allows visitors to post only one review to a given web page (topic).

  • Only authenticated users can review grants reviewing permissions only to authenticated visitors.

    User can modify and delete his reviews allows authenticated visitors to modify and delete the reviews they post.

    Restrict user to one review per topic allows authenticated visitors to post only one review to a given web page (topic).

26.4 Deploying the Reviews Widget Tags

This section is for users assigned the Designer role. Designers can deploy the Reviews widget tag and all of its related widget tags with either default or custom settings by selecting Reviews, Deploy, and then the name of the widget tag you wish to deploy in the menu bar. Table 26-6 lists the reviews widget tags and indicates which type of deployment each tag supports.

Table 26-6 Deploying the Reviews Widget Tags

Widget Tag Deploy with Default Settings Configure and Deploy Custom Settings

Reviews

Yes

Yes

Reviews Summary

No

Yes

Links to Topics

No

Yes

Average Rating

No

Yes

Top Ranked Reviews

Yes

Yes

Recently Reviewed

Yes

Yes

Most Reviewed

Yes

Yes

This section contains the following topics:

26.4.1 Deploying a Default Reviews Widget Tag

Several types of reviews widgets can be deployed with default settings: Reviews, Top Ranked Reviews, Recently Reviewed, and Most Reviewed. The default settings for the Reviews widget are its saved settings, which are configured in the Permissions screen (select Reviews, Configure, and then Permissions) and Appearance screen (select Reviews, Configure, and then Appearance). The default settings for all other review related widgets are configured out-of-the-box and cannot be reconfigured in the Community interface. Each reviews widget has its own deployment screen, which displays the widget tag. The default settings are used as property values in the widget tag.

To deploy default reviews widget tags

  1. In the menu bar, select Reviews, Deploy, and then select the name of the widget tag you wish to deploy:

    • Reviews – to deploy the Reviews widget tag. If reviewing is enabled (in the "Reviewer Permissions" screen), the Reviews widget displays a review field. If displaying reviews is enabled (in the Reviews Appearance screen), then a list of site visitors' reviews is displayed on the web page.

      Note:

      If any of the following deployment scenarios are true, you will have to customize the Reviews widget by specifying a resource ID:

      • You wish to link the Links to Topics widget to a Reviews widget.

      • You want to deploy the Reviews Summary widget on a web page different from the one on which the desired Reviews widget is deployed.

      • You want the Reviews Average Rating widget to display the average rating of the web page on which a Reviews widget tag is deployed.

      • You want to deploy more than one Reviews widget tag on the same page.

      For more information, see the description for the Resource ID field in Table 26-7.

    • Top Ranked Topics – to deploy the Top Ranked Reviews widget tag. When deployed, this widget lists and provides links to the website's highest rated web pages (topics).

      Note:

      By default, the Top Ranked Reviews widget lists topics that have an associated Reviews widget of resource type "Others." To configure the Top Ranked Reviews widget to list topics of all resource types, you will have to modify the widget tag by removing the "resource_type":"other" parameter. For more information, see the Oracle Fusion Middleware WebCenter Sites Developer's Guide.

    • Recently Reviewed – to deploy the Recently Reviewed widget tag. When deployed, this widget displays a list of the top ten web pages (topics) to which site visitors have recently posted reviews.

      Note:

      By default, the Recently Reviewed widget lists topics that have an associated Reviews widget of resource type Others. To configure the Recently Reviewed widget to list topics of all resource types, you will have to modify the widget tag by removing the "resource_type":"other" parameter. For more information, see the Oracle Fusion Middleware WebCenter Sites Developer's Guide.

    • Most Reviewed – to deploy the Most Reviewed widget tag. When deployed, this widget displays a list of the top ten web pages (topics) to which site visitors frequently post reviews.

      Note:

      By default, the Most Reviewed widget lists topics that have an associated Reviews widget of resource type Others. To configure the Most Reviewed widget to list topics of all resource types, you will have to modify the widget tag by removing the "resource_type":"other" parameter. For more information, see the Oracle Fusion Middleware WebCenter Sites Developer's Guide.

    The deployment screen for each widget looks similar to the Reviews Deployment screen, shown in Figure 26-7:

Figure 26-7 'Reviews Deployment' Screen: Site Settings vs. Custom Settings

Description of Figure 26-7 follows
Description of "Figure 26-7 'Reviews Deployment' Screen: Site Settings vs. Custom Settings"

  1. In the "Tag Format" field, make sure Site settings is selected.

  2. Deploy the widget tag:

    1. In the "Tag" field, copy (Ctrl+C) the widget tag.

    2. Insert the widget tag into the desired template, preview the asset to which the template is assigned, and publish the template to the website. For detailed instructions, see steps 3 – 7 in Section 24.3, "Next Steps."

26.4.1.1 Hiding the Default Reviews Widget

If you want to hide a default Reviews widget that is displayed on various web pages, instead of accessing the template's source code, you (depending on your role in the Community application) can use the Reviews widget's Permissions and Appearance screens.

  1. If you are a moderator, hide the review field:

    1. In the menu bar, select Reviews, then select Configure, and then select Permissions.

    2. In the "Reviewing Enabled" field, select No.

    3. Click Save.

      The review field is now hidden from site visitors.

  2. If you are a designer, hide the list of reviews:

    1. In the menu bar, select Reviews, then select Configure, and then select Appearance.

    2. In the "Show Reviews" field, select Do not display.

    3. Click Save.

      The list of reviews is now hidden from site visitors.

26.4.2 Deploying Custom Reviews Widget Tags

You can customize any widget tag related to reviewing functionality (except Links to Topics) by setting its properties using the tag generator in the widget's Deployment screen. Each time a widget tag is customized, it must be redeployed because custom values cannot be saved in the Community interface, instead they are saved only in that particular instance of the widget tag.

To configure and deploy custom reviews widget tags 

  1. In the menu bar, select Reviews, then select Deploy, and then select the name of the widget tag you wish to customize and deploy:

    • Reviews – to customize and deploy the Reviews widget tag: that is, (1) Configure the Reviews widget tag with a unique identifier and resource type so that it can be referred to by other reviewing related widgets for its content, such as the number of reviews and the average rating. (2) Specify the web page (topic title and URL) on which the Reviews widget tag is deployed. (3) Reconfigure certain properties that were set as defaults in the tag's Permissions (select Reviews, Configure, and then select Permissions) screen and Appearance (select Reviews, Configure, and then select Appearance) screen.

    • Reviews Summary – to customize and deploy the Reviews Summary widget tag; that is, specify the resource ID of a Reviews widget in the "Reviews Summary Deployment" screen. When deployed, the Reviews Summary widget displays short, summarized information about the number of reviews posted to the web page on which the specified Reviews widget is deployed along with the date of the most recently posted review.

    • Links to Topics – to customize and deploy the Links to Topics widget tag; that is, specify the resource ID of a Reviews widget and, optionally, the resource URL of a web page to which you wish this widget to link. When deployed, the Links to Topics widget displays summarized information about the specified Reviews widget, such as the number of reviews posted to the web page (topic) on which that Reviews widget is deployed, along with a link to the desired web page (if you specified the URL of a web page in the Links to Topics widget tag).

      Note:

      You can configure this widget to display summarized information about and links to multiple Comments and/or Reviews widgets. For instructions, see the Oracle Fusion Middleware WebCenter Sites Developer's Guide.

    • Average Rating – to customize and deploy the Reviews Average Rating widget tag: that is, for the Reviews Average Rating widget to display the average rating of a given topic (web page), the Reviews Average Rating widget must be configured to refer to the Reviews widget, deployed on the desired topic (web page), by its resource ID.

    • Top Ranked Topics – to customize and deploy the Top Ranked Reviews widget tag: that is, have the Top Ranked Reviews widget display the highest rated topics of a desired type (instead of topics of type "Others"). For example, topics of type "Article" are posted on a web page; each article has its own Reviews widget of resource type "Article." If the Top Ranked Reviews widget is to list the highest rated topics of type "Article," it must be configured to refer to the Reviews widget by resource type.

      Note:

      To configure the Top Ranked Reviews widget to list topics of all resource types, you will have to modify the widget tag by removing the "resource_type":"other" parameter. For more information, see the Oracle Fusion Middleware WebCenter Sites Developer's Guide.

    • Recently Reviewed – to customize and deploy the Recently Reviewed widget tag: that is, have the Recently Reviewed widget display recently reviewed topics of a desired type (instead of topics of type "Others"). For example, topics of type "Article" are posted on a web page; each article has its own Reviews widget of resource type "Article." If the Recently Reviewed widget is to list the recently reviewed topics of type "Article," it must be configured to refer to the Reviews widget by resource type.

      Note:

      To configure the Recently Reviewed widget to list topics of all resource types, you will have to modify the widget tag by removing the "resource_type":"other" parameter. For more information, see the Oracle Fusion Middleware WebCenter Sites Developer's Guide.

    • Most Reviewed – to customize and deploy the Most Reviewed widget tag: that is, have the Most Reviewed widget display the most popular topics of a desired type (instead of topics of type "Others"). For example, topics of type "Article" are posted on a web page; each article has its own Reviews widget of resource type "Article." If the Most Reviewed widget is to list the most popular topics of type "Article," it must be configured to refer to the Reviews widget by resource type.

      Note:

      To configure the Most Reviewed widget to list topics of all resource types, you will have to modify the widget tag by removing the "resource_type":"other" parameter. For more information, see the Oracle Fusion Middleware WebCenter Sites Developer's Guide.

  2. In the "Tag Format" field, select Custom Settings. Customize the desired widget tag by setting values for the available fields in the tag's custom deployment screen.

    For field definitions, see:

  3. Deploy the custom tag:

    1. In the "Tag" field, copy (Ctrl+C) the widget tag.

    2. Insert the widget tag into the desired template, preview the asset to which the template is assigned, and publish the template to the website. For instructions, see steps 3 – 7 in the Section 24.3, "Next Steps."

26.4.3 Custom Widget Tag Deployment Screens

Once you access a given widget's custom deployment screen, you can use the available fields to set custom (temporary) values for the widget tag. These values are not saved, except in the template to which you copy the customized instance of the tag. This section provides field definitions.

26.4.3.1 Custom Reviews Widget Tag's Deployment Screen

The screen shown in Figure 26-8 is used to define custom values for a particular instance of the Reviews widget tag, which can then be deployed on web pages.

Figure 26-8 'Reviews Deployment' Screen

Description of Figure 26-8 follows
Description of "Figure 26-8 'Reviews Deployment' Screen"

Note:

The Default field value references the setting that is specified in the widget's "Permissions" or "Appearance" screen. If you choose a default setting for your custom tag, and you deploy the tag, that default setting will be dynamically updated if its value is modified and saved in the Community interface.

Table 26-7 Customizing and Deploying the Reviews Widget Tag

Field Description

Review Type

Select the type of review structure your deployment supports. Select either:

  • Brief review – Supports a review field with rating capabilities, which allows visitors to write a review and submit a rating with their review.

  • Full review – Supports a review field with a title field and rating capabilities, which allows visitors to write a review, include a title for their review, and submit a rating with their review.

Rating

Determine whether the Reviews widget supports a binary rating (Thumbs Up/Thumbs Down) where visitors can specify whether they liked or disliked the topic, or a complex rating (Stars) where visitors can rate the topic by selecting a number of stars.

Resource ID

Enter a resource ID (unique identifier) for this instance of the Reviews widget tag. This resource ID can be used in other reviews widget tags (for example, the Reviews Summary widget tag) to refer to this instance of the Reviews widget. You can enter a maximum of 50 English alphanumeric characters into this field.

Note:

  • This field is required only if you want to configure other reviews widget tags to refer to this Reviews widget's content (for example, the number of reviews posted to the web page).

  • If you wish to link the Links to Topics widget to this instance of the Reviews widget, you will have to note the URL of the web page on which this Reviews widget is deployed.

Resource Type

Select a resource type (topic type) for this instance of the Reviews widget tag. The resource type of a Reviews widget tag categorizes the web page on which it is deployed. If you do not specify a resource type, the topic (web page) on which this instance of the Reviews widget tag is deployed is associated with the default Others resource type.

Note: The current category file (Section 26.3.1, "Reconfiguring the Reviews Widgets' Appearance Settings") determines the resource types that are available to you.

Review Submit Box

Specify whether the review field will be displayed At the top or At the bottom of the list of reviews on a given page.

Display Order

Select one of the following to specify the order in which approved reviews will be displayed on a given page:

  • Most ranked at the top – Displays the reviews that site visitors rank the most at the top of the list of reviews.

  • Oldest at the top – Displays the oldest reviews at the top of the list of reviews.

  • Newest at the top – Displays the most recently posted reviews at the top of the list of reviews.

  • Least ranked at the top – Displays the reviews site visitors rank the least (or have not ranked) at the top of the list of reviews.

Review Ranking

Specify whether visitors can rank individual reviews as Helpful or Not Helpful. Select one of the following:

  • Enabled for all visitors – All visitors (authenticated and anonymous) can rank the reviews posted to a web page.

  • Enabled for registered visitors – Only authenticated visitors can rank the reviews posted to a web page.

  • Disabled – Individual reviews cannot be ranked.

Resource Title

Enter the title of the web page (topic) on which the widget tag will be deployed.

Resource URL

Enter the URL of the web page on which the widget tag will be deployed.

Post Status

Select either Open or Close to specify whether site visitors can post reviews to the page on which this widget tag is deployed.

Note: If you deploy the Reviews widget with a "Post Status" of Close on a web page (topic), you cannot enable reviewing on that web page (topic) from the "Reviews by Topic" screen.

Login Bar Required

Select either Yes or No to specify whether a Login Bar widget tag will be embedded in and deployed with the Reviews widget tag.

Note: If you select No, you can still deploy a standalone Login Bar widget tag on the same page as the Reviews widget (for instructions, see Section 28.3, "Deploying a Login Bar Widget Tag").

26.4.3.2 Custom Reviews Summary Widget Tag's Deployment Screen

The screen shown in Figure 26-9 is used to define custom values for a particular instance of the Reviews Summary widget tag, which can then be deployed on web pages.

Figure 26-9 'Reviews Summary Deployment' Screen

Description of Figure 26-9 follows
Description of "Figure 26-9 'Reviews Summary Deployment' Screen"

Table 26-8 Customizing and Deploying the Reviews Summary Widget Tag

Field Description

Resource ID

Specify the resource ID (unique identifier) of a Reviews widget tag. When the Reviews Summary widget is deployed, it displays summarized information about the number of reviews posted to the web page on which the specified Reviews widget is deployed.

Show Last Review Date

Select Yes to display the most recent date a review was posted to a web page, or select No to display only the number of reviews posted to the page.

Default Value: No

26.4.3.3 Custom Links to Topics Widget Tag's Deployment Screen

The screen shown in Figure 26-10 is used to define custom values for a particular instance of the Links to Topics widget tag, which can then be deployed on web pages.

Figure 26-10 'Links to Topics Deployment' Screen

Description of Figure 26-10 follows
Description of "Figure 26-10 'Links to Topics Deployment' Screen"

Table 26-9 Customizing and Deploying the Links to Topics Widget Tag

Field Description

Resource ID

This field is required. Specify the resource ID (unique identifier) of a Reviews widget tag. When the Links to Topics widget is deployed, it displays summarized information about the number of reviews posted to the web page on which the specified Reviews widget is deployed.

Resource URL

If you want the Links to Topics widget to redirect visitors to a certain web page when a visitor clicks the summarized information about a Reviews widget, specify the resource URL of the desired web page.

Note: If you do not specify a resource URL, when a visitor clicks the summarized information about the specified Reviews widget, the Links to Topics widget redirects the visitor to the page on which the Reviews widget (specified in the Resource ID field) is deployed. If there are multiple Reviews widgets with the same resource ID deployed on the page, the Links to Topics widget redirects the visitor to the last active widget on that page.

26.4.3.4 Custom Reviews Average Rating Widget Tag's Deployment Screen

The screen shown in Figure 26-11 is used to define custom values for a particular instance of the Reviews Average Rating widget tag, which can then be deployed on web pages.

Figure 26-11 'Reviews Average Rating Deployment' Screen

Description of Figure 26-11 follows
Description of "Figure 26-11 'Reviews Average Rating Deployment' Screen"

Table 26-10 Customizing and Deploying the Average Rating Widget Tag

Field Description

Resource ID

Specify the resource ID (unique identifier) of a Reviews widget tag. When this instance of the Reviews Average Rating widget is deployed, it displays the average rating of the web page on which the specified Reviews widget is deployed.

26.4.3.5 Custom Top Ranked Reviews Widget Tag's Deployment Screen

The screen shown in Figure 26-12 is used to define custom values for a particular instance of the Top Ranked Reviews widget tag, which can then be deployed on web pages.

Figure 26-12 'Top Ranked Reviews Deployment' Screen

Description of Figure 26-12 follows
Description of "Figure 26-12 'Top Ranked Reviews Deployment' Screen"

Table 26-11 Customizing and Deploying the Top Ranked Reviews Widget Tag

Field Description

Resource Type

Select a resource type (topic type). When the Top Ranked Reviews widget is deployed, it lists the highest rated topics of a certain type (for example, Article) on which a Reviews widget assigned to the specified resource type is deployed. If the deployed Reviews widgets are not assigned a resource type, select Others.

Default Value: Others

Note: The current category file (Section 26.3.1, "Reconfiguring the Reviews Widgets' Appearance Settings") determines the resource types that are available to you.

Rating

Select a type of ratings widget: Stars or Thumbs Up/Down. Only web pages on which a ratings widget of the specified type is deployed will be included in the list.

Default Value: Stars

Number of Topics

Specify the number of web pages (topics) to be included in the list (for example, enter 5 to display a list of the five highest rated topics).

Default Value: 10

Include Since

Click in this field to render the date picker. Select a date by which to filter the web pages that will be listed. When deployed, the Top Ranked Reviews widget lists only the web pages whose reviews were posted on or after the specified date. This allows you to avoid displaying outdated pages and reviews.

Note: If you do not wish to use the date picker, you can enter a date using the format dd-mm-yyyy (for example, 02-04-2011).

26.4.3.6 Custom Recently Reviewed Widget Tag's Deployment Screen

The screen shown in Figure 26-13 is used to define custom values for a particular instance of the Recently Reviewed widget tag, which can then be deployed on web pages.

Figure 26-13 'Recently Reviewed Deployment' Screen

Description of Figure 26-13 follows
Description of "Figure 26-13 'Recently Reviewed Deployment' Screen"

Table 26-12 Customizing and Deploying the Recently Reviewed Widget Tag

Field Description

Resource Type

Select a resource type (topic type). When the Recently Reviewed widget is deployed, it lists the recently reviewed topics of a certain type (for example, Article) on which a Reviews widget assigned to the specified resource type is deployed. If the deployed Reviews widgets are not assigned a resource type, select Others.

Default Value: Others

Note: The current category file (Section 26.3.1, "Reconfiguring the Reviews Widgets' Appearance Settings") determines the resource types that are available to you.

Number of Topics

Specify the number of web pages (topics) to be included in the list (for example, enter 5 to display the five most recently reviewed topics).

Default Value: 10

Include Since

Click in this field to render the date picker. Select a date by which to filter the web pages that will be listed. When deployed, the Recently Reviewed widget lists only the web pages whose reviews were posted on or after the specified date. This allows you to avoid displaying outdated pages and reviews.

Note: If you do not wish to use the date picker, you can enter a date using the format dd-mm-yyyy (for example, 02-04-2011).

26.4.3.7 Custom Most Reviewed Widget Tag's Deployment Screen

The screen shown in Figure 26-14 is used to define custom values for a particular instance of the Most Reviewed widget tag, which can then be deployed on web pages.

Figure 26-14 'Most Reviewed Deployment' Screen

Description of Figure 26-14 follows
Description of "Figure 26-14 'Most Reviewed Deployment' Screen"

Table 26-13 Customizing and Deploying the Most Reviewed Widget Tag

Field Description

Resource Type

Select a resource type (topic type). When the Most Reviewed widget is deployed, it lists the most reviewed topics of a certain type (for example, Article) on which a Reviews widget assigned to the specified resource type is deployed. If the deployed Reviews widgets are not assigned a resource type, select Others.

Default Value: Others

Note: The current category file (Section 26.3.1, "Reconfiguring the Reviews Widgets' Appearance Settings") determines the resource types that are available to you.

Number of Topics

Specify the number of web pages (topics) to be included in this list (for example, enter 5 to list the five topics site visitors frequently review).

Default Value: 10

Include Since

Click in this field to render the date picker. Select a date by which to filter the web pages that will be listed. When deployed, the Most Reviewed widget lists only the web pages whose reviews were posted on or after the specified date. This enables you to avoid displaying outdated pages and reviews.

Note: If you do not wish to use the date picker, you can enter a date using the format dd-mm-yyyy (for example, 02-04-2011).