Note: You are currently viewing documentation for Moodle 3.9. Up-to-date documentation for the latest stable version of Moodle may be available here: Moodle app notifications.

Moodle app notifications: Difference between revisions

From MoodleDocs
 
(34 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{Mobile}}
{{Mobile}}


The app supports two types of notifications: Local and Push.  
==For students and teachers==
[[File:12Notifications.png|thumb|Forum post notification]]
The Moodle mobile app lets you keep up to date with all that's happening in your courses and on the site. Every time you open the app, events are synchronised with the website.


Local notifications are only for events in your Moodle calendar. Push notifications are connected to the messaging system in Moodle, so you receive notifications for internal messages, new forum posts, submitted assignments and every message sent by any Moodle module that can be configured in your Messaging profile option.
You will receive [[Calendar|Moodle calendar]] event notifications automatically. If you don't want to get them, you can turn them all off individually (or globally) in the Calendar events options in the main menu.


Local notifications are enabled by default and you don't have to configure anything, Push notifications need to be enabled by your site administrator and configured in your message profile.
You will also receive notifications of messages, forum posts, submitted assignments etc (known as 'push notifications') if your site administrator has enabled these. To receive these notifications you need to enable them EITHER via the app OR via the website.


== Local notifications ==
To enable mobile notifications via the app:


Local notifications are enabled by default: the app creates local notifications based in your calendar events (every time you open the app, the events are re-synchronized deleting the old ones). Note that groups events are not currently supported.
# Go to the app settings then Notification preferences
# Move the slider so that disable notifications is off
# Move the slider to turn on notifications for assignment, feedback, forum etc. as required


You can disable local notifications in the app (go to the “Settings > General” section) or individually for each event via the "Calendar events" option in the main menu.
To enable mobile notifications via the website:


== Push notifications ==
# Go to your user menu (top right of each page) and select Preferences
# Click the link 'Notification preferences'
# Click to turn on notifications for assignment, feedback, forum etc. as required


Push notifications are connected to the messaging system in Moodle so you receive notifications for internal messages, new forum posts, submitted assignments and every message sent by any Moodle module that can be configured in your Messaging profile option.
{|
|-
| [[File:notification preferences app.png|thumb|Notification preferences in the app]]
| [[File:notification preferences web.png|thumb|Notification preferences on website]]
|}


Enabling push notifications:
==For administrators==


1.  (Optional step) If your Moodle installation is 2.6 or below, you will need to install the [https://moodle.org/plugins/view.php?plugin=message_airnotifier Mobile notifications plugin]. For Moodle 2.7 and onwards you need to enable the plugin. For Moodle versions 2.4 and 2.5 the [[Moodle Mobile additional features]] plugin must also be installed. *
Push notifications can be enabled by an administrator by connecting their Moodle site to a messaging server such https://messages.moodle.net (available for [[Site registration|registered Moodle sites]] only). An access key can be obtained via ''Administration > Site administration > Plugins > Message outputs > Mobile Notifications''.  


2. Connect it to a messaging server (you can use ours if your Moodle site is registered). Go to ''Site administration > Plugins > Message outputs > Mobile Notifications'' and click in ''Request access key''. If you have problems requesting the access key, please fill in this form: http://goo.gl/forms/WLwkbe8b7c (your site registration will be checked and we will send you an access key in a few days if everything is correct).
Note that from 2 April 2020, there will be certain limitations when using push notifications. Depending on the size of your site and the number of user devices receiving notifications, you may need to sign up to a Premium plan in the Moodle Apps portal: https://apps.moodle.com. For further information, see the official announcement [https://moodle.org/mod/forum/discuss.php?d=397926 Introducing our new Moodle App plans].


3.  Users need to connect at least once with the latest version of the app in order to register their phones with your site.
You can enable by default Mobile notifications for your students, please read the "Default message outputs" section in [[Messaging settings]].


4.  Users must configure notifications in the Moodle messaging preferences (''Administration > My profile settings > Messaging'').
If you have problems requesting the access key, please register your site on the Moodle Apps Portal https://apps.moodle.com once your site is registered there, an Airnotifier access key will be automatically generated for you.


<nowiki>*</nowiki> Only for Moodle from 2.7 and onwards: If you upgrade your Moodle installation, you will have to reinstall the plugin since it adds a couple of functions to the core Moodle Mobile service. See https://tracker.moodle.org/browse/MDLSITE-2815?focusedCommentId=273741&page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#comment-273741 for more information.
Users then need to connect at least once with the latest version of the Moodle Mobile app in order to register their phones with the Moodle site.


=== Receiving calendar notifications via Push messages ===
=== Event Reminders plugin===


You can receive calendar notifications via Push messages, it requires a plugin to be installed in your Moodle site: [https://moodle.org/plugins/view/local_reminders Event Reminders]
Push notifications can also include calendar event notifications, however this requires the [https://moodle.org/plugins/view/local_reminders Event Reminders plugin] to be installed on the Moodle site.


This plugin will automatically send reminders for Moodle calendar events in a timely manner via Moodle message interface. It also allows users to control how they receive messages for each type of event in Moodle calendar.
The Event Reminders plugin will automatically send reminders for Moodle calendar events in a timely manner via Moodle message interface. It also allows users to control how they receive messages for each type of event in the Moodle calendar.


=== Installing your own Notifications infrastructure ===
=== Installing your own notifications infrastructure ===


If you have a customized version of the Mobile app, or you want to use your own Notifications infrastructure, then you will have to install a private [http://airnotifier.github.io AirNotifier] (backend server for notifications).
If you have a customized version of the Moodle Mobile app, or you want to use your own notifications infrastructure, you will have to install a private [http://airnotifier.github.io AirNotifier] (backend server for notifications).


We use a slightly modified version of Airnotifier: https://github.com/jleyva/airnotifier/tree/moodle2.  
https://messages.moodle.net uses a slightly modified version of Airnotifier: https://github.com/moodlehq/airnotifier/tree/moodle2.  


You will have to add your app certificates there, see https://github.com/airnotifier/airnotifier/wiki/Installation.
'''UPDATE''': Google is deprecating FCM in April, 2019. The following steps may not be valid starting that date


The AirNotifier message plugin allows you to point to your custom AirNotifier instance using your own access keys.
You will have to add your app certificates - see https://github.com/airnotifier/airnotifier/wiki/Installation for further information.


Remember to install using GIT (repository https://github.com/jleyva/airnotifier.git branch ''moodle2'').
The Airnotifier message plugin allows you to point to your custom Airnotifier instance using your own access keys.


[[de:Mobile App - Push-Mitteilungen]]
Remember to install using GIT (repository https://github.com/moodlehq/airnotifier.git branch ''moodle2'').
 
Moodle offers a branded app service including a private notifications infrastructure, for more information visit https://moodle.com/mobileapp/
 
== Troubleshooting ==
 
If your users are not receiving push notifications please check:
 
* You have not exceeded the maximum number of active devices according to your Moodle App Plan. You can register for free on https://apps.moodle.com to check your current active user devices to check if you need to upgrade to a Pro/Premium plan.
* You have entered an Airnotifier access key in the Mobile settings in the Site administration
* Mobile is enabled (open eye) in 'Manage message outputs' in the Site administration
* Any user not receiving notifications has enabled mobile notifications in the mobile app in App settings > Notification preferences then check that "Disable notifications" is not selected
* Any user not receiving notifications has enabled the type of notifications they want to receive in App settings > Notification preferences
* Any user not receiving notifications hasn't disabled his current device in App settings > Notification preferences > 3 dots menu > Configure devices
* Mobile notifications are not disallowed by an administrator in 'Default message outputs' in the Site administration
* Mobile notifications are enabled in the user's Android phone (Settings > Apps > Moodle Mobile > Show notifications ticked) or iOS phone (in iOS in Settings -> Moodle Mobile > Notifications)
* The server where your Moodle site is installed is able to connect to messages.moodle.net (port 443) via telnet
* You are using the Moodle Mobile official app. If you are using a custom/branded app for your institution, please contact your institution since custom apps need their own notifications infrastructure (see above).
* Your Moodle installation cron jobs are not locked. You can check it executing the CRON manually and reading the output, more info [https://moodle.org/mod/forum/discuss.php?d=361595 here]
 
=== Testing push notifications ===
 
To test push notifications:
 
# Ensure that mobile notifications are enabled (as described above).
# Go to a course and create a forum with forced subscription.
# Log in as a student and create a new discussion in the forum.
# As the same student, log in on the mobile app, go to App settings > Notification preferences > Forum and enable all the notifications.
# In the same page, check that at the top of the page you see "You are configuring Mobile notifications". If it says "You are configuring notifications for web (or email)", switch to mobile via the three dots menu at the top right.
# In the same page, tap the three dots menu (top right), go to Configure devices and check that your current device is enabled.
# Now, put the Moodle Mobile app in background (switching to a different app or going to your device home).
# Log in to the site (on the web) and post a reply to the discussion started by the student., ticking the option "Send forum post notifications with no editing-time delay".
# Verify that the student receives a push notification on their mobile device.
 
[[de:Moodle App - Systemnachrichten]]
[[ca:Notificacions_de_la_app_Mobile]]
[[es:Mobile app Notificaciones Push]]
[[es:Mobile app Notificaciones Push]]
[[fr:Notifications de l'app mobile]]

Latest revision as of 17:53, 20 April 2020


For students and teachers

Forum post notification

The Moodle mobile app lets you keep up to date with all that's happening in your courses and on the site. Every time you open the app, events are synchronised with the website.

You will receive Moodle calendar event notifications automatically. If you don't want to get them, you can turn them all off individually (or globally) in the Calendar events options in the main menu.

You will also receive notifications of messages, forum posts, submitted assignments etc (known as 'push notifications') if your site administrator has enabled these. To receive these notifications you need to enable them EITHER via the app OR via the website.

To enable mobile notifications via the app:

  1. Go to the app settings then Notification preferences
  2. Move the slider so that disable notifications is off
  3. Move the slider to turn on notifications for assignment, feedback, forum etc. as required

To enable mobile notifications via the website:

  1. Go to your user menu (top right of each page) and select Preferences
  2. Click the link 'Notification preferences'
  3. Click to turn on notifications for assignment, feedback, forum etc. as required
Notification preferences in the app
Notification preferences on website

For administrators

Push notifications can be enabled by an administrator by connecting their Moodle site to a messaging server such https://messages.moodle.net (available for registered Moodle sites only). An access key can be obtained via Administration > Site administration > Plugins > Message outputs > Mobile Notifications.

Note that from 2 April 2020, there will be certain limitations when using push notifications. Depending on the size of your site and the number of user devices receiving notifications, you may need to sign up to a Premium plan in the Moodle Apps portal: https://apps.moodle.com. For further information, see the official announcement Introducing our new Moodle App plans.

You can enable by default Mobile notifications for your students, please read the "Default message outputs" section in Messaging settings.

If you have problems requesting the access key, please register your site on the Moodle Apps Portal https://apps.moodle.com once your site is registered there, an Airnotifier access key will be automatically generated for you.

Users then need to connect at least once with the latest version of the Moodle Mobile app in order to register their phones with the Moodle site.

Event Reminders plugin

Push notifications can also include calendar event notifications, however this requires the Event Reminders plugin to be installed on the Moodle site.

The Event Reminders plugin will automatically send reminders for Moodle calendar events in a timely manner via Moodle message interface. It also allows users to control how they receive messages for each type of event in the Moodle calendar.

Installing your own notifications infrastructure

If you have a customized version of the Moodle Mobile app, or you want to use your own notifications infrastructure, you will have to install a private AirNotifier (backend server for notifications).

https://messages.moodle.net uses a slightly modified version of Airnotifier: https://github.com/moodlehq/airnotifier/tree/moodle2.

UPDATE: Google is deprecating FCM in April, 2019. The following steps may not be valid starting that date

You will have to add your app certificates - see https://github.com/airnotifier/airnotifier/wiki/Installation for further information.

The Airnotifier message plugin allows you to point to your custom Airnotifier instance using your own access keys.

Remember to install using GIT (repository https://github.com/moodlehq/airnotifier.git branch moodle2).

Moodle offers a branded app service including a private notifications infrastructure, for more information visit https://moodle.com/mobileapp/

Troubleshooting

If your users are not receiving push notifications please check:

  • You have not exceeded the maximum number of active devices according to your Moodle App Plan. You can register for free on https://apps.moodle.com to check your current active user devices to check if you need to upgrade to a Pro/Premium plan.
  • You have entered an Airnotifier access key in the Mobile settings in the Site administration
  • Mobile is enabled (open eye) in 'Manage message outputs' in the Site administration
  • Any user not receiving notifications has enabled mobile notifications in the mobile app in App settings > Notification preferences then check that "Disable notifications" is not selected
  • Any user not receiving notifications has enabled the type of notifications they want to receive in App settings > Notification preferences
  • Any user not receiving notifications hasn't disabled his current device in App settings > Notification preferences > 3 dots menu > Configure devices
  • Mobile notifications are not disallowed by an administrator in 'Default message outputs' in the Site administration
  • Mobile notifications are enabled in the user's Android phone (Settings > Apps > Moodle Mobile > Show notifications ticked) or iOS phone (in iOS in Settings -> Moodle Mobile > Notifications)
  • The server where your Moodle site is installed is able to connect to messages.moodle.net (port 443) via telnet
  • You are using the Moodle Mobile official app. If you are using a custom/branded app for your institution, please contact your institution since custom apps need their own notifications infrastructure (see above).
  • Your Moodle installation cron jobs are not locked. You can check it executing the CRON manually and reading the output, more info here

Testing push notifications

To test push notifications:

  1. Ensure that mobile notifications are enabled (as described above).
  2. Go to a course and create a forum with forced subscription.
  3. Log in as a student and create a new discussion in the forum.
  4. As the same student, log in on the mobile app, go to App settings > Notification preferences > Forum and enable all the notifications.
  5. In the same page, check that at the top of the page you see "You are configuring Mobile notifications". If it says "You are configuring notifications for web (or email)", switch to mobile via the three dots menu at the top right.
  6. In the same page, tap the three dots menu (top right), go to Configure devices and check that your current device is enabled.
  7. Now, put the Moodle Mobile app in background (switching to a different app or going to your device home).
  8. Log in to the site (on the web) and post a reply to the discussion started by the student., ticking the option "Send forum post notifications with no editing-time delay".
  9. Verify that the student receives a push notification on their mobile device.