Recurrent Setup Guidelines
RECURRENT COMPONENTS PREPARATION
In the Design Portal, the Admin user will create a Program > Series > Challenges > and all related components in the normal manner.
IMPORTANT rules and limitations:
- Avoid creating Flash Messages, Tokens, Awards, and Sweepstakes with triggers based on Leaderboard positions. Series' containing components with such triggers CANNOT be made Recurrent at present. All unsupported triggers for Recurrency are marked with the prefix “Do not use for recurrent:."
- When configuring a Challenge to be Recurrent, treat this initial Challenge as the first in an ongoing series of its virtual duplicates. For example, if you set the Challenge start for “01/15/2023 10:00 AM” with a
daily frequency, its virtual duplicate will be created on “01/16/2023 10:00 AM,” followed by another on “01/17/2023 10:00 AM,” and so on.
It is highly recommended to not to publish any components before going to Setup dialog dialog of a Series (see next section). This dialog will show any possible blockers to make Series recurrent, for instance, if there’re any forbidden triggers configured.
Avoid creating Flash Messages, Tokens, Awards, and Sweepstakes with triggers based on Leaderboard positions. Series' containing components with such triggers CANNOT be made Recurrent at present. All unsupported triggers for Recurrency are marked with the prefix “Do not use for recurrent:."
RECURRENT SERIES SETUP
Admins in Design Center are able to setup Recurrent Series on an existing Series using the dialog that opens by clicking the Recurrent Setup menu item:
A series can only become recurrent if all its components are ready and published, and it doesn't contain unsupported elements like triggers based on Leaderboard position or Challenges with certain intervals. If these conditions aren't met, the Recurrent Setup dialog will display warnings.
The Recurrent Setup dialog is easy to use. Simply mark the Series as recurrent and setup recurring frequency. At this time, the available options are: Daily, Weekly, and Monthly (every 30 days).
IMPORTANT: Once the series is saved as recurrent, all components become read-only and it will be impossible to add/modify challenges, questions, flash messages, and other related elements. Additionally, it is not possible to delete any regular or recurring series or challenge if they are already published.
At the same time, it's possible to archive Recurrent Series or Challenges once they are published. However, their statistics will still be shown in reports. Additionally, archived Recurrent Series or Challenges will continue to send questions and other notifications to its participants. Archiving Series and Challenges currently only organizes the interface between Series and Challenges that we don't use and are no longer relevant.
IMPORTANT 2: When a recurrent series is duplicated, the clone is NOT recurrent by default.
STOPPING RECCURENCY
To stop a recurrent series, select the Recurrent Setup option.
Select Stop Recurrent. There's nothing else to configure, it will stop the recurrent series.
If you stop Series Recurrency, the next occurrence wouldn't happen, but already running Challenges would continue till their scheduled end date, including nested components.
REPORTS SUPPORT FOR RECCURENCY
Following reports are available at this time for Programs that contain Recurrent Series:
1. Goal Progress Report.
2. Excluded Users.
The following reports are supported for Recurrent Challenges:
1. Participants Progress Report that shows all time progress for all participants within recurrent Challenge. Split by Company/Partner is also available.
Consolidated Reports that support Recurrent Series:
1. Questions Progress.
2. Goal Progress.
3. Participants Progress.
REST API SUPPORT FOR RECURRENCY
API endpoints have been updated to work with Recurrent games:
1. All Series endpoints now have additional Boolean data field is_recurrent .
2. Series Subscriptions endpoint returns all time subscribptions within recurrent series.
3. All Challenges endpoints now have additional Boolean data field is_recurrent .
4. Challenges Report endpoint returns all time data for all participants within recurrent Challenge with the possibility to filter by Company/Partner.
REST WEB & MOBILE APPS FOR RECURRENCY
All web and mobile apps support recurrent games with no limitations.
Also, at the moment it’s possible to join to recurrent series again (second time), but from technical point of view such user will join another version of this series. Statistics for such a user will be calculated based on the very first version of the series to which he joined.
Leaderboard aggregates data for all users within the same game (i.e. within the same series).