Gamification Module Configuration
Gamification objects, such as Actions, Missions, Badges and User Records can have configuration detail issues that are easy to troubleshoot if you know what you are looking for. This documents purpose is to outline some of the common gotchas and provide a step by step way to verify and troubleshoot the setup.
Possible Issues to Consider
- Missions are not credited to users who complete Actions
- Users do not get a Badge for completing a Mission
- Points are not awarded
- Given the Bunchball gamification module is configured.
- User has admin access to the gamification and Jive admin console.
- 1 or more Missions/Badges with or without Points are setup for users to earn via Actions they can take in Jive
- User completes the Action as it is defined within Bunchball gamification module, yet they do not see any progress on their Badges and/or they don't have credit within the gamification module itself.
- Users Points do not update or are not reflecting a leader board
For our example, we will consider a user who does not see any Points increment from the Actions they make in the Jive community application.
We will look at a custom test Mission, Document Creator. Looking at the user's Missions on the Profile page > Reputation tab, we can see they have 0% completed towards the Document Creator Mission.
There can be many reasons this may not be updating, so here are the things to check for. We will go through a comprehensive journey through the gamification setup and point out all the details that must be in order for the gamification plugin to work properly.
First we will check the user record and make sure the event is coming over to Bunchball. The userid can be found on the people page in the admin console.
In our example case, it is userid: 2001
Now within the gamification console, visit the Users tab.
From here, we can see the user has a point total. This can be used to see if their total goes up when they take specific Actions.
Tip: It is generally a good idea to start making notes of the details as they are reviewed/observed. In this case, the point total and time this is checked will be handy to reference later.
Next, check that gamification "thinks" the user is eligible for the Mission. Do this from within the Users menu by clicking on the Missions tab. Looking at the example, we can see the Document Creator is listed under the Available Missions. If your Mission is not here, it is possible that they have completed the mission or, there is some other criteria in the mission definition that precludes them from advancing on the Mission. This will be checked on a bit later in more detail.
If the user checks out and is verified as eligible, we can look into the Mission and Actions next.
Navigate to Actions then go to the Missions tab. We will start with the Mission itself then work our way back through the Actions the Mission requires and the users completing the Action.
Again, using our example Mission, Document Creator, here are things to look for. Please note, the screen shot below may be referenced for each step.
- Ensure that the Mission is active and make a note of whether it is repeatable. You also want to look and verify it should even be visible on the users profile page.
- Make a note of the Rule, and if ALL or ANY rules must be met. These are very specific.
- In our example below, there is only one trigger defined, so the any or all setting would work either way.
- Check each trigger. In this case, there is only 1, but there could be more (scroll down). Copy the trigger name to your notes for reference.
- For our example, this Mission requires the DocumentEvent-CREATED Action
- For each trigger that is defined, check if it has Metadata. If so, copy these to your notes for later reference as these must also exactly match. The edit button will open the full list of Metadata that may be defined.
Now, it is also good to scroll down and make a note of the Points or Badge the Mission can give.
Next, click to the Advanced tab
5. Check the start date. If the user completed the Action before this date, they won't get credit.
- Please note, this date does not need to be set manually and will populate automatically to match when the Mission was first created.
6. If the Award (or Badge) should be applied to the user automatically, the Send Callback needs to be checked for this to work.
7. If the Mission is set to limit to once per day, make sure the user did not already complete the Mission for that day. In this example, it is unlimited, so it would not be a problem.
After reviewing and checking the Mission itself, it is time to work back and ensure the Action is setup properly to update this Mission for the user.
Recall, that this Mission required the DocumentEvent-CREATED with Number of calls >=1 (1 or more) times.
Navigate to the Actions > Actions tab and find the specific Action on the list.
- Double check that the Action EXACTLY matches what is defined in the Mission.
- This is CASE-SENSITIVE.
- This is when the notes you took will begin to come in handy.
- Check that the notification for this can be repeated and if there is any other restrictions or settings that may cause this to be missed or not trigger
- Verify it is not limited or, if it is that the users Actions still qualify based on this criteria
If everything checks out so far, then the next step is to check that an event comes over for a user.
Find the users page again and this time, we will visit the Action history.
There may be many (or none) Actions showing. To find the Action for a given day or just today, you may need to adjust the filters
- The date range can be set back if you are troubleshooting a past event
- Filter by tags can be OR or AND, and refer to the next field
- In this tags field, you can enter in keywords that would match up to the Actions. As an example, the ... button will bring these up to select from.
Looking at our example userid = 2001, we see there are no Actions for creating a document in the past 30 days.
After reviewing all the settings, the next task is to force an Action to occur and then verify that gamification both updates and reports this back to Jive.
While logged in as the affected user, perform the defined Action. To satisfy our example, we create a new document.
Refreshing the users Action history should bring up the Action if it registered.
And the user profile now has the activity of earning the Points along with the progress towards the Badge. In our example case only 1 document was required and, this Badge was repeatable, so it still shows as eligible to complete.
With some attention to detail, it is possible to troubleshoot most gamification configuration issues by working through the setup in an organized manner. Here are some general points to keep in mind when working with JIve Gamification.
- The data is stored in Bunchball and pulled over with each request or view of Jive
- Treat everything in gamification configuration as CASE-SENSITIVE
- It is easy to setup your own test objects and work through the way that Bunchball sees the actions you take in Jive by trial and error
Action - A specific event generated by a a user within Jive that propagates to gamification and may or may not apply towards an award or completion of a Mission. Example: Creating a document
Mission - A pre-defined rule set that awards users Points and/or Badges based on specific Action(s) a user has completed.
Trigger - A defined set of criteria on a Mission. There may be more then one trigger and these are typically defined by a single Action and may or may not contain defined Metadata.
Award - What the user receives when they fulfill all the requirements of a Mission. This can be Points, Badge, or both.
Badge - One form of an Award. Users can earn these for completing Missions
Points - Another type of award that is credited to a user when they complete a Mission
Metadata - Set of attributes to further define an Action or Mission. As an example, this is a good way to define a Mission in a specific Space or Social Group.