| Scroll Ignore | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||
|
Présentation - Widget Météo
Un widget météo permet d'afficher des informations clés sur un service en particulier ( hôte ou cluster ).
( voir la page Widget Météo - Détail - Météo )
Description
Pour le Un widget météo, il est composé possible de ces informations configurer :
- le nom du service ;
- le statut et son contexte ( s'il en a ) ;
- la valeur du SLA ;
- la tendance actuelle du SLA ( ascendante ou descendante ) ;
| Info |
|---|
Pour plus d'informations sur les widgets météo, référez-vous à la page HIDDEN - V02.08.02 - Widget Météo - Détail - Météo |
Description
Pour un widget météo il faut configurer :
- sa position X, Y, largeur et hauteur;
- son service ( nom ou identifiant )
Configuration
- Sa position dans la grille : positionnement sur l'axe des abscisses ( axe x ) et des ordonnées ( axe y ).
- Sa taille : largeur et hauteur.
- La couleur de son arrière-plan: ( Couleur du contexte, du statut, des deux… )
- Sa partie gauche :
- Le type d’icône à afficher
- Sa partie en haut à droite :
- L'afficher ou la cacher,
- Le type d’icône à afficher.
- Sa partie réservée au texte :
- Le type de nom de l'élément à afficher,
- Le nombre de lignes maximum que le texte peut prendre,
- L'alignement vertical du texte,
- Le pourcentage du zoom de la taille de la police.
- Sa partie réservée pour les SLA:
- L'afficher ou la cacher,
- afficher ou cacher l’icône SLA.
Configuration
| Code Block | ||||
|---|---|---|---|---|
| ||||
| Code Block | ||||
| ||||
... "grid_elements": [ { "position_x" : 300, "position_y" : 34, "width" : 15, "height" : 5, : 3, "content" : { "type" : "weather_widget", "item" : { "item_uuid" : "50589d91a4ff11e7b9eff8bc12640001c618793e4e3a4a599d6f1cd3bf2a16fd", "item_typename" : "hostVMWARE_HOST_BORDEAUX_SUDOUEST", "item_nametype" : "MVP_VMWARE_VCENTER_HEALTH_SUDOUESThost" } } } ] ... |
Positionnement et Dimensionnement
| Code Block | ||||
|---|---|---|---|---|
| ||||
... "grid_elements": [ { "position_x": 30 }, "layout" : { "background" : "default", "position_y": 3, "information_to_display" : { "width" "left_area" : { : 15, "height" "icon_type" : 3, ..."status_then_context" } ] ... |
| Code Block |
|---|
position_x |
---
Abscisse du point "le plus en haut à gauche" d'un widget :
- Correspond à la case numéro X dans la largeur de la grille;
- Doit obligatoirement être défini.
| Code Block |
|---|
position_y |
Ordonnée du point "le plus en haut à gauche" d'un widget :
- un nombre => Correspond à la case numéro Y dans la hauteur de la grille;
- Doit obligatoirement être défini.
| Code Block |
|---|
width |
Correspond à la largeur du widget :
- un nombre, entre 1 et le nombre de cases en largeur de la grille;
- "all" => Pour prendre toute la largeur de la page :
- Dans ce cas, sa "position_x" devra être 0.
- "default" => la valeur sera calculée avec le système de "Calcul de la valeur en cascade" ( voir la page HIDDEN - V02.08.02 - Concept et paramétrage des widgets - Edition - Météo ).
| Code Block |
|---|
height |
Correspond à la hauteur du widget :
- un nombre, non limité, car la hauteur de la grille n'est pas limité;
- "default" => la valeur sera calculée avec le système de "Calcul de la valeur en cascade" ( voir la page HIDDEN - V02.08.02 - Concept et paramétrage des widgets - Edition - Météo ).
Si le paramètre "height" n'est pas présent dans la configuration du widget, c'est comme s'il valait "default".
Contenu du widget météo
| Code Block | ||||
|---|---|---|---|---|
| ||||
... "grid_elements": [ { ... , "top_right_area" : { "displayed" : false, "icon_type" : "quality_service_icon" }, "sla_area" : { "displayed" : true, "show_icon" : true }, "name_area" : { "property_used_as_name" : "visualisation_name", "nb_lines_max" : 2, "content" : { "vertical_align" : "middle", "type" : "weather_widget", "itemfont_zoom_percent" : { ... } 100 } } } } } } ] ... |
Positionnement et Dimensionnement
Type| Code Block |
|---|
|
|
|
|
Type du widget, dans le cas du widget météo ce paramètre doit être obligatoirement défini à la valeur : weather_widget.
| Code Block |
|---|
item |
Permet de définir quel élément va être affiché ( voir le chapitre Identification du service de la widget ).
| Code Block |
|---|
property_used_as_name |
| Info |
|---|
Le paramètre n'est pas configurable sur le widget même, car pour des questions de cohérence, la propriété qui sera utilisée comme nom sera la même sur l'ensemble de la météo. ( Voir le chapitre Définir les valeurs par défaut des widgets météo ). |
| Code Block |
|---|
state_icon |
| Info |
|---|
Le paramètre n'est pas configurable sur le widget même, car pour des questions de cohérence, la propriété qui sera utilisée comme nom sera la même sur l'ensemble de la météo. ( Voir le chapitre Définir les valeurs par défaut des widgets météo ). |
| Code Block |
|---|
background |
| Info |
|---|
Le paramètre n'est pas configurable sur le widget même, car pour des questions de cohérence, la propriété qui sera utilisée comme nom sera la même sur l'ensemble de la météo. ( Voir le chapitre Définir les valeurs par défaut des widgets météo ). |
| Code Block |
|---|
display_sla |
| Info |
|---|
Le paramètre n'est pas configurable sur le widget même, car pour des questions de cohérence, les SLA sont affichées ou cachées sur l'ensemble de la météo. ( Voir le chapitre Définir les valeurs par défaut des widgets météo ). |
Identification du service de la widget
| Code Block | ||||
|---|---|---|---|---|
| ||||
...
"item": {
"item_uuid" : "50589d91a4ff11e7b9eff8bc12640001",
"item_type" : "host",
"item_name" : "MVP_VMWARE_VCENTER_HEALTH_SUDOUEST"
}
... |
| ||
...
"grid_elements": [
{
"position_x": 0,
"position_y": 4,
"width" : 15,
"height" : 5,
...
}
]
... |
| Nom | Type | Défaut | Commentaire | ||
|---|---|---|---|---|---|
| Numéro de cellule | --- | Abscisse du point "le plus en haut à gauche" d'un widget :
| ||
| Numéro de cellule | --- | Ordonnée du point "le plus en haut à gauche" d'un widget :
| ||
| Nombre de cellules | --- | Correspond à la largeur du widget :
Si le paramètre "width" n'est pas présent dans la configuration du widget, c'est comme s'il valait "default". | ||
| Nombre de cellules | --- | Correspond à la hauteur du widget :
Si le paramètre "height" n'est pas présent dans la configuration du widget, c'est comme s'il valait "default". |
| Anchor | ||||
|---|---|---|---|---|
|
Contenu du widget météo
Le Widget Météo est divisé en quatre zones:
- La zone de gauche ( obligatoire ).
- La zone du nom de l'élément ( obligatoire ).
- La zone en haut à droite ( optionnelle ).
- La zone SLA ( optionnelle ).
Chaque zone possède sa propre configuration.
| Panel |
|---|
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
...
|
| Code Block |
|---|
item_uuid |
L'identifiant du service ( uuid ) si défini le contenu de "item_name" sera ignoré
| Code Block |
|---|
item_type |
Le type du service ( host ou cluster );
| Code Block |
|---|
item_name |
Le nom de l'élément Shinken ( propriété host_name ). Si aucun identifiant "item_uuid" n'est défini, l'élément sera recherché par le nom de l'élément
Exemple
| Code Block | ||||
|---|---|---|---|---|
| ||||
... "grid_elements": [ ... { "position_x": 30, "position_y": 3, "width" : 15, "height" : 3, ... "content" : { "type" : "weather_widget", "item" : { "item_uuid... }, "layout" : "50589d91a4ff11e7b9eff8bc12640001",{ "item_type "background" : "hostdefault", "iteminformation_to_namedisplay" : "MVP_VMWARE_VCENTER_HEALTH_SUDOUEST" { "left_area" : { } } ... }, ... ] ... |
La configuration ci-dessus correspond à la configuration du widget météo encadré en bleu dans l'image ci-dessous.
| Panel |
|---|
"top_right_area" : {
...
},
"sla_area" : {
...
},
"name_area" : {
...
}
}
}
}
}
]
... |
| Nom | Type | Défaut | Commentaire | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| String | - | Type du widget, dans le cas du widget titre ce paramètre doit être obligatoirement défini à la valeur : weather_widget . | ||||||||||||||||||||||||||||||
| Clé | - | Permet d'indiquer quel élément de la configuration va être affiché. | ||||||||||||||||||||||||||||||
| Clé | - | Permet de paramétrer l'affichage du widget :
| ||||||||||||||||||||||||||||||
| String | status_context_from_webui | Cette clé doit être renseignée dans la clé layout et permet de configurer la couleur de fond du widget par rapport au statut et au contexte.
| ||||||||||||||||||||||||||||||
| Clé | - | Cette clé doit être renseignée dans la clé layout et permet de paramétrer l'affichage des différentes zones du widget :
| ||||||||||||||||||||||||||||||
| Anchor | ||||
|---|---|---|---|---|
|
Zone du nom de l'élément ( propriété : item )
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
...
"grid_elements": [
{
...
"content" : {
...
"item" : {
"item_uuid" : "c618793e4e3a4a599d6f1cd3bf2a16fd",
"item_name" : "VMWARE_HOST_BORDEAUX_SUDOUEST",
"item_type" : "host"
},
...
}
}
]
... |
| Nom | Type | Défaut | Valeur attendue | ||
|---|---|---|---|---|---|
| String | --- | L'identifiant du service ( uuid ) si défini le contenu de "item_name" sera ignoré | ||
| String | --- | Le type du service ( host ou cluster ); | ||
| String | --- | Le nom de l'élément Shinken ( propriété host_ name ). Si aucun identifiant "item_uuid" n'est défini, l'élément sera recherché par le nom de l'élément. |
Zone de gauche ( propriété : left_area )
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
...
"grid_elements": [
{
...
"content" : {
...
"layout" : {
...
"information_to_display" : {
"left_area" : {
"icon_type" : "status_then_context"
},
...
}
}
}
}
]
... |
| Nom | Type | Défaut | Valeur attendue | ||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Texte | status_context_from_webui | Permet de configurer le type d'affichage des icônes du statut et du contexte.
|
| Warning |
|---|
Une icône définie dans la zone en haut à droite ne peut être définie dans la zone de gauche. |
| Panel | ||
|---|---|---|
| ||
Zone en haut à droite ( propriété : top_right_area )
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
...
"grid_elements": [
{
...
"content" : {
...
"layout" : {
...
"information_to_display" : {
...
"top_right_area" : {
"displayed" : false,
"icon_type" : "quality_service_icon"
},
...
}
}
}
}
]
... |
| Nom | Type | Défaut | Valeur attendue | ||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Booléen | false | Permet de définir si la zone est cachée ou affichée. 3 valeurs possibles :
| ||||||||||||||||||||||||||||
| Texte | quality_service_icon | Permet de configurer quel icône va être affiché dans la zone. 6 valeurs possibles :
|
| Warning |
|---|
Un icône défini dans la zone en haut à droite ne peut être définie dans la zone de gauche |
| Panel | ||
|---|---|---|
| ||
Zone SLA ( propriété : sla_area )
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
...
"grid_elements": [
{
...
"content" : {
...
"layout" : {
...
"information_to_display" : {
...
"sla_area" : {
"displayed" : true,
"show_icon" : true
},
...
}
}
}
}
]
... |
| Nom | Type | Défaut | Valeur attendue | |||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Booléen | true | Permet de configurer l'affichage des valeurs SLA 3 valeurs sont possibles :
| |||||||||||||||||||||||||||
| Booléen | false | Permet d'afficher ou cacher l'icône SLA 3 valeurs sont possibles :
|
| Panel | ||
|---|---|---|
| ||
| Panel | ||
|---|---|---|
| ||
Zone d'affichage du nom de l'élément ( propriété : name_area )
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
...
"grid_elements": [
{
...
"content" : {
...
"layout" : {
...
"information_to_display" : {
...
"name_area" : {
"property_used_as_name" : "visualisation_name",
"nb_lines_max" : 2,
"vertical_align" : "middle",
"font_zoom_percent" : 100
}
}
}
}
}
]
... |
| Nom | Type | Défaut | Valeur attendue | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Texte | visualisation_name | Définis quel sera le nom qui va être affiché dans le widget.
| ||||||||||||||||||||
| Nombre entier | 2 | Permet de définir le nombre de lignes maximums de l'affichage du nom de l'élément. Si le nom est plus long que cette limite, il sera coupé avec des "...". | ||||||||||||||||||||
| Texte | middle | Permet de configurer l'alignement du texte par rapport à la verticale.
| ||||||||||||||||||||
| Entier | 100 | Zoom en pourcentage de la taille de la police. Doit être supérieur à 0 Une valeur de 200 affiche un texte deux fois plus gros Une valeur de 50 affiche un texte deux fois plus petit Si la valeur "default" est appliqué, la |
Définir les valeurs par défaut du widget "météo" dans une météo
Dans chapitre "layouts" de la grille, il suffit de définir / compléter le chapitre "weather_widget_layout" :
Certains paramètres ne sont configurable que dans le layout ( pour des questions de cohérence d'affichage ) :
webui-module-service-weather".- Vous trouverez la définition de ces paramètres de configuration dans la page HIDDEN - V02.08.02 - Configuration de la disposition par défaut des widgets.
| Code Block |
|---|
...
"layouts" : {
"weather_widget_layout" : {
"width" : 10,
"height" : 3,
"content" : {
"property_used_as_name" : "definition_name",
"state_icon" : "only_status",
"background" : "context_then_status",
"display_sla" : true
}
},
... |
| Code Block |
|---|
property_used_as_name |
Définis quel sera le nom qui va être affiché dans le widget.
3 valeurs possibles :
| Code Block |
|---|
default |
| Code Block |
|---|
definition_name |
Affiche le nom de l'élément.
| Code Block |
|---|
visualisation_name |
| Code Block |
|---|
state_icon |
Permet de configurer le type d'affichage des icônes du statut et du contexte.
5 valeurs possibles :
| Code Block |
|---|
default |
la valeur sera calculée avec le système de "Calcul de la valeur en cascade" ( voir la page HIDDEN - V02.08.02 - Concept et paramétrage des widgets - Edition - Météo ).
| Code Block |
|---|
from_webui |
| Code Block |
|---|
context_then_status |
| Code Block |
|---|
status_then_context |
| Code Block |
|---|
only_status |
| Code Block |
|---|
background |
Permet de configurer la couleur de fond du widget par rapport au statut et au contexte.
6 valeurs possibles :
| Code Block |
|---|
default |
la valeur sera calculée avec le système de "Calcul de la valeur en cascade" ( voir la page HIDDEN - V02.08.02 - Concept et paramétrage des widgets - Edition - Météo ).
| Code Block |
|---|
from_webui |
| Code Block |
|---|
context_then_status |
Si l'élément n'a aucun contexte, la couleur de fond se basera sur la couleur du statut.
| Code Block |
|---|
context_and_status |
Si l'élément n'a aucun contexte, la couleur de fond se basera sur la couleur du statut.
| Code Block |
|---|
only_status |
| Code Block |
|---|
no_background |
| Code Block |
|---|
display_sla |
Permet d'activer ou désactiver l'affichage du taux SLA.
3 valeurs possibles :
| Code Block |
|---|
default |
valeur sera calculée avec le système de "Calcul de la valeur en cascade" ( voir la |
| Code Block |
|---|
false |
| Code Block |
|---|
true |






