Scoring and Badges Essentials scoring-and-badges-essentials

The AEM Communities scoring and badges feature identifies and rewards community members.

The details of setting up the feature are described at

This page contains additional technical details :

Displaying Badges displaying-badges

Whether a badge is displayed as text or image is controlled on the client side in the HBS template.

For example, search for this.isAssigned in /libs/social/forum/components/hbs/topic/list-item.hbs:

{{#each author.badges}}

  {{#if this.isAssigned}}

    <div class="scf-badge-text">

      {{this.title}}

    </div>

  {{/if}}

{{/each}}

{{#each author.badges}}

  {{#unless this.isAssigned}}

    <img class="scf-badge-image" alt="{{this.title}}" title="{{this.title}}" src="{{this.imageUrl}}" />

  {{/unless}}

{{/each}}

If true, isAssigned indicates that the badge was assigned for a role, and the badge should be displayed as text.

If false, isAssigned indicates that the badge was awarded for an earned score and the badge should be displayed as an image.

Any changes to this behavior should be made in a customized script (either override or overlay). See Client-side Customization.

Debug Log for Scoring and Badging debug-log-for-scoring-and-badging

To help debug scoring and badging, a custom log file can be set up. The contents of this log file may then be provided to customer support if problems are encountered with the feature.

For detailed instructions, visit Create a Custom Log File.

To quickly set up a slinglog file :

To see log entries:

UGC for Scoring and Badging ugc-for-scoring-and-badging

It is possible to view the UGC related to scoring and badging when the chosen SRP is either JSRP or MSRP, but not ASRP. (If not familiar with these terms, see Community Content Storage and Storage Resource Provider Overview.)

The descriptions for accessing scoring and badging data use JSRP, as the UGC is easily accessible using CRXDE Lite.

JSRP on author: experimenting in the author environment results in UGC that is only visible from the author environment.

JSRP on publish: similarly, if testing on the publish environment, it is necessary to access CRXDE Lite with administrative privileges on a publish instance. If the publish instance is running in production mode (nosamplecontent run mode), it is necessary to enable CRXDE Lite.

The base location of UGC on JSRP is /content/usergenerated/asi/jcr/.

Scoring and Badging APIs scoring-and-badging-apis

The following APIs are available for use :

The latest Javadocs for the installed feature pack are available to developers from the Adobe repository. See Using Maven for Communities : Javadocs.

The location and format of the UGC in the repository is subject to change without warning.

Example Setup example-setup

The screenshots of repository data come from setting up scoring and badging for a forum on two different AEM sites :

Access Scoring UGC access-scoring-ugc

Use of the APIs is preferred.

For investigative purposes, using JSRP for the example, the base folder containing scores is

The child node of scoring is the scoring rule name. Thus, a best practice is that scoring rule names on a server be globally unique.

For the Geometrixx Engage site, the user, and their score, are in a path constructed with the scoring rule name, community site’s site id ( engage-ba81p), a unique id, and the user’s id :

For the Community Components guide site, the user, and their score, are in a path constructed with the scoring rule name, a default id ( default-site), a unique id, and the user’s id :

The score is stored in the property scoreValue_tl which may only contain a value or indirectly refer to an atomicCounter.

Access Badging UGC access-badging-ugc

Use of the APIs is preferred.

For investigative purposes, using JSRP for the example, the base folder containing information about assigned or awarded badges is

Followed by the path to the user’s profile, ending in a badges folder, such as:

Awarded badge awarded-badge

Assigned badge assigned-badge

Additional Information additional-information

To display a sorted list of members based on points: