Date de publication: le lundi 24 janvier 2011 à 14h18
Dernière modification: par Pascal BOYER le dimanche 30 octobre 2011 à 12h43

29/09/2010 8:36

versions 3.9, 3.10, 4.x

eZ Publish has a built-in notification system that allows users to be informed about miscellaneous events that occur. It is possible to be notified when objects are updated or published, when workflows are executed and so on. 
eZ Publish propose un système d'avis de mise à jour permettant d'informer les utilisateurs de l'existence de différents événements. Il est ainsi possible d'être tenu informé de la mise à jour ou de la publication d'objets, de l'exécution de workflows (flux de travail) etc...

There are two built-in types of notifications:
Deux types d'avis de mise à jour sont proposés par défaut:

• Subtree notifications
  Avis de mise à jour d'une arborescence
• Collaboration notifications
  Avis d'exécution du système de collaboration (workflow)

Subtree notifications / Avis de mise à jour d'une arborescence

It is possible to subscribe for notifications about a subtree. For example, if you have a set of articles located under a folder called "Business", a user can subscribe for subtree notifications for this folder. The system will then send an E-mail to the user every time changes are made under the "Business" folder. The following changes will trigger a notification:
Il est possible de souscrire à l'avis de mise à jour d'une arborescence. Si vous avez, par exemple, un ensemble d'articles placés dans le dossier Business, un utilisateur peut alors souscrire à l'avis de mise à jour de l'arborescence de ce dossier. Le système enverra donc un mail à cet utilisateur à chaque modification du contenu du dossier Buisiness. Les modifications suivantes déclencheront un avis de mise à jour:

• When a new node is published within the subtree.
  Lorsqu'un nœud est publié dans l'arborescence,
• When the contents of an existing node is changed.
  Lorsque le contenu d'un nœud de l'arborescence est modifié.

A user can choose to receive notifications in the form of a single E-mail or as a digest of messages.
Un utilisateur peut choisir de recevoir un avis de mise à jour sous la forme d'un mail ou d'un «résumé».

Collaboration notifications / Avis d'exécution du système de collaboration

The eZ Publish collaboration system allows you to work together with other people so that you can approve/reject any changes they made when it comes to content. For example, you can specify that all the changes made in the Standard section can not be published without your approval. (This can be done by creating a new Approve event within a new workflow initiated by the "content-publish-before" trigger function.) If somebody (except you, the administrator) edits content located under the "Standard" section, the system will generate new collaboration messages. For example, if somebody changes article "A", the system will generate a new collaboration message "article A awaits your approval" for you and another collaboration message "article A awaits approval by editor" for the user who changed it.
Le système de collaboration d'eZ Publish vous permet de travailler avec d'autres personnes afin que vous approuviez ou rejetiez n'importe quelle modification apportée par ces utilisateurs et devant être intégrée au module content. Vous pouvez décider, par exemple, que toute modification liée à la section Standard ne pourra être publiée qu'après approbation. Ceci peut être réalisé en créant un événement Approve dans un nouveau workflow exécuté par la fonction du déclencheur content-publish-before. Si quelqu'un, excepté vous qui êtes l'administrateur, édite un contenu placé dans la section  Standard , le système génèrera des messages de collaboration. Si quelqu'un modifie, par exemple, l'article A, le système générera, à votre attention, un message de collaboration intitulé L'article A attend votre approbation et un second message L'article A attend l'approbation de l'éditeur à l'attention de l'auteur des modifications.

To view your collaboration messages, click the "My Account" tab in the administration interface and then access the "Collaboration" link on the left. You will be able to review/approve/reject the changes.
Pour voir les messages de collaboration, cliquez sur l'onglet Mon compte ou Tableau de bord de l'interface d'administration puis cliquez sur le lien Collaboration ou Mes paramètres de notification dans le menu gauche. Vous pourrez alors annoter, approuver ou rejeter les modifications.

You can use collaboration notifications to be notified by E-mail about new collaboration messages. The system will send you an E-mail every time a new collaboration message is generated for you.
Vous pouvez utiliser les avis d'exécution du système de collaboration pour être tenu au courant par mail d'un nouveau message d'exécution du système de collaboration. Le système vous enverra un mail chaque fois qu'un message de collaboration est généré à votre attention.

Processing notifications / Traitement des avis de mise à jour

In the root of the eZ Publish directory there is a file called "runcronjobs.php". It takes care of processing the workflows, notifications and other tasks that should be processed in the background. If you are going to use the notification system, "runcronjobs.php" must be executed periodically. The most common way to do this is to set up a scheduled job that runs every 30-60 minutes or so. Please refer to the "Configuring cronjobs" and "Running cronjobs" sections for more information.
Vous trouverez, à la racine du répertoire d'installation d'eZ Publish, un fichier runcronjobs.php. Ce fichier permet de traiter les workflows, les avis de mise à jour ainsi que d'autres tâches devant être exécutées en tâche de fond. Si vous envisagez d'utiliser le système d'avis de mise à jour, alors le script runcronjobs.php doit être exécuté périodiquement. Le moyen le plus courant pour le faire est d'exécuter une tâche cron toutes les 30 ou 60 minutes, par exemple. Référez-vous aux paragraphes The cronjob script et Cron jobs pour plus d'informations.

In accordance with the instructions specified in the "cronjobs/notification.php" file, "runcronjobs.php" launches the main notification processing script "kernel/classes/notification/eznotificationeventfilter.php".
En accord avec les instructions spécifiées dans le fichier cronjobs/notification.php, le script runcronjobs.php lance le script principal de traitement d'avis de mise à jour: kernel/classes/notification/eznotificationeventfilter.php

If you need to launch this script manually, add the "notification/runfilter" notation to the administration interface URL and then click the "Run notification filter" button there (see the next screenshot).
Si vous avez besoin de lancer ce script manuellement, ajoutez notification/runfilter à l'URI de l'interface d'administration et cliquez ensuite sur le bouton Démarrer le filtre de notification présenté par la figure ci-dessous:

The notification filter interface
Interface du filtrage des notifications

Please note that processing notifications may cause a timeout error if there is a huge amount of notification events in the database. Because of this, the "runfilter" view of the "notification" module should only be used for testing and debugging.
Notez que le traitement des avis de mise à jour peut engendrer des erreurs de timeout (dépassement de temps) s'il y a une grande quantité d'avis de mise à jour dans la base de données. Pour cette raison, la vue runfilter du module de notification ne doit être utilisé qu'à des fins de tests ou de débugage.