Event Monitor specification: Difference between revisions

Revision as of 09:15, 3 June 2014

Event Monitor
Project state	Specification/Prototyping
Tracker issue	MDL-45758
Discussion	https://moodle.org/mod/forum/discuss.php
Assignee	Ankit, Simey

Note: This page is a work-in-progress. Feedback and suggested improvements are welcome. Please join the discussion on moodle.org or use the page comments.

The Event Monitor report will allow users to select events and receive notifications in real time* when the chosen event happens. This report will be built on top of the new Events_2 infrastructure.

How it works

The user or site admin creates a specific set of “rules” that can be subscribed to.
Each rule defines a event and frequency parameters.
The users select the rules they are interested in and then subscribe to it at course level for a specific module or all modules.
Whenever the event occurs in the system , in the frequency specified in the rule, a message is sent out to all the subscribers.
Since we would be using Moodle messaging system to send out these notifications, it can be delivered in any format supported by Moodle (Mobile notification, popup, email etc)
There would be some default rules that would be shipped with the report, that users can subscribe to straight away.

User interface mock-ups

List rules

This is the main page of Event Monitor where users can see list of rules. This page lets you subscribe/un-subscribe to the rules. And this also lets you manage the rules if you have appropriate permissions (create/edit/delete/copy)

This is roughly how the page would look like:-

Add/Edit a rule

This is the form where users can create a new rule, customise the filters (frequency and time) and personalise the notification message.

A specific example

Consider the case when you want to be notified when active discussions are going on in the forums.

The figure above show the creation of a new rule called 'My Student Discussions', which is set to monitor 'Post Created event' on 'Forum Module'.

In this case, any user subscribed to this rule will receive notifications whenever '30 posts are created in 60 minutes' on the forum they are subscribed to.

The notification will contain the customised message as configured in the rule.

Benefits

Real time monitoring of events happening in Moodle.
Admin can be notified when there is heavy activity on the site or they can monitor specific actions that interests them (ex:- course delete).
Notification can be sent straight to users' mobile if needed to inform them of situation that needs their immediate attention.
The report would be designed to trigger an event when a given subscription criteria are met. This will allow developers to build really powerful scripts on top of the report. For example, say a block displaying “Hot forums”, or something more complex like load balancing when there is lot of activity in the forum or quiz.

Usage scenarios

Send notification when more than X posts in any forum are made in a given course in Y minutes.
Send notification when assignment is submitted in their course.
Send notification (to admin) when a course is deleted.
Send notification (to students) that a particular activity has been updated.

@@ Line 1: / Line 1: @@
 {{Infobox Project
 |name = Event Monitor
-|state = Specification
+|state = Specification/Prototyping
 |tracker = MDL-45758
 |discussion = https://moodle.org/mod/forum/discuss.php
@@ Line 9: / Line 9: @@
 {{Work in progress}}
-The Event Monitor tool will allow users choose their favourites events and receive notifications in real time when the choosen event is happening in the frequency and time.
+The Event Monitor report will allow users to select events and receive notifications in real time* when the chosen event happens.
+This report will be built on top of the new [[Events_2]] infrastructure.
-The main concept is to turn the new event system more usefull to teachers and admin.
+== How it works ==
+* The user or site admin creates a specific set of “rules” that can be subscribed to.
+* Each rule defines a event and frequency parameters.
+* The users select the rules they are interested in and then subscribe to it at course level for a specific module or all modules.
+* Whenever the event occurs in the system , in the frequency specified in the rule, a message is sent out to all the subscribers.
+* Since we would be using Moodle messaging system to send out these notifications, it can be delivered in any format supported by Moodle (Mobile notification, popup, email etc)
+* There would be some default rules that would be shipped with the report, that users can subscribe to straight away.
-== Benefis ==
+=== User interface mock-ups ===
-* Introduce the hot spot concept on moodle.
+==== List rules ====
-* Create a close relation between teachers and students.
-* Real time monitoring of favourite events.
-* Keep Admins aware about major changes in the system.
-== Usage scenarios ==
+This is the main page of Event Monitor where users can see list of rules. This page lets you subscribe/un-subscribe to the rules. And this also lets you manage the rules if you have appropriate permissions (create/edit/delete/copy)
-* Send message to teacher when more than X posts in any forum in their course in Y minutes.
+This is roughly how the page would look like:-
-* Send message to teacher when assignment is submitted in their course.
+[[File:listrules.png]]
-* Send message to admin when a course is deleted.
-* Send message to student when they are graded for activity X.
-* Send message to forum poster when someone replies to their post.
-* Send message to student when assignment/activity due date changes or is upcoming and they haven't submitted their submission/answer.
-* Ability for a teacher to send a message to students that a particular activity has been updated (versus notify students whenever any change, such as a type being fixed).
-== User interface mock-ups ==
+==== Add/Edit a rule ====
-'''List rules'''
+This is the form where users can create a new rule, customise the filters (frequency and time) and personalise the notification message.
-This is the main page of Event Monitor where users can list rules, subscribe to a rule, choose a specific module to monitor and delete rule.
+[[File:addrule.png]]
-In the List rule page the user have a button Add New Rule, to access a form to create a new rule.
-[[File:listrules.png]]
-'''Add new rule'''
+=== A specific example ===
+Consider the case when you want to be notified when active discussions are going on in the forums.
-This is the form where users can create a new rule, customize the frequency and time and create a personalized notification message.
+The figure above show the creation of a new rule called 'My Student Discussions', which is set to monitor 'Post Created event' on 'Forum Module'.
-[[File:addrule.png]]
+In this case, any user subscribed to this rule will receive notifications whenever '30 posts are created in 60 minutes' on the forum they are subscribed to.
-The figure above show the creation of a new rule called My Student Discussions, where the teacher add a criteria to monitor Post Created event on Forum Module.
+The notification will contain the customised message as configured in the rule.
-In this case, the teacher will receive notifications every 30 posts created in 60 minutes. The user created a personalized message using a tag to receive a link to the forum.
+== Benefits ==
-== How it works ==
+* Real time monitoring of events happening in Moodle.
-The user identify a certain event which he want to monitor and access Site Administration > Reports > Event Monitor > Add new Rule.
+* Admin can be notified when there is heavy activity on the site or they can monitor specific actions that interests them (ex:- course delete).
+* Notification can be sent straight to users' mobile if needed to inform them of situation that needs their immediate attention.
+* The report would be designed to trigger an event when a given subscription criteria are met. This will allow developers to build really powerful scripts on top of the report. For example, say a block displaying “Hot forums”, or something more complex like load balancing when there is lot of activity in the forum or quiz.
-He must fill all fields (Name, Plugin, Event, Frequency and Time and Message Template. After fill all the fields he submit the rule and will be redirected to the List Rules.
+== Usage scenarios ==
-In the List Rules the user will be allowed to perform the following actions:
-* Select a specific module to monitor or all the modules.
+* Send notification when more than X posts in any forum are made in a given course in Y minutes.
-* Subscribe or unsubscribe of a rule.
+* Send notification when assignment is submitted in their course.
-* Create a new rule.
+* Send notification (to admin) when a course is deleted.
-* Delete a rule.
+* Send notification  (to students) that a particular activity has been updated.
-* Copy rules.
 == See also ==
@@ Line 66: / Line 62: @@
 * [[Event 2]]
 * Moodlerooms developed a "[http://kb.moodlerooms.com/article/81/administrator Personalized Learning Designer]" that has some of these features (mostly for individual students only).
+* Real time means “as soon as possible” - this depends on the cron configuration of the site.

Documentation