5.13. Notifications

Les notifications sont une fonctionnalité de Bugzilla qui peut venir ennuyer régulièrement les utilisateurs à des moments spécifiés. En utilisant cette fonctionnalité, les utilisateurs peuvent exécuter des recherches enregistrées à des moments spécifiques (c-à-d. le 15 du mois à minuit) ou à intervalles réguliers (c-à-d. toutes les 15 minutes le dimanche). Les résultats de la recherche sont envoyés à l'utilisateur, soit dans un seul courriel, soit un courriel par bogue, accompagné d'un texte descriptif.

Avertissement

Dans cette section, il sera supposé que tous les utilisateurs sont membres du groupe « bz_canusewhines », appartenance de groupe nécessaire pour pouvoir utiliser le système de notifications. Vous pouvez facilement rendre tous les utilisateurs membres du groupe « bz_canusewhines » en définissant l'expression régulière d'utilisateur à « .* » (sans les guillemets).

Il est important aussi de mentionner le groupe « bz_canusewhineatothers ». Les membres de ce groupe peuvent créer des notifications pour tout utilisateur ou groupe dans Bugzilla en utilisant un formulaire étendu dans l'interface des notifications. Les fonctionnalités seulement disponibles pour les membres du groupe « bz_canusewhineatothers » seront notées aux endroits appropriés.

Note

Pour que les notifications fonctionnent, un script Perl spécial doit être exécuté à intervalles réguliers. Plus de détails sont disponibles dans Section 2.3.3.

Note

Cette section ne couvre pas le script whineatnews.pl. Consultez Section 2.3.2 pour plus d'informations sur la programmation des notifications.

5.13.1. Évènement

Le système de notifications définit un « événement » comme une ou plusieurs requêtes exécutées à intervalles réguliers, dont les résultats (s'il y en a) sont envoyées par courriel à l'utilisateur. Les événements sont créés en cliquant sur le bouton « Ajouter un événement ».

Quand le nouvel événement est créé, la première chose à faire est de définir la « Ligne de sujet du courriel ». Le contenu de ce champ sera utilisé dans le sujet de tous les courriels générés par cet événement. En plus du paramétrage de la ligne du sujet, un emplacement est prévu pour saisir un description qui sera incluse au début de chaque message (pour indiquer pourquoi vous recevez ce courriel).

L'étape suivante consiste à indiquer quand l'événement doit être exécuté (« Programmation ») et quelles recherches doivent être faites (« Requêtes »).

5.13.2. Programmation des notifications

Chaque événement de notification est associé à zéro ou plus programmations. Une programmation est utilisée pour indiquer quand la requête (spécifiée dessous) doit être exécutée. Un nouvel événement est créé sans programmation (ce qui signifie qu'il ne sera jamais exécuté, car il n'est pas programmé). Pour ajouter une programmation, cliquez sur le bouton « Ajouter une nouvelle programmation ».

Chaque programmation utilise un intervalle que vous utilisez pour dire à Bugzilla quand l'événement doit être exécuté. Un événement peut être exécuté certains jours de la semaine, certains jours du mois, pendant les jours ouvrables (du lundi au vendredi) ou chaque jour.

Avertissement

Faites attention si vous définissez votre événement pour qu'il soit exécuté le 29, le 30 ou le 31 du mois, car il pourrait ne pas s'exécuter exactement comme prévu. Si vous voulez que votre événement s'exécute le dernier jour du mois, sélectionnez l'intervalle « Le dernier jour du mois ».

Quand vous avez spécifié le ou les jours pendant lesquels l'événement doit être exécuté, vous devez alors indiquer l'heure de l'exécution de l'événement. Vous pouvez exécuter l'événement à une certaine heure du ou des jours spécifiés, ou chaque heure, demie-heure ou quart d'heure du ou des jours spécifiés.

Si une programmation ne s'exécute pas aussi souvent que vous le voudriez, vous pouvez créer une autre programmation pour le même événement. Par exemple, si vous voulez exécuter un événement les jours dont les dates sont divisible par sept, vous devrez ajouter quatre programmations à l'événement, déclenchées les 7, 14, 21 et 28 du mois (un jour par programmation) à l'heure ou à chaque intervalle de temps choisi.

Note

Si vous êtes membre du groupe « bz_canusewhineatothers », vous aurez alors une option supplémentaire : « Envoyer à ». En utilisant ceci, vous pouvez contrôler qui recevra les courriels générés par cet événement. Vous pouvez choisir d'envoyer les courriels à un seul utilisateur (identifié par l'adresse électronique) ou à un groupe (identifié par le nom du groupe). Pour envoyer les courriels à plusieurs utilisateurs ou groupes, créez une nouvelle programmation pour chaque utilisateur ou groupe supplémentaire.

5.13.3. Requêtes de notifications

Chaque notification est associée à zéro ou plus requêtes. Une requête est toute recherche enregistrée à exécuter dans la programmation spécifiée (voir plus haut). Un nouvel événement est créé sans requête associée (ce qui signifie que l'événement ne sera jamais exécuté car il n'y aura jamais de résultats à renvoyer). Pour ajouter une requête, cliquez sur le bouton « Ajouter une nouvelle requête ».

Le premier champ à examiner dans votre nouvelle requête ajoutée est le champ « Ordre ». Les requêtes sont exécutées et les résultats inclus dans l'ordre indiqué par le champ « Ordre ». Les requêtes ayant des valeurs faibles pour le champ « Ordre » seront exécutées avant celles ayant des valeurs élevées pour ce champ.

Le champ suivant à examiner est le champ « Requête ». C'est l'endroit où vous choisissez la requête à exécuter. Plutôt que de définir les paramètre de recherche ici, il vous est demandé de choisir dans la liste des recherches enregistrées (la même liste apparaît dans le pied de chaque page de Bugzilla). Vous n'êtes autorisé à choisir que les recherches que vous avez enregistré vous-même (le recherche enregistrée par défaut, « Mes bogues » n'est pas un choix valide). Si vous n'avez pas de recherches enregistrées, profitez de cette opportunité pour en créer une (voir Section 5.5.4).

Note

Lors de l'exécution des requêtes, le système de notifications agit comme si vous étiez l'utilisateur exécutant la requête. Ce qui signifie que le système de notifications ignorera les bogues correspondant à votre requête pour lesquels vous n'avez pas d'accès.

Quand vous avez choisi la recherche enregistrée à exécuter, donnez à la requête un titre descriptif. Ce titre apparaîtra dans le courriel, au-dessus des résultats de la requête. Si vous choisissez « Un message par bogue », le titre de la requête apparaîtra en haut de chaque courriel qui contient un bogue correspondant à votre requête.

Enfin, décidez si les résultats de votre requête doivent être envoyés dans un seul courriel ou si chaque bogue doit apparaître dans son propre courriel.

Avertissement

Réfléchissez soigneusement avant de cocher la case « Un message par bogue ». Si vous créez une requête qui correspond à des milliers de bogues, vous recevrez des milliers de courriels !

5.13.4. Enregistrement des modifications

Quand vous avez terminé de définir une programmation et de créer au moins une recherche enregistrée, cliquez sur le bouton « Mettre à jour/Appliquer ». Ceci enregistrera votre événement et le rendra disponible pour une exécution immédiate.

Note

Si vous voulez supprimer un événement, vous pouvez le faire en utilisant le bouton « Supprimer l'événement » dans le coin supérieur droit de chaque événement. Vous pouvez aussi modifier un événement existant en cliquant sur le bouton « Mettre à jour/Appliquer » après avoir terminé vos modifications.