Page History

Scroll Ignore

scroll-viewport	true
scroll-pdf	true
scroll-office	true
scroll-chm	true
scroll-html	false
scroll-docbook	true
scroll-eclipsehelp	true
scroll-epub	true	scroll-html	false

Panel

title	Sommaire

Table of Contents

style	none

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 ).

Plus d'informations sur les widgets météos dans cette page : Widget Météo - Détail - Météo

Description

Pour le widget météo, il est possible de configurer :

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

language	bash
theme	RDark
title	Exemple d'un widget météo

...     
"grid_elements": [
	{  
    	"position_x" : 0,
    	"position_y" : 4,
    	"width" : 15,
    	"height" : 5,
    	"content" : {
    	    "type" : "weather_widget",
    	    "item" : {
    	        "item_uuid" : "c618793e4e3a4a599d6f1cd3bf2a16fd",
    	        "item_name" : "VMWARE_HOST_BORDEAUX_SUDOUEST",
    	        "item_type" : "host"
    	    },
    	    "layout" : {
    	        "background" : "default",
    	        "information_to_display" : {
    	            "left_area" : {
    	                "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,
    	                "vertical_align" : "middle",
    	                "font_zoom_percent" : 100
    	            }
    	        }
    	    }
    	}
	}
]
...

Positionnement et Dimensionnement

Code Block

language	bash
theme	RDark
title	Positionnement du widget

...    
"grid_elements": [
	{
		"position_x": 0,
        "position_y": 4,
        "width"     : 15,
        "height"    : 5,
		...
    }
]
...

NomTypeDéfautCommentaire

No Format
position_x

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.

No Format
position_y

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.

No Format
width

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".

No Format
height

Nombre de cellules ---

Correspond à la hauteur du widget :

un nombre, limité à 1000 ;
"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 "height" n'est pas présent dans la configuration du widget, c'est comme s'il valait "default".

AnchorweatherWidgetEditContentweatherWidgetEditContent

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
Image Removed

Code Block

language	bash
theme	RDark
title	Exemple d'un widget météo

...     
"grid_elements": [
	{  
		...
    	"content" : {
    	    "type" : "weather_widget",
    	    "item" : {
				...
    	    },
   		    "layout" : {
			    "background" : "default",
				"information_to_display" : {
					"left_area" : {
							...
					},
					"top_right_area" : {
						...
					},
					"sla_area" : {
						...
					},
					"name_area" : {
						...
					}
				}
    	    }	
    	}
	}
]
...

NomTypeDéfautCommentaire

No Format
type

String -

Type du widget, dans le cas du widget titre ce paramètre doit être obligatoirement défini à la valeur : weather_widget .

No Format
item

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 ).

No Format
layout

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 )

No Format
background

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 :

Nom

Commentaire

No Format
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 ).

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.

No Format
only_status

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

No Format
no_background

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.

Info
Le paramètre peut être aussi configuré pour toutes les widgets de la vue. Pour plus d'information sur la configuration global de ce paramètre ( Voir le chapitre Définir les valeurs par défaut des widgets météo ).

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)

Anchoridentificationpartidentificationpart

Zone du nom de l'élément ( propriété : item )

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"     
			},
			...
        }
    }
]
...

NomTypeDéfautValeur attendue

No Format
item_uuid

String ---

L'identifiant du service ( uuid ) si défini le contenu de "item_name" sera ignoré

No Format
item_type

String ---

Le type du service ( host ou cluster );

No Format
item_name

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

language	bash
theme	RDark
title	left_area

...     
"grid_elements": [
	{  
		...
    	"content" : {
			...
    	    "layout" : {
				...
    	        "information_to_display" : {
    	            "left_area" : {
    	                "icon_type" : "status_then_context"
    	            },
					...
    	        }
    	    }
    	}
	}
]
...

NomTypeDéfautValeur attendue

No Format
icon_type

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

No Format
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 ).

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.

No Format
only_status

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

No Format
sla_tendency

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

No Format
quality_service_icon

Affiche l'indicateur de la qualité de service.

Info
Le paramètre peut être aussi configuré pour tous les widgets de la vue. Pour plus d'information sur la configuration globale de ce paramètre ( Voir le chapitre Définir les valeurs par défaut des widgets météo ).

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 Removed

Zone en haut à droite ( propriété : top_right_area )

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"
    	            },
					...
    	        }
    	    }
    	}
	}
]
...

NomTypeDéfautValeur attendue

No Format
displayed

Booléen false

Permet de définir si la zone est cachée ou affichée.

3 valeurs possibles :

NomCommentaire

No Format
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 ).

No Format
false

La zone est cachée.

No Format
true

La zone est affichée.

No Format
icon_type

Texte quality_service_icon

Permet de configurer quel icône va être affiché dans la zone.

6 valeurs possibles :

Nom

Commentaire

No Format
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 ).

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.

No Format
only_status

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 Removed

Zone SLA ( propriété : sla_area )

Code Block

language	bash
theme	RDark
title	sla_area

...     
"grid_elements": [
	{  
		...
    	"content" : {
			...
    	    "layout" : {
				...
    	        "information_to_display" : {
					...
    	            "sla_area" : {
    	                "displayed" : true,
    	                "show_icon" : true
    	            },
					...
    	        }
    	    }
    	}
	}
]
...

NomTypeDéfautValeur attendue

No Format
displayed

Booléen true

Permet de configurer l'affichage des valeurs SLA

3 valeurs sont possibles :

Nom

Commentaire

No Format
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 ).

No Format
false

N'affiche pas les valeurs SLA

No Format
true

Affiche le taux SLA

Info
Le paramètre peut être aussi configuré pour tous les widgets de la vue. Pour plus d'information sur la configuration globale de ce paramètre ( Voir le chapitre Définir les valeurs par défaut des widgets météo ).

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 )

Concept

Pour éviter d'avoir à configurer toutes les valeurs, la plupart des champs de configuration utilisent une configuration par défaut.

Le premier niveau est défini par l'administrateur Shinken dans des fichiers de configuration, qui sera utilisé pour toutes les météos.

( voir la page Configuration de la disposition par défaut des widgets - webui-module-service-weather )

Le deuxième niveau se situe au niveau de la météo pour définir le comportement du widget météo pour cette météo uniquement.

Définir les valeurs par défaut du widget "météo" dans une météo

Dans le chapitre "layouts" de la grille, il suffit de définir / compléter le chapitre "weather_widget_layout".

Certains paramètres ne peuvent pas avoir de valeur par défaut ( il faudra donc définir ces paramètres pour chaque widget ) :

position_x,
position_y,
type,
item.

Les paramètres suivants sont configurables par défaut :

Pour la zone de gauche ( paramètre left_area ) :
- icon_type
Pour la zone en haut à gauche ( paramètre top_right_area )
- displayed
- icon_type
Pour la zone SLA ( paramètre sla_area )
- displayed
- show_icon
Pour la zone du nom de l'élément ( paramètre name_area )
- property_used_as_name
- nb_lines_max
- vertical_align
- font_zoom_percent
La couleur de fond ( paramètre background )
La hauteur ( paramètre height )
La largeur ( paramètre width )

Pour connaitre les valeurs à saisir pour ces paramètres, se référer au chapitre décrivant la configuration du contenu d'un widget ( voir la page Widget Météo - Édition JSON - Météo )

Si la valeur "default" est utilisée 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".
( voir la page Configuration de la disposition par défaut des widgets - webui-module-service-weather )

Info
Il ne faut définir que les valeurs pour lesquelles on souhaite mettre un paramètre par défaut.

Panel

title	Exemple

Image Removed

No Format
show_icon

Booléen false

Permet d'afficher ou cacher l'icône SLA

3 valeurs sont possibles :

Nom

Commentaire

No Format
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 ).

No Format
false

Cache l'icône SLA

No Format
true

Affiche l'icône SLA

Panel

title	Exemple avec "show_icon" à "true" et "displayed" à "true"

Image Removed

Panel

title	Même exemple avec l'indicateur de qualité de service dans la zone de gauche

Image Removed

Zone d'affichage du nom de l'élément ( propriété : name_area )

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
    	            }
    	        }
    	    }
    	}
	}
]
...

NomTypeDéfautValeur 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 :

Nom

Commentaire

No Format
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 ).

No Format
item_name

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.

Info
Le paramètre peut être aussi configuré pour tous les widgets de la vue. Pour plus d'information sur la configuration globale de ce paramètre ( Voir le chapitre Définir les valeurs par défaut des widgets météo ).

No Format
nb_lines_max

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 "...".

No Format
vertical_align

Texte middle

Permet de configurer l'alignement du texte par rapport à la verticale.
4 valeurs possibles :

Nom

Commentaire

No Format
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 ê).

No Format
top

Permet un affichage en haut de la zone dédiée au texte.

No Format
middle

Permet un affichage centré par rapport à la zone dédiée au texte.

No Format
bottom

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 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 ).

Image Removed AnchorConfigurationLayoutWidgetWeatherConfigurationLayoutWidgetWeatherDéfinir les valeurs par défaut du widget "météo" dans une météo

Code Block

language	bash
theme	RDark

... 
"layouts" : { 
	"weather_widget_layout" : { 
		"width" : 10,
		"height" : 3,
		"content" : {
			"layout" : {
				"background" : "context_then_status",
				"information_to_display" : {
					"left_area" : {
						"icon_type" : "context_then_status"
					},
					"top_right_area" : {
						"displayed" : false,
						"icon_type" : "quality_service_icon"
					},
				 	"sla_area" : {
						"displayed" : true,
						"show_icon" : false
					},
					"name_area" : {
						"property_used_as_name" : "item_name",
						"nb_lines_max" : "2",
						"vertical_align" : "middle",
						"font_zoom_percent" : "default"
					}
				}
			}
		}
	},
}
...

Dans le chapitre "layouts" de la grille, il suffit de définir / compléter le chapitre "weather_widget_layout".

Certains paramètres ne peuvent pas avoir de valeur par défaut ( il faudra donc définir ces paramètres pour chaque widget ) :

position_x,
position_y,
type,
item.

Les paramètres suivants sont configurables par défaut :

Pour la zone de gauche ( paramètre left_area ) :
- icon_type
Pour la zone en haut à gauche ( paramètre top_right_area )
- displayed
- icon_type
Pour la zone SLA ( paramètre sla_area )
- displayed
- show_icon
Pour la zone du nom de l'élément ( paramètre name_area )
- property_used_as_name
- nb_lines_max
- vertical_align
- font_zoom_percent
La couleur de fond ( paramètre background )
La hauteur ( paramètre height )
La largeur ( paramètre width )

Pour connaitre les valeurs à saisir pour ces paramètres, se référer au chapitre décrivant la configuration du contenu d'un widget météo ( voir le chapitre Contenu du widget météo )

Si la valeur "default" est utilisée 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"

voir la définition de ces paramètres de configuration dans la page Configuration de la disposition par défaut des widgets - webui-module-service-weather

Info
Il ne faut définir que les valeurs pour lesquelles on souhaite mettre un paramètre par défaut .

Page tree

Versions Compared

Old Version 1

New Version Current

Key

Présentation - Widget Météo

Description

Configuration

Positionnement et Dimensionnement

Contenu du widget météo

Zone du nom de l'élément ( propriété : item )

Zone de gauche ( propriété : left_area )

Zone en haut à droite ( propriété : top_right_area )

Zone SLA ( propriété : sla_area )

Concept

Définir les valeurs par défaut du widget "météo" dans une météo

Zone d'affichage du nom de l'élément ( propriété : name_area )