| Scroll Ignore |
|---|
| scroll-viewport | true |
|---|
| scroll-pdf | true |
|---|
| scroll-office | true |
|---|
| scroll-chm | true |
|---|
| scroll-docbookhtml | truefalse |
|---|
| scroll-eclipsehelpdocbook | true |
|---|
| scroll-epubeclipsehelp | true |
|---|
| scroll-htmlepub | true |
|---|
|
|
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 )
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 ) ;
Pour un widget météo il faut configurer :
- sa position X, Y, largeur et hauteur;
- son service ( nom ou identifiant )
- 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.
| Code Block |
|---|
| language | bash |
|---|
| theme | RDark |
|---|
| title | Exemple d'un widget météo |
|---|
|
... |
| Code Block |
|---|
| language | js |
|---|
| title | Exemple d'un widget météo |
|---|
|
...
"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"
}
}
}
]
... |
| Code Block |
|---|
| language | js |
|---|
| title | Positionnement du widget |
|---|
|
...
"grid_elements": [
{
"position_x": 30,
},
"layout" : {
"position_ybackground" : 3"default",
"width" "information_to_display" : {
: 15,
"heightleft_area" : {
: 3,
...
}
]
... |
| Nom | Type | Défaut | Commentaire |
|---|
Numéro de cellule | --- | 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.
| Numéro de cellule | --- | 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.
| Nombre de cellules | --- | 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 Concept et paramétrage des widgets - Edition - Météo ).
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".
| Code Block |
|---|
| language | js |
|---|
| title | Contenu d'un widget météo |
|---|
|
...
"grid_elements": [
{
...
"icon_type" : "status_then_context"
},
"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
...
}
}
}
]
... |
| Nom | Type | Défaut | Valeur attendue |
|---|
String | --- | Type du widget, dans le cas du widget météo ce paramètre doit être obligatoirement défini à la valeur : weather_widget. | Object | --- | 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 ). |
| 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 ). |
| 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 ). |
| Anchor |
|---|
identificationpart | identificationpart | | Code Block |
|---|
| language | js |
|---|
| title | Contenu d'un widget météo |
|---|
|
...
"item": {
"item_uuid" : "50589d91a4ff11e7b9eff8bc12640001",
"item_type" : "host",
"item_name" : "MVP_VMWARE_VCENTER_HEALTH_SUDOUEST"
}
... |
| Code Block |
|---|
| language | bash |
|---|
| theme | RDark |
|---|
| title | Positionnement du widget |
|---|
|
...
"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 : - un nombre => Correspond à la case numéro X dans la largeur de la grille ;
- Doit obligatoirement être défini.
|
| Numéro de cellule | --- | 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.
|
| Nombre de cellules | --- | 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 Configurer un widget - Édition JSON - Météo ).
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 |
|---|
| weatherWidgetEditContent |
|---|
| weatherWidgetEditContent |
|---|
|
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 |
|---|
Image Added
|
| Code Block |
|---|
| language | bash |
|---|
| theme | RDark |
|---|
| title | Exemple d'un widget météo |
|---|
|
...
|
| 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 | | Code Block |
|---|
| language | js |
|---|
| title | Configuration du widget d'exemple |
|---|
|
...
"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 |
|---|
Image Removed
|
| Anchor |
|---|
ConfigurationLayoutWidgetWeather | ConfigurationLayoutWidgetWeather | "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é. Pour cela, il faut définir trois sous clés à la clé item ( pour plus d'information, voir l'explication de chaque sous-clé dans le chapitre item ). |
| Clé | - | Permet de paramétrer l'affichage du widget : - La couleur de fond
- Le paramètre de gestion des zones d'affichages ( paramètre information_to_display )
|
| 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. 6 valeurs possibles : |
Dans chapitre "layouts" de la grille, il suffit de définir / compléter le chapitre "weather_widget_layout" :
Il ne faut définir que les valeurs pour lesquels on souhaite mettre un paramètre par défaut;Certains paramètres ne peuvent pas avoir de valeur par défaut :position_x,position_y,type,item.Certains paramètres ne sont configurable que dans le layout ( pour des questions de cohérence d'affichage ) :property_used_as_namestate_iconbackground display_slaSi vous utilisez la valeur "default" pour un paramètre qui l'accepte, la valeur sera alors celle présente dans le fichier de configuration du module "webui-module-service-weather".| 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
}
},
... |
| Nom | Type | Défaut | Commentaire |
|---|
| Code Block |
|---|
property_used_as_name |
Texte | definition_name | Définis quel sera le nom qui va être affiché dans le widget. 3 valeurs possibles : | Nom | Commentaire | a valeur sera calculée avec le système de "Calcul de la valeur en cascade" ( voir la page | Concept et paramétrage des widgets - Edition | Code Block |
|---|
definition_name |
Affiche le nom de l'élément. | | Code Block |
|---|
visualisation_name |
Affiche la valeur définie dans la propriété "Nom d'affichage pour l'interface de visualisation" de l'élément. | | Texte | from_webui | | No Format |
|---|
status_context_from_webui |
| 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 Paramétrage de l'interface de Visualisation ) | | No Format |
|---|
context_then_status |
| La couleur de fond 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. | | No Format |
|---|
context_and_status |
| 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. | | La couleur de fond ne se base que sur la couleur du statut. | | Si l'élément a un contexte, la couleur de la bordure sera la couleur du contexte. Autrement, la bordure sera de la couleur du statut. La couleur de fond sera transparente. |
|
| No Format |
|---|
information_to_display |
| Clé | - | Cette clé doit être renseignée dans la clé layout et permet de paramétrer l'affichage des différentes zones du widget : - La zone de gauche ( paramètre left_area )
- La zone d'affichage du nom de l'élément ( paramètre name_area )
- La zone en haut à droite ( paramètre top_right_area)
- La zone d'affichage des SLA ( paramètre sla_area)
|
|
|
|
|
| Anchor |
|---|
| identificationpart |
|---|
| identificationpart |
|---|
|
| Code Block |
|---|
| language | bash |
|---|
| theme | RDark |
|---|
| title | Contenu d'un widget météo |
|---|
|
...
"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. |
| Code Block |
|---|
| language | bash |
|---|
| theme | RDark |
|---|
| title | left_area |
|---|
|
...
"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. 5 valeurs possibles : | Nom | Commentaire |
|---|
| La valeur sera calculée avec le système de "Calcul de la valeur en cascade" ( voir la page Configurer un widget - Édition JSON - Météo ). | | No Format |
|---|
status_context_from_webui |
| 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 Paramétrage de l'interface de Visualisation ) | | No Format |
|---|
context_then_status |
| 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é.
| | No Format |
|---|
status_then_context |
| L'icône du statut sera mise en avant par rapport à celle du contexte. | | Seule l'icône du statut sera affichée. | | Affiche la flèche de la tendance SLA en plus grand. | | No Format |
|---|
quality_service_icon |
| Affiche l'indicateur de la qualité de service. |
|
| Warning |
|---|
Une icône définie dans la zone en haut à droite ne peut être définie dans la zone de gauche. |
| Panel |
|---|
| title | Exemple avec comme valeur "context_then_status" |
|---|
|
Image Added
|
| Code Block |
|---|
| language | bash |
|---|
| theme | RDark |
|---|
| title | top_right_area |
|---|
|
...
"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 : | Nom | Commentaire |
|---|
| La valeur sera calculée avec le système de "Calcul de la valeur en cascade" ( voir la page Configurer un widget - Édition JSON - Météo ). | | No Format |
|---|
status_context_from_webui |
| 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 Paramétrage de l'interface de Visualisation ) | | No Format |
|---|
context_then_status |
| 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é. | | No Format |
|---|
status_then_context |
| L'icône du statut sera mise en avant par rapport à celle du contexte. | | Seul l'icône du statut va être affiché. | | No Format |
|---|
quality_service_icon |
| Affiche l'icône de qualité de service |
|
| Warning |
|---|
Un icône défini dans la zone en haut à droite ne peut être définie dans la zone de gauche |
| Panel |
|---|
| title | Exemple avec comme valeur "status_then_context" |
|---|
|
Image Added
|
| Code Block |
|---|
| language | bash |
|---|
| theme | RDark |
|---|
| title | sla_area |
|---|
|
...
"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 :
| Info |
|---|
Quand la qualité de service est affichée, la flèche de tendance SLA est affichée à côté de l'icône de la qualité de service et est masquée à côté des SLAs afin d'alléger l’affichage. ( car il s’agit de la même information ) |
|
| Panel |
|---|
| Image Added
|
|
|---|
|
| Booléen | false | Permet d'afficher ou cacher l'icône SLA 3 valeurs sont possibles : |
| Panel |
|---|
| title | Exemple avec "show_icon" à "true" et "displayed" à "true" |
|---|
|
Image Added
|
| Panel |
|---|
| title | Même exemple avec l'indicateur de qualité de service dans la zone de gauche |
|---|
|
Image Added
|
| Code Block |
|---|
| language | bash |
|---|
| theme | RDark |
|---|
| title | name_area |
|---|
|
...
"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 |
|---|
| No Format |
|---|
property_used_as_name |
| Texte | visualisation_name | Définis quel sera le nom qui va être affiché dans le widget. 3 valeurs possibles : | Permet de configurer le type d'affichage des icônes du statut et du contexte.
5 valeurs possibles :
| Nom | Commentaire |
|---|
la valeur sera calculée avec le système de "Calcul de la valeur en cascade" ( voir la page Concept et paramétrage des widgets - Edition - Météo ). | 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 )
| | Code Block |
|---|
context_then_status |
L'icône du contexte sera mise en avant par rapport à celui du statut. | | Code Block |
|---|
status_then_context |
L'icône du statut sera mise en avant par rapport à celle du contexte. | Seule l'icône du statut sera affichée. | Texte | from_webui | Permet de configurer la couleur de fond du widget par rapport au statut et au contexte. 6 valeurs possibles :
| Nom | Commentaire | la | valeur sera calculée avec le système de "Calcul de la valeur en cascade" ( voir la page | Concept et paramétrage des widgets - Edition codefromwebuiSe basera sur le type d'affichage de la couleur de fond configuré pour les portails et les tableaux de bord. ( paramètre tiles_background du fichier webui_cfg_overload.cfg )
| | Code Block |
|---|
context_then_status | La couleur de fond se basera uniquement sur le contexte | Affiche le nom de l'élément. | | No Format |
|---|
visualisation_name |
| Affiche la valeur définie dans la propriété "Nom d'affichage pour l'interface de visualisation" de l'élément. | 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 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
| | Nombre entier | 2 | Permet de définir le nombre de lignes maximums de l'affichage du 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. | La couleur de fond ne se base que sur la couleur du statut. | Si l'élément a un contexte, la couleur de la bordure sera la couleur du contexte. Autrement la bordure sera de la couleur du statut. La couleur de fond sera blanche.
| . 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. 4 valeurs possibles : | Nom | Commentaire |
|---|
| La valeur sera calculée avec le système de "Calcul de la valeur en cascade" ( voir la page Configurer un widget - Édition JSON - Météo ê ). | | Permet un affichage en haut de la zone dédiée au texte. | | Permet un affichage centré par rapport à la zone dédiée au texte. | | Permet un affichage en bas de la zone dédiée au texte. |
|
| No Format |
|---|
font_zoom_percent |
| 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 | Booléen | true | Permet d'activer ou désactiver l'affichage du taux SLA. 3 valeurs possibles :
|
| Nom | Commentaire |
la valeur sera calculée avec le système de "Calcul de la valeur en cascade" ( voir la page
Concept et paramétrage des widgets - Edition Configurer un widget - Édition JSON - Météo
).
Désactive l'affichage du taux. | Active l'affichage du taux.
Image Added