Parameter reference for the tag and rating widgets

Each of the portal tagging and rating features have parameters that you can set to determine the look and functionality of these features.


How to configure parameters for the tag and rating widgets

You configure the tag and rating widgets by setting parameters. You can set these parameters globally for all tag or rating widgets in the portal in the CP configuration service. You can also set them for individual instances of the tag and rating widgets by using the JavaScript parameters in the following topics. These settings become effective for the affected widget instance and override the settings in the CP configuration service for the individual widget. The parameter settings take override priority by the following hierarchy:

  1. Settings that are specified for an individual tagging or rating widget instance take highest priority.

  2. If a parameter is not set for the individual widget instance, the settings specified in the CP Configuration Service takes effect.

  3. If a parameter is not set by either of the two options above, the default value defined in the widget class itself takes effect.


Example: In the CP Configuration Service the attribute for private tagging is set to true: com.ibm.wps.tagging.dialog.privateTaggingEnabled = true . The tag widget ABC instance includes the attribute privateTaggingEnabled = false . As a result all tag widgets in the portal have private tagging enabled except tag widget ABC.

Most of the parameters exist as corresponding sibling parameters that you can set both globally in the CP Configuration Service and for individual widget instances and in code. The parameter in the CP Configuration Service consists of the prefix com.ibm.wps.cp. and the related parameter for configuring widget instances. Example:

Some of the parameters have no corresponding siblings and exist only for one of the two ways of configuring them. The parameters that exist only for configuring widget instances are mandatory, as they identify the resource for which the widget is called.

For details about the parameters in the CP Configuration service and how to set them refer to the topic about the portal CP Configuration Service for tagging and rating, and Setting service configuration properties.
Usage notes for the parameter lists in the following topics: The lists show the parameters with their default if they have one. In these cases the parameters are shown with an equal sign between the parameter and the value. This is how you specify the setting when you include the widget declaratively. If you include the widget programmatically, use a colon instead of the equal sign.


Parent

Configuration reference


Related tasks


Set service configuration properties
CP Configuration Service for tagging and rating
Configure the tag cloud
How tagging and rating works in the portal

 


+

Search Tips   |   Advanced Search