At Ziqni we believe in creating competitions that are as simple or as complex as required. Competitions can be a single round, with one contest, or multi-round, with many different contests.
The user will work their way through tabs at the top of the page, using the 'previous' and 'next' buttons. They will be able to move between tabs to amend any information as they create a competition. All required information will be marked with an asterisk.
The information below provides an overview of how to create a quick contest. To access the API for contests please click here.
- From the dashboard page, scroll to Competitions and click.
This will load the search/ create page. Click create and select Single round competition and contest.
The page below will now load.
Settings
The first step to creating a single contest in the ZIQNI system is to generate the settings. This is where the user inputs the basic information required for the Contest.
- Name the contest.
- Group the contest using tags. Tags can be selected from options that have been created by typing directly into the field. Multiple tags can be selected.
- Write a short description of the contest. This is for reference only and is an optional field. This is limited to 500 characters.
- Include the terms and conditions. These set out the instructions for the contest.
- Add metadata to describe and extend the contest, using a pair of values and keys.
- Click next once all information has been entered.
Strategies ( Scheduling and Scoring)
This creates a timeframe for the Contest and sets out the scoring strategy that will be used. For a more in depth understanding of the scoring straegies and how ranking can be applied to contests and competitions please read the scoring strategy knowledge articles.
- Select the date and time the contest will start and end.
- Choose the scoring strategy that will be applied to the contest.
- Use the toggle to decide if default ranking is on/off.
- Once all information has been entered, click next.
Entrants
This tab sets the criteria for the groups of members who can participate.
- Decide on the minimum number of entrants.
- Select the maximum number of entrants. This is an optional field.
- Use the toggle to turn Opt in on / off. Opt-in Required is the constraint that has been added to the contest. The default is set to off. This means order for a member to participate in the contest, they must manually opt in.
- Use the toggle to choose whether all registered members can participate or just select groups. If the toggle is on, all registered members can participate.
- Move the toggle to off to choose select groups.
- Click Select Member Tags and the page below will load.
- Check the boxes of the member groups that will have access to the contest. Once all member groups are chosen, click add.
Once all member groups have been added, the following page will load. The user will select the dependencies for the member groups to participate using the must, should, must not rules.
- Must- for the member group to participate they must have this tag.
- Should - for the member group to participate they should have this tag.
- Must Not - for the member group to participate they must not have this tag.
- Ensure the minimum should match is correct - this sets out the minimum number of tags that have to match in order for a member to be eligible for the competition/ contest.
Rewards
Creating a reward in contests is optional. In Contests, a reward will be triggered based on the rule structure. Multiple rewards can be created for contests. Rewards for contests will be displayed in the contest leaderboard on the widget. No rewards will be displayed for an overall competition unless a reward has been added to the competition.
- Select the reward icon.
- Give the Reward a name for example - Congratulations Badge
- Group the Reward using tags. Tags can be selected from options that have been created or you can type and add tags directly in the box. Multiple tags can be selected
- Determine numerical the value of the reward. This number is the quantity of the reward. For example: How many badges?
- Decide the reward type from the drop-down menu. This will have to have been made in Settings --> Reward types.
- Use the toggle to decide if set the point in time is on/ off. When on this allows the user to set a date for the reward to expire for all members. When set to off the user can decide on the period of time a member has to claim their reward, for example, 5 days.
- Create a time delay in minutes which will provide a number of minutes between the achievement being triggered and the reward being issued
- Select the period of time the member has to claim their reward until it is no longer valid, for example - must be claimed in 5 days.
- Write a short description of the achievement. This is for reference only and is an optional field. This is limited to 500 characters.
- Decide whether Acknowledgement is required for the reward- Does the member have to manually claim the reward or is it issued automatically?
- 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.
- Add metadata to describe and extend, using a pair of values and keys.
Previously created rewards can also be added to a contest.
- Click on Add from Template.
The page below will load.
- Choose from the list of previously created rewards by checking the box next to the reward.
- Click on the Add button.
- The Edit page will load, from here information can be edited if required.
- Once all information is correct, click on create.
- The reward has now been added to the contest.
Rules
Using Ziqni's rule engine the user can create as many different rule combinations as required from simple to extremely complex. In contests the rules are the criteria that are set for how the member will access the contest.
Please refer to the ZIQNI's Rule Engine articles for a more in-depth explanation and examples of how this can be used.
- Choose how the rules will be structured - rules can be created using any are true statements or all are true.
- Click on the + sign to add further criteria to the rules.
- Complete the then statement to state what will happen when each rule structure is met.
- Rules need to be created for all parts of a competition;
- Start - Create the rule structure that will set the criteria for the contest to start.
- Finish- Create the rule structure that will set the criteria for the contest to finish
- Finalise- Create the rule structure that will set the criteria for the contest to finalise all data.
- Cancel- Create the rule structure that will set the criteria for the contest to be canceled.
- Entrant- Create the rule structure that will set the criteria for the entrants to participate in the contest to be eligible.
The action buttons in the top right-hand corner of the Rules page allow the user to access a number of features.
- <> Displays the JSON string along the right-hand side of the screen.
- Clear allows the user to delete the rules and begin to create new ones.
- Save as template - a string of rules can be saved as a template for future use.
- Load as Template - load previously saved rule creations.
- Arrow Icon - Expands the page to allow easy creation of more complex rule structures.
Products
Products are the games the members are participating in.
- Decide if all products will be included in the competition/ contest. The default is for the toggle to be set to on, meaning all products are included.
- Click the toggle off to restrict products to only those the user has chosen.
- Select individual products or products grouped using tags. Once one of these options has been selected, the page below will load.
- Check the boxes of the individual products or product tags that will be included in the competition/ contest.
- Once all products have been chosen click add.
If product tags were selected, the following page will load. The user will select the dependencies for the product tags to be included using the must, should, must not rules.
- Must- for the product group to be included it must have this tag
- Should - for the product group to be included it should have this tag.
- Must Not - for the product group to be included it must not have this tag.
- Ensure the minimum should match is correct - this sets out the minimum number of tags that have to match in order for a product group to be eligible for the competition.
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.
- Click next once all translations have been completed.
Summary
This allows the user to preview all information that has been entered.
- Use the arrow icon to open each section to preview 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 Contest 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.
Using the drop down arrow, the information in the white fields can be edited.