Client Success Simulator guide

The Client Success Simulator is a great tool to use for quality assurance when launching a brand new site or setting up a new challenge. Admins can access the simulator from their site's admin dashboard.

The simulator checks specific settings within your site's registration options, setup choices, and challenges to ensure the best experience for your patrons and staff while also maintaining a wide range of personalization. If a box has a green checkmark to its left, that specific setting has passed the simulator's review. If a box is outlined in red and has a red X to the left of the text, that setting needs review and/or editing. If a box is outlined in yellow and has a yellow warning to its left, that setting may be problematic, but isn't necessarily incorrect.

Within your site's registration settings, the simulator checks:

1. Registration Fields: This test checks that all registration fields you have enabled (including those that are only enabled at the challenge level) have had options added. If you selected to display a registration field that doesn't have added options for readers to choose from (i.e., if you have selected to display branches at registration, but haven't added any branch options), this test will fail.
   • If this test fails, go to Setup > Site Options > Registration Fields to update the specific field options.
2. Required Fields: This test checks that all registration fields you have set to be required are also set to be displayed.
   • If this test fails, go to Setup > Site Options > Registration Fields > Display or Require Fields to update which fields are displayed and required.
3. Schools: This test checks whether there's an option for adults within your list of school options.
   • If this test fails, go to Setup > Site Options > Registration Fields > Schools and add an "Adult - Not Applicable" option.
4. Username and Email: This test checks username and email login settings.
   • If this test fails, contact your Client Success Manager or the Helpdesk.

Within your site's setup options, the simulator checks:

1. Welcome Email: This test checks that you have customized the welcome email that goes out to newly registered readers.
   • If this test fails, go to Setup > Site Options > Welcome Email to update your email content.
2. Contact Us: This test checks that another email address has been added to the contact message recipients along with [e-mail].
   • If this test fails, go to Setup > Site Options > "Contact Us" Email Addresses to add a staff email address or to re-add the [e-mail] email address. Please ensure that all email addresses are separated with a comma.
3. Library Admin Count: This test checks that there are five or fewer users with the library administrator role, as with the power of creating challenges comes the power of deletion
   • If this test fails, go to Reports > Other Reports > Role Reports to view all accounts' access levels and double check that those with these admin accounts truly need them. If you would like to change an account's access level, follow these steps.
4. Library Staff Count: This test checks that there is a sufficient number of users with library staff or library staff plus accounts. We recommend adding at least one general staff or staff plus account per branch/location.
   • If this test fails, consider creating more staff accounts by following these steps. 
5. Picture Reviews:This test checks that reviews are enabled if picture reviews are also enabled.
   • If this test fails and you want reviews and picture reviews to be allowed on your site, go to Setup > Site Options > Site Setup Options and check Allow Book Reviews. If this test fails and you don't want to allow reviews, contact your Client Success Manager or the Helpdesk to disallow picture reviews. 
6. Book Lists: This test checks that your book lists have unique titles.
   • If this test fails, go to Content > Book Lists to edit your book list titles.
7. Landing Page: This test checks that your landing page text has been updated and does not include any of the pre-filled example text.
   • If this test fails, go to Setup > Landing Page > Landing Page Content to edit the text that displays on your site's landing page.
8. Signup Enabled: This test checks whether registration is enabled on your site.
   • If this test fails, go to Setup > Site Options > Site Settings and check off Allow Signups.
9. Logging Enabled: This test checks whether logging is enabled on your site.
   • If this test fails, go to Setup > Site Options > Site Settings and check off Allow Logging.
10. Points: This test checks that a point value has been assigned to all active log types if points are enabled.
    • If this test fails, go to Setup > Manage Points System to set the number of points earned for each active log type.
11. Bulk Logging and Titles: This test checks that a site only has batch logging or require title enabled, not both.
    • If this test fails, go to Setup > Site Options > Site Settings and either check Allow Batch Logging and uncheck Require Book Title if you want to allow readers to log multiple books at once; or check Require Book Title and uncheck Allow Batch Logging if you want all readers to input their book titles.

Within your site's challenges, the simulator checks:

1. Challenge Names: This test checks that duplicated challenges have been updated so the titles no longer contain "Copy of".
   • If this test fails, go to Setup > Manage Challenges to edit the challenge with "Copy of" in its title and update its title.
2. Duplicate Names: This test checks that all challenge names are unique. This is important for our reporting system, as well as your internal site organization and URLs.
   • If this test fails, go to Setup > Manage Challenges to update your challenge title(s). An easy way to differentiate titles is to add the age range and year to the title.
3. Challenge Descriptions: This test checks that challenge descriptions are at least 140 characters. 
   • If this test fails, go to Setup > Manage Challenges to edit the challenge with a short description and add more text. Consider including how patrons earn badges and prizes, what log type they will use, if there are activities and reviews, how patrons complete the challenge, etc.
4. Challenge Image: This test checks that every challenge has an image.
   • If this test fails, go to Setup > Manage Challenges to edit the challenge without an image and add a header image that is 920px x 351px and less than 10MB. Jpeg, jpg, gif, and png are all accepted file types.
     
5. Log Types: This test checks that any log type being used within a challenge is active on the site.
   • If this test fails, go to Setup > Manage Log Types to update the log types that are active on your site.
6. Registration Badge: This test checks to make sure all challenges have a registration badge.
   • If this test fails, go to Setup > Manage Challenges and edit the challenge(s) without a registration badge to add one.
7. Badge Counts: This test checks that each challenge has at least 12 badges that can be earned.
   • If this test fails, go to Setup > Manage Challenges and edit the challenge(s) with fewer than 12 badges to add more. You can split up activities within multiple activity badges, add higher logging goals, or reward more book reviews with review badges to increase your number of overall badges.
8. Multiple Log Types in One Challenge: This test checks that there are not multiple reading log types in one reading challenge.
   • If this test fails, go to Setup > Manage Challenges and edit the challenge(s) with multiple log types. Within the challenge, make sure that all the logging badges have the same log type (i.e., all books or all minutes, instead of a mix of books and minutes). If you want to give readers the choice between two log types, we recommend duplicating your challenge and offering one challenge for books and one challenge for minutes. 
9. Restricted Badge Dates: This test checks that any logging badges with restricted dates are not overlapping.
   • If this test fails, go to Setup > Manage Challenges and edit the challenge(s) with overlapping date-restricted logging badges. Within the challenge, edit the logging badges dates so that they are for distinct time periods (i.e., Aug. 10 to Aug 17, then Aug. 18 to Aug. 25).
10. Activities: This test checks that activity badges have at least one activity.
    • If this test fails, go to Setup > Manage Challenges and edit the challenge without activities included in its activity badges. Then, follow these steps to add activities.
11. Activity Badges: This test checks that duplicated activity badges have updated titles without "Copy of" in the title.
    • If this test fails, go to Setup > Manage Challenges and edit the challenge with duplicate activity badges to update their titles.
12. Challenge for All Ages: This test checks to make sure there is a challenge available for every age.
    • If this test fails, consider extending the age range for your challenge(s) or creating a simple logging badge for those ages that are not covered by your existing challenges so that all your patrons can participate.
13. Limited Challenge Options: This test checks whether more than three challenges exist for any age group at one time.
    • If this test fails, consider eliminating or combining one or more challenges, or editing the age ranges for your challenges to that patrons aren't overwhelmed with too many options.
14. Active Challenges: This test checks that there's at least one active challenge.
    • If this test fails, consider creating an ongoing challenge for readers to participate in all year long.
15. Ticket Rewards: This test checks whether there are multiple prize options available when tickets are attached to a challenge.
    • If this test fails, add more ticket prize options to the challenge that rewards tickets under Setup > Manage Challenges or disable tickets within that challenge and create a grand prize drawing under Setup > Manage Drawings instead.
16. Ticket Reward Names: This test checks that duplicated ticket prizes have updated, unique titles.
    • If this test fails, edit the ticket prize option names within the ticket challenge so that they are all differentiated from one another. If you have multiple ticket prizes of one type to give away, you should enter that as one ticket prize option and select multiple winners, rather than creating multiple ticket prize options.
17. Cumulative Badges: This test checks to make sure that non-date restricted logging and review badges in a challenge are cumulative, so that the badges build on one another. These badges' goals go up: 1 hr, 3 hrs, 5 hrs, 10 hrs, for example. As people read more, they get to the next milestone. They automatically have to do this within the dates of the reading challenge.
    • If this test fails, edit the challenge without cumulative badges to ensure that there are multiple logging and/or review milestones for patrons to achieve, instead of multiple "1 book" or "1 review" badges.
18. Reward Names: This test checks that rewards are named differently than the badges they're attached to.
    • If this test fails, edit the reward or badge titles to differentiate them.
19. Points Challenge Log Types: This test checks whether there are logging or review badges added in a points-based challenge. We strongly advise against using both points and logging badges. 
    • If this test fails, remove either your logging badges and have patrons accumulate points badges by logging reading, OR remove your points badges and have patrons accumulate logging badges.
20. Points Challenge Points Badges: This test checks to ensure that any points-based challenges include points badges. Without points badges, your patrons will not earn points.
    • If this test fails, edit the challenge in question to add cumulative points badges.

The Client Success Simulator also includes a Best Practices tab, where you can read about the suggestions we've gleaned from our annual Summer Reading Report. These are all optional tactics that we've seen increase the success of and participation in Beanstack challenges.