CP Configuration Service for tagging and rating

CP Configuration Service for tagging and rating

The CP Configuration Service provides the parameters for tagging and rating.
The settings for the parameters listed here apply to tagging and rating portal wide. Some of these parameters have corresponding parameters that we can apply to individual tag or rating widget instances by the code that calls the widget instance. These can be dialog or inline widgets for tagging and rating.
A setting applied to an individual widget overwrites the portal wide setting by the CP Configuration Service parameter listed here.
In the following list of parameters the values given in parentheses are the default values. Parameters marked with <none> have no default values.

General parameters for tagging and rating

The following list shows general properties are for tagging and rating.

com.ibm.wps.cp.tagging.isTaggingEnabled = (true)

com.ibm.wps.cp.rating.isRatingEnabled = (true)

Enable or disable tagging or rating in the portal user interface Default is true.

com.ibm.wps.cp.tagging.contextMenu.isTaggingEnabled = (true)

com.ibm.wps.cp.rating.contextMenu.isRatingEnabled = (true)

Enable or disable the page menu entries for tagging and rating. Default is true.

com.ibm.wps.cp.tagging.portletContextMenu.isTaggingEnabled = (true)

com.ibm.wps.cp.rating.portletContextMenu.isRatingEnabled = (true)

Enable or disable the portlet menu entries for tagging and rating. Default is true.

com.ibm.wps.cp.default.feed.expiration = (600000)

Set the default feed expiration time. Specify value in milliseconds. The default is 600000 milliseconds = 10 minutes.

com.ibm.wps.cp.tagging.tagspace.TimeStampRange = (500)

Range in which the time stamps of a tag space should be considered equal in milliseconds. Setting this to a low value might impact performance.

com.ibm.wps.cp.tagging.normalization.displayNormalizedNames = (false)

Whether the normalized tag names are shown in the tag cloud. Accepted values are false|true . The default value is false . If there are three tags: cot?, cote, and c?te, the values for this parameter have the following meaning:

false

Default. All three tags show up separately in the tag cloud with a count of 1 each. Search suggestions for c are cot? , cote, and c?te; search suggestions for co are cot? and cote; search suggestion for c? is only c?te .

true

All three tags are normalized to the tag name cote. Only this tag name, cote, is shown in the tag cloud or suggested by the search service.

com.ibm.wps.cp.tagging.normalization.typeAhead = (nonnormalized)

Determine which tag names the type ahead feature for tag creation shows to the user. Accepted values are nonnormalized|normalized . Default is nonnormalized. If there are three tags: cot?, cote, and c?te, the values for this parameter have the following meaning:

nonnormalized

Default. Suggestions from the type ahead feature are as follows:

If a user types the characters c? , the type ahead service suggests c?te .

If a user types the characters co , the type ahead service suggests cot? and cote .

normalized

If set to normalized , the suggestions from the type ahead feature are as follows:

If a user types the characters c? or co , the type ahead service shows all three tags as suggestions: c?te , cot? , and cote .

com.ibm.wps.cp.filter.tagging.blacklist = (false)

Exclude unwanted tags, that is tags that might be seen as offending. If enabled, the blacklist filter checks every term that a user enters as a tag, before it is really applied and stored. If the term being used is listed on the blacklist, the portal does not allow this tag to be used and responds with an error message.

com.ibm.wps.cp.filter.tagging.whitelist = (false)

Check every term that users want to use as a tag before it is really applied and stored. If the term that the user types is not listed on the whitelist, the portal does not allow this tag to be used and responds with an error message. This way operators can specify a controlled vocabulary from which users need to chose when they want to tag resources.

com.ibm.wps.cp.tagging.validation.regex = [^\<\>\(\)\[\]:]{1,50}

Regular expression used to validate the tag names that users type. The default is [^\<\>\(\)\[\]:]{1,50}"} . This means that users can type tag names that are from 1 to 50 characters long and do not contain any angled brackets, parentheses, brackets, or colons: < > ( ) [ ] : .
Limitations:

Angled brackets ( < and > ) are not allowed within tag names. Therefore no matter how you customize the regular expression, angled brackets are not accepted.

Tag names must contain at least one alphanumeric character. Tag names that consist only of non-alphanumeric characters are not allowed either. Example: "!^#" .

com.ibm.wps.cp.rating.average.expected.averagerating = (3.0)

Expected rating average per rated item. An item can be a single resource, or a search scope, such as all resources of type A or category B.

com.ibm.wps.cp.rating.averagel.expected.numberofratings = (10)

Expected number of ratings per item. This value influences the credibility of the rating instances. The higher this value is, the more the average value is influenced by the value of the parameter com.ibm.wps.cp.rating.average.expected.averagerating .

com.ibm.wps.cp.rating.maxratingvalue = (5)

Maximum value that a rating can have. The default is 5.

Properties for the dialog tag widget in the default user interface

com.ibm.wps.cp.tagging.dialog.countsEnabled = (false)

Whether the count of each community tag is displayed. The count shows how often the tag has been applied by users. Default is false. To have the count of each community tag displayed, specify true . The count is then displayed in parentheses.

com.ibm.wps.cp.tagging.dialog.customLabelAddTags

Non-localized label shown for the text field that users use to add new tags. Example: Type your tag here: . Non-localized means that the label does not change with the browser language. This parameter has no default value.

com.ibm.wps.cp.tagging.dialog.customLabelCommunityTags

Custom string to show as the header text in the user interface for tags in the community section. Example: Community tags for resource XYZ . This parameter has no default value.

com.ibm.wps.cp.tagging.dialog.customLabelPersonalPrivateTags

Custom string to show as the header text in the user interface for tags in the personal private section. Example: Personal private tags for resource XYZ . This parameter has no default value.

com.ibm.wps.cp.tagging.dialog.customLabelPersonalPublicTags

Custom string to show as the header text in the user interface for tags in the personal public section. Example: Personal public tags for resource XYZ . This parameter has no default value.

com.ibm.wps.cp.tagging.dialog.customMessageNoCommunityTags

Non-localized label to display when no community tags are available. This parameter has no default value.

com.ibm.wps.cp.tagging.dialog.customMessageNoPersonalTags

Non-localized label to display when no personal tags are available. This parameter has no default value.

com.ibm.wps.cp.tagging.dialog.defaultView = (PUBLIC)

Specify which view tab is preselected by default, Public or Private. The default is PUBLIC . The other possible value is PRIVATE .

com.ibm.wps.cp.tagging.dialog.deletingEnabled = (true)

Whether a user can delete the user's personal tags Default is true.

com.ibm.wps.cp.tagging.dialog.displayTabs = (true)

Whether you want the tabs for switching between private and public tagging to be displayed to users. The default is true . Change this to false only if you deactivate private tagging by setting the parameter...
com.ibm.wps.cp.tagging.dialog.privateTaggingEnabled = false

com.ibm.wps.cp.tagging.dialog.maxCommunityTags = (50)

Maximum number of community tags shown in the community view. Specify a numeric value. Default is 50 . This limit is a display limitation of the widget, not a functional limitation.
Increasing this value can impact the performance of the tagging widget.

com.ibm.wps.cp.tagging.dialog.maxPersonalTags = (50)

Maximum number of personal tags that a user can assign to one resource. Specify a numeric value. Default is 50 . This limit applies separately to each, personal public and personal private tags. In other words, the default of 50 allows 50 public and 50 private tags per resource. This limit is a display limitation of the widget, not a functional limitation.
Increasing this value can impact the performance of the tagging widget.

com.ibm.wps.cp.tagging.dialog.maxPersonalTags = (50)

Maximum number of personal tags that users can create in the widget. Specify a numeric value. Default is 50 . This limit applies separately to each, personal public and personal private tags, in other words, the default of 50 allows 50 public and 50 private tags per user per resource. This limit is a display limitation of the widget, not a functional limitation. Increasing this value can impact the performance of the tagging widget.

com.ibm.wps.cp.tagging.dialog.order = (DESC)

Order direction for displaying the tags. Related to...
com.ibm.wps.cp.tagging.dialog.orderMetric

It can take the following values:

DESC

Default. Specifies descending order.
For example, when the default TAG_SPACE_COUNT_REVERSE_NAME is specified for the previous order metric parameter, tags with the highest count and the lowest character in the alphabet are listed first.

ASC

Specifies ascending order.
For example, if the order metric parameter is specified as...
orderMetric = TAG_SPACE_COUNT

...tags with the lowest count are listed first.

com.ibm.wps.cp.tagging.dialog.orderMetric = (TAG_SPACE_COUNT_REVERSE_NAME)

Order metric for the order by which the tags are displayed. To determine the actual order, use the parameter...
com.ibm.wps.cp.tagging.dialog.order

The default value is TAG_SPACE_COUNT_REVERSE_NAME. Tags are shown first by the tag count, with resources with more tags shown before resources with fewer tags, then, if resources have the same number of tags, alphabetically. Other possible values are:

TAG_SPACE_NAME
TAG_SPACE_COUNT
TAG_SPACE_CREATION_DATE
TAG_SPACE_LAST_MODIFIED_DATE
TAG_SPACE_COUNT_NAME

For more details refer to the class com.ibm.portal.cp.Constants.OrderMetric

com.ibm.wps.cp.tagging.dialog.privateTaggingEnabled = (true)

Whether users can add private tags in the dialog tag widget Default is true. If false , users can add only public tags.

com.ibm.wps.cp.tagging.dialog.tagsChangedEvent = (tagsChanged)

Event fired when a user adds or deletes a tag in the dialog widget. This event is caught by the inline tag widget or widgets of the same resource. These then update themselves.Default is tagsChanged. The event name specified here must be matched by the event name specified for the tag inline widget.
com.ibm.wps.cp.tagging.dialog.localePickerEnabled = (true)

Control whether the drop down button for selecting locales is displayed. Users can associate a locale with the tag that they apply to make sure it is displayed correctly.

com.ibm.wps.cp.tagging.dialog.messageFadeOutDuration = (1000)

Time that the fade-out action of return messages takes in milliseconds. This affects the fade-out after information, warning, or error messages that have been displayed. The default is 1000 milliseconds.

com.ibm.wps.cp.tagging.inline.tagsClickable = (true)

Whether the tags can be clicked for redirection or public render parameter exposure. The default is true .

com.ibm.wps.cp.tagging.inline.tagClickTransmitScopes = (false)

Whether scopes to which a tag belongs, for example categories, are transmitted, when a user clicks a tag. Setting true makes sense only if you also set...
com.ibm.wps.cp.tagging.inline.tagsClickable = true

com.ibm.wps.cp.tagging.inline.tagScope = (COMMUNITY_PERSONAL_PUBLIC)
Scope of tags to show in this inline widget. Specify one of the following values:
ALL|COMMUNITY|PERSONAL|PERSONAL_PUBLIC|PERSONAL_PRIVATE|COMMUNITY_PERSONAL_PUBLIC
If you do not specify a value, the parameter defaults to COMMUNITY_PERSONAL_PUBLIC .
localePickerEnabled = (true)

Whether the locale picker is shown. The default is true . The locale picker is a dropdown button that users can use to determine under which locale they want to save their tag to make sure that it is displayed correctly. By default tags are saved under the default locale.
Properties for the inline tag widget in the alternative user interface

com.ibm.wps.cp.tagging.inline.countsEnabled = (false)

Whether the count of each community tag is displayed. The count shows how often the tag has been applied by users. Default is false. To have the count of each community tag displayed, specify true . The count is then displayed in parentheses.

com.ibm.wps.cp.tagging.inline.customLabel

Non-localized custom label to describe the displayed tags. If you do not want any further labelling or to keep the label short, this can be an empty string. This parameter has no default value.

com.ibm.wps.cp.tagging.inline.customMessageNoTags

Non-localized custom label to display if no tags are available. This can happen when users have not assigned tags to the piece of content yet. Non-localized means that the label does not change with the browser language. This parameter has no default value.

com.ibm.wps.cp.tagging.inline.displayTwisty = (COLLAPSED)

Behavior of twisty displayed as part of the inline tag widget. Valid values are COLLAPSED|EXPANDED|HIDDEN :

COLLAPSED

The twisty is displayed but closed. Default.

EXPANDED

Both the twisty and the widget are shown.

HIDDEN

The twisty is not displayed. The widget is open and cannot be closed.

com.ibm.wps.cp.tagging.inline.maxResults = (5)

Number of tags shown per resource. The default value is 5 .

com.ibm.wps.cp.tagging.inline.showDialogLauncher = (true)

Control whether a plus ( + ) button for starting the corresponding dialog widget is shown. The default is true .

com.ibm.wps.cp.tagging.inline.tagClickActionMode = (TAG_CENTER)

Action to perform when the user clicks a tag.

TAG_CENTER

The widget redirects the user to the tag center. Default.

PUBLIC_RENDER_PARAMETER

The widget exposes a public render parameter with the tag name.

com.ibm.wps.cp.tagging.inline.tagsChangedEvent = (tagsChanged)

Event that informs the inline widget about changes to the tags for the resource. This allows the inline widget to update the tag set, for example if a user adds a tag in the dialog widgetDefault is tagsChanged. The event name specified here must match the event name specified for the tag dialog widget.

com.ibm.wps.cp.tagging.inline.order = (DESC)

Order direction for displaying the tags. Related to...
com.ibm.wps.cp.tagging.dialog.orderMetric

It can take the following values:

DESC

Default. Specifies descending order.
For example, when the default TAG_SPACE_COUNT_REVERSE_NAME is specified for order metric parameter, tags with the highest count and the lowest character in the alphabet are listed first.

ASC

Specifies ascending order.
For example, if the order metric parameter is specified as...
orderMetric = TAG_SPACE_COUNT

...tags with the lowest count are listed first.

com.ibm.wps.cp.tagging.inline.orderMetric = (TAG_SPACE_COUNT_REVERSE_NAME)

Order metric for the order by which the tags are displayed. To determine the actual order, use the parameter...
com.ibm.wps.cp.tagging.dialog.order

The default value is...
TAG_SPACE_COUNT_REVERSE_NAME

Tags are shown first by the tag count, with resources with more tags shown before resources with fewer tags, then, if resources have the same number of tags, alphabetically. Possible values are:

TAG_SPACE_COUNT_REVERSE_NAME
TAG_SPACE_NAME
TAG_SPACE_COUNT
TAG_SPACE_CREATION_DATE
TAG_SPACE_LAST_MODIFIED_DATE
TAG_SPACE_COUNT_NAME

For more details refer to the class com.ibm.portal.cp.Constants.OrderMetric

Properties for the dialog rating widget in the default user interface

com.ibm.wps.cp.rating.dialog.customLabelCommunityRatings

Custom string to show as the header text in the user interface for ratings in the community section. Example: Community ratings for resource XYZ . This parameter has no default value.

com.ibm.wps.cp.rating.dialog.customLabelPersonalPrivateRatings

Custom string to show as the header text in the user interface for tags in the personal private section. Example: Personal private tags for resource XYZ . This parameter has no default value.

com.ibm.wps.cp.rating.dialog.customLabelPersonalPublicRatings

Custom string to show as the header text in the user interface for ratings in the personal public section. Example: Personal public ratings for resource XYZ . This parameter has no default value.

com.ibm.wps.cp.rating.dialog.defaultView = (PUBLIC)

Specify which view tab is preselected by default, Public or Private. The default is PUBLIC . The other possible value is PRIVATE .

com.ibm.wps.cp.rating.dialog.deletingEnabled = (true)

Whether a user can delete the user's personal ratings Default is true.

com.ibm.wps.cp.rating.dialog.displayTabs = (true)

Whether you want the tabs for switching between private and public rating to be displayed to users. The default is true . Change this to false only if you deactivate private rating by setting the parameter com.ibm.wps.cp.rating.dialog.privateTaggingEnabled to false .

com.ibm.wps.cp.rating.dialog.messageFadeOutDuration = (1000)

Time that the fade-out action of return messages takes in milliseconds. This affects the fade-out after information, warning, or error messages that have been displayed. The default is 1000 milliseconds.

com.ibm.wps.cp.rating.dialog.numStars = (5)

Number of stars or asterisks of which a rating consists. Specify a positive numeric value. Default is 5 .

com.ibm.wps.cp.rating.dialog.privateRatingEnabled = (true)

Whether users can add private ratings in the dialog rating widget Default is true. If false , users can add only public ratings.

com.ibm.wps.cp.rating.dialog.ratingsChangedEvent = (ratingsChanged)

Event fired when a user adds or deletes a rating in the dialog widget. This event is caught by the inline rating widget or widgets of the same resource. These then update themselves.Default is ratingsChanged. The event name specified here must be matched by the event name specified for the rating inline widget.

Properties for the inline rating widget in the alternative user interface
com.ibm.wps.cp.rating.inline.customLabel

Non-localized custom label to describe the displayed ratings. If you do not want any further labelling or to keep the label short, this can be an empty string. This parameter has no default.

com.ibm.wps.cp.rating.inline.displayTwisty = (COLLAPSED)

Behavior of twisty displayed as part of the inline rating widget. Valid values are COLLAPSED|EXPANDED|HIDDEN :

COLLAPSED

The twisty is displayed but closed. Default.

EXPANDED

Both the twisty and the widget are shown.

HIDDEN

The twisty is not displayed. The widget is open and cannot be closed.

com.ibm.wps.cp.rating.inline.onStarClickOpenDialog = (true)

Control whether a click the asterisks of the rating starts the dialog rating widget.

com.ibm.wps.cp.rating.inline.onStarHoverShowRatingDistribution = (true)

Control whether the rating distribution is displayed when the user hovers the mouse over the asterisks of the widget. The default is true .

com.ibm.wps.cp.rating.inline.ratingDistributionPosition = [30, 30]

Array that determines the top and left pixel position of the bon that shows the rating distribution. The default is [30, 30] .

com.ibm.wps.cp.rating.inline.numStars = (5)

Number of stars or asterisks of which a rating consists. Specify a positive numeric value. Default is 5 .

com.ibm.wps.cp.rating.inline.ratingsChangedEvent = (ratingsChanged)

Event that informs the inline widget about changes to the ratings for the resource. This allows the inline widget to update the ratings set, for example if a user adds a rating in the dialog widgetDefault is ratingsChanged. The event name specified here must match the event name specified for the rating dialog widget.

com.ibm.wps.cp.rating.inline.ratingScope = (COMMUNITY_PERSONAL_PUBLIC)
Scope of ratings to show in this inline widget. Specify one of the following values:
ALL|COMMUNITY|PERSONAL|PERSONAL_PUBLIC|PERSONAL_PRIVATE|COMMUNITY_PERSONAL_PUBLIC
If you do not specify a value, the parameter defaults to COMMUNITY_PERSONAL_PUBLIC .
For more details refer to the class com.ibm.portal.cp.Scope in the portal Javadoc and to the Tagging and rating parameter reference.
com.ibm.wps.cp.rating.inline.showDialogLauncher = (true)

Control whether a plus ( + ) button for starting the corresponding dialog widget is shown. The default is true .
Parent: Portal configuration services
Related reference:
Tag dialog widget parameter reference
Inline tag widget parameter reference
Rating dialog widget parameter reference
Inline rating widget parameter reference