About Aurora badge rules and supported criteria
For each community badge you want to create, you must define the rule that determines how a member achieves or receives the badge. For simpler rules, you can use the built-in tool that enables you to select a criterion and additional qualifiers. However, if you want a more complex rule for a badge, you can use the Advanced Editor to enter badge formulas. Badge formulas include a combination of a formula clause type, a keyword, an operator, and a value. When the calculation of a value in a formula returns a true result, the member achieves the badge. The badge achievement is then reflected in their profile and badges page. To create more complex badge rule expressions that require multiple rules be met before awarding a badge, you can use the “AND” operator. Common use cases for badges with multiple rule criteria include profile completion tasks and more complex engagement options. For example, you may want to award a “VIP Contributor” badge to members who: Have received at least 100 likes Have had at least 25 answers marked as Accepted Solutions Have posted at least 10 blog articles Tip: You can also use community roles as an additional requirement for any badges based on activity. By taking advantage of the “unlocking” game dynamic, you can set certain badges to be earnable only after a community member has reached a rank that grants them the required role. Create a complex badge rule Go to Settings > Users > Badges. To add a rule to a badge in an existing badge set, click the name of the badge set that contains the desired badge and then click Add Badge. Otherwise, create a new badge set where you want the badge with complex rules to live (see Create badge sets and badges). After entering the badge Name, Description, and Icon, in the Criteria drop-down menu, select Advanced Editor. In the Advanced Editor field, enter your custom badge rules. Enter each rule you want met (making sure that each rule has an identifier, operator, and value). Enter AND between each rule. Select the Hide from member profile until earned checkbox to ensure that the badge is displayed on member profiles only when the rules are met. Click Add Badge. Let’s say you want to create a badge for new members to encourage them to begin participating in the community. You might create a rule like this: metric.net_overall_threads >= 5 AND metric.net_kudos_weight_received >= 20 AND metric.net_accepted_solutions >= 3 This complex rule may be great for a badge that rewards users for creating new content with great quality. Feel free to use this example for your own community! Note: You cannot create complex rules with OR or NOT. Supported badge clauses and badge criteria A badge formula can include one of five types of clauses depending on the type of behavior you want to reward. You can chain rules together to create complex criteria using these clause types: Metric: Assigns a badge based on the value of a specific community activity recorded for each member. Member in role: Assigns a badge to a set of members based on community-level roles. User ID in set: Assigns a badge to a manually specified set of members based on their numeric user ID. This should be reserved for awarding rare badges to a small group of members. Non-Default profile setting value: Assigns badges based on members changing the default state of a specific setting or profile field on their member profiles. Specific profile setting value: Assigns badges based on the member changing a setting in their profile to a specific value. (For example, you could award a badge when a member sets their profile language to French.) Clause Type Clause Format (variables in bold) Metric metric.name_of_metric >= number Example: metric.net_accepted_solutions >= 1 Roles user.role.name in ['role'] Example: user.role.name in ['Administrator', 'Khoros'] User ID user.id in [id] Example: user.id in [10, 2, 5] Non-default profile setting setting.setting_key != 'default' Example: setting.profile.location != 'default' Profile setting value setting.setting_key = '[value]' Example: setting.profile.location = 'Argentina' Rewarding user activity using metrics For definitions of exactly what these metrics are, refer to these Aurora Analytics Metrics Definitions. The following member activity metrics are supported for use in a badge formula using the format: metric.name_of_metric >= [number] Accepted Solutions metric.net_accepted_solutions All Content Types metric.net_overall_posts metric.net_overall_replies metric.net_overall_threads Blogs metric.net_blog_articles metric.net_blog_comments metric.net_blog_posts Forums metric.net_posts metric.net_threads metric.net_replies Ideas metric.net_idea_threads metric.net_idea_comments metric.net_idea_posts Images and video metric.image_upload_count metric.video_upload_complete_count Likes metric.net_kudos_weight_given metric.net_kudos_weight_received Message views metric.message_views Sign-ins metric.logins KBs metric.net_published_tkb_articles metric.net_tkb_comments Rewarding specific members You can award badges to a specific group of members based on their role or user ID. Since you can’t edit a rule after you create the badge, we recommend using roles as the basis of your rule criteria. That way, if you need to add or remove members later, you can modify the member list for the role independent of the badge rule criteria. Important: If you want members to be notified (via email or real-time notifications) of a role-based badge, you must roll out the badge first and then add the role for that member. If the member already has the role before the badge is published, the member will not be notified. Keep in mind: Newly created badges are automatically applied to all members who already match the criteria, resulting in email notifications being sent out to community members depending on your badge notification settings. You need to coordinate such badge releases with Khoros to avoid a surge of emails being sent out to the community members, which can impact your community performance. Use single quotes around the role name. Use commas if you enter more than one. For example, to award a badge to all members with the “Admin” or “Moderator” role, enter this rule criterion: user.role.name in [‘Admin’, ‘Moderator’] You should use "user ID in set" in badge criteria only if you have a static, unchanging list of specific members. This clause type should be used only in special cases to award badges for one-time achievements. Otherwise, you’ll need to delete and recreate the badge each time you want to add another member’s user ID to the rule. Use commas if you enter more than one. For this case, use this format: user.id in [10,2,5] Rewarding profile completion You can use the profile setting below to create badges that reward members for filling out more information about themselves in their profile. These settings can all be used with the "Non-default profile settings" clause. Profile setting identifier Setting name Setting location setting.profile.name_first First Name My Settings > Personal setting.profile.name_last Last Name My Settings > Personal setting.profile.location Location My Settings > Personal setting.profile.biography Bio My Settings > Personal > Bio setting.profile.url_homepage Personal Site My Settings > Personal avatar_changed Note: To award a badge when a member changes their default avatar image, use this syntax: avatar_changed = true Avatar My Settings > Personal > Edit Rewarding date-based activity You can award badges based on date-based activities. Setting identifier Setting options Examples consecutive sign-ins number setting.user.max_consecutive_logins >= 2 registration_date date registration_date > "2015-01-01" (see supported syntax options below) time_since_registration time value in days, months, or years time_since_registration >= "1 years" signin_date date signin_date > "2015-01-01" (see supported syntax options below) About sign-in related activity We store a counter of the number of days in a row and the last sign-in time. When someone signs in, we get the date of the last increment and the date of today, and we count the days between. If < 1, we ignore it (so no gaming the system). If == 1, we increment the day counter. If > 1, we set the day counter to 0. About entering dates You can enter dates (which must be in quotes) in all formats supported by ISO 8061: Year: YYYY (eg 1997) Year and month: YYYY-MM (eg 1997-07) Complete date: YYYY-MM-DD (eg 1997-07-16) Complete date plus hours and minutes: YYYY-MM-DDThh:mmTZD (eg 1997-07-16T19:20+01:00) Complete date plus hours, minutes and seconds: YYYY-MM-DDThh:mm:ssTZD (eg 1997-07-16T19:20:30+01:00) Complete date plus hours, minutes, seconds and a decimal fraction of a second YYYY-MM-DDThh:mm:ss.sTZD (eg 1997-07-16T19:20:30.45+01:00) where: YYYY = four-digit year MM = two-digit month (01=January, etc.) DD = two-digit day of month (01 through 31) hh = two digits of hour (00 through 23) (am/pm NOT allowed) mm = two digits of minute (00 through 59) ss = two digits of second (00 through 59) s = one or more digits representing a decimal fraction of a second TZD = time zone designator (Z or +hh:mm or -hh:mm) Note: When an ISO 8601 date doesn't specify a time zone, it is considered to represent local time. We do not override the local time zone for this purpose, so the date is parsed from the badge clause based on the server's local time zone. So that will differ depending on the AWS region: US-West-2 (PST) EU-West-1 (CET) To prevent confusion on the Internet, date strings (for example, in badge clauses) may specify a time zone. Related topics: About Badges and Badge sets Create badge sets and badges Feature badge sets on the member profile Delete badge sets and badges Example badge sets and badges View badges from the member profileAurora: Revoke a badge
As an admin, you may want to remove a badge if it was awarded in error or if you suspect that the member “gamed the system” to receive the badge. Note: To revoke badges, you must be assigned a role with the Revoke Badges permission granted. To revoke a badge: Go to the Member Profile of the member whose badge you want to revoke. At the top right of the page, click View All Badges. At the top right of the member badges screen, open the Settings (gear icon) menu. Click Manage Badges. Hover your cursor over the right side of the row of the badge you want to revoke. When the button appears, click Revoke. Revoked badges remain in the list on the Manage Badges window but are grayed out and displayed with a date indicator of when the badge was revoked. If you revoked a badge by mistake, you can hover your cursor over the right side of the revoked badge in the list and click Re-Grant. Related topics: About Badges and Badge Sets Delete badge sets and badgesAbout Aurora Badges and Badge Sets
A badge is a type of visual reward that community members can earn for completing specific community actions or for achieving important community milestones. They serve as a great way to encourage members to use different community features and spend more time engaging with the community. You can create badges that encourage the specific behaviors that you want to instill in your members. When participation slows, they are a great tool to re-engage members. Note: The default maximum number of badges is set to 200. If you require more badges in the future, open a Support ticket. In Aurora, badge sets are groups of related badges. These can be designed to reflect linear progression in a particular achievement—for example, a badge set titled “Likes” could have badges in it that reflect a member receiving 10 likes, 20 likes, 50 likes, 100 likes, and so on. But badges in a set could also be related in a different way that does not require a progression, such as in a badge set called “Helping Hand,” in which there is a badge for creating a post, a badge for replying to a post, a badge for receiving a like, and a badge for having an accepted solution. When members earn badges, their profile is updated to reflect these accomplishments for everyone to see. Each badge has its own custom image, making it instantly recognizable in the community. An admin can choose to upload the same or a different image for each badge in a set. Each badge has its own event-based requirements that are calculated each time a member takes an action or has actions taken on their content or their profile. Each achievement has a unique trigger, name, description, and image associated with it. The top of the Member Profile shows the most recently earned badge in up to 5 different badge sets. If an admin has chosen to feature any badge sets, those sets are prioritized. Click View All Badges to see a complete list of earned badges. Depending on admin configuration, members may also see unearned badges shown in gray.When the member discovers new achievements, those badges gain color to show that they’ve been reached. Below the set, an indicator is displayed for how many badges in that set have been unlocked. If no badges in that set have been unlocked, “Locked” appears instead. Related topics: Create badge sets and badges About badge rules and supported badge criteria Feature badge sets on the member profile Delete badge sets and badges Example badge sets and badges View badges from the member profileAurora: Create and edit badge sets and badges
In Aurora communities, admins can categorize a group of related badges into a badge set. These can either progress in difficulty (such as an increasing number of likes received) or relate in another way (such as likes received, accepted solutions, and posted content rolling up into one overall achievement). After creating a badge set, admins can add badges to it. As members earn badges in a set, they can view which badges they’ve earned, and if designated by an admin, which badges they have yet to earn. Create a badge set Badge sets enable you to group your related badges together. You can also set which badge sets you want to feature on the member profile, which is useful if you have a large number of badge sets. To create a badge set: Go to Settings > Users > Badges. Click Add Set. On the Add Set window, enter a Name for the set. Click Add Set. Add badges to the set as needed. Reorder badges using the drag and drop functionality. (Optional) To feature a particular badge set on member profiles, go to the main Badges page and click the Feature (star) icon. The most recently achieved badge earned within this set is shown. Note: You can feature 5 badge sets at one time. Reorder badge sets using the drag and drop functionality. If you do not feature any badge sets, the order of the badge sets determines the badges that appear on the member profile. The most recently earned badge in up to 5 badge sets appears. Create a badge When you create a badge, it belongs to a set of related badges. Using the Criteria field, you determine the requirements needed to earn the badge. To create a badge: Go to Settings > Users > Badges. Click the name of the set where you want to add the badge or create a new badge set. Click Add Badge. On the Add Badge window, enter the Name of the badge. (Optional) Enter a Description for the badge. Upload an Icon for the badge. SVG or PNG format is required. For best results, use a square image with 240px minimum dimensions. To begin building rules for this badge, in the Criteria drop-down menu, select a criterion: Requirement builder: To create requirements guided by predefined metrics, select an option other than Roles or Advanced Editor. Then, when another field, such as Number of times, appears, enter a value. For example, to award members who receive 25 likes, in the Criteria menu, select Likes received, and enter 25 as the Number of times. Roles: To award this badge to members with specific roles, search for the applicable role and select it from the list. Advanced Editor: Enter the formula you want to use for the badge. Note: You cannot edit badge Criteria after saving the badge. Select the Hide from member profile until earned checkbox to hide the badge from member profiles until it is earned. If you do not select this checkbox, members can view this badge in gray until it is earned, when it will gain color. (Optional) To download a CSV file of all members who have been awarded this badge, click Download CSV on the Edit Badge window. Click Add Badge. Edit an existing badge set After you’ve created a badge set, there may be circumstances in which you want to manage the badges that are included within it or change the name of the set. Go to Settings > Users > Badges. Expand the badge set you want to edit by clicking its name. Complete the following as needed: To manage the set name, click Edit Set and edit the Name field. To add more badges to the set, click Add Badge. To move a badge from one set to another, ensure that the set to which you want to move it is also expanded, and then drag and drop the badge to the desired location in the destination badge set. To delete a badge from the set and from your community, hover your cursor over the row of the badge you want to delete, open the Options menu, and click Delete. Edit an existing badge After a badge has been added, the Criteria field and related values cannot be modified. If you need to manage the criteria for a badge, you must delete the badge and recreate it with the new criteria. Otherwise, you can edit the Name, Description, and Icon and change your selection for the Hide from member profile until earned checkbox. To manage these settings: Go to Settings > Users > Badges. Click the badge set name to expand the badge set containing the badge you want to edit. Hover your cursor over the row of the badge you want to edit and open the Options menu. Click Edit. Change settings as desired. (Optional) To download a CSV file of all members who have been awarded this badge, click Download CSV. Click Save Changes. Related topics: About Badges and Badge Sets About badge rules and supported badge criteria Feature badge sets on the member profile Delete badge sets and badges Example badge sets and badges View badges from the member profileAurora: Feature badge sets on the member profile
Admins can choose to feature up to 5 badge sets on the Member Profile page. The most recently earned badge within each of these badge sets is shown. If the member hasn’t earned a particular featured badge, it is either grayed out or not visible on the profile depending on chosen admin settings. As an admin, you can choose to feature a badge set at any time with no disruption to badges. If you choose not to feature any badge sets, the member profile displays the most recently achieved badge in each of the top (up to) 5 badge sets in the list on the admin Badges page. Reorder the badge sets using the drag and drop functionality if you want to change which badges appear. If you choose to feature fewer than 5 badge sets but have 5 or more badge sets in your community, the featured badge sets take precedence over the other badges. Here’s an example scenario of how badges may be featured on the member profile: Let’s say you have 6 total badge sets in your community. On the admin Badges page, you’ve named the badge sets letters A through F in ascending alphabetical order. You’ve chosen to feature badge sets B and C. Now let’s view the member profile of ChadB: Position 1 shows ChadB’s most recently earned badge in badge set B, since badge set B is a featured badge set and is prioritized over other badge sets. Position 2 shows ChadB’s most recently earned badge in badge set C, since badge set C is a featured badge set and is prioritized over other badge sets. Position 3 shows ChadB’s most recently earned badge in badge set A, since badge set A appears first in the list on the admin Badges page but is prioritized below featured badge sets. Position 4 shows ChadB’s most recently earned badge in badge set D, since badge set D appears next in the list outside of featured badge sets on the admin Badges page. Position 5 shows a grayed-out badge from badge set E since ChadB has not yet earned any badges from this badge set, but badge set E appears next in the list on the admin Badges page. To feature badge sets on the member profile: Go to Settings > Users > Badges. Click the Feature (star) icon. Note: You can feature up to 5 badge sets at one time. Related topics: About Badges and Badge Sets Create badge sets and badges About badge rules and supported badge criteria Delete badge sets and badges Example badge sets and badges View badges from the member profileAurora: Delete badge sets and badges
If you’ve entered incorrect requirements on a badge or no longer need a particular badge set or badge, you can delete it. Note: After you’ve saved a badge, you cannot change its requirements (Criteria). To change the requirements, you must delete the badge and recreate it with the updated requirements. Delete a badge set If you no longer need a particular badge set, such as an out-of-the-box one or outdated one, you can delete it. Go to Settings > Users > Badges. Click the name of the badge set you want to delete. Click Edit Set. Click Delete. A confirmation window opens that indicates how many badges within the set will be deleted along with the set. All badges in the set will be revoked from any members who received them. Delete a badge If you no longer need a badge or if you want to change its Criteria, you can delete it. Note: After you’ve saved a badge, you cannot change its requirements. To change the requirements, you must delete the badge and recreate it with the updated requirements. Go to Settings > Users > Badges. Click the name of the badge set containing the badge you want to delete. Open the Options menu in the row of the badge you want to delete. Click Delete. The confirmation window that opens reminds you that deleting the badge revokes it from all members who have received it. (Optional) Create a new badge with updated requirements (Criteria) to replace the one you deleted.Example Aurora badge sets and badges
The following article outlines an example setup of badge sets containing badges and their requirements. While you are welcome to use these as the basis for your badges, we recommend creating your own badges and badge sets with icons to fit your brand. Collaborator The Collaborator badge set rewards members who post responses to other members of the community. Badge Name Description Requirement First Reply You have earned this badge for posting 1 reply! metric.net_overall_replies >=1 Staying Engaged You have earned this badge for posting 5 replies! metric.net_overall_replies >=5 Responsive You have earned this badge for posting 20 replies! metric.net_overall_replies >=20 Insightful You have earned this badge for posting 50 replies! metric.net_overall_replies >=50 Articulate You have earned this badge for posting 100 replies! metric.net_overall_replies >=100 Helpful The Helpful badge set rewards members as they receive likes on their content. Badge Name Description Requirement First Like! You have earned this badge for receiving 1 like! metric.net_kudos_weight_received >=1 Stamps of Approval You have earned this badge for receiving 20 likes! metric.net_kudos_weight_received >=20 Round of Applause You have earned this badge for receiving 50 likes! metric.net_kudos_weight_received >=50 Well Liked You have earned this badge for receiving 100 likes! metric.net_kudos_weight_received >=100 Popular You have earned this badge for receiving 250 likes! metric.net_kudos_weight_received >=250 Problem Solver The Problem Solver badge set rewards members as their responses are marked as accepted solutions. Badge Name Description Requirement First Solution! You have earned this badge for posting 1 solution! metric.net_accepted_solutions >=1 Third Time’s the Charm You have earned this badge for posting 3 solutions! metric.net_accepted_solutions >=3 Troubleshooter You have earned this badge for posting 5 solutions! metric.net_accepted_solutions >=5 To the Rescue You have earned this badge for posting 10 solutions! metric.net_accepted_solutions >=10 Enlightened You have earned this badge for posting 20 solutions! metric.net_accepted_solutions >=20 Conversation Starter The Conversation Starter badge set rewards members who post content in the community. Badge Name Description Requirement First Discussion! You have earned this badge for starting 1 discussion! metric.net_overall_threads >=1 Conversation Starter You have earned this badge for starting 5 discussions! metric.net_overall_threads >=5 Conversationalist You have earned this badge for starting 10 discussions! metric.net_overall_threads >=10 Inquisitive Mind You have earned this badge for starting 20 discussions! metric.net_overall_threads >=20 Curious Intellect You have earned this badge for starting 50 discussions! metric.net_overall_threads >=50 Related topics: About Badges and Badge Sets Create badge sets and badges About badge rules and supported badge criteria Feature badge sets on the member profile Delete badge sets and badges View badges from the member profileAurora: Manage permissions to view badges (admin)
Admins can control whether members can view badges in the community and receive notifications for earned badges through the View Badges permission. While the default and recommended setting is Grant, admins may want to set the permission to Deny if they are in the process of creating badges for the first time. They can later set it to Grant once the badge sets and badges have been completed. This permission can be adjusted for community permission defaults and for roles at the community level. Note: Permissions to create and edit badges are inherent to the Administrator role and cannot be modified or added to other roles. To manage the View Badges permission in Community Permission Defaults: Note: To manage this permission for a particular community-level role, follow the same process after navigating to that role’s permissions. Go to Settings > Roles and Permissions > Community Permission Defaults. Go to the Badges section. Beside View Badges, select Deny or Grant as needed. Related topics: About roles and permissions Permission descriptions About Badges and Badge Sets
