Configure Leaderboards (Service Configuration)

This topic provides procedures for adding and changing leaderboards in the service configuration for a title.

For an overall introduction to the various elements of the service configuration, see Introducing Service Configuration.

Sections in this topic:

What is a global leaderboard?

The Xbox Live Leaderboard service provides global leaderboard storage and retrieval capacity for Xbox Live titles. Each leaderboard score is automatically updated by the Xbox data platform to reflect the appropriate values of their underlying statistic instances. Multiple leaderboards can be maintained for each title.

Create a leaderboard

To create a new leaderboard

  1. On the Service Configuration Tasks page for the product instance, click Leaderboards.
  2. On the Leaderboards page, if the Add New Leaderboard dialog box is not already displayed, click New and then, in the dialog box, specify values in the following fields.
    • Leaderboard ID - Internal identifier for the developer to reference a particular global leaderboard.
    • Stat Instance - Click on Select an instance to launch the Add Stat Instance picker. You can use the drop-down list to select the statistic instance to evaluate for the leaderboard. Select a Stat Rule (such as “EnemyDefeats”) from the drop-down list. If the Stat Rule has a Stat Field appended to it (such as “EnemyDefeats.GameplayModeId”), the Stat Field will automatically appear in the list of Stat Field(s). Click Add Stat Instance after you’ve selected the statistic instance.
      For info about selecting a statistic instance, see Selecting a Statistic Instance (Service Configuration).

      Note The data type of the statistic instance must be either INTEGER or DOUBLE, and not STRING or DATETIME.
      The statistic instance isn’t displayed to the customer.
      For more info, contact your developer account manager (DAM) or refer to the Xbox One XDK documentation.

    • Sort - Specify how you want the displayed gamers sorted:
      • Ascending - The gamer with the lowest score is listed first.
      • Descending - The gamer with the highest score is listed first. This is the default behavior.

      Indicate Ascending if higher values are better, or Descending if lower values are better. Player scores will be ranked accordingly.

  3. When you have all of the fields and values for your new leaderboard the way that you want them, click Add New Leaderboard to create the leaderboard and close the dialog box.

Your new leaderboard is now listed on the Leaderboards page.

Change a leaderboard

Important Making changes to or deleting existing leaderboards that have been published isn’t supported. You must create a new leaderboard with a different leaderboard ID. Changing the sort order or the underlying instance of a statistic of a leaderboard might cause data loss. Avoid reusing leaderboard IDs that have been previously configured and published.

Delete a leaderboard

Important Making changes to or deleting existing leaderboards that have been published isn’t supported. You must create a new leaderboard with a different leaderboard ID. Changing the sort order or the underlying instance of a statistic of a leaderboard might cause data loss. Avoid reusing leaderboard IDs that have been previously configured and published.