Feature Wiki

Information about planned and released features

Tabs

System Notification Guideline

Page Overview

[Hide]

1 Description

Usually, ILIAS is sending notifications automatically when specific workflows / procedures have been exectuted. Triggers could be a request for course or group access, an expiring user account or a new posting in a monitored forum. These system notifications always need to have sufficient information for the user and shouldn't confuse him.

2 Guideline for System Notifications

All notifications should have the following structure:

Title

Explanation

Example

Salutation

Hello John Doe,

Message

What has happened? / What will happen?

A new user has been registered. ...
(or)
The following wiki page has been updated ...
Wiki: ...
Page: ...
Updated by: ...

Task

What do I have to do?

To confirm this registration enter the ILIAS user administration and activate the account.

Explanation

Why do I receive the following message?

You receive this message because you have activated the notification about new postings in this forum.

Additional information

Signature

* * * * *
This mail has been sent automatically by
ILIAS installation {client name}
URL: {client URL}

Implementation details can be found in the Dev Guide.

3 Presentation & Layout

All messages have a kind of table style.

Example:

You have been subscribed to a course.
Course title: XYZ
URL: http://.....

This style is much easier to handle in different languages because there is no need to include system data into the language text and to take care of the different grammar in different languages.

4 Handling of Non-compliant Messages / Violation of Guideline

System messages that are not following this guideline are considered as bugs and need to be fixed. These issues should always be assigned to the appropriate module category.

Example:

ILIAS sends a non-compliant message about a new forum posting -> Bug is assigned in Mantis to "Forum".

If you have found a non-compliant message, please report it to Mantis first. Then add Mantis bug ID + version below:

5 Collection of All Notifications in ILIAS

This is a list of existing notification mails in ILIAS (4.3). The current status of a notification is shown on the left side while the desired status is presented at the right side. Necessary changes to make the mail text compliant to the guideline are marked like this.

5.1 Blog

Purpose of notification: comment on blog posting

Current Status

Desired Status

Hallo Matthias Kunkel,

der folgende Blog-Eintrag wurde kommentiert:

Blog: optes-Blog
Blog-Eintrag: optes-Webseite : Bitte um Unterstützung
Letzte Änderung durch: Gates, Bill [billyboy]

Kommentar:
"Hallo Herr Kunkel,

ich möchte mich Steve Jobs anschließen und die Neugestaltung des öffentlichen Auftrittes von optes.de loben! Auf einen Blick erfasst man alle wichtigen Informationen und die Graphik ist ebenfalls sehr ansprechend. Vielen Dank für Ihr Engagement!

Beste Grüße

Bill Gates"

URL: http://www.optes.de/goto_optes_blog_164_92.html

* * * * *
optes
Projekt-ILIAS
http://www.optes.de

Hallo Matthias Kunkel,
 
der folgende Blog-Eintrag wurde kommentiert.
 
Blog: optes-Blog
Blog-Eintrag: optes-Webseite : Bitte um Unterstützung
Letzte Änderung durch: Gates, Bill [billyboy]
 
Kommentar:
------------------------------------------------------------
Hallo Herr Kunkel,
 
ich möchte mich Steve Jobs anschließen und die Neugestaltung des öffentlichen Auftrittes von optes.de loben! Auf einen Blick erfasst man alle wichtigen Informationen und die Graphik ist ebenfalls sehr ansprechend. Vielen Dank für Ihr Engagement!
 
Beste Grüße
 
Bill Gates
------------------------------------------------------------
 
Zum Blog-Eintrag gehen: http://www.optes.de/goto_optes_blog_164_92.html
 
Sie erhalten diese Nachricht, weil Sie die Benachrichtigungsfunktion für das oben genannte Blog aktiviert haben.
 
* * * * *
Diese E-Mail wurde automatisch versandt von der
ILIAS-Installation: Projekt-ILIAS
URL: http://www.optes.de

5.2 Course

Notification about course subscription

Current Status

Desired Status

Hallo Elias Dario,

wir haben Sie soeben entsprechend Ihres Antrags in den Kurs "Deutsch Klasse 10" aufgenommen.

Wählen Sie den folgenden Link, um auf den Kursinhalt zuzugreifen:

http://www.ilias.de/test43/goto.php?target=crs_5433&client_id=test43

  • * * * *
ilias4evaluation
ILIAS 4.3 Evaluation Platform
http://www.ilias.de/test43/?client_id=test43

Hallo Elias Dario,

wir bestätigen Ihre Abmeldung vom Kurs "Deutsch Klasse 10". Ihre Kursmitgliedschaft ist damit beendet.

  • * * * *
Diese E-Mail wurde automatisch versandt von der
ILIAS-Installation: ILIAS 4.3 Evaluation Platform
URL: http://www.ilias.de/test43/?client_id=test43

Notification about unsubscription from course

Current Status

Desired Status

Hallo Elias Dario,

wir bestätigen Ihre Abmeldung vom Kurs "Deutsch Klasse 10".

  • * * * *
ilias4evaluation
ILIAS 4.3 Evaluation Platform
http://www.ilias.de/test43/?client_id=test43

Hallo Elias Dario,

wir haben Sie soeben entsprechend Ihres Antrags in den Kurs "Deutsch Klasse 10" aufgenommen.

Wählen Sie den folgenden Link, um auf den Kursinhalt zuzugreifen:
» http://www.ilias.de/test43/goto.php?target=crs_5433&client_id=test43

  • * * * *
Diese E-Mail wurde automatisch versandt von der
ILIAS-Installation: ILIAS 4.3 Evaluation Platform
URL: http://www.ilias.de/test43/?client_id=test43

5.3 Data Collection

Current Status

Desired Status

Guten Tag Oskar Truffer,

Der folgende Datensatz wurde aktualisiert:

Datensammlung: Import Test
Tabelle: Import Test
E-Mail: Ot@studer-raimann.ch
Note: 10
Anrede: Herr
Rating: 0
Date: 2004-10-12
ILIAS-Module: http://localhost/trunk/goto.php?target=mcst_106&client_id=ilias_trunk
Anbieter: Anbieter 1, Anbieter 3
Bild: ot.jpg

Letzte Änderung durch: [root]

URL: http://localhost/trunk/goto.php?target=dcl_111&client_id=ilias_trunk

Sie erhalten diese Nachricht weil Sie die Benachrichtigungen für die oben genannte Datensatzsammlung aktiviert haben.

Hallo Oskar Truffer,

der folgende Datensatz wurde aktualisiert:

Datensammlung: Import Test
↵
Tabelle: Import Test
↵
Aktualisierter Datensatz:
------------------------------------------------------------
E-Mail: Ot@studer-raimann.ch
Note: 10
Anrede: Herr
Rating: 0
Date: 2004-10-12
ILIAS-Module: http://localhost/trunk/goto.php?target=mcst_106&client_id=ilias_trunk
Anbieter: Anbieter 1, Anbieter 3
Bild: ot.jpg
------------------------------------------------------------
Aktualisiert von: User, Ruth [root]

Zur Datensammlung gehen: http://localhost/trunk/goto.php?target=dcl_111&client_id=ilias_trunk

Sie erhalten diese Nachricht, weil Sie die Benachrichtigungsfunktion für die oben genannte Datensatzsammlung aktiviert haben.
 
* * * * *
Diese E-Mail wurde automatisch versandt von der
ILIAS-Installation: ILIAS Documentation and Information Center
URL: http://www.ilias.de/docu

5.4 Forum

Purpose of notification: New posting in forum

Current Status

Desired Status

Hallo Matthias Kunkel,
 
Neuer Beitrag im Forum: Course and Group Management
 
Forum: Course and Group Management
 
Thema: Upload many objects to mediapool
 
Neuer Beitrag:
------------------------------------------------------------
Autor: habakuk.tibatong
Datum: 2013-05-01 10:59:16
Betreff: Re: Upload many objects to mediapool
 
Hi Alex
As fare as I know there is no such feature - unfortunately.
Regards Habakuk
------------------------------------------------------------
Zum Beitrag gehen: http://www.ilias.de/docu/goto.php?target=frm_1887_2030_6168&client_id=docu
 
Diese E-Mail wurde von der ILIAS-Installation docu, http://www.ilias.de/docu/?client_id=docu automatisch an Sie versandt.

Hallo Matthias Kunkel,
 
es gibt einen neuen Beitrag im Forum: Course and Group Management
 
Thema: Upload many objects to mediapool
 
Neuer Beitrag:
------------------------------------------------------------
Autor: habakuk.tibatong
Datum: 2013-05-01 10:59:16
Betreff: Re: Upload many objects to mediapool
 
Hi Alex
As fare as I know there is no such feature - unfortunately.
Regards Habakuk
------------------------------------------------------------
Zum Beitrag gehen: http://www.ilias.de/docu/goto.php?target=frm_1887_2030_6168&client_id=docu
 
Sie erhalten diese Nachricht, weil Sie die Benachrichtigungsfunktion für das oben genannte Forum aktiviert haben.
 
* * * * *
Diese E-Mail wurde automatisch versandt von der
ILIAS-Installation: ILIAS Documentation and Information Center
URL: http://www.ilias.de/docu

5.5 Wiki

Purpose of notification: Modified wiki page (notification about new page is similar).

Current Status

Desired Status

Hallo Matthias Kunkel,

die folgende Wiki-Seite wurde editiert:

Wiki: Feature Wiki
Seite: Right and Wrong Instead of Points
Geändert von: Killing, Alexander [alex]

URL: http://www.ilias.de/docu/goto.php?target=wiki_1357_Right_and_Wrong_Instead_of_Points

* * * * *
docu
ILIAS Documentation and Information Center
http://www.ilias.de/docu

Hallo Matthias Kunkel,
 
die folgende Wiki-Seite wurde editiert:
 
Wiki: Feature Wiki
Seite: Right and Wrong Instead of Points
Geändert von: Killing, Alexander [alex]
 
Zum Beitrag gehen: http://www.ilias.de/docu/goto.php?target=wiki_1357_Right_and_Wrong_Instead_of_Points
 
* * * * *
Diese E-Mail wurde automatisch versandt von der
ILIAS-Installation: ILIAS Documentation and Information Center
URL: http://www.ilias.de/docu

6 Status

  • Guideline shall be implemented until release Release 4.1
  • Funding: Funded by ILIAS-Verein and developers
  • Development: Feature is to be developed by module maintainers

7 Additional Information

  • If you want to know more about this feature, its implementation or funding, please contact: Matthias Kunkel
  • Streamlining of system notifications has already been tackled with System Notifications by E-Mail for 4.0 and 4.1

8 Discussion

Matthias Kunkel, 08 MAY 2013: I have added several notifications (ongoing) that still need to be adapted to the standard.

Last edited: 28. May 2024, 09:47, Kunkel, Matthias [mkunkel]