Commit 7540e221 authored by Donovan Watteau's avatar Donovan Watteau 🎲

Merge branch 'doc/weather-updates' into 'develop'

doc/weather-updates

See merge request !644
parents 4b963012 72b4b9cc
Pipeline #4428 passed with stage
in 1 minute and 38 seconds
......@@ -7,8 +7,7 @@
### Guide utilisateur
1. [Présentation générale](#presentation-generale)
2. [Les tuiles](#les-tuiles)
3. [La fenêtre 'Plus d'infos'](#la-fenetre-plus-dinfos)
4. [Les détails d'une entité d'un service](#les-details-dune-entite-dun-service)
3. [La modale](#la-modale)
### Guide exploitant
1. [Paramètres du widget](#parametres-du-widget)
......@@ -27,31 +26,62 @@ Le contenu de texte de cette tuile est personnalisable (*Cf: [Guide exploitant](
La couleur de la tuile et l'icône présente sur celle-ci permettent d'obtenir des informations sur **l'état** de l'observateur:
### 1. La couleur
#### La couleur
La couleur de la tuile correspond à l'état de l'observateur. Cet état est calculé en prenant en compte le pire état parmi les entités surveillées par cet observateur.
Exemple :
Un observateur surveille deux entités, A et B. A a un état de 1. B a un état de 3. L'état de l'observateur sera alors égal à 3.
- Vert : Etat = 0 => Ok
- Jaune : Etat = 1 => Mineur
- Orange : Etat = 2 => Majeur
- Rouge : Etat = 3 => Critique
- Gris :
- Vert: Etat = 0 => Ok
- Jaune: Etat = 1 => Mineur
- Orange: Etat = 2 => Majeur
- Rouge: Etat = 3 => Critique
- Gris: L'observateur (ou toutes les entités de l'observateur) possède un comportement périodique actif (pause, maintenance, ...).
### 2. L'icone
#### L'icone
- Soleil
- Soleil + Nuage
- Nuage
- Pluie
- Clé
- Lune
- Pause
- Soleil: L'observateur possède un état "Ok" (égal à 0)
- Personne: L'observateur possède un état Mineur (égal à 1) ou Majeur (égal à 2)
- Nuage: L'observateur possède un état: "Critique" (égal à 3)
- Clé: L'observateur possède un comportement périodique actif, de type "Maintenance"
- Lune: L'observateur possède un comportement périodique actif, de type "Hors plage de surveillance"
- Pause: L'observateur ne possède pas de comportement périodique, mais toutes les entités liées à cet observateur possèdent un comportement périodique actif.
### La fenêtre 'Plus d'infos'
### Les détails d'une entité d'un service
#### Le clignotement
Une tuile de la météo de service clignotera si une des entités lui appartenant possède une alarme non acquittée, et que celui-ci n'est pas en pause/ne possède pas d'entité en pause.
### La modale
Au clic sur une tuile de la météo de services, une fenêtre s'ouvre.
Le contenu de cette fenêtre est configurable depuis les paramètres du widget.
Celle-ci contient, au choix :
- "Plus d'infos": Cette fenêtre présente des informations supplémentaires concernant l'observateur sur lequel vous avez cliqué. Celle-ci peut, notamment, contenir la liste des entités concernées par l'observateur. Le template de cette fenêtre est configurable depuis les paramètres du widget.
![modale - Plus d'infos](./img/modal_more_infos.png "modale - Plus d'infos")
- "Bac à alarmes": Cette fenêtre contient un widget Bac à alarmes. Ce Bac à alarmes regroupe toutes les alarmes dans le spectre de l'observateur. Celui-ci est configurable depuis les paramètres du widget.
![modale - Bac à alarmes](./img/modal_alarmlist.png "modale - Bac à alarmes")
### Les actions
Dans [la modale "Plus d'infos"](#la-modale), il vous est possible d'afficher la liste des entités concernées par l'observateur (*Cf: [Template - modale](#template-modale)*).
Si la liste d'entités est affichée, des actions sont disponibles sur chacune d'entre elles. Les actions disponibles dépendent de l'état de l'entité.
Au clic sur les icônes d'actions, celles-ci sont mises en attente. Elles ne sont exécutées qu'au clic sur le bouton ```Envoyer``` de la modale "Plus d'infos".
- ![Action: Déclarer un incident](./img/action_declareTicket.png "Action: Déclarer un incident") *Déclarer un incident*: Cette action vous permet de déclarer un numéro de ticket, associé à un incident. Au clic sur cette action, une fenêtre s'ouvre, vous permettant d'indiquer un numéro de ticket. Cette action déclenche également automatiquement une action d'acquittement.
- ![Action: Pause](./img/action_pause.png "Action: Pause") *Pause*: Cette action vous permet de mettre une entité en pause. Au clic, une fenêtre s'ouvre. Celle-ci vous permet de renseigner un commentaire, ainsi que la raison de la pause. Cette action n'est disponible que pour les entités qui ne sont pas déjà en pause.
- ![Action: Play](./img/action_play.png "Action: Play") *Play*: Cette action vous permet de retirer la mise en pause d'une entité. Cette action n'est disponible que pour les entités en pause.
- ![Action: acquittement](./img/action_ack.png "Action: acquittement") *Acquittement*: Cette action vous permet d'acquitter une alarme présente sur une entité. Cette action n'est disponible que pour les entités ayant un état différent de "Ok" (0), et ayant une alarme non acquittée.
- ![Action: Validate](./img/action_validate.png "Action: Validate") *Valider*: Cette action déclenche un changement d'état de l'alarme, de majeur (2) à critique (3). Elle entraîne également automatiquement une action d'acquittement. Celle-ci n'est disponible que pour les entités ayant un état majeur (2).
- ![Action: Invalidate](./img/action_invalidate.png "Action: Invalidate") *Invalider*: Cette action déclenche une action d'annulation de l'alarme. Elle entraîne également automatiquement une action d'acquittement. Celle-ci n'est disponible que pour les entités ayant un état majeur (2).
## Guide exploitant
### Paramètres du widget
......@@ -59,12 +89,15 @@ Un observateur surveille deux entités, A et B. A a un état de 1. B a un état
2. Titre
3. Editeur de filtre
4. Paramètres avancés
1. Template - Tuiles
2. Template - Modal
3. Template - Entités
4. Colonnes - Petit
5. Colonnes - Moyen
6. Colonnes - Large
1. Template - Tuiles
2. Template - modale
3. Template - Entités
4. Colonnes - Petit
5. Colonnes - Moyen
6. Colonnes - Large
7. Marges
8. Hauteur
9. Type de modale
#### Taille du widget (*requis*)
......@@ -106,7 +139,7 @@ Une variable est disponible ici pour vous permettre d'affiché les détails de l
Exemple : Pour afficher le champ `display_name` de l'observateur (qui correspond au nom de l'observateur), il vous faut écrire dans le template : `{{ watcher.display_name }}`.
Tous les champs disponibles dans l'observateur sont disponibles ici.
##### Template - Modal
##### Template - modale
Ce paramètre permet de personnaliser les informations affichées en haut de la fenêtre 'Plus d'infos' (ouverte au clic sur 'Plus d'infos', sur une des tuiles de la météo de services).
......@@ -141,3 +174,30 @@ Il suffit de faire glisser le curseur pour sélectionner le nombre de colonne pa
Ce paramètre permet de définir la proportion de l'écran, en largeur, prise par chaque tuile de la météo de services. Ce paramètre concerne les écrans d'ordinateurs (largeur > 900px). Une tuile occupe au minimum une colonne (1/12 de la largeur de la page), et au maximum 12 colonnes (100 % de la largeur de la page).
Il suffit de faire glisser le curseur pour sélectionner le nombre de colonne par tuile souhaité.
##### Marges
Ce paramètre permet de régler les espaces séparant les tuiles de la Météo de services.
Celui-ci est séparé en quatre, vous permettant de régler l'espace que vous souhaitez pour chaque côté des tuiles (haut, bas, droite et gauche).
Pour modifier ce paramètre, faites glisser le sélecteur, afin de choisir une valeur entre 0 et 5 (0 correspondant à l'absence de marge, 5 le maximum de marge).
Par défaut, ce paramètre est réglé sur une valeur de 1 pour chacuns des côtés des tuiles.
##### Hauteur
Ce paramètre permet de régler la hauteur des tuiles de la Météo de services.
Pour le modifier, faites glisser le sélecteur, afin de choisir une valeur entre 1 (hauteur minimale) et 20 (hauteur maximale).
Par défaut, ce paramètre est réglé sur une valeur de 1.
##### Type de modale
Ce paramètre vous permet de sélectionner le type de modale que vous souhaitez ouvrir au clic sur une tuile de la Météo de services.
Les types de modale disponibles sont :
- "Plus d'infos": Cette modale vous permet d'afficher (grâce à un template configurable) des détails supplémentaires sur l'observateur sur lequel vous cliquez.
- "Bac à alarmes": Cette modale vous permet d'afficher un widget Bac à alarmes, regroupant les alarmes liées à l'observateur. Ce widget est configurable grace aux [Paramètres du bac à alarmes](#parametres-du-bac-a-alarmes).
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment