rrusso / block_acclaim

Acclaim Moodle plugin

Description

This is a Moodle Block Plugin used to issue Acclaim badges when a course is successfully completed.

Installation

To install this block plugin:

1. Clone this repository
2. Remove directory .git and .gitignore
3. Zip the repository directory block_acclaim and name acclaim.zip
4. Login to Moodle as Administrator
5. Navigate to: Site Administration > Plugins > Install Plugins
6. Under Plugin type, choose “Block”
7. Drag and drop acclaim.zip
8. Select “Install Plugin From Zip”
9. Next, select “Install plugin!” If all validations pass.
10. Choose “Upgrade Moodle database now”.
11. Press continue, when prompted to upgrade version.
12. Finally, enter the Acclaim URL, your Organization ID and Token
13. Lastly, choose “Save changes”.

Usage

Once the Block Plugin has been installed, you can attach a Badge to any of your Moodle Courses as follows.

1. Begin by logging in as Administrator, teacher, or course creator.
2. Turn on editing.
3. Next, select the course you wish to attach a badge to from Navigation > Current Course. You must be in a course view to add the Acclaim Block because it operates in that course context.
4. Add the Acclaim Block from “Add A Block” drop down.
5. Next, click “Select Badge” in the Acclaim Block to choose which Acclaim badge will be issued upon course completion.
6. Select a badge to be issued by selecting the “Acclaim Badges” drop down. This list is generated by connecting to the Acclaim platform using the credentials defined during installation.
7. Optionally select a badge expiration date by choosing the date, and checking “Enable”
8. Lastly, select “Save Changes”

Additional Settings

In addition to configuring the Acclaim plugin, you will also need to configure how a course is successfully completed.

1. First, navigate to Home > Navigation > My Courses > Select Course > Edit Settings
2. Enable completion tracking, and select save.
3. Finally, edit the Criteria that will trigger a course completion. This can be done by navigating to administration > course administration > select criteria. For example, course grade.

Note: If course completion tracking is missing from the course settings, enable completion tracking: Administration > Course administration > Edit Settings > Enable completion tracking.

Further documentation on course completion tracking can be found here: https://docs.moodle.org/23/en/Course_completion_settings

Unit Tests

This plugin includes unit tests to verify functionality.

1. Create env variable named token with value of a valid token on Acclaim.
2. vendor/bin/phpunit acclaim_lib_test my/tests/acclaim_test.php

To Do

1. The stage environent and org ID is hard coded in the unit tests. This should be changed to something like a env variable.
2. Allow a course to have a badge set to none (or delete).
3. Create language file so this plugin can be used on platforms other then english.

Update 20160314

1. Replaced entering API URL with dropdown with production and sandbox as choices
2. Get all active templates when more than 50 and sorted alphabetically