Documentation:WordPress/Plugins/BadgeOS

From UBC Wiki
Jump to: navigation, search

Overview

BadgeOS is a plugin that enables badging feature to your CMS (Wordpress) website. There are several steps needed to integrate badging into your website. The process is as follows:

  • Step 1: Access BadgeOS and additional Plugins
  • Step 2: Set-up Login Links
  • Step 3: Creating Badges
  • Step 4: Develop Badge Issuing Triggers
  • Step 5: Integrate with Credly (Note: This step is only require if you want badge earners to share their badges through social networks)

Step 1: Access BadgeOS and Additional Plugins

In order to add badge functionality to the site, you will need to activate BadgeOs Plugin. The plugins are currently only available to Open Badges UBC pilot projects. If you are interested in being a part of the pilot, submit your request through the "Apply to the Pilot" form.

If you have obtained permission to use the BadgeOS Plugins through the Open Badges UBC project, follow these instructions:

  1. Go to support.cms.ubc.ca
  2. Click on 'Submit Questions'
  3. Select your Unit
  4. Fill in the form. Beside Title, type Request for activation of the plugin
  5. Beside Your Question, indicate that you want to activate the BadgeOs Plugin.

Adding additional functionality (Optional)

There are multiple Add-on Plugins available to enhance the badge functionality on your site. Such as:

  • LearnDash LMS and BadgeOS LearnDash Add-On: You may want to activate this plugin if you want to add quizzes to your website, and reward users with badges once they complete the quiz.
  • BadgeOS Notifications Add-On : Activate this plugin if you want notification to pop up when a user earn a badge. It helps users to be aware of the badge that they earn.
  • BadgeOS Triggers Add-On : If you want to add custom AND/OR step logic and the ability to restrict badges to certain roles, activate this plugin.

Step 2: Set-up Login Links

In order for participants to earn a badge, they will need to be logged in to UBC CMS or UBC Blogs first. The most convenient way is to add a login link to your CMS site:

  1. Create your login URL. Your login URL for your website will be:https://cas.id.ubc.ca/ubc-cas/login?service=https%3A%2F%2Fsites.olt.ubc.ca%2Fwp-login.php%3Fredirect_to%3Dhttp%3A%2F%2FYour Site URL%2F?badgelogin=1. For example, if your website is dt1.sites.olt.ubc.ca, your login URL will be: https://cas.id.ubc.ca/ubc-cas/login?service=https%3A%2F%2Fsites.olt.ubc.ca%2Fwp-login.php%3Fredirect_to%3Dhttp%3A%2F%2Fds1.sites.olt.ubc.ca%2F?badgelogin=1. You can find your website's URL form Dashboard.
    You can find out the URL of your website from Dashbaord.
  2. Add this link to a page or a post or a widget. When a badge earner click on this link, they will be able to start earning badges

Step 3: Creating Badges

  1. Go to Dashboard> Badge OS > Badges
  2. Click on Add New
  3. You are now able to create a badge. Enter title to add a name to your badge. For example, "Contributor"
  4. Use the visual editor to add the description of the badge. For example "Earn a contributor badge by submitting 2 comments on any of the blog post"
  5. On the right side menu, under Achievement Image, click on set achievement image to add an image to your badge. On best practices on how to create a badge image, see Badge Icon Design.
  6. Under Achievement Data, set a congratulation text. For example "Congratulations! You have earned contributor badge!!"

Step 4: Set a trigger(or steps) for Badges

Trigger is an essential component for badges. Trigger allows you to set the condition for badges. There are many options for triggers:

Step 5: Credly Integration

If you want your badges to be portable to social network sites, you will need to set-up a Credly account.

  1. In order to integrate Badge OS with Credly, you will need to create an account in Credly, follow the instruction below to [Create a Credly account. If you already have an account in Credly, skip to next step.
  2. Go to your CMS site
  3. Go to Dashboard>BadgeOS>Credly Integration
  4. Select yes for Enable Badge Sharing via Credly.
  5. Under Get Credly API Key, enter your username and password of your Credly Account.
  6. Click on Save Setting.
  7. A section called Credly Field Mapping will appear. This option allows you to control the type of information you want to send it out to Credly. You can set it to default.
  8. Click on Save Settings
  9. Go back to Dashboard> Badge OS > Badges to edit your badge. Under Badge Sharing Option, select Yes for Send to Credly when earned option.

Video Resources

You can also watch the video tutorial to help you with setting up Credly Integration.


FAQ

See the FAQ page to solve common questions in BadgeOS and LearnDash.