LMS Integration: Moodle/OpenLMS Plugin Installation Guide

Overview

This article includes steps for an LMS Administrator to enable the Aviso Moodle Plugin in their hosted environment for LMS integration with SS&E in new SS&E implementations.

  • The following instructions will enable all LMS Data Synchronization with SS&E, including the assignment data sync.
  • For instructions on how to upgrade the Moodle Plugin on an existing LMS-SS&E integration, see How to Upgrade the Moodle Plugin.

Moodle Versions: 3.x, 4.x

OpenLMS 

In some cases it may be necessary to contact OpenLMS Support. For OpenLMS, please contact OpenLMS Support and ask them to install the SS&E Aviso plugin. The SS&E / Aviso user created above should then be given access to the plugin.

Installation

  1. Enable Web Services
    1. Navigate to Site administration -> General -> Advanced Features
    2. Check "Enable web services" then click "Save Changes".
  2. Enable Rest format for Web Services
    1. Navigate to Site administration -> Server -> Web services, Manage protocols
    2. Check Enable for "REST protocol" then click "Save Changes".
  3. Install the Plugin
    1. Download the aviso.zip Plugin file from the bottom of this article.
    2. Navigate to Site administration -> Plugins -> Plugins, Install plugins
    3. 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.
    4. Navigate to Administration / Site administration / Notifications to Apply Database updates.
  4. Create the Aviso User
    1. Navigate to 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@watermarkinsights.com".
    6. Click Create User button.
  5. Create the Aviso Role
    1. Download the avisorole.xml file.
    2. Navigate to 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 Aviso Role to the 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 Aviso External Service
    1. Navigate to Site administration -> Server -> Web services, External services
    2. For the Aviso external service, click Functions.
    3. Verify that the "Aviso" External Service has the following functions:
      1. local_aviso_assignments_by_moodle_id
      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
      6. local_aviso_user_detail
      7. local_aviso_assignments_and_grades_by_moodle_id
    4. Add the Aviso System User as an Authorized user to the "Aviso" external service.
  8. Contact your Watermark Project Manager and Technical Consultant to let them know that all the above is complete, and share token for API access (Please send securely, not via email, ticket, Kantata, etc.) and they will test Moodle connectivity.

Technical Notes

Moodle Web Services Documentation: https://docs.moodle.org/402/en/Using_web_services

Moodle Updates & Upgrades

When using self-created roles in a Moodle system, upgrades and updates don't usually include them, so they can become corrupted. After upgrading or updating to a new version of Moodle, be sure to verify the settings and permissions above.

Was this article helpful?
0 out of 0 found this helpful

Articles in this section

How to Contact Support
There are many ways to reach out! Click here for our support options.
Watermark Academy
Click to access the Watermark Academy for consultation, training, and implementation companion courses.