Create a Leaderboard Layout

A leaderboard layout defines what users see when they view the leaderboard. This includes the leaderboard's name, filters, and value format.

There are different methods of creating a leaderboard layout depending on your program.

The following steps detail how to create or edit a leaderboard layout for the Impact block.

  1. Before creating a layout, create the leaderboard structure to define what you want the leaderboard to track.

  2. Open Nitro Studio > Motivate > Leaderboards > Layouts tab.

  3. Click New or click Edit (Edit Button) to update an existing layout.

  4. Enter the layout settings:

    Field

    Description

    Leaderboard Name

    Select the leaderboard data you want to display with the layout.

    Name

    The layout name. This name will appear to end users in the leaderboard dropdown list.

    Group Class

    Filters the leaderboard by the specified group class(es). The selected group class must be a segment. If no group class is specified, all groups are shown.

    Aggregate user leaderboards and group leaderboards can have only one group class filter. Other user leaderboards can be filtered by multiple group classes.

    Note: The leaderboard displays the points/missions/actions based on the user's current group membership, not their historical group membership.

    Value Format

    The format for the values in a non-points leaderboard. Points leaderboards show values with a comma followed by the point category icon, short name, or name (in that order).

    Use "%d" to represent the number precision and optionally, add a prefix or suffix. For example, $%d.dd shows values as $56.00. Or %d courses shows values as 10 courses.

    Criteria

    Select how to calculate the leaders based on the leaderboard type.

    For Actions leaderboards:

    • Count - Returns leaders with the most number of actions logged.
    • Sum - Returns leaders with the highest cumulative action values logged.
    • Minimum - Returns leaders with the lowest action value logged. Shows leaders in ascending order.
    • Maximum - Returns leaders with the highest action value logged.
    • Average - Returns leaders with the highest average of the action values logged.

    For Points leaderboards:

    • Lifetime Balance - Returns leaders with the highest balance after calculating point credits plus debits.
    • Credit Balance - Returns leaders who have the most point credits.
    • Debit Balance - Returns leaders who have the most point debits.

    For Missions leaderboards:

    • Completion Count - Returns leaders who have the most number of missions completed.

  1. Click Save.

  2. Add the layout(s) to the Impact block.

See also

Impact

Blocks.htm

Web Components