LMS Integration: Moodle/OpenLMS Plugin Installation Guide

This document describes the steps for an LMS Administrator to enable the SS&E / Aviso Moodle Plugin in their hosted environment.

In some cases it may be necessary to contact Moodle Support.

NOTE: For OpenLMS, please contact OpenLMS support and ask them to install the SS&E Aviso plugin. The SS&E / Aviso user created below should then be given access to the plugin.

Version: Moodle 3.x

Installation

1. Enable Web Services
   1. Navigate to Administration / Site administration / Advanced features.
   2. Check "Enable web services" then click "Save Changes".
2. Enable Rest format for Web Services
   1. Navigate to Administration / Site Administration / Plugins / Web services / Manage Protocols.
   2. Check Enable for "REST protocol" then click "Save Changes".
3. Install the Plugin
   1. Navigate to Administration / Site administration / Advanced features / Plugins / Install plugins.
   2. If using Remote Learner
      1. Go to the Remote Learner Manager block.
      2. Click on the "Manage Add Ons" link.
      3. Remove the check mark from "Only Show Golden Add Ons".
      4. Type in "Aviso" in the search bar.  "Aviso Web Services" will appear.
   3. Navigate to Administration / Site administration / Notifications to Apply Database updates.
4. Create the SS&E / Aviso User
   1. Navigate to Administration / Site administration / Users / Accounts / Add a new user.
   2. Specify username as "Aviso System".
   3. Set Authentication method to "Manual accounts"
   4. Set Password to a random 50 character strong password.  Keep this password for later.
   5. Set first name to "Aviso", Surname to "System" and email address to "lms@avisoretention.com".
   6. Click Create User button.
5. Create the SS&E / Aviso Role
   1. Download the avisorole.xml file.
   2. Navigate to Administration / Site Administration / Users / Permissions / Define Roles.
   3. Click "Add a new role" button.
   4. Click "Choose a file..." button.
   5. Browse to provided avisorole.xml file and upload.
6. Assign the SS&E / Aviso Role to the SS&E / Aviso User
   1. Navigate to Administration / Site administration / Users / Permissions / Assign system roles.
   2. Click the "Aviso Role".
   3. Add the Aviso System user to the role.
7. Configure the External Service
   1. Navigate to Administration / Site administration / Plugins / Web services / External services.
   2. For the Aviso external service, click Functions.
   3. Verify the "Aviso" External Service has these 5 functions:
      1. core_grades_get_grades
      2. core_course_get_courses
      3. local_aviso_enrollments_by_moodle_id
      4. local_aviso_grades_by_moodle_id
      5. local_aviso_gradeColumns_by_moodle_id
   4. Add the Aviso user as an Authorized user to the "Aviso" external service.
8. Contact SS&E staff.
   1. Provide username, password. SS&E staff will login to your SS&E system account to obtain the security token for API access.
   2. Ask SS&E staff to test Moodle connectivity.

References

https://docs.moodle.org/29/en/Using_web_services