Commit cd39855f authored by Donovan Watteau's avatar Donovan Watteau

Merge branch 'doc/template-variable-changes' into 'develop'

doc/template-variables-changes

See merge request !641
parents 7540e221 91ebd5f0
Pipeline #4434 passed with stage
in 1 minute and 50 seconds
......@@ -14,7 +14,8 @@
### Guide exploitant
1. [Paramètres du widget](#parametres-du-widget)
1. [Aide sur les variables](#aide-variables)
2. [Paramètres du widget](#parametres-du-widget)
## Guide utilisateur
......@@ -72,7 +73,7 @@ Le filtre par période permet de filtre les alarmes en ne conservant que les ala
Ce filtre est disponible en cliquant sur l'icone ![Filtre par période](./img/period-filter.png "Filtre par période") présente à droite du sélecteur de filtre. Une fenêtre apparaît.
![Modal filtre par période](./img/modal-filtre-periode.png "Modal filtre par période")
![modale filtre par période](./img/modal-filtre-periode.png "modale filtre par période")
Il suffit alors de sélectionner la période souhaitée parmi les périodes prédéfinies, ou d'en créer une personalisé en sélectionnant 'Personnalisé', puis en renseignant les dates de début et de fin.
Cliquez ensuite sur 'Appliquer'.
......@@ -98,6 +99,20 @@ Le choix par défaut est réglable dans les paramètres du bac à alarmes (*Cf:
## Guide exploitant
### Aide - Variables
Durant la configuration de votre widget Bac à alarmes, notamment paramètres "Info popup", et "Fenêtre Plus d'infos", il vous sera possible d'accéder à des variables concernant les alarmes et les entités.
Exemple: Il vous sera possible d'afficher, dans la fenêtre "Plus d'infos", l'état de l'alarme.
Afin de connaitre les variables disponibles, une modale d'aide est disponible.
Pour y accèder, entrez dans le mode d'édition (*Cf: [Vues - Mode d'édition](../../vues#mode-edition)*).
Un bouton d'action supplémentaire "Liste des variables disponibles" apparaît alors pour chaque alarme.
Au clic sur ce bouton, une fenêtre s'ouvre. Celle-ci liste toutes les variables disponibles dans vos différents paramètres. Un bouton, à droite de chacune des variables, vous permet de copier directement dans le Presse-papier le chemin de cette variable.
### Paramètres du widget
1. Taille du widget
......@@ -152,12 +167,12 @@ Ce paramètre permet de définir quels colonnes seront affichées dans le bac à
Afin d'**ajouter une colonne**, cliquez sur le bouton 'Ajouter'.
Une colonne vide est alors ajoutée. Afin de finaliser l'ajout, il est nécessaire de remplir les champs demandés.
Le champ "Label" définit le nom de la colonne, qui sera affiché en haut de tableau. Le champ "Valeur" définit la valeur que doit prendre ce champ. Tous les champs de l'alarme et de l'entité concernée par l'alarme peuvent être utilisés, en préfixant le nom du champ par "alarm" ou "entity".
Le champ "Label" définit le nom de la colonne, qui sera affiché en haut de tableau. Le champ "Valeur" définit la valeur que doit prendre ce champ. Tous les champs de l'alarme et de l'entité concernée par l'alarme peuvent être utilisés.
Exemple : Pour ajouter une colonne ayant pour label "Composant" et pour valeur le nom du composant, renseignez les champs comme suit :
* Label : "Composant"
* Valeur : "alarm.component"
* Valeur : "alarm.v.component"
Pour supprimer une colonne, cliquez dans la liste des colonnes sur la croix rouge présente en haut à droite de la case de la colonne que vous souhaitez effacer.
......@@ -202,8 +217,8 @@ Une case info popup vide apparaît.
Cette case comporte deux champs :
* Colonne : Ce champ permet de définir sur quelle colonne l'info popup sera disponible. Il faut ici entrer la **valeur** de la colonne, et non son nom.
Exemple : pour ajouter une info popup sur la colonne que vous avez nommée "Connecteur", avec comme valeur "v.connector" (*Cf: [Paramètre "Nom des colonnes"](#nom-des-colonnes)*), il faut entrer ici "v.connector" et non "Connecteur".
* Texte : Ce champ, qui a la forme d'un éditeur de texte, permet de définir le contenu de l'info popup. Le langage utilisé ici pour le template de la popup est l'Handlebar. Deux variables sont disponibles : "alarm" et "entity". Exemple : Pour ajouter au template l'état de l'alarme, ajoutez au template `{{ alarm.state.val }}`.
Exemple : pour ajouter une info popup sur la colonne que vous avez nommée "Connecteur", avec comme valeur "alarm.v.connector" (*Cf: [Paramètre "Nom des colonnes"](#nom-des-colonnes)*), il faut entrer ici "alarm.v.connector" et non "Connecteur".
* Texte : Ce champ, qui a la forme d'un éditeur de texte, permet de définir le contenu de l'info popup. Le langage utilisé ici pour le template de la popup est l'Handlebar. Deux variables sont disponibles : "alarm" et "entity". Exemple : Pour ajouter au template l'état de l'alarme, ajoutez au template `{{ alarm.v.state.val }}`.
Vous pouvez ajouter autant d'info popup que vous le souhaitez.
......@@ -219,4 +234,4 @@ Deux variables sont disponibles ici, 'alarm' et 'entity'.
En plus du texte que vous souhaitez afficher, il vous est donc possible d'intégrer des informations de l'alarme ou de l'entité concernée par cette alarme.
Exemple : Pour afficher l'état de l'alarme, ajoutez `{{ alarm.state.val }}`.
Exemple : Pour afficher l'état de l'alarme, ajoutez `{{ alarm.v.state.val }}`.
......@@ -14,7 +14,8 @@
6. [Comportements périodiques](#comportements-periodiques)
### Guide exploitant
1. [Paramètres du widget](#parametres-du-widget)
1. [Aide sur les variables](#aide-variables)
2. [Paramètres du widget](#parametres-du-widget)
## Guide utilisateur
......@@ -132,6 +133,18 @@ Pour ajouter un comportement périodique sur une sélection d'entités, sélecti
## Guide exploitant
### Aide - Variables
Durant la configuration de votre widget Exporateur de contexte, notamment la liste des colonnes, il vous sera possible d'accéder à des variables concernant les entités.
Afin de connaitre les variables disponibles, une modale d'aide est disponible.
Pour y accéder, entrez dans le mode d'édition (*Cf: [Vues - Mode d'édition](../../vues#mode-edition)*).
Un bouton d'action supplémentaire "Liste des variables disponibles" apparaît alors pour chaque entité du tableau.
Au clic sur ce bouton, une fenêtre s'ouvre. Celle-ci liste toutes les variables disponibles dans vos différents paramètres. Un bouton, à droite de chacune des variables, vous permet de copier directement dans le Presse-papier le chemin de cette variable.
### Paramètres du widget
1. Taille du widget
......
......@@ -10,7 +10,8 @@
3. [La modale](#la-modale)
### Guide exploitant
1. [Paramètres du widget](#parametres-du-widget)
1. [Aide sur les variables](#aide-variables)
2. [Paramètres du widget](#parametres-du-widget)
## Guide utilisateur
### Présentation générale
......@@ -84,6 +85,21 @@ Au clic sur les icônes d'actions, celles-ci sont mises en attente. Elles ne son
- ![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
### Aide - Variables
Durant la configuration de votre widget Météo de services, notamment les Templates, il vous sera possible d'accéder à des variables concernant les observateurs.
Exemple: Il vous sera possible d'afficher, pour chacune des tuiles de la météo de services, le nom de l'observateur, ou son identifiant, etc.
Afin de connaitre les variables disponibles, une modale d'aide est disponible.
Pour y accéder, entrez dans le mode d'édition (*Cf: [Vues - Mode d'édition](../../vues#mode-edition)*).
Un bouton d'aide apparaît alors sur chacune des tuiles de la Météo de service.
Au clic sur ce bouton, une fenêtre s'ouvre. Celle-ci liste toutes les variables disponibles dans vos différents templates. Un bouton, à droite de chacune des variables, vous permet de copier directement dans le Presse-papier le chemin de cette variable.
### Paramètres du widget
1. Taille du widget
2. Titre
......@@ -135,13 +151,27 @@ Le langage utilisé ici est le Handlebars.
Cliquez sur le bouton 'Afficher/Editer'. Une fenêtre s'ouvre avec un éditeur de texte. Entre le texte souhaité pour le template des tuiles, puis cliquez sur 'Envoyer'.
Une variable est disponible ici pour vous permettre d'affiché les détails de l'observateur : `watcher`.
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 }}`.
Une variable est disponible ici pour vous permettre d'afficher les détails de l'observateur : `entity`.
Exemple : Pour afficher le champ `display_name` de l'observateur (qui correspond au nom de l'observateur), il vous faut écrire dans le template : `{{ entity.display_name }}`.
Tous les champs disponibles dans l'observateur sont disponibles ici.
##### Template - modale
##### Template - Modale
Ce paramètre permet de personnaliser les informations affichées dans la fenêtre 'Plus d'infos' (ouverte au clic sur 'Plus d'infos', sur une des tuiles de la météo de services).
Il vous est possible ici d'afficher, à n'importe quel endroit de la modale, la liste des entités concernées par l'observateur sur lequel vous avez cliqué. Pour ce faire, insérez dans le template:
```
{{ entities }}
```
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).
Cela aura pour effet d'insérer dans la modale la liste des entités. Par défaut, le nom de l'entité sera affiché pour chacune d'entre elles. Il vous est possible de modifier la valeur affichée ici. Tous les champs de l'entité sont disponibles. Pour ce faire, ajoutez un argument ```name``` à la balise précédemment ajoutée. Il vous est donc possible d'écrire, par exemple :
```
{{ entities name="_id" }}
```
Pour chaque entité de la liste, l'id de l'entité sera affiché, à la place de son nom.
Celui-ci fonctionne de la même manière que le paramètre Template - Tuile présenté ci-dessus. Cliquez [ici](#template-tuile) pour vous rendre à cette partie.
......@@ -149,6 +179,8 @@ Celui-ci fonctionne de la même manière que le paramètre Template - Tuile pré
Ce paramètre permet de personnaliser les informations affichées pour chaque entités dans la fenêtre 'Plus d'infos' (ouverte au clic sur 'Plus d'infos', sur une des tuiles de la météo de services).
**Attention: La liste des entités n'est affichée que si cela a été précisé dans le [Template - Modale](#template-modale).**
Le langage utilisé ici est le Handlebars.
Cliquez sur le bouton 'Afficher/Editer'. Une fenêtre s'ouvre avec un éditeur de texte. Entre le texte souhaité pour le template des tuiles, puis cliquez sur 'Envoyer'.
......
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