Sommaire

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

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

Positionnement du widget
...    
"grid_elements": [
	{
		"position_x": 0,
        "position_y": 4,
        "width"     : 15,
        "height"    : 5,
		...
    }
]
...
NomTypeDéfautCommentaire
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.
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.
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 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".

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


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.

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
type
String -

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

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

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

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

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 )

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.
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.
only_status
La couleur de fond ne se base que sur la couleur du statut.
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.

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

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)




Zone du nom de l'élément ( propriété : item )
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
item_uuid
String ---

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

item_type
String ---

Le type du service ( host ou cluster );

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 )
left_area
...     
"grid_elements": [
	{  
		...
    	"content" : {
			...
    	    "layout" : {
				...
    	        "information_to_display" : {
    	            "left_area" : {
    	                "icon_type" : "status_then_context"
    	            },
					...
    	        }
    	    }
    	}
	}
]
...




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

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

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é. 
status_then_context
L'icône du statut sera mise en avant par rapport à celle du contexte.
only_status
Seule l'icône du statut sera affichée.
sla_tendency
Affiche la flèche de la tendance SLA en plus grand.
quality_service_icon
Affiche l'indicateur de la qualité de service.

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




Une icône définie dans la zone en haut à droite ne peut être définie dans la zone de gauche.

Exemple avec comme valeur "context_then_status"

Zone en haut à droite ( propriété : top_right_area )
top_right_area
...     
"grid_elements": [
	{  
		...
    	"content" : {
			...
    	    "layout" : {
				...
    	        "information_to_display" : {
					...
    	            "top_right_area" : {
    	                "displayed" : false,
    	                "icon_type" : "quality_service_icon"
    	            },
					...
    	        }
    	    }
    	}
	}
]
...


NomTypeDéfautValeur attendue
displayed
Booléen false

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

3 valeurs possibles :

NomCommentaire
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 ).
false
La zone est cachée.
true


La zone est affichée.
icon_type
Texte quality_service_icon

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

6 valeurs possibles : 

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

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

status_then_context
L'icône du statut sera mise en avant par rapport à celle du contexte.
only_status
Seul l'icône du statut va être affiché.
quality_service_icon
Affiche l'icône de qualité de service


Un icône défini dans la zone en haut à droite ne peut être définie dans la zone de gauche

Exemple avec comme valeur "status_then_context"

Zone SLA ( propriété : sla_area ) 
sla_area
...     
"grid_elements": [
	{  
		...
    	"content" : {
			...
    	    "layout" : {
				...
    	        "information_to_display" : {
					...
    	            "sla_area" : {
    	                "displayed" : true,
    	                "show_icon" : true
    	            },
					...
    	        }
    	    }
    	}
	}
]
...


NomTypeDéfautValeur attendue
displayed
Booléen true

Permet de configurer l'affichage des valeurs SLA

3 valeurs sont possibles :

NomCommentaire
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 ).
false
N'affiche pas les valeurs SLA
true
Affiche le taux SLA

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


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 )



Exemple



show_icon
Booléen false

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

3 valeurs sont possibles :

NomCommentaire
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 ).
false
Cache l'icône SLA
true
Affiche l'icône SLA
Exemple avec "show_icon" à "true" et "displayed" à "true"

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

Zone d'affichage du nom de l'élément ( propriété : name_area ) 
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
property_used_as_name
Texte visualisation_name

Définis quel sera le nom qui va être affiché dans le widget.
3 valeurs possibles :

NomCommentaire
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 ).
item_name
Affiche le nom de l'élément.
visualisation_name
Affiche la valeur définie dans la propriété "Nom d'affichage pour l'interface de visualisation" de l'élément.

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


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

vertical_align
Texte middle

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

NomCommentaire
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 ê ).
top
Permet un affichage en haut de la zone dédiée au texte.
middle
Permet un affichage centré par rapport à la zone dédiée au texte.
bottom
Permet un affichage en bas de la zone dédiée au texte.
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 Configurer un widget - Édition JSON - Météo ).