Skip to main content
ExLibris
  • Subscribe by RSS
  • Ex Libris Knowledge Center

    Moodle

    Product Information

    Category

    Learning Management System (LMS)

    Virtual Learning Environment (VLE)

    Sub-category  
    Website https://moodle.org/
    Product version 2.7 – 3.3
    Documentation https://docs.moodle.org/33/en/Main_page
    API Documentation
    • Connect as admin
    • Go to Administration Settings block > Plugins > Web services > API documentation

    About Moodle

    Moodle is a learning platform designed to provide educators, administrators and learners with a single robust, secure and integrated system to create personalized learning environments. You can download the software onto your own web server or ask one of our knowledgeable Moodle Partners to assist you.
    Moodle is built by the Moodle project which is led and coordinated by Moodle HQ, which is financially supported by a network of over 80 Moodle Partner service companies worldwide.

    Integration Overview

    The campusM integration with Moodle has three different options available. Institutions can choose to integrate in one the following methods:
    • Live tile to display up to date information on the campusM homescreen
    • Static tile to link the user directly to Moodle
    • In-app integration that uses a Moodle plugin to display content within the campusM app

    In addition, a notifications plugin can be utilized to send users push messages through campusM. Notifications can be used with any of the three options.

    Live Tile

    The Live tile is a dashboard of the most important and dynamic information from Moodle that is displayed on the home screen of campusM. A configurable list of icons is displayed in a concise, easy to ready and up to date format. Icons available for display include:
    • Assignments
    • Forum posts
    • Events
    • Grades
    • Messages
    Selecting a live tile icon will link the user to the appropriate section in Moodle. For example, if the tile shows new events, tapping on this area will open the Moodle calendar. If the tile shows an assignment is due, tapping will open that assignment in Moodle.
    Tapping a Live Tile Icon will link directly to Moodle. Mobile users will be directed to the Moodle mobile app. If the app has not been installed on the user’s device, it will launch the App or Play Store at the appropriate page to install it. Portal users will link to the Moodle website .

    Static Tile (Direct link to the Moodle App)

    This option provides for a static Moodle tile within campusM that will link directly to Moodle mobile. It connects users to the web version of Moodle which allows them to interact with all activity types. Mobile users will be directed to the Moodle mobile app. If the app has not been installed on the user’s device, it will launch the App or Play Store at the appropriate page to install it. Portal users will link to the Moodle website.

    In-App Integration

    This integration creates a mobile front end to Moodle. The user remains in the campusM app and does not have to link out to Moodle mobile to access certain functionality. It allows the student to view all enrolled courses and resources, view and post to forums, view and answer choice activities and view page, book and assignment activities within the app. In addition, users can link out to the web version of Moodle which allows them to interact with all other activity types.
    All resources, pages and books can be downloaded to the device for use offline.

    Notifications (Send Moodle messages as Push Notifications)

    This integration allows students to receive push notifications to their device from Moodle messages. This is most often used for notification of updates to and feedback from assignments, and replies to forum posts. However, any type of Moodle message can be delivered as a push notification if the student chooses. Alerts from forums and assignments contain a link to the forum or assignment. This links to the activity in the Moodle mobile app or the Moodle website as appropriate.

    Integration Method

    • Live Tile & Direct Link – Moodle REST API
    • In-app integration – Moodle REST API

    Prerequisites

    There are several prerequisites to the campusM integration with Moodle.

    Live Tile and/or In-App Integration

    Prerequisite Additional Information
    Moodle version 3.1 or higher  
    Provide a minimum of three (3) Test accounts containing  comprehensive and typical data from various faculties, groups or departments, including the following:
    • Courses
    • Assignments (Moodle)
    • Grades
    • Messages
    • Forums
    • Calendar
    • Choice
    • Page
    • Book
    • Resources (Files)
    The test accounts should allow testing the integration according to the Suggested Testing Guidelines. i.e. should support authentication / log into the app as the test account been provided and run complete end-to-end testing of the integration functionality.
    Provide Moodle base URL
    • Test URL (using the same authentication method as the live URL)
    • Live URL

    Moodle URLs must be publicly accessible

    To ensure increased security, only HTTPS is supported.

    If:
    • Moodle version less than 3.2

    or

    • Protected by a single sign on (SSO) system
    1. Provide Ex Libris your IdP domain name
    2. Install the Moodle plugin: https://moodle.org/plugins/local_mobile 
    Screenshot - 1.png

    Enable the REST protocol

    • Go to the web services overview page (Site administration > Plugins > Web services > Overview)
    • Follow the ‘Enable protocols’ link
    • Enable REST protocol
    Screenshot - 2.png
    Ensure Moodle is configured to work with Moodle mobile Screenshot - 3.png
    The 'Type of Login' field should be selected as 'Via an embedded browser (for SSO plugins).  clipboard_e9f7d7b1ea8941f071b1090eaad1437b3.png

    Notifications

    Prerequisite Additional Information

    Install the message outputs plugin: Go to Site administration > Plugins > Message outputs

    Screenshot - 4.png

    Enter the following:

    Screenshot - 5.png
    • Organization Code: Navigate to  the campusM App Manager "App Manager -> App Settings -> Security Settings". The Organization code is the last number in the URL.
    • Organization Password: The Organization password can be found on the same page in the second textbox called “Service password”.
    Screenshot - 6.png
    • AEK Menu ID: Navigate to: App Manager -> AEK -> AEK Menu Options -> e-Learning (Add AEK menu option if e-Learning is not listed).
    • The AEK Menu ID can be found in the “Component type” text box
    Screenshot - 7.png
    • AEK Service ID: Navigate to: App Manager -> App Settings -> Customer Web Services -> Authentication Access -> Username/Password.
    • The AEK Service ID is the last number in the URL.
    Screenshot - 8.png

    User Experience

    The Moodle integration offers two types of tiles (live or static) available for the institution to choose from based on their preference and overall branding and UX guidelines.
    Property Live Tile Static Tile
    Default Size 2x3 1x1
    Minimum Size 2x3 1x1
    Suggested Design Moodle.JPG Static Tile.png

    Screenshots

    Live Tile

    clipboard_ebfc2e1a5c086b074f78042d947e8d53f.png   Live Tile - Screenshot - 2.png

    In-App Integration

    In-App - Screenshot - 1.png   In-App - Screenshot - 2.png   In-App - Screenshot - 3.png   In-App - Screenshot - 4.png

    Offline Functionality

    Supported only for the in-app integration; All resources, pages and books can be downloaded to the device for use offline.

    Configuration Options

    The following elements are available for configuration as part of the campusM-Moodle integration.
    Configuration Item Options
    Display Icons Allow institutions to choose which icons are displayed. Each option can be either shown or hidden:
    • Assignments
    • Forum posts
    • Events
    • Grades
    • Messages
    Hide Options (by default visible)
    • Grades
    • Summaries
    Display Grade Allow institution to show the Grades icon but not the actual grades.
    Detail View
    Allow institutions to show live tile information in a summary view or a per course detail view.
    Summary View:
    The summary view will aggregate data for all courses and display information associated with each icon.
    Tapping this tile will open a screen with a summary of each course. This summary can be shown as a campusM live tile screen with a full list of courses, or can link directly to the in-app integration or the Moodle mobile app/website.
    Detail View:
    The detail view will display a group of icons for each course the student is enrolled in up to four courses.
    Tapping an icon on this tile will link directly to the in-app integration or the Moodle mobile app/website and open to the corresponding page.
    *If the student is enrolled in more than four courses, the display will default to a summary view.
    Button Link Behavior (Course) Turn On View courses via Moodle Website (Button link)
    Link Behavior Open links within campusM or externally via another browser app

    Labels

    Label Default Value
    Tile name on home screen

    Moodle (static tile) 

    Moodle (Live tile- summary) 

    Moodle Courses (Live tile – detail)

    Tile screen title Moodle Live tile (Summary View - campusM live tile with full list of courses)
    Log in message Please login to Moodle
    Icon Name
    • Activities Completed
    • Announcements
    • Assignments
    • Course(s)
    • Events
    • Forum posts
    • Grade
    • Messages
    • Next Activity Due
    • No Upcoming Activities

    Suggested Testing Guidelines

    The following acceptance criteria is recommend to be used as part of the testing and approval process:
    Live tile:
    • Icons are displayed or hidden according to configuration selection
    • Icons update to show new information
    • Summary view – Information is aggregated into the appropriate icon and displayed as the correct numerical value (ex: announcements for all courses are counted)
    • Summary view – Tapping the tile opens the campusM live tile screen with a full list of courses, or links directly to the Moodle mobile app/website
    • Tapping an icon opens Moodle to the corresponding page in the Moodle mobile app/website
    Static tile:
    • Tapping the Moodle tile links the user to the Moodle mobile app, the app store, the play store or the Moodle website as appropriate
    • Was this article helpful?