To create a reward all mandatory information is marked with an asterisk and must be completed. Rewards can only be created within an Achievement, Compeition or Contest. From the Reward page you can view and e already created awards.
The information below provides an overview of how to create reward . Remember these can only be created withen an Achievement, Competition or Contest. To access the API for rewards please click here.
At Ziqni, creating rewards is easy and quick.
Settings
- Give the Reward a name for example - Congratulations Badge
- Group the reward using tags. Tags can be selected from options that have been created by typing directly in the field. Multiple tags can be selected.
- Decide on Ranking. This will only be available when it is a competition or contest- Rankings will appear on the leaderboard. The reward rank is a numerical value that represents the position on the leaderboard and who the reward is eligible for. For example, if your congratulations badge is for first place, your reward rank would be 1.
- Determine numerical the value of the reward. This number is the quantity of the reward. For example: How many badges?
- Attach the reward to an entity type such as competition or achievement, using the drop-down menu.
- Include the entityId to link the reward to a specific entity.
- Link the reward to a reward type, created in settings, by its unique ID.
- Write a short description of the reward. This is for reference only and is an optional field. This is limited to 500 characters.
- Set an issue limit - this is how many times the reward can be claimed. There is a direct relationship between the issue limit and the number of achievements. The reward issue limit cannot be more than the total number of achievements set.
- Create a time delay in minutes which will provide a period of time between the achievement being triggered and the reward being issued.
- Use the toggle to decide on the expiry of the reward. Point in time sets the exact moment the reward will expire for everyone and can no longer be claimed. For example, 3 months after the achievement has been met.
- Set a period in which the member has to claim the reward once achieved. For example 1 week from the time they were awarded it.
- Either point in time or period can be filled in, not both
- Add metadata to describe and extend the reward using a pair of values and keys.
Translations
The languages are pre-set and must already be added in the language settings. If these have not been added, translation will not function.
If additional languages are required, go to Settings → Languages and add a new language.
- Select the language the fields are to be translated into.
- The text that can be translated is automatically pre-populated. The user must write the translation into the translation box.
- Once all fields have been translated the language name will have a green check to show it has been successfully translated. Another language can then be chosen if required.
- If the translation has not been successful (something has been left out) the language will have a pink exclamation mark to let the user know there is an error/ missing information.
- Click next once all translations have been completed.
Summary
This page summarises the information that has been entered.
- Use the arrow icon to open each section to view the summary.
- If any edits are required, this can be done by moving between the tabs. All information can be edited at this stage. Once the reward is created, specific information will be locked and will no longer be able to be edited.
- When all information is correct, click on Finish and the Reward has been created.
- A preview page will now load, from this page, information can be edited or deleted using the Action button.
- Once the edit page opens, only information with a white background will be editable.
