Review Preference

You can customize your review by adding a type, on premises and on the cloud.

This page discusses:

Preference Access

Administrators only can customize this preference. For more information, see Customizing Administrator Preferences.

Review Preference Usage

This preference declares a list of review types that are made available when creating a review.

  1. Click to create a review type.
  2. Expand the review type to define its fields.
  3. Define the following fields:
    Field Description
    name Internal identifier of the type, for persistence
    title Title used when displaying this review type
    annotationColor Optional color used for the annotation

    By default, the color is yellow.

    annotateTraceability Capability to annotate traceability links:
    • no: no annotation is possible on traceability nodes
    • snapshot: snapshot traceability nodes can be annotated
    • all: all traceability nodes can be annotated
    anyUserCanEditProperties Editing restriction of the message properties:
    • true: any user can edit the message properties
    • false: only the creator of the message can modify its properties

    By default, the value is true.

    copyPropertiesOnReply Copy of the message properties from the message to the reply messages:
    • true: the properties are copied
    • false: the properties are not copied

    By default, the value is true.

    messageProperties List of property declarations attached to this type
  4. From the messageProperties section, expand a property to define its fields:
    Field Description
    name Internal identifier of the property, for persistence
    title Title used when displaying this property
    type Type of this property.

    The possible values are string and Boolean.

    The default is string.

    mandatory A Boolean.

    The value of this property is mandatory.

    multiple A Boolean.

    The property can have multiple value.

    range List of possible values for the property.

    If absent, no constraint applies to the value (except for Booleans).

    defaultValue If present, specifies a default value for the property.

    If absent, the default value is dependent on the presence of a range and on the type.