Broadleaf Rating & Review Services

Overview

Manages Rating & Reviews.

Data Model

See the Data Model for information on the key domain classes used by the Rating & Review service.

Key Components

CustomerRatingService

The DefaultCustomerRatingService handles customer interactions with their own RatingDetails.

Domain

RatingDetail

Holds the rating amount and review from a customer for a specific target. The target is defined via the RatingSummary member. A RatingDetail has a status to determine if it is included in the RatingSummary. See Rating Statuses for more details.

RatingSummary

Holds the rating total for a target item (product or variant). For Variants, there is also a reference to the parent product’s RatingSummary.

Sandboxing Configuration

At the time of this writing, there’s no sandboxable entities in this service. If a sandboxable entity is introduced in this service, the following configurations should be added:

spring:
  cloud:
    stream:
      bindings:
        persistenceOutput:
            triggeredJobEventInputPurgeSandbox:
              group: ratings-purge-sandbox
              destination: triggeredJobEvent
broadleaf:
   transitionrequest:
     enabled: true
   changesummary:
     notification:
       active: true
   tracking:
     sandbox:
       purge:
         enabled: true

See Sandboxing In Detail for more details.

Note	These configurations typically only affect the Granular Deployment model. For `Min` and `Balanced` deployements, these configurations are likely already added at the flexpackage-level configuration.