Concept

Cette section détaille les différents paramètres qu'il est possible de configurer pour le widget météo.

Accéder à la fenêtre d'édition des paramètres

Pour accéder à la fenêtre de configuration du widget météo, en mode édition, il suffit de cliquer sur la roue crantée ( ) sur le côté droit du widget ( cadre rouge dans l'illustration ).



Édition d'un widget météo

Choisir l'élément

Widget non configuré
Widget configuré





Sur un widget météo non configuré, dans un premier temps, seul le paramétrage de l'élément à lui associer est proposé.

Une fois ce choix effectué, par l'un des deux sélecteurs disponibles ( Nom de l'élément ou Nom de Visualisation ), le reste du formulaire sera affiché.

Les sélecteurs permettent de réduire la liste les éléments proposés en saisissant des caractères à rechercher dans leur nom, ainsi qu'en choisissant le type de l'élément  ( Hôte ou Cluster ).

Il faudra obligatoirement sélectionner un élément parmi les listes proposées.

Pour les widgets configurés, le choix de l'élément est modifiable dès que nécessaire pour les deux sélecteurs.

Il faudra alors obligatoirement définir la valeur d'une des deux propriétés, l'UUID, non-modifiable, et l'autre propriété se mettront à jour une fois le choix effectué.

Nom de l'élément

Permet de choisir l'élément via une liste proposant tous les éléments configurés dans Shinken par leur nom.

  • La valeur est à sélectionner dans une liste de tous les éléments configurés dans Shinken. 
  • Il est possible de filtrer par type d'éléments : hôte ou cluster.
  • Il est possible de chercher en tapant le nom de l'élément désiré.
  • Contraintes :
    • Il n'y a pas de valeur par défaut sur cette propriété, elle doit impérativement être définie ( Shinken la renseignera automatiquement si le nom de visualisation est défini ).
Spécificité
  • Clé dans le JSON = item_name.
Nom de visualisation

Permet de choisir l'élément via une liste proposant tous les éléments configurés dans Shinken par leur nom de visualisation.

  • La valeur est à sélectionner dans une liste de tous les éléments configurés dans Shinken. 
  • Il est possible de filtrer par type d'éléments : hôte ou cluster.
  • Il est possible de chercher en tapant le nom de l'élément désiré.
  • Contraintes :
    • Il n'y a pas de valeur par défaut sur cette propriété, elle doit impérativement être définie ( Shinken la renseignera automatiquement si le nom de l'élément est défini ).
UUID

Permet de définir l'élément directement en saisissant son UUID ( voir la page TIPS - Récupérer l'UUID d'un élément ( Cluster / Hôte / Check ) )

Affichage

Nom

Permet de définir si le widget doit afficher le nom de l'élément, ou son nom de visualisation.

  • Valeurs possibles :
    • Nom de l'élément,
    • Nom de la Visualisation,
    • Par défaut ( une des valeurs ci dessus, en fonction de la configuration ).
Spécificité
  • Clé dans le JSON = property_used_as_name.

Nom de l'élément

Nom de visualisation

Fond

Permet de configurer l'arrière plan ( et la bordure ) du widget en fonction de son contexte et/ou de son statut.

  • Valeurs possibles :
    • Forcé à la configuration de l'Interface de Visualisation,
    • Contexte puis statut,
    • Contexte et statut,
    • Statut uniquement,
    • Pas d'arrière plan,
    • Par défaut ( une des valeurs ci dessus, en fonction de la configuration ).

Le tableau suivant détaille chacune de ces valeurs possibles.

Spécificité
  • Clé dans le JSON = background.
Valeur

Exemple

Commentaire
Forcé à la configuration de l'Interface de Visualisation

Se basera sur le type d'affichage du statut et du contexte configuré pour les portails et les tableaux de bord de l'Interface de Visualisation ( paramètre tiles_background du fichier  webui_cfg_overload.cfg ).
Contexte puis statut

Se basera uniquement sur le contexte de l'élément.
Si l'élément n'a aucun contexte, la couleur de fond se basera sur la couleur du statut.
Contexte et statut

Si l'élément a un contexte, la couleur de fond sera de la couleur du contexte et du statut. Un fond blanc sera affiché afin de pouvoir voir le nom de l'élément et le taux des SLA.
Si l'élément n'a aucun contexte, la couleur de fond se basera sur la couleur du statut.

Statut uniquement

La couleur de fond ne se base que sur la couleur du statut.

Pas d'arrière plan

La couleur de l'arrière plan sera blanche.

La couleur de la bordure sera :

  • celle du contexte s'il y en a un
  • celle du statut sinon

Zones 

Le widget météo est composé de 4 zones :

  • Zone de gauche,
  • Zone du nom,
  • Zone en haut à droite,
  • Zone SLA.

Les deux premières sont obligatoirement affichées, les deux dernières peuvent être cachées.

Les formulaires de type radio En haut à droite et SLA permettent de choisir les options d'affichages de ces deux zones :

  • Valeurs possibles :
    • Affiché,
    • Caché,
    • Par défaut ( soit Affiché, soit Caché, en fonction de la configuration ).

Un aperçu en bas du formulaire permet de se faire une idée du rendu final sur le widget.

Spécificité
  • Clé dans le JSON = displayed.

Exemples avec les zones qui peuvent être cachées 

En haut à droite : Affiché

En haut à droite : Caché

SLA : Affiché

SLA : Caché

Aperçu et configuration par zone

L'aperçu situé dans le formulaire de configuration du widget permet de :

  • voir le rendu visuel du widget suivant les choix de configuration faits,
  • choisir la zone à configurer ( et cacher les autres zones d'affichages )


Ce widget est un aperçu ( il ne contient pas les données réelles de l'élément associé ) : 

  • Le statut est OK (   )
  • Le contexte est Période de maintenance ( )
  • La valeur du SLA est de 100%
  • Le nom de l'élément est "Nom de l'élément"
  • Le nom de visualisation de l'élément est "Nom de visualisation de l'élément"

La taille est prédéfinie pour une visualisation optimale

Configuration des différentes zones

Pour configurer chacune des zones composant le widget, il faut cliquer sur la roue crantée ( ) située sur son coin droit supérieur dans l'aperçu.

Si la roue est violette, cela signifie que la zone est configurée uniquement par des valeurs par défaut. Dans le cas contraire, elle ressortira grise pour indiquer une modification dans la zone.

Après le clic, le formulaire de configuration de la zone choisie est affiché sous l'aperçu.

Zone de gauche

Type d'icône

Permet de choisir quel type icône sera affiché sur la partie de gauche.

  • Contraintes : la valeur choisie ne doit pas être la même que dans la zone en haut à droite.
  • Valeurs possibles :
    • Forcé à la configuration de l'Interface de Visualisation,
    • Statut puis contexte,
    • Contexte puis statut,
    • Statut uniquement,
    • Flèche de tendance SLA,
    • Indicateur de la qualité de service,
    • défaut ( une des valeurs ci dessus, en fonction de la configuration ).
Spécificité
  • Clé dans le JSON = icon_type.
Forcé à la configuration de l'Interface de Visualisation

à sans doute refaire

Se basera sur le type d'affichage du statut et du contexte configuré pour les portails et les tableaux de bord. ( paramètre tiles_background du fichier webui_cfg_overload.cfg )
Statut puis contexte

L'icône du statut sera mise en avant par rapport à celle du contexte.
Contexte puis statut

L'icône du contexte sera mise en avant par rapport à celui du statut.
S'il n'y a aucun contexte présent sur l'élément alors seul le statut sera affiché.

Statut uniquement

Seule l'icône du statut sera affichée.

Flèche de tendance SLA

Affiche la flèche de la tendance SLA en plus grand.

Indicateur de la qualité de service

Affiche l'indicateur de la qualité de service.

Zone en haut à droite

Type d'icône

Permet de choisir quel type icône sera affiché sur la partie en haut à droite.

  • Contraintes : la valeur choisie ne doit pas être le même que dans la zone de gauche.
  • Valeurs possibles :
    • Forcé à la configuration de l'Interface de Visualisation,
    • Statut puis contexte,
    • Contexte puis statut,
    • Statut uniquement,
    • Indicateur de la qualité de service,
    • Par défaut ( une des valeurs ci dessus, en fonction de la configuration ).
Spécificité
  • Clé dans le JSON = icon_type.
Forcé à la configuration de l'Interface de Visualisation

Se basera sur le type d'affichage du statut et du contexte configuré pour les portails et les tableaux de bord. ( paramètre tiles_background du fichier webui_cfg_overload.cfg )
Statut puis contexte

 L'icône du statut sera mise en avant par rapport à celle du contexte.

Contexte puis statut

L'icône du contexte sera mise en avant par rapport à celui du statut.
S'il n'y aucun contexte présent sur l'élément alors seul le statut sera affiché.

Statut uniquement

Seul l'icône du statut va être affiché.

 Indicateur de la qualité de service

Affiche l'icône de qualité de service


Zone SLA

Afficher l'icone

Permet d'afficher ou non l'icône de qualité de service sur la zone SLA.

  • Valeurs possibles :
    • Affiché ;
    • Caché ;
    • Par défaut ( soit Affiché, soit Caché, en fonction de la configuration ).
Spécificité
  • Clé dans le JSON = show_icon .

Affiché

Caché

Zone du nom

Alignement vertical

Permet de définir le positionnement vertical du nom dans le widget.

  • Valeurs possibles :
    • Haut ( placé en haut ),
    • Milieu ( placé au centre ),
    • Bas ( placé en bas ),
    • Par défaut ( une des valeurs ci dessus, en fonction de la configuration ).
Spécificité
  • Clé dans le JSON = vertical_align.

Haut

Bas

Zoom du texte

Permet de changer la taille de la police du nom ( en pourcentage ).

  • Contraintes : doit être un pourcentage ( ex: 25 pour 25%, 300 pour 300% ).
  • Remarque :
    • une valeur trop petite rendra le texte illisible.
    • une valeur trop grande peut entrainer un troncage du nom ( si jamais il devait dépasser de la taille du widget météo ).
Spécificité
  • Clé dans le JSON = font_zoom_percent.

Zoom du texte : 100

Zoom du texte : 120

Nombre de lignes max

Permet de changer le nombre maximal de lignes sur lesquelles afficher le nom.

  • Contraintes : doit être un nombre entier positif.
  • Remarque :
    • une valeur trop petite peut aboutir à un troncage du nom 
Spécificité
  • Clé dans le JSON = nb_lines_max.

Nombre de lignes max : 1

Nombre de lignes max : 2