Difference between revisions of "Moodle app additional features"

Jump to: navigation, search
(Admin users, please read)
(Enable authentication for sites using SSO methods (like Shibboleth and CAS))
 
(16 intermediate revisions by 5 users not shown)
Line 9: Line 9:
  
 
The Moodle Mobile additional features plugin provides new features and web services for the Moodle Mobile app which are currently only available in the latest Moodle version.
 
The Moodle Mobile additional features plugin provides new features and web services for the Moodle Mobile app which are currently only available in the latest Moodle version.
 +
 +
This plugin is officially developed and maintained by Moodle HQ
  
 
== How it works ==
 
== How it works ==
  
 
Once installed the plugin creates a new service "Moodle Mobile additional features". The Mobile app checks if this service is enabled. If not, the Mobile app falls backs to the standard core Mobile app service.
 
Once installed the plugin creates a new service "Moodle Mobile additional features". The Mobile app checks if this service is enabled. If not, the Mobile app falls backs to the standard core Mobile app service.
 +
 +
Please, open [[Moodle Mobile features]] to check what new features are added to your site depending on your Moodle version.
  
 
== Features ==
 
== Features ==
  
* Support for sites using SSO authentication methods (Shibboleth and CAS)
+
* Support for Moodle sites prior to 3.2 using SSO authentication methods (Shibboleth, CAS and Google OAuth 2)
 
* Support for sites using MNet authentication (Moodle Network authentication)
 
* Support for sites using MNet authentication (Moodle Network authentication)
* Retrieval of course grades
 
 
* Support for push notifications in Moodle sites prior to version 2.6
 
* Support for push notifications in Moodle sites prior to version 2.6
  
 
=== Enable authentication for sites using SSO methods (like Shibboleth and CAS) ===
 
=== Enable authentication for sites using SSO methods (like Shibboleth and CAS) ===
  
VERY IMPORTANT NOTE: You need to disable the "Auto login guest" option "autologinguests". This setting is not compatible with the SSO via app.
+
VERY IMPORTANT NOTE: If SSO is not working for your (or it is failing randomly), you'd need to disable the "Auto login guest" option "autologinguests". This setting may not be compatible with the SSO via app in some sites (it should work fine in Moodle 3.2 onwards).
  
 
SSO and MNet authentication is not supported in the Windows 8 and Windows Phone 8 apps
 
SSO and MNet authentication is not supported in the Windows 8 and Windows Phone 8 apps
Line 32: Line 35:
 
; '''Via the app''' : Is the default login, the user must introduce his credentials in the app
 
; '''Via the app''' : Is the default login, the user must introduce his credentials in the app
 
; '''Via a browser window''' : A new browser instance is open in the mobile device pointing to the login form in the Moodle site (which may again redirect to external identity providers if required). The user must introduce his credentials there. This is the option that must be selected for sites using SSO methods (or for sites that wants to force the user to authenticate in the site, not in the app)
 
; '''Via a browser window''' : A new browser instance is open in the mobile device pointing to the login form in the Moodle site (which may again redirect to external identity providers if required). The user must introduce his credentials there. This is the option that must be selected for sites using SSO methods (or for sites that wants to force the user to authenticate in the site, not in the app)
 +
;'''Via an embedded browser''': The embedded browser shows the login form in the Moodle site (which may again redirect to external identity providers if required). The user must introduce his credentials there. An embedded browser provides a better user experience, though it doesn't work with all SSO plugins.
 +
{{MediaPlayer | url = https://www.youtube.com/watch?v=cl8rsyyyg9g | desc = Video showing Moodle Mobile SSO}}
 +
 +
When using the "Via a browser window" option, you can optionally specify an URL scheme to be used by the system to open the Mobile app. By default, the URL scheme used to open the app will be the one indicated by the own app during the SSO process. If you've developed a custom app using its own URL scheme and you want to allow only SSO logins via your app, you can indicate there an URL scheme. The site will detect that setting and will use it instead of the value indicated by the app.
  
 +
=== Configuring the app from your site ===
  
<mediaplayer>https://www.youtube.com/watch?v=cl8rsyyyg9g</mediaplayer>
+
* Disable app functionalities for your site. If there's a feature you don't want to make available via the app you can disable it here.
 +
* Rename app text strings.
 +
* Add new items in the app's main menu (the side menu).
 +
* Replace the Change site option with a "Log out" one to force the users to enter their credentials on their next access.
  
 
== Installation ==
 
== Installation ==
Line 40: Line 51:
 
# Unpack the zip file into the local/ directory. A new directory will be created called local/mobile.
 
# Unpack the zip file into the local/ directory. A new directory will be created called local/mobile.
 
# Go to ''Site administration > Notifications'' to complete the plugin installation.
 
# Go to ''Site administration > Notifications'' to complete the plugin installation.
# Go to ''Site administration > Plugins > Web services > Mobile'' and enable web services for mobile devices (Remember to save the changes)
+
# Go to ''Site administration > Mobile app > Mobile settings'' and enable web services for mobile devices (Remember to save the changes)
 
# Go to ''Site administration > Plugins > Web services > External services'', edit "Moodle Mobile additional features" and check the "Enabled" field, then save changes.
 
# Go to ''Site administration > Plugins > Web services > External services'', edit "Moodle Mobile additional features" and check the "Enabled" field, then save changes.
# Go to ''Site administration > Users > Permissions > Define roles'', edit the Authenticated user role and allow the capability moodle/webservice:createtoken.
+
# Go to ''Site administration > Users > Permissions > Define roles'', edit the Authenticated user role and allow the capability [[Capabilities/moodle/webservice:createmobiletoken|moodle/webservice:createmobiletoken]].
  
 
Note: You need to have upgraded the Moodle Mobile app to version 1.4.4.
 
Note: You need to have upgraded the Moodle Mobile app to version 1.4.4.
Line 54: Line 65:
 
This can be solved easily, administrators must create a token manually in Moodle (''Plugins > Web Services > Manage tokens'') for the local_mobile service. '''Note:''' Be sure to toggle the default "Moodle mobile web services" setting to "Moodle mobile additional features service" before creating the token.  
 
This can be solved easily, administrators must create a token manually in Moodle (''Plugins > Web Services > Manage tokens'') for the local_mobile service. '''Note:''' Be sure to toggle the default "Moodle mobile web services" setting to "Moodle mobile additional features service" before creating the token.  
  
[[de:Mobile App - Zusatzfunktionen]]
+
[[de:Moodle Mobile - Zusatzfunktionen]]
 
[[es:Características adicionales de Moodle Mobile]]
 
[[es:Características adicionales de Moodle Mobile]]
 +
[[fr:Fonctionnalités additionnelles de l'app mobile]]
 +
[[it:Funzionalità aggiuntive della App Moodle]]

Latest revision as of 08:36, 30 April 2019

The Moodle Mobile additional features plugin provides new features and web services for the Moodle Mobile app which are currently only available in the latest Moodle version.

This plugin is officially developed and maintained by Moodle HQ

How it works

Once installed the plugin creates a new service "Moodle Mobile additional features". The Mobile app checks if this service is enabled. If not, the Mobile app falls backs to the standard core Mobile app service.

Please, open Moodle Mobile features to check what new features are added to your site depending on your Moodle version.

Features

  • Support for Moodle sites prior to 3.2 using SSO authentication methods (Shibboleth, CAS and Google OAuth 2)
  • Support for sites using MNet authentication (Moodle Network authentication)
  • Support for push notifications in Moodle sites prior to version 2.6

Enable authentication for sites using SSO methods (like Shibboleth and CAS)

VERY IMPORTANT NOTE: If SSO is not working for your (or it is failing randomly), you'd need to disable the "Auto login guest" option "autologinguests". This setting may not be compatible with the SSO via app in some sites (it should work fine in Moodle 3.2 onwards).

SSO and MNet authentication is not supported in the Windows 8 and Windows Phone 8 apps

Once the plugin is installed, you need to go to Site administration > Plugins > Local plugins > Moodle Mobile additional features

There you can choose the "Type of login":

Via the app 
Is the default login, the user must introduce his credentials in the app
Via a browser window 
A new browser instance is open in the mobile device pointing to the login form in the Moodle site (which may again redirect to external identity providers if required). The user must introduce his credentials there. This is the option that must be selected for sites using SSO methods (or for sites that wants to force the user to authenticate in the site, not in the app)
Via an embedded browser
The embedded browser shows the login form in the Moodle site (which may again redirect to external identity providers if required). The user must introduce his credentials there. An embedded browser provides a better user experience, though it doesn't work with all SSO plugins.
Video showing Moodle Mobile SSO

When using the "Via a browser window" option, you can optionally specify an URL scheme to be used by the system to open the Mobile app. By default, the URL scheme used to open the app will be the one indicated by the own app during the SSO process. If you've developed a custom app using its own URL scheme and you want to allow only SSO logins via your app, you can indicate there an URL scheme. The site will detect that setting and will use it instead of the value indicated by the app.

Configuring the app from your site

  • Disable app functionalities for your site. If there's a feature you don't want to make available via the app you can disable it here.
  • Rename app text strings.
  • Add new items in the app's main menu (the side menu).
  • Replace the Change site option with a "Log out" one to force the users to enter their credentials on their next access.

Installation

  1. Unpack the zip file into the local/ directory. A new directory will be created called local/mobile.
  2. Go to Site administration > Notifications to complete the plugin installation.
  3. Go to Site administration > Mobile app > Mobile settings and enable web services for mobile devices (Remember to save the changes)
  4. Go to Site administration > Plugins > Web services > External services, edit "Moodle Mobile additional features" and check the "Enabled" field, then save changes.
  5. Go to Site administration > Users > Permissions > Define roles, edit the Authenticated user role and allow the capability moodle/webservice:createmobiletoken.

Note: You need to have upgraded the Moodle Mobile app to version 1.4.4.

If you are currently using the Moodle Mobile app, you will need to log out of all your sites in order for the app to detect the new service.

Admin users, please read

This plugin installs a new service in your Moodle installation, the automatic token creation for this type of services is forbidden for admin users. This means that admin users will not be able to use the Mobile app.

This can be solved easily, administrators must create a token manually in Moodle (Plugins > Web Services > Manage tokens) for the local_mobile service. Note: Be sure to toggle the default "Moodle mobile web services" setting to "Moodle mobile additional features service" before creating the token.