Welcome, Guest Login
Higher Logic User Group Site Higher Logic User Group Site Higher Logic Support Center

Support and Documentation

Recognition: Ribbons and Points

Last Updated: May 10, 2016 04:03PM EDT
Ribbons and badges provide visual rewards and incentives for users.  They can be attributed to users directly and through automated rules.  When coordinated with managed automation rules ribbons and badges can incentivize desired community activity in gamification schemes.  There is no technical difference between a “ribbon” and a “badge” – both are images that display on profile pages when earned or attributed directly.  For the purposes of brevity this documentation will refer to both as “ribbons”.   The user interfaces in the Admin site which also commonly omit the word “badge”.

Points are accumulated by users. Actions taken by a user can achieve points, and content created by a user can generate points when others act on it through such actions as recommendations.     

Ribbon Settings

Any individual ribbon can have the following characteristics.  These are set in the Admin site via the Digital Ribbons page:
  • Image – the most visible aspect of any ribbon or badge is the Ribbon Image.  JPG, PNG and GIF file types are supported with a maximum width of up to 250 px.  Ribbons over the maximum width will be resized.  
  • Name – the name of the ribbon is seen by administrators and can differ from the text displayed to users. The name of the ribbon only serves to enhance clarity for managers.  
  • Text displayed – the ribbon image can have a text overlay.  This can be simply not used when the text exists within the ribbon image itself.
  • Sort Order - this determines the order of the ribbons when displayed with multiple other ribbons the
  • Description - text describing the ribbon.  The description displays on cursor hover over a ribbon when on a user's profile. 
  • URL – ribbons can send a user to a specific webpage when clicked.
  • Category – ribbons can be grouped into common categories.  Categories such as “Certifications” and “Years of Membership” are common
  • Achievable status – ribbons that are achievable can be previewed to users who have not yet earned them.  The preview state is partially opaque.  The preview of an achievable ribbon will only be visible to the profile owner looking at their own profile.    

Attributing Ribbons to Users

Ribbons can be attributed to any user directly or via an automation rule.  Ribbons are directly established by HLAdmins for any user on an individual user’s profile Admin tab.  Ribbons are often set across multiple users by automation rules.  Automation rules are used to establish ribbons across all users with a specific characteristic or set of characteristic.  

The following are examples of common automation rule ribbon assignments:
  • Attribute the “Veteran Member” ribbon to all users who are Members with an account start date that is 5 years or older
  • Attribute the “Blogger” ribbon to all users who have posted more than five blogs
  • Attribute the “MVP” ribbon to all users who have accumulated over 1,000 engagement points
  • Attribute the “Board Member” ribbon to all users who are in the “Board of Directors” Community

Ribbon Display

Ribbons are displayed on user profiles via the Directory:Ribbons:RibbonDisplay MVC Action control.   The primary page for displaying ribbons is the Profile Achievements page (page code contributionsachievements) nested under the Contributions Profile tab.  Ribbons are also commonly displayed on all pages of the profile via configuration in Profile Base.  

Ribbons and badges display to all users when achieved (pending page and content item visibility settings in the CMS).  Ribbons are most commonly displayed by ribbon category.  There are a number of points of configuration for ribbons.  “Achievable” ribbons can display or not display the opaque state to users who have not yet achieved them.  The absence of ribbons (the null state display) can be configured for different experiences by profile owners looking at their own profile and for users visiting another person’s profile.

Opacity for Unachieved Ribbons

Ribbons that are achievable can be displayed with opaque status to users who are looking at their own profile pages.  The only benefit of setting any ribbon as achievable is to display with opacity prior to it being earned.  If opacity-for-unearned is not desired for a ribbon simply ignore the opacity toggle in the ribbon configuration page.  Where ribbons are displayed, opacity for unachieved ribbons is configured by including ShowUnattained="true" as a parameter for the Directory:Ribbons:RibbonDisplay MVC Action control.   The default for this parameter is false.
the badge at right displays opacity as unearned/achievable

Display by Ribbon Categories

By default, the Directory:Ribbons:RibbonDisplay MVC Action control displays all ribbons.  Displaying the ribbons of a particular category is achieved via configuration.  Ribbon categories are created in the Admin site’s Ribbon Categories page.  The category for any specific ribbon is attributed when editing a ribbon. 

The display of only a specific category of ribbon via the Directory:Ribbons:RibbonDisplay MVC Action control is achieved by inclusion of the CategoryName parameter.  Set the value for this parameter to the exact name, including spaces, for the category.  Only one ribbon category can be displayed per instance of the Directory:Ribbons:RibbonDisplay control – multiple values within the same parameter are not supported.

Ribbon-area Display when the Profile Owner has None

Ribbons that are earned or given to a profile owner will show to all users who can visit the profile areas where they are displayed.  A user having no ribbons or a particular ribbon category or no ribbons at all is a common occurrence. 

There are three possible displays where a user has a null:

1)    Opaque ribbons
Ribbons that are not yet earned can display with opacity indicating they are  possible but not currently achieved.

2)    Text
Words within a formatted display area can be configured to inform or incent action
an example of text displayed for null states


3)    Nothing at all
Neither the content item header nor anything in the content area will show

These three display options can vary within the same configuration.  A logged-in user can see something different on their profile than another user who is only visiting a profile of another person.  

Supported null-state display combinations with configuration:

1)    Opacity for the profile owner and nothing for the profile visitor
(The ribbons must be configured as achievable in the Admin site’s Ribbons Configuration area)
ShowUnattained="true" NoDataHide="True"

2)    Text for the Profile owner and text for the Profile visitor
NoDataHide="False" NoDataTextUserDesc="Text" NoDataText="More Text"

3)    Text for the Profile owner and nothing displayed for the profile visitor
NoDataHide="True" NoDataTextUserDesc="Text" NoDataText="More Text"

4)    Nothing displayed to any user
(including the Content Item header)
NoDataHide="True"

Parameter list for the Directory:Ribbons:RibbonDisplay MVC Action control

CategoryName="variable"
Purpose: display a subset of ribbons previously determined via categories managed and attributed in the Admin site.
Variables: text inputs identical to the category names configured in the Admin site
Default: show all ribbons

NoDataHide="variable"  
Purpose: Hide the display where users have no ribbons to display
Variables: true or false
Default: false

NoDataText="variable"
Purpose: Show text to prompt action or inform where a user has no ribbons to display.  Text displayed is in two parts – the no-data label and the no-data description.  This determines the text for the no-data label.
Variables: text input
Default: no text is displayed when not configured

NoDataTextUserDesc="variable"
Purpose: Show text to prompt action or inform where a user has no ribbons to display.  Text displayed is in two parts – the no-data label and the no-data description.  This determines the text for the no-data description.
Variables: text input
Default: no text is displayed when not configured

ShowAttainableOnly="variable"
Purpose: Show only those ribbons that can be achieved, omitting those that have been achieved.
Variables: true or false
Default: false

ShowCategoryName="variable"
Purpose: the category name can be displayed uniquely within the content display (below the header).
Variables: true or false
Default: true

ShowUnattained="variable"
Purpose: Show only the ribbons that can be achieved along with those that have been achieved.
Variables: true or false
Default: true

Points

User actions can result in the user receiving points.  Points can be the basis of recognition, such as ribbons being awarded through automation rules and a user appearing on a leaderboard of points awardees.  There are four categories of points.  Engagement Points, Contribution Points and Reputation Points are closely related.  Points values are configurable on the Engagement Types page found in the Users navigation area of the Admin site. Volunteer Points are the fourth category of points and are determined by configuration of the volunteer product.

Engagement Points, Contribution Points and Reputation Points

The three primary kinds of points are closely related.  Contribution Points and Reputation Points are subsets of Engagement Points.

E = Engagement Point criteria
C = Contribution Point criteria
R = Reputation Point criteria


E C R       Best Answer : Content created by the user marked as the Best Answer
E             Bio Updated : The number of updates that the user has made to their bio
E C          Blog Comments : The number of blog posts on which the user has commented
            Blogs Viewed : The number of blog posts that the user has viewed in detail
E C          Blogs Written : The number of blog posts that the user has written
E C          Calendar Events Added : The number of calendar events that the user has added
           Calendar Events Registered : The number of registrations for the user
            Communities Admin : The number of communities of which the user is an administrator
E C          Communities Created : The number of communities that the user has created
E             Community Invitations Accepted : The number of community invitations accepted
            Community Invitations Sent : The community invitations sent by the user
            Community Membership : The number of communities in which the user is a member
E             Contact Information Updated : Updates to the user's contact information
E             Contact Invitations Accepted : Contact invitations received and accepted
E             Contact Invitations Sent : Contact invitations sent by the user
E              Contacts (Friends) : The number of contacts or friends the user currently has
E              Demographics Updated : The number of demographic updates that the user has made
E C          Education Details Updated : The number of education updates that the user has made
            eGroup Moderations : The number of posts the user has moderated (moderators only)
            eGroup Posts Read : The number of eGroup posts that the user has read
E C          eGroup Posts Written : The number of eGroup posts that the user has written
E             eGroup Subscriptions : The number of real-time subscriptions for the user
E C          Glossary Term Comments : The number of glossary comments made by the user
E C          Glossary Terms Edited : The number of glossary terms that the user has edited
E C          Glossary Terms Rated : The number of glossary terms that the user has rated
E             Glossary Terms Viewed : The number of glossary terms viewed in detail
            Job History Updated : The number of job history updates by the user
E             Library Entries Moderated : Library entries moderated (moderators only)
E C          Library Entries Posted : Library entries posted/uploaded by the user
E C          Library Entries Rated : Library entries that the user has rated
            Library Entries Viewed : Library entries that the user has viewed in detail
E C          Library Entry Comments : Library entry comments made by the user
E             Messages Received : Person-to-person messages received/read
E             Messages Sent : Person to person messages that the user has sent
            Networks : The number of networks of which the user is a member
E             New Sessions Added : Event sessions that the user has created
E             Profile Picture Updated : Profile picture updates by the user
E C R       Recommended Content : Content created by the user was recommended by others
E C          Related Links : Releated links and related entries added by the user to library entries
E             RSS Subscriptions : The number of RSS subscriptions that the user maintains
            Sessions Updated : The number of sessions that the user has updated
E C          Website Pages Created : The number of website pages that the user has created
E C          Website Pages Updated : The number of website pages the user has updated
            Website Pages Viewed : The number of website pages that the user has viewed

Points Leaderboards

Points leaderboards can be configured using the ws:Engagement user control.  The default configuration is to show a leaderboard for Engagement Points. It is possible to make this list display for Contribution Points leaders through configuration.  The following parameters allow configuration of the display desired. 
  • NumberToShow="number"
    determines the number of users to display in the list.  The default is 4. 
     
  • IsContributors="T/F"
    determines whether the list shows a leaderboard based on Contribution Points.  The default, false, is to display based on Engagement Points.
     
  • EngagementPeriod="string"
    determines the period of time for the points calculations.  This parameter accepts only two time periods; 30 days and 7 days.  These are achieved with EngagementPeriod="past7days" and EngagementPeriod="past30days".  The default, for all time, is achieved by omitting any EngagementPoint parameter.
     
  • DisplayOrientation="string"
    determines whether the display is horizontal or vertical.  The default is vertical.  DisplayOrientation="display-horizontal" achieves a horizontal display.
     
  • IgnoreSecurityGroups="string"
    allows specific security groups to be omitted from the display.  This is helpful for removing staff users. An example of this is IgnoreSecurityGroups="Staff" if "staff" is a configured security group.
Note that leaderboards generated by the ws:Engagement user control cannot respect community-specific leaders at this time. 

Volunteer Points

Volunteer Points are configured within the Volunteer Manager product.  See the Volunteer Manager Configuration area of the Volunteer Settings page for more information about Volunteer Points.
support@higherlogic.com
http://assets1.desk.com/
false
higherlogic
Loading
seconds ago
a minute ago
minutes ago
an hour ago
hours ago
a day ago
days ago
about
false
Invalid characters found
/customer/en/portal/articles/autocomplete