How To Use BadgeOS

/How To Use BadgeOS
How To Use BadgeOS 2020-08-06T16:00:35-04:00

Achievement Types:

Following are the steps to add a new achievement type:

  • Navigate to BadgeOS > Achievement types.
  • Click Add New.
  • Add Title (‘Badge’ as an achievement type is already added to default and is displayed in the menu to your left). Please note the title cannot be longer than 20 characters.
  • Add Plural Name under the Achievement Type Data section.
  • If you would like to have quick access to this achievement type in the left menu, check the option Show in Menu? under the Achievement Type Data section.

GIF:

Title and Description

To add a new achievement follow these steps:

  • Navigate to the desired Achievement type. For example, if you created ‘Badge’, you need to click on the Badge item in the menu on your left.
  • Click Add New.
  • Add Title and Description.

Here is what it would look like on the front end:

Required steps

  • Add Required Steps. Steps are the conditionals of an achievement to be considered complete. This will define what your users will need to do to earn the badge.

Achievement Data

  • Points Awarded

If you would like to reward your users with points every time they receive a badge, you can set this up in this field.

You can also use this option to deduct the selected points type on the earning of that specific achievement. You have to insert the desired negative value for example -50 for the Point Awarded field and select the point types from the dropdown.

  • Earned by

Earned by option shows how this achievement can be earned.

All Earned by options are explained below:

  • Completing Steps

Select Earned by option as Completing steps. It displays the required steps to configure the achievement.

  • Minimum Number of Points

Select Earned by option as the Minimum number of points. This achievement can be achieved when a user achieved the selected number of points.

  • Admin-awarded Only

Select Earned by option as Admin-awarded Only. This achievement can be earned only when the admin awards this achievement to the user from the user profile.


Award from the user profile

  • Sequential Steps

If you selected ‘Completing steps’ in the ‘Earned by’ field, you will see another box appear called ‘Sequential steps’. Check this box if you’d like your users to complete the steps in the exact order you listed them or leave this box unchecked if it does not matter in what order your users will need to complete the steps.

Now user should log in first then comment on a post to earn the achievement

 

  • Show Earners

If this option is checked then it will display a list of users on the front-end who have earned this achievement.

  • Maximum Earnings

This field defines the maximum amount of times an achievement can be awarded. For example, if you decide to award a badge every time your student comments on a post, you can limit as to how many badges they can get for commenting. In other words, if you specify 10 in this field, it will mean that your user can only get 10 badges for this activity.

If you don’t want to limit the number of badges for this activity, insert ‘-1’ or leave the field empty.

  • Hidden

If the selected option is Hidden to User then it will hide the achievement from the user. The hidden achievement won’t list in the Achievement list and it will also be hidden on the BadgeOS Earned User Achievement widget even after earning the achievement. The hidden earned achievement can only be seen in the user profile from the admin panel.

  

  • Allow Attachment for Submission

This option can only be used with submissions. It allows attachment on the submission if checked

Attachment file can be attached with the submission

Attachment can be found at BadgeOS > Submissions open the submission and the attachment file will be placed at the end of the submission.

  • Allow Attachment for Submission Comment

This option can only be used with submissions. It allows attachment to the comments of the submission.

  • Badge Sharing Option

Configuring this section you can make the earned badge for this achievement shareable via Credly on social networks, such as Facebook, Twitter, LinkedIn, Mozilla Backpack, or the badge earner’s own blog or site.

Follow these steps:

  • Select Yes for Send to Credly when earned field.
  • Select Yes for Include Evidence field.
  • Select Yes for Enable Notification field if you want to send Credly email notification to the user on earning that specific achievement.

OR
Select No for Enable Notification field if you don’t want to send Credly email notification to the user on earning that specific achievement

  • Select Yes for Include Testimonial field.
  • Set Expiration.
  • Select Yes if you want to allow the badge to be given by others for Allow Badge to be Given by Others field.
  • Select Credly Badge Category.

Note: You can configure global settings for Credly integration from Credly Integration under the BadgeOS menu.

  • Required Steps:

Required Steps option will show if Completing Steps is selected in Earned by.

  • Log in to Website:

From the required steps select login to the website and insert the value in the number of times field. This will be triggered when user login and the user will be awarded this specific achievement.
Use the “Label” field to optionally customize the titles of that step.

 

  • Not Login For X Days:

From the required steps select Not Login For X Days and insert the value in the days and the number of times field. This will be triggered when the user not logged in for X define days and the user will be awarded this specific achievement.
Use the “Label” field to optionally customize the titles of that step.

  • Comment on a post:

From the required steps select Comment on a post and insert the value in the number of times field. This will be triggered when a user comments on any post and the user will be awarded this specific achievement.
Use the “Label” field to optionally customize the titles of that step.

  • Comment on a specific post:

From the required steps select Comment on a specific post then paste the id of the post and insert the value in the number of times field. This will be triggered when a user comments on that specific post and the user will be awarded this specific achievement.
Use the “Label” field to optionally customize the titles of that step.

The ID of the post is located in the URL of that post

  • Publish a new post:

From the required steps select Publish a new post and insert the value in the number of times field. This will be triggered when a user publishes a new post and the user will be awarded this specific achievement.

Use the “Label” field to optionally customize the titles of that step.

Note: Only admin, editor, and the author can earn that achievement.

If you are using any plugin which allows all users to create the post/page from the front-end, all users can earn that achievement by publishing a new post.

  • Publish a new page:

From the required steps select Publish a new page and insert the value in the number of times field. This will be triggered when a user publishes a new page and the user will be awarded this specific achievement.

Use the “Label” field to optionally customize the titles of that step.

Note: Only Admins and Editors can publish the page.

If you are using any plugin which allows all users to create the post/page from the front-end, all users can earn that achievement by publishing a new page.

  • Register to the website:

From the required steps select Register to the website. This will be triggered when a user registers into the website and the user will be awarded this specific achievement.

Use the “Label” field to optionally customize the titles of that step.

  • Daily visit website:

From the required steps select the Daily visit website. This will be triggered on the first login of the day and the user will be awarded this specific achievement.

Use the “Label” field to optionally customize the titles of that step.

  • Specific Achievement of Type:

From the required steps select Specific Achievement of Type then select the achievement type and then achievement. This will be triggered when a specific achievement of the selected type is achieved and the user will be awarded this specific achievement.

Use the “Label” field to optionally customize the titles of that step.

  • Any Achievement of Type:

From the required steps select Any Achievement of Type then select the achievement type. This will be triggered when any achievement of the selected type is achieved and the user will be awarded this specific achievement. Use the “Label” field to optionally customize the titles of that step.

  • All Achievements of Type:

From the required steps select All Achievement of Type then select the achievement type. This will be triggered when all achievements of the selected type are achieved and the user will be awarded this specific achievement.

Use the “Label” field to optionally customize the titles of that step.

  • Publish the post.

How to Add Achievement GIF:

Log Entries:

Log entries contain information about all events triggered by your users.

Log entries can be enabled or disabled from the BadgeOS > Settings.

Point Types

BadgeOS lets you define unlimited user points wallets named points types.

You can configure as many points types as you like: Credits, Gems, Coins, etc.

 To add a new point type, follow these steps:

  • Select Point types from the BadgeOS menu and click Add New.
  • Add title and plural name for this point type.
  • Add a featured image from the meta box on the right side of the edit page.

Point Award

  • To award the points, define the required steps for this point type to be considered complete. By clicking the Add New Step;
  • Select an option from the drop-down for the Require field;
  • Specify how many times the user should perform the action;
  • Click Save All Steps.

You can add multiple steps.

Point Deducts

  • To deduct the point,  define the required steps for this point type to be considered complete. By clicking the Add New Step.
  • Select an option from the drop-down for the Require field.
  • Enter the desired number for the Times field.
  • You can add multiple steps.
  • Click Save All Steps.

In the example below, our users will be lost 10 points every time they fail a quiz. They can lose 10 points for a failed quiz 100 times. 

  • Publish the post.

You can add multiple steps.

Required Steps To Award and Deduct Point types

  • Log in to Website:

From the required steps select login to website then insert points and insert the value in the number of times field. This will be triggered when the user login.

  • Comment on a post:

From the required steps select Comment on a post then insert points and insert the value in the number of times field. This will be triggered when a user comments on any post.

  • Comment on a specific post:

From the required steps select Comment on a specific post then insert points and insert the value in the number of times field. This will be triggered when a user on a specific post.

  • Publish a new post:

From the required steps select Publish a new post, then insert points and insert the value in the number of times field. This will be triggered when a user publishes a new post.

  • Publish a new page:

From the required steps select Publish a new page then insert points and insert the value in the number of times field. This will be triggered when a user publishes a new page.

  • Register to the website:

From the required steps select Register to the website then insert points and insert the value in the number of times field. This will be triggered when a user registers to the website.

  • Daily visit website:

From the required steps select the Daily visit website then insert points and insert the value in the number of times field. This will be triggered on the first login of the day.

How to Add Point Type Gif:

View Earned Points on the User Profile Page

Admin can view the earned points of any user on the user’s profile page (Users -> All Users -> Click on a specific user -> Scroll down to Earned Points)

The admin can also display the points, ranks, and achievements on the BuddyPress profile page. It requires BuddyPress plugin and BadgeOS Community add-on to be installed and activated.

Rank Types

BadgeOS lets you define unlimited ranks that your users can reach named rank types. You can configure as many rank types as you like and call them as you see fit: Grade, Level, etc, and in each rank type, you can configure unlimited ranks that your users can reach for interacting with your site.

Be ready to name your ranks and follow these steps to add a new rank type:

  • Select Rank types from the BadgeOS menu and click Add New.
  • Add title and plural names for the rank. For example, our rank type will be called ‘Levels’
  • Check Show in the Menu option.



  • Publish the post.

How to Add Rank Type Gif:

Add New Rank:

After adding a new rank type a new menu will appear in your admin area named Ranks.

Ranks are similar to achievements (Badges). The only difference is that the same achievement (badge) can be awarded multiple times while the same rank can be awarded only once.

To add a new rank follow these steps:

  • Select the created rank type from WP Dashboard > BadgeOS > Ranks, click Add New.
  • Add title and description.
  • Add a featured image from the meta box on the right side of the edit page.
  • If you want to award the rank if the user reaches a specific number of points of a specific point type, select “Yes” from the field Allow reach with points?, A new field Points to Unlock will be enabled.
  • Enter the desired number of points in the field Points to Unlock, also select the points type from the drop-down.

Rank Requirement

  • To award the rank, define the required steps for this point type to be considered complete. By clicking the Add New Step.
  • Select an option from the drop-down for the Require field.
  • Enter the desired number for the Times field.
  • Click Save All Steps.
  • Select the rank priority from the Rank Details meta box,  if you set to “0” it will be awarded to all the users as a default rank. The rank priority defines the order a user can achieve ranks. Users will need to get lower priority ranks before getting this one.
  • Publish the post.

How to Add Rank Gif:

Settings:

BadgeOS plugin settings can be configured from BadgeOS > Settings. Different options can be found here for the configuration of the plugin.

Minimum Role to Administer the BadgeOS plugin:

The admin can select the minimum role to administer the BadgeOS plugin.

Minimum Role to Administer Submissions/Nominations:

The admin can select the minimum role to administer the submissions and nominations.

Send Email When Submissions/nominations are Received:

If this option is enabled, the system will automatically send an email to the admin when submissions or nominations received.

Notification Email Addresses:

Here the admin can enter the email addresses for the notification. 

Delete Data on Uninstall:

If this option is enabled, it will delete all BadgeOS database entries on uninstall including posts, setting options, user meta.

Debug Mode:

This option can be used to show the detail error information. When enabled it will show some meta-data values on the user’s profile edit page.

Log Entries:

Log entries can be enabled or disabled from this option.

Rank Post Type:

Here the admin can customize the ranks type slug name.

Rank Step Post Type:

Here the admin can customize the rank step post type slug name.

Point Type:

Here the admin can customize the point type slug name.

Point Award:

Here the admin can customize the point award slug name.

Point Deduct:

Here the admin can customize the point deduct slug name.

Default Point Type:

Using this option, you can select the default point type. It is necessary to select the default point type.

BadgeOS Add-on Licenses:

In this section, the admin can insert the license keys of activated BadgeOS premium add-ons and check their activation status.

BadgeOS DB Upgrade:

To update the users’ existing achievements and points in the BadgeOS table, click on the “Upgrade 3.0 DB” button.

BadgeOS Upgrade Achievement:

To update the existing achievement points with the point types, click on the “Upgrade Achievements” button below.

Achievements Tools

Using the Achievement tool option the admin can award or revoke the achievements in bulk.

Award Achievements in Bulk:

Award Achievements in Bulk option allows you to award the achievements in bulk to your users.

Achievements to Award:

Here you can choose the achievement(s) to award. You can select multiple achievements.

Award to All Users:

Check this point to award the selected achievement(s) to all users.

Users to Award:

Here you can choose users to award the selected achievement(s). You can select multiple users.

Once you select all the above-desired options, click the Award Achievements button to award the selected achievement(s).

Revoke Achievements in Bulk:

Revoke Achievements in Bulk option allows you to revoke the achievements in bulk from your users.

Achievements to Revoke:

Here you can choose the achievement(s) to revoke. You can select multiple achievements.

Revoke to All Users:

Check this point to revoke the selected achievement(s) from all users.

Users to Revoke:

Here you can choose users to revoke the selected achievement(s). You can select multiple users.

Once you select all the above-desired options, click the Revoke Achievements button to revoke the selected achievement(s).

Credits Tools

Using the Credit tool option the admin can award or revoke the credit/points in bulk.

Award Credits in Bulk:

Award Credit in Bulk option allows you to award the credit in bulk to your users.

Select Credit Type:

Here you can choose the credit type(s) to award. You can select multiple credit types.

Credit Amount:

Enter the amount of credit to award.

Award to All Users:

Check this point to award the selected credit type(s) to all users.

Users to Award:

Here you can choose users to award the selected credit type(s). You can select multiple users.

Once you select all the above-desired options, click the Award Credit button to award the selected credit type(s).

Revoke Credits in Bulk:

Revoke Credits in Bulk option allows you to revoke the credits in bulk from your users.

Credits to Revoke:

Here you can choose the credit type(s) to revoke. You can select multiple credit types.

Revoke to All Users:

Check this point to revoke the selected credit type(s) from all users.

Users to Revoke:

Here you can choose users to revoke the selected credit type(s). You can select multiple users.

Once you select all the above-desired options, click the Revoke Credits button to revoke the selected credit type(s).

Ranks Tools

Using the Rank tool option the admin can award or revoke the rank(s) in bulk.

Award Ranks in Bulk:

Award Ranks in Bulk option allows you to award the ranks in bulk to your users.

Ranks to Award:

Here you can choose the rank(s) to award. You can select multiple ranks.

Award to All Users:

Check this point to award the selected rank(s) to all users.

Users to Award:

Here you can choose users to award the selected rank(s). You can select multiple users.

Once you select all the above-desired options, click the Award Ranks button to award the selected rank(s).

Revoke Ranks in Bulk:

Revoke Ranks in Bulk option allows you to revoke the rank(s) in bulk from your users.

Ranks to Revoke:

Here you can choose the rank(s) to revoke. You can select multiple achievements.

Revoke to All Users:

Check this point to revoke the selected rank(s) from all users.

Users to Revoke:

Here you can choose users to revoke the selected rank(s). You can select multiple users.

Once you select all the above-desired options, click the Revoke Ranks button to revoke the selected rank(s).

System Tools

Server Info:

All the information about the server, PHP Configuration, WordPress and BadgeOS will be listed here.

Email Notifications feature allows you to send instant custom emails to the achievements/ranks/points earners. You can find the email settings from Dashboard > BadgeOS > Tools > Emails (tab)

General Settings:

Email Logo:

You can choose an email logo by using this option. Click “Choose file”.  Select the logo. 

From Name:

Enter the email sender name here.

From Email:

Enter the sender email address here.

Footer Text:

You can add custom footer text in this field.

Click Save.

Achievements:

This email will be sent if any user earned any achievement.

Disable Earned Achievement Email:

Check this option, if you want to disable earned achievement email.

Subject:

Enter the email subject here. 

You can use these shortcodes [achievement_type], [date_earned], [achievement_title], [points], [user_email], [user_name] to add achievement type, date earned, achievement title, points, user email, and user name in email subject respectively.

Content:

Enter the email content here. 

You can use these shortcodes [achievement_type], [date_earned], [achievement_title], [achievement_link], [achievement_image], [points], [user_email], [user_name], [user_profile_link] to add achievement type, date earned, achievement title, achievement link, achievement image, points, user email, and user name in email respectively.

Click Save.

Achievements Steps:

This email will be sent if any user completed any achievement step.

Disable Achievement Steps Email:

Check this option, if you want to disable achievement step email.

Subject:

Enter the email subject here. 

You can use these shortcodes [step_title], [date_earned], [user_email], [user_name] to add step title, date earned, user email, and user name in email subject respectively.

Content:

Enter the email content here. 

You can use these shortcodes  [step_title], [date_earned], [user_email], [user_name], [user_profile_link] to add step title, date earned, user email, user name and user profile link in email respectively.

Click Save.

Ranks:

This email will be sent if any user earned any rank.

Disable Rank Email:

Check this option, if you want to disable rank email.

Subject:

Enter the email subject here. 

You can use these shortcodes [rank_type], [date_earned], [rank_title], [user_email], [user_name] to add rank type, date earned, rank title, user email, and user name respectively.

Content:

Enter the email content here. 

You can use these shortcodes  [rank_type], [date_earned], [rank_title], [rank_link], [rank_image], [user_email], [user_name], [user_profile_link] to add rank type, date earned, rank title, rank link, rank image, user email, user name, user profile link in email respectively.

Click Save.

Ranks Steps:

This email will be sent if any user completed any rank step.

Disable Achievement Steps Email:

Check this option, if you want to disable rank step email.

Subject:

Enter the email subject here. 

You can use these shortcodes [rank_step_title], [date_earned], [user_email], [user_name] to add rank step title, date earned, user email, and user name in email subject respectively.

Content:

Enter the email content here. 

You can use these shortcodes [rank_step_title], [date_earned], [user_email], [user_name], [user_profile_link] to add rank step title, date earned, user email, user name and user profile link in email respectively.

Click Save.

Points Award:

This email will be sent if any user earned points of any points type.

Disable Point Award Email:

Check this option, if you want to disable point awarded email.

Subject:

Enter the email subject here. 

You can use these shortcodes [point_title], [date_earned], [credit], [user_email], [user_name] to add  point title, date earned, credit, and user email in email subject respectively.

Content:

Enter the email content here. 

You can use these shortcodes [point_title], [date_earned], [credit], [user_email], [user_name], [user_profile_link] to add point title, date earned, credit, user email, user name, user profile link in email respectively.

Click Save.

Points Deduct:

This email will be sent if points of any points type deducted from the user’s account.

Disable Point Award Email:

Check this option, if you want to disable point deducted email.

Subject:

Enter the email subject here. 

You can use these shortcodes [point_title], [date_earned], [credit], [user_email], [user_name] to add  point title, date earned, credit, and user email in email subject respectively.

Content:

Enter the email content here. 

You can use these shortcodes [point_title], [date_earned], [credit], [user_email], [user_name], [user_profile_link] to add point title, date earned, credit, user email, user name, user profile link in email respectively.

Click Save.

OB (Open Badge) Integration

Note: This feature is only available in BadgeOs Version 3.6.

On the Open Badge Settings page, you have to configure the settings for pages. All four pages are created and selected by default.

  • Assertion Page:

In this Page, the system will store the assertion of JSON data. The open badge needs assertion data in JSON format for validation purposes.

  • Issuer Page:

In the Issuer page, the system will store issuer JSON data. The open badge needs issuer data in JSON format for validation purposes.

  • Badge Page:

Badge page where badge JSON data will show up. The open badge needs badge data in JSON format for validation purposes.

  • Evidence Page:

Here, the user can verify the badge and share the badge on social communities. If you are using a custom evidence page, you have to add [badgeos_evidence] shortcode to the page.

Convert Non-open Standard Achievements:

Click the “Convert Achievements” button to convert existing non-open standard user’s achievements into open standards.  This button will only appear if you have non-open standard achievements awarded to the users. By clicking it, all these non-open standard achievements will be converted into open standards. 

If you convert your Credly based achievements into OB, that means that your learners will no longer need to login to Credly account to receive a verifiable badge.

Convert Credly Based Achievements to Open Badge Based Achievements:

Click “Convert Credly Achievements” button to convert all the existing Credly badges to the Open Badge achievements/badges

Check the option “Disable the Credly option too while configuring open badge” if you want to disable all the Credly options while converting them into Open Badges.

Now, there is a straight forward Setup Pages button or link below in Open Badge Settings to recreate OB pages with a single click if someone missed it for the first time.

Configure OB (Open Badge) Options in Bulk:

You can also configure the Open Badge options in bulk. To do so, you have to follow these steps:

  • Navigate to the achievement type, i.e Badges.
  • Check “title”. It will select all the created badges/achievements.
  • Select the “edit” option from the drop-down. Click “Apply”.
  • Enable the “Badge Baking?” option.
  • Enable “Evidence”.
  • Enter desired Expiration in days/months/years.
  • Click update.

Open Badge Verification:

The users can verify their earned badges. To verify the earned badges, you have to follow these steps:

  • Navigate to the user’s profile page.
  • Scroll down to the “Earned Achievements” section, all the earned achievements will be listed here.
  • Click at the “Evidence” link in front of the desired achievement.

  • It will redirect you to the achievement’s evidence page.
  • Click at the “Verify” button.

  • A pop-up will appear, that will show you all the verification data.

Download Open Badge:

In this release the users cannot download achievements from their profile (we’re planning to release this feature in the next versions of the plugin). However, as an admin, you can find this link in your WordPress Admin Panel. Here are the instructions.

  • Navigate to the user’s profile page.
  • Scroll down to the “Earned Achievements” section, all the earned achievements will be listed here.
  • Click at the “Download” link in front of the desired achievement.

You will receive a .png picture and anyone can verify the badge by uploading it to any OB verification site such as https://openbadgesvalidator.imsglobal.org/

Widget

BadgeOS User Earned Achievement Widget can be included in any widget area. To do so, follow these steps:

  • Navigate to Appearance from WP Dashboard. 
  • Select Widget.
  • Search BadgeOS User Earned Achievement Widget.
  • Drag or drop BadgeOS User Earned Achievement to the desired sidebar.
  • Enter Title.
  • Enter Number to display (i.e 10, mean only recent 10 earned achievements will be shown at the selected sidebar). Enter 0 for displaying all earned achievements.
  • Check Rank Types for Display only the following User Rank Types option to display the selected  Rank Types in the sidebar. 
  • Select Point Type for Select Point Type option. Total points of selected point type will be displayed on the front-end.
  • Check Achievement Types for Display only the following User Achievement Types option to display the selected  Achievement Types in the sidebar. 
  • Click Save.

Frontend:

Shortcodes:

Check the shortcodes from Dashboard > BadgeOS > Help / Support.

Also, you can add the BadgeOS shortcodes into the pages and posts by clicking on the Add BadgeOS Shortcode button on the editor.

All Available Shortcodes:

Achievement List – [badgeos_achievements_list]

Output a list of achievements.

  • Attributes:
  • type – Single, or comma-separated list of, achievement type(s) to display. Accepts: all, badges Default: all
  • limit – Number of achievements to display. Default: 10
  • show_filter – Display filter controls. Accepts: True, False Default: true
  • show_search – Display a search input. Accepts: True, False Default: true
  • orderby – Parameter to use for sorting. Accepts: Menu Order, Achievement ID, Achievement Title, Published Date, Last Modified Date, Achievement Author, Random Default: menu_order
  • order – Sort order. Accepts: Ascending, Descending Default: ASC
  • user_id – Show only achievements earned by a specific user.
  • include – Comma-separated list of specific achievement IDs to include.
  • exclude – Comma-separated list of specific achievement IDs to exclude.
  • wpms – Show achievements from all network sites. Accepts: True, False Default: false

Example: [badgeos_achievements_list limit="10" show_filter="true" show_search="true" orderby="menu_order" order="ASC" wpms="false"]


Single Achievement – [badgeos_achievement]

Render a single achievement.

  • Attributes:
  • id – The ID of the achievement to render.

Example: [badgeos_achievement id=""]


Nomination Form – [badgeos_nomination]

Render a nomination form for a specific achievement.

  • Attributes:
  • achievement_id – Achievement ID to award.

Example: [badgeos_nomination achievement_id=""]


Nominations List – [badgeos_nominations]

Display a filterable list of nominations.

  • Attributes:
  • limit – Number of nominations to display. Default: 10
  • status – Nomination statuses to display. Accepts: All, Approved, Denied, Pending Default: all
  • show_filter – Display filter controls. Accepts: True, False Default: true
  • show_search – Display a search input. Accepts: True, False Default: true

Example: [badgeos_nominations limit="10" status="all" show_filter="true" show_search="true"]


Submission Form – [badgeos_submission]

Render a submission form.

  • Attributes:
  • achievement_id – Achievement ID to award.

Example: [badgeos_submission achievement_id=""]


Submissions List – [badgeos_submissions]

Display a filterable list of submissions

  • Attributes:
  • limit – Number of submissions to display. Default: 10
  • status – Display only submissions of this status. Accepts: All, Approved, Denied, Pending Default: all
  • show_filter – Display filter controls. Accepts: True, False Default: true
  • show_search – Display a search input. Accepts: True, False Default: true
  • show_attachments – Display submission attachments. Accepts: True, False Default: true
  • show_comments – Display submission comments. Accepts: True, False Default: true

Example: [badgeos_submissions limit="10" status="all" show_filter="true" show_search="true" show_attachments="true" show_comments="true"]


Credly Assertion Page – [credly_assertion_page]

Adds support for Credly’s “Custom Assertion Location” feature, available to Credly Pro members only. After placing this shortcode on a page, copy that page’s URL and append “?CID={id}” to the end (e.g. https://badgeos.org/assertion/?CID={id}). Paste this full URL in the “Custom Assertion Location” field in your Credly Account Settings. All of your Credly badges will be linked back to this site where the official badge information is displayed automatically.

  • Attributes:
  • width – Content width. Default: 560
  • height – Content height. Default: 1000
  • CID – Optional Credly Badge ID to display instead of dynamically passed ID.

Example: [credly_assertion_page width="560" height="1000" CID=""]

All BadgeOS Blocks

Single Achievement – Block

The Single Achievement – Block displays a single achievement.

To add Single Achievement – Block on any post/page, please follow these steps:

  • Navigate to the desired post/page.
  • Click at the “Add Block” icon (+).
  • Scroll down to the “BadgeOS Block” or search “BadgeOS.”
  • Expand the section.
  • Select the Single Achievement – Block.

  • Set up the Single Achievement – block from the right sidebar.

  • Publish/Update.

Achievement List – Block

The Achievement List – Block displays a list of all achievements.

To add Achievement List – Block on any post/page, please follow these steps:

  • Navigate to the desired post/page.
  • Click at the “Add Block” icon (+).
  • Scroll down to the “BadgeOS Block” or search “BadgeOS.”
  • Expand the section.
  • Select the “Achievement List – Block.”

  • Set up the Achievement List – Block from the right sidebar.

  • Publish/Update.

User Earned Achievements – Block

The User Earned Achievements – Block displays a list of all earned achievements of a user.

There will be a link on all listed earned achievements, If the badge/achievement is an open badge it will be redirected to the evidence page and If the badge/achievement is a normal badge it will be redirected to the badge detail page.

To add User Earned Achievements – Block on any post/page, please follow these steps:

  • Navigate to the desired post/page.
  • Click at the “Add Block” icon (+).
  • Scroll down to the “BadgeOS Block” or search “BadgeOS.”
  • Expand the section.
  • Select the “User Earned Achievements – Block.”

  • Set up the User Earned Achievements – Block from the right sidebar.

  • Publish/Update.

User Earned Points – Block

The User Points Achievements – Block displays a list/grid of all earned points of a user.

To add User Earned Points – Block on any post/page, please follow these steps:

  • Navigate to the desired post/page.
  • Click at the “Add Block” icon (+).
  • Scroll down to the “BadgeOS Block” or search “BadgeOS.”
  • Expand the section.
  • Select the “User Earned Points – Block.”

  • Set up the User Earned Points – Block from the right sidebar.

  • Publish/Update.

User Earned Ranks – Block

The User Ranks Achievements – Block displays a list/grid of all earned ranks of a user.

To add User Earned Ranks – Block on any post/page, please follow these steps:

  • Navigate to the desired post/page.
  • Click at the “Add Block” icon (+).
  • Scroll down to the “BadgeOS Block” or search “BadgeOS.”
  • Expand the section.
  • Select the “User Earned Ranks – Block.”

  • Set up the User Earned Ranks – Block from the right sidebar.

  • Publish/Update.

Single Rank – Block

The Single Achievement – Block displays a single achievement.

To add Single Achievement – Block on any post/page, please follow these steps:

  • Navigate to the desired post/page.
  • Click at the “Add Block” icon (+).
  • Scroll down to the “BadgeOS Block” or search “BadgeOS.”
  • Expand the section.
  • Select the Single Rank – Block.

  • Set up the Single Rank – block from the right sidebar.

  • Publish/Update.

Ranks List – Block

The Ranks List – Block displays a list of all achievements.

To add Ranks List – Block on any post/page, please follow these steps:

  • Navigate to the desired post/page.
  • Click at the “Add Block” icon (+).
  • Scroll down to the “BadgeOS Block” or search “BadgeOS.”
  • Expand the section.
  • Select the “Ranks List – Block.”

  • Set up the Ranks List – Block from the right sidebar.

  • Publish/Update.

Evidence – Block

Evidence – Block displays the evidence page for any User’s badge.

To add Evidence – Block on any post/page, please follow these steps:

  • Navigate to the desired post/page.
  • Click at the “Add Block” icon (+).
  • Scroll down to the “BadgeOS Block” or search “BadgeOS.”
  • Expand the section.
  • Select “Evidence – Block.”

  • Set up the Evidence – Block from the right sidebar.
  • Achievement – Lets you specify the achievement
  • User – Lets you specify the User
  • Award ID – Lets you specify the particular awarded badge if it’s earned more than one time 

  • Publish/Update.

Frontend:

Credly Assertion Page – Block

The Credly Assertion Page – Block creates a Credly assertion page.

To add Credly Assertion Page – Block on any post/page, please follow these steps:

  • Navigate to the desired post/page.
  • Click at the “Add Block” icon (+).
  • Scroll down to the “BadgeOS Block” or search “BadgeOS.”
  • Expand the section.
  • Select the “Credly Assertion Page – Block.”

  • Set up the Credly Assertion Page – Block from the right sidebar.

  • Publish/Update.

Earned Points/Achievements/Ranks List/Grid View

The user can view his/her earned points/achievements/ranks in both list and grid view.

Note:

If you created a badge and then decided to delete it, your students will still see it in their profiles. You will need to remove the badges from their profile as an admin from the back-end for those badges to stop appearing.

Manually Award or Revoke Achievements:

Administrators that meet the minimum role to administer BadgeOS can award or revoke any achievement or step from the user edit profile.

Simply, scroll to the Award an Achievement section on the user’s profile and select the Achievement Type to Award.

On the action column, you will see two actions Award Achievement or Revoke Achievement.

Award Achievement: By clicking this action the achievement will be awarded to the user.

Revoke Achievement: Just visible if the user already has earned this achievement, by clicking this action the achievement will be revoked to the user.

Manually Award or Revoke Ranks:

Administrators that meet the minimum role to administer BadgeOS can award or revoke any rank from the user edit profile.

Simply, scroll to the Award Ranks section on the user’s profile and click Display Ranks to Award.

On the action column, you will see two actions Award Rank or Revoke Rank.

Award Rank: By clicking this action the achievement will be awarded to the user.

Revoke Rank: Just visible if the user already has earned this achievement, by clicking this action the achievement will be revoked to the user.