/
LMS - Moodle

LMS - Moodle

Table of Contents


1. Overview

Ready Education supports Moodle 2.7+, and integrates with Moodlerooms. Moodle comes with a built-in web service designed for mobile application integration. The service uses an XML-RPC interface to retrieve Announcements, Assignments, Discussions, and Grades for a student. Ready Education courses integration requires Moodle Plugin.

Note: The minimum required version of Moodle for POST/Reply to discussion is 3.0.

2. Moodle Integration Requirements

Step 1: Create Service Account & Install Moodle Plugin

  1. Enable Web Services Status: Yes

  2. Enable Protocols Status: xmlrpc, rest, soap3.

  3. Create a specific web services user dublabs_webservices.

  4. Check user capability: The user should have appropriate capabilities according to the protocols used, for example webservice/rest:use, webservice/soap:use. To achieve this, create a web services role with protocol capabilities allowed, and assign it to the dublabs_webservices user as a system role.

  5. Install our Moodle Plugin in both your TEST and PROD instances. The latest Moodle plugin can be downloaded HERE.     

    1. Copy /local/wsstudentgrade in /local location

    2. Login with System admin in Moodle

    3. System automatically prompt you to install new web-service

  6. Enable web service advance feature (Admin > Advanced features)

  7. Enable REST protocol (Admin > Plugins > Web services > Manage protocols)

  8. Add permission "moodle/webservice:createtoken" to the "Authenticated_User" role. Go to site administration -->user --> define roles --> edit authenticated user --> show advanced settings. Look for the "moodle/webservice:createtoken" option and allow the user to create tokens.

 

Step 2: Create Test User

Provide a test user account that can pass authentication, and has overlapping course data in both your SIS and LMS. Click here to view more information about our test user requirements: Test User and Test Data Requirements.

3. Provide the following information to your Technical Consultant

Provide the following information to your Technical Consultant by emailing integrations@readyeducation.com to create a ticket.

1. Test Environment

Confirmation that the Moodle Plugin was installed on your Test/Dev Moodle instance.
Your TEST Moodle URL e.g. https://readyeducation-test.moodle.com

2. Prod Environment

Confirmation that the Building Block was installed on Prod Moodle instance.
Your PROD Moodle URL e.g. https://readyeducation.moodle.com

3. Test User

  • Send login credentials for Test User with courses data and ability to pass SSO (you can use https://privnote.com/ to send the credentials securely).

  • [ ] Confirmation of which environment the test user is setup in (TEST and/or PROD).

  • [ ] Confirmation of which courses the student is enrolled in and what course data has been added.