Moodle
Overview
The Moodle product integration allows students, lecturers, and other users to view their Moodle information, including course content and grades, on the campusM app.
Due to Moodle authentication flow, Moodle product integration is currently supported only for native application and not for the web application. However, it is possible to configure a link to your institution's Moodle Website when using the web application. For more information, see Moodle Web in the Configuration section.
User Experience
The following section describes information relating to the user experience for the Moodle product integration.
User Workflow Diagram
The following diagram displays the user workflow:
User Workflow Diagram
Authentications
See the user Workflow Diagram for a description of the authentications process.
Offline Support
Users can view cached data from previous sessions.
Moodle Live Tile
The Moodle produce integration offers two types of tiles that can appear in the homepage: live and static. The live live tile displays active information relating to your courses while the static tile has fixed information. For information on configuring the Moodle live tile, see Live Tile in the Configuration section.
The recommended size of the live tile is 2X3.
It is possible to use the live tile either with full product integration (OTB behavior) or with a linkout to an external website, app or any other tile. For more information, see Configuring Live Tile Linking.
Screenshots
The following is an overview of the Moodle product integration user interface for a reference when configuring it.
| The following is an example of the Moodle Live Tile that appears on your campusM homepage | A summary of the course | Resources for the course |
 |
 |
 |
| Assignment Status | Help with Assignment | Forum |
 |
 \ |
 |
| Grades | Options | Email Inbox |
 |
 |
 |
Technical Overview
The following section describes technical information for the Moodle product integration.
Supported Versions
Moodle 3.7 and later
Prerequisites
- Moodle URL must be publicly available and open to all.
- implement the following procedure in Moodle configuration to use the Moodle product integration:
- Enable the REST protocol:
- Go to the Web services overview page (Site administration > Plugins > Web services > Overview).
- Select the Enable protocols link.
- Enable the REST protocol.
- Confirm that Moodle is configured to work with Moodle mobile:
- For the Type of Login field, select Via an embedded browser (for SSO plugins).
Technical Flow Diagram
The following is the technical flow diagram for the Moodle product integration:
Technical Flow Diagram
To configure the Moodle product integration, select Add Product Integration from the Product Integrations main menu option.
Configuration
To configure the Moodle product integration, select Add Product Integration from the Product Integrations main menu option.
Select Moodle and the following configuration page appears:
Configuring Moodle
The following table describes the configuration options available on this page.
| Configuration Option | Description | Mandatory | Data Type | Default | Example |
|---|---|---|---|---|---|
| Enable Product Integration | Select to enable the product integration on the user's campusM app. | No | Check box | Yes | |
| Product Integration Description | A description of the product integration for internal use | Yes | Description | - | |
| Screen Title | The title that appears in the top header of the service | No | String | Moodle | |
| General | |||||
| Default Locale | Enter a default location | No | String | en-gb | |
| Time Format | Enter the time format to be used in the service. | No | Drop-down List | LT | |
| Date Format (short) | Enter the short date format to be used in the service. | No | Drop-down List | ll | |
| Date Format (long) | Enter the long date format to be used in the service. | No | Drop-down List | LL | |
| DateTime Format (short) | Enter the short date/time format to be used in the service. | NO | Drop-down List | llll | |
| DateTime Format (long) | Enter the long date/time format to be used in the service. | No | Drop-down List | LLLL | |
| Look and Feel | |||||
| Primary Theme Color | Select a color for the main elements on the page | No | Color Picker | #444444 | |
| Secondary Theme Color | Select a color for the secondary elements on the page | No | Color Picker | #6f8ea4 | |
| Moodle Server Config | |||||
| Base URL of Moodle Instance | The base URL of the Moodle instance | Yes | URL | https://campusmmoodledemo.co.uk | |
| Login Timeout | The number of minutes for the user login until timeout | No | Number | 2 | |
| Moodle Web | |||||
| Enable Moodle Web | Select to enable a link to Moodle from the campusM Web application. As currently Moodle product integration is supported for native devices and not for web, it is possible to use web with link-out to Moodle site. | No | Check box | No | |
| URL for link-out when using web | Your institution’s Moodle URL | No | URL | ||
| Text / Labels | |||||
| Error Message | The error message text | No | String | An error has occurred. Please try again later. | |
| Service Content | |||||
| Courses Page Title | The title at the top of the Courses page | No | Drop-down List | Courses | |
| Courses Navigation Menu Label | The label of the Courses navigation menu link | No | Drop-down List | Courses | |
| Enable Grades View | Select to enable grades view for end-users | No | Checkbox | Not checked | |
| Grades Page Title | The title at the top of the Grades page | No | String | Grades | |
| Grades Navigation Menu Label | The label of the Grades navigation menu link | No | String | Grades | |
| Courses Navigation Menu Label | The label of the Grades navigation menu link | No | String | Courses | |
| Enable Links View | Select to enable links view for end-users | No | Checkbox | Not checked | |
| Links Page Title | The title at the top of the Links page | No | String | Links | |
| Links Navigation Menu Label | The label of the links navigation menu link | No | String | ||
| Links List | Enter links to appear in the Links page | No | String | Link text: Moodle web app Link: https://campusmmoodledemo.co.uk |
|
| Add Item | Select to add links to the Links page | Button | |||
| Live Title | |||||
| Live Tile Enabled | Enable the Moodle live tile | No | Checkbox | ||
| Icon Bar Courses Enabled | Enable the Courses link in the icon bar | No | Checkbox | ||
| Icon Bar Courses Label | The Courses label in the icon bar | No | String | Courses | |
| Icon Bar Assignments Enabled | Enable the Assignments link in the icon bar | No | Checkbox | ||
| Icon Bar Assignments Label | The Assignments label in the icon bar | No | String | Assignments | |
| Icon Bar Events Enabled | Enable the Events link in the icon bar | No | Checkbox | ||
| Icon Bar Events Label | The Events label in the icon bar | No | String | Events | |
| How many Days | The number of days in the future for which to look for events | No | Number | 7 | |
| Messages Enabled | Enable the Messages link in the icon bar | No | Checkbox | ||
| Messages Label | The Messages label in the icon bar | No | String | Message | |
| Message Types | Indicate the message type: Conversations, Notifications, or both | No | Drop-down List | Both | |
| Label - "Next Activity" | The label of the link to move to the next activity | No | String | Next Activity | |
| Label - "No Activity Due" | The label of the message that no activity is due | No | String | No Activities Due | |
| Activities to Include | Select the activities to include | No | Checkbox | ||
| Caching - Max Age | The number of hours that cached content can be presented to the user | No | Number | 720 | |
| Caching Time to Live | The number of minutes that cached data will be used before a refetch is attempted | No | Number | 10 | |