Activables are what defines a Gamification Scheme. They represent either Actions Players do or Rewards Players unlock according to associated Conditions that must be fulfilled by Players to gather them. Some Activables are linked to each other (which gives verticality in the Scheme hierarchy), some are not.
The principle is rather easy: you define a collection of Activables and Players try to activate/unlock them via the API. For each activation trial must a score be associated. Simplest form being a boolean (Player did the Action), more advanced form being Integers and Floats (e.g: Player won XXX points).
An Activable is created via the GUI within a Gamification Scheme (see Fig. 1) and is defined by the following attributes:
| Attribute | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| ID | automatically generated, you can't specify it. It will become useful when issuing 'activate' request from clients. | ||||||||
| Name | can be whatever you want, between 3 and 255 characters (included). | ||||||||
| Scoretype | This is probably the most important attribute. It defines what kind of score a Player does when she tries to activate the Activable. Four types are available:
Scoretype attribute can't be updated after Activable creation. |
||||||||
| Team required |
Check that box for Activables that MUST be activated in name of a Team. Providing a team_id when activating is always allowed even if team required attribute is unchecked but Live Metrics aggregating by teams might return incomplete results on these Activables (as some Players might not belong to Teams). Team Required attribute can't be updated after Activable creation. |
||||||||
| Categories |
comma separated and up to five categories. Total number of characters can't exceed 128. Activables sharing a similar category (and same scoretype) can be aggregated in Live Metrics and Virtual Money Conditions. This is super-useful when your Players gather scores from different Activables that conceptually represent a same resource (e.g: Points, Gold, ...). Example: Let's imagine a first activable named "Gold Mining" that Players activates regularly with an Integer score of +50. As an onboarding gift, you grant them a second activable named "Gold Bonus" with Integer score +200. As the two Activables share category 'gold', Place2Be sees their respective scores as of same nature. When the Players want to gather a third Activable representing a gift with Virtual Money condition "category: gold -250", scores of "Gold Mining" and "Gold Bonus" will be aggregated to check if enough score has been collected to spend on it, as they are considered a same resource. |
Once defined, Activables exist in the Gamification Scheme and can be activated by users (sending 'activate' requests). But as is, Activables wouldn't make sense (at all and/or between each other) if anyone could activate them without (pre) conditions to be fulfilled. These are defined via Condition Sets which is the core of Place2Be.
