Event Monitor specification
Event Monitor | |
---|---|
Project state | Implementation |
Tracker issue | MDL-45758 |
Discussion | https://moodle.org/mod/forum/discuss.php?d=261660 |
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 Event 2 infrastructure.
How it works
- The user or site admin creates a specific set of “rules” that can be subscribed to.
- Each rule defines an 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 are 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
Subscribe to a rule
This is the main page of the Event Monitor report where users can see a list of rules and their current subscriptions. This also lets users to subscribe to new rules or delete their current subscriptions.
Manage rules
This page lets you manage the rules if you have appropriate permissions (create/edit/delete/copy)
This is roughly how the page will 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
One scenario may be that you wish to be notified when discussions are becoming active in the forums.
The figure above shows 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.
Message template
One interesting option of rule monitoring is the message templates. When creating or editing a rule, the user can use placeholders to receive a detailed notification. These are the available placeholder for use on message template field.
Placeholder | What it does? | Example |
---|---|---|
{link} | Link to the location where the event happened. | http://localhost/integration_master/mod/forum/discuss.php?d=2 |
{modulelink} | Link to the module where the event has happened. | http://localhost/integration_master/mod/forum/view.php?id=8 |
{rulename} | Rule name created by the user. | Students discussions |
{description} | Given description of the rule created by the user. | I want to receive notifications when a student create post in a discussion. |
{eventname} | Event name that is being monitored. | Forum post created.
The example above show the placeholders for a rule which to monitor the Forum post created event. Benefits
Usage scenarios
Future work
See also
|