Note:

If you want to create a new page for developers, you should create it on the Moodle Developer Resource site.

OpenBadges User Documentation: Difference between revisions

From MoodleDocs
No edit summary
No edit summary
Line 46: Line 46:
===Earning badges===
===Earning badges===


Normally, badges are awarded to users automatically based on their actions in the system. Based on such events as completion of a course or activity, updating user profile, etc., criteria completions of a badge are calculated. If a user completed all necessary requirements, they are issued a badge.
Normally, badges are awarded to users automatically based on their actions in the system. Completion criteria of an active badge are re-calculated every time an event such as completion of a course or activity, or updating user profile happens. If a user completed all necessary requirements, they are issued a badge and sent an email notification.


Badges that have manual award among their criteria can be issued by one user to another. Users who issue a badge have to have "moodle/badges:awardbadge" capability. Site administrators can choose their role when issuing a badge.
[[File:11_email.png||border]]
 
Badges that have manual award among their criteria can be issued by one user to another. Users who issue a badge must have "moodle/badges:awardbadge" capability. Site administrators can choose their role when issuing a badge.


[[File:10_award.png]]
[[File:10_award.png]]


===Displaying badges===
===Displaying badges===
Newly earned badges are added to a private user badge collection which can be managed on "My badges" page from "My profile" options menu. On "My badges" page users can view all earned badges and their details, download these badges, manage their visibility on user profile, and perform search through the badges.
If external backpack connections are enabled on the web site, there will also be option related to external badges management.
[[File:13_mybadges.png]]
All badges earned by a user can be displayed on their profile page.
[[File:12_profile.png]]


===Connecting external backpack===
===Connecting external backpack===

Revision as of 01:14, 11 February 2013

Note: This page is a work-in-progress. Feedback and suggested improvements are welcome. Please join the discussion on moodle.org or use the page comments.


Background

This document describes how to use openbadges feature developed by TotaraLMS.

If you would like to give us any feedback, please use this openbadges forum, or email to Yuliya Bozhko.

Using Open Badges Feature

To begin with, there are two categories of badges:

  • Site badges - available to users site-wide and related to the site related activities, like finishing a set of courses.
  • Course badges - available to users enrolled in the course and related to the activities that happen inside of this course.

There are not many differences between these badge types. Depending on a badge type, it is decided what kind of criteria can be attached to a badge and where they can be found in navigation menu.

Badges administration

Site administrators and users with capability "moodle/badges:manageglobalsettings" can set up general settings for badges such as default issuer name, url, contacts, and enable course badges or external backpack connections.

0 settings.png

Creating badges

Badges can be created by users with capability "moodle/badges:createbadge". By default, this capability is set for manager, course creator, and editing teacher roles.

1 newbadge.png

After a badge has been created, users can check its details on overview page.

2 created.png

Managing badges

On "Manage badges" page in course or site administration, all existing badges are displayed in a table showing current badge image, status, criteria, how many users have already earned this badge, and a set of available actions.

8 management.png

Depending on user role and permissions, the following actions are available in badge management:

9 actions.png

Note: Activate and deactivate actions depend on the current status of a badge (e.g. if a badge is active, users will see deactivate action icon).

Earning badges

Normally, badges are awarded to users automatically based on their actions in the system. Completion criteria of an active badge are re-calculated every time an event such as completion of a course or activity, or updating user profile happens. If a user completed all necessary requirements, they are issued a badge and sent an email notification.

11 email.png

Badges that have manual award among their criteria can be issued by one user to another. Users who issue a badge must have "moodle/badges:awardbadge" capability. Site administrators can choose their role when issuing a badge.

10 award.png

Displaying badges

Newly earned badges are added to a private user badge collection which can be managed on "My badges" page from "My profile" options menu. On "My badges" page users can view all earned badges and their details, download these badges, manage their visibility on user profile, and perform search through the badges.

If external backpack connections are enabled on the web site, there will also be option related to external badges management.

13 mybadges.png

All badges earned by a user can be displayed on their profile page.

12 profile.png

Connecting external backpack

"My Badges" block

"My badges" block displays all badges earned by a user.