Console User Guide
The Gamification engine Web console is based upon React-Admin UI framework, where the games may be configured.
When run locally, the web console is accessible through the following link
Console homepage shows the list of your games.
You can:
- create a new game by clicking on “Add new game” button.
- export existing games by clicking "Export" button.
- view game details clicking on 'Manage' button.
- search from list of game by name.
You can create a new game uploading the json file:
You can export the existing games to json file.
Clicking on "Manage" button will open the landing page of game configuration.
One can edit the game settings using 'EDIT GAME' link.
Following parameters can be configured.
- an expiration date for the game.
- if game accepts hidden challenge, it is possible to configure a date to disclosure them.
- using CRON expression, one can schedule the start time of 'auto challenge choice' task. More details in task section
- delete the game.
The 'Point Concept' menu presents a list of existing concept. One create a new one or delete it.
You can configure periods for PointConcept.
A period has:
- a label to identificate it,
- a start date (optional),
- an end date (optional),
- a duration (in days),
- a capacity: how many period instances should be stored (optional).
One can create and delete point concept.
A Badges menu item is a container for a category of badges. One has the possibility to create and delete badges.
A ChallengeModels represents a template for a challenge type.
For every model it's possible to configure:
- the name of the model
- a list of fields that define the challenge.
Actions page show the list of actions bound to the game with the possibility to create a new action or delete it.
Rules page presents the list of game rules. You have the possibility to insert a new rule, edit or delete it. A rule have a name and the content. System will provide a syntax validation before insert it, it will show a list of occurred errors.
It's possible to define multiple levels for a game. A level is calculated on a PointConcept and it contains a set of thresholds.
When a player reach a level threshold, he can be rewarded with some inventory items. These items can be configured accessing the advanced settings.
It's possible to define:
- choices: it's the number of inventory items a player can activate,
- available models: a set of inactive items gained by the player,
- active models: a player can be reward with a set of immediately active items.
Tasks menu presents the list of active leaderboards for the game. It is possible to create, delete or edit a leaderboard. There are two types of leaderboards:
- incremental,
- general.
An incremental leaderboard is bound to a period defined for a PointConcept. The definition of the period regulates the trigger and content of these leaderboard.
Leaderboard fields:
- Name: name of the task,
- Point concept name: the score used to calculate the leaderboard,
- Period name: period used to define the temporal leaderboard duration,
- Number elements in classification: how many positions in your podium are rewarded though event rule trigger,
- Classification name: event name to trigger a particular rule.
- Delay: delay the trigger of a leaderboard (optional).
A general leaderboard is calculated on the total score of a PointConcept.
Leaderboard fields:
- Name: name of the task,
- Point concept name: the score used to calculate the leaderboard,
- Cron expression: task schedule is represent by a linux cron expression (some examples here http://www.quartz-scheduler.org/documentation/quartz-1.x/tutorials/crontrigger)
- Number elements in classification: how many positions in your podium are rewarded though event rule trigger,
- Classification name: event name to trigger a particular rule.
- Delay: delay the trigger of a leaderboard (optional).
Game monitor presents the list of the all players in the game and the possibility to filter the list by playerId.
It's presented the complete state for every player:
- PointConcept with relative total scores and scores of defined periods,
- gained badges,
- levels,
- inventory,
- challenges (single and group) assigned to the player,
- game custom data.
