ÃÛ¶¹ÊÓƵ

DocumentationAEM 6.4Communities Guide

Leaderboard Feature leaderboard-feature

Last update: Wed May 03 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • User
CAUTION
AEM 6.4 has reached the end of extended support and this documentation is no longer updated. For further details, see our . Find the supported versions here.

Introduction introduction

The Leaderboard component provides the ability to obtain a sense of how members are interacting within the community by ranking members according to points earned (basic scoring) or their expertise (advanced scoring).

Prior to including the leaderboard component on a page, it is necessary to configure Communities Scoring and Badges.

This section of the documentation describes

  • Adding the Leaderboard component to a community site

  • Configuration settings for the Leaderboard component

Adding a Leaderboard to a Page adding-a-leaderboard-to-a-page

To add a Leaderboard component to a page in author mode, locate the component

  • Communities / Leaderboard

and drag it into place on a page.

For necessary information, visit Communities Components Basics.

When first placed on a page of a community site, this is how the component appears:

chlimage_1-8

Configuring Leaderboard configuring-leaderboard

Select the placed Leaderboard component to access and select the Configure icon which opens the edit dialog.

chlimage_1-9 chlimage_1-10

Settings tab settings-tab

Under the Settings tab, specify what information related to the member is displayed:

  • Display Name
    A descriptive name to display for the board, reflecting the rules selected for displaying badges and scores.

    Default is Leaderboard, if nothing entered.

  • Badge
    If checked, a column for badge icons is included in the leaderboard.

    Default is unchecked.

  • Badge Name
    If checked, a column for the badge name is included in the leaderboard.

    Default is unchecked.

  • Use Avatar
    If checked, the member’s avatar image is included in the leaderboard, next to their name link to their member profile.

    Default is unchecked.

Rules tab rules-tab

Under the Rules tab, the community site, and its scoring and badging rules

  • Rule Location
    (required) Location where the Scoring/Badging rule is configured.

  • Scoring Rule
    (required) Specific rule generating the scores to display.

  • Badging Rule
    (required) Specific rule generating the badge to display.

  • Display Limit
    Number of members to display per page.

    Default is 10.

Example: Participants Leaderboard example-participants-leaderboard

This leaderboard reports results from applying basic scoring rules.

Leaderboard component configuration:

  • Settings tab:

    • Display Name = Participation Board

    • checked:

      • Badge
      • Badge Name
      • Use Avatar

  • Rules tab:

    • Rule Location = /content/sites/communities/jcr:content
    • Scoring Rule = /etc/community/scoring/rules/forums-scoring
    • Badging Rule = /etc/community/badging/rules/reference-badging
    • Display Limit = 10

chlimage_1-11

Example: Experts Leaderboard example-experts-leaderboard

This leaderboard reports results from applying advanced scoring rules.

Leaderboard component configuration:

  • Settings tab:

    • Display Name = Expertise Board

    • checked:

      • Badge
      • Use Avatar

  • Rules tab:

    • Rule Location = /content/sites/communities/jcr:content
    • Scoring Rule = /etc/community/scoring/rules/adv-forums-scoring
    • Badging Rule = /etc/community/badging/rules/adv-forums-badging
    • Display Limit = 10

chlimage_1-12

Additional Information additional-information

More information may be found on the Leaderboard Essentials page for developers.

Instructions for creating rules are provided on the Communities Scoring and Badges page for administrators.

recommendation-more-help
5d37d7b0-a330-461b-814d-068612705ff6