Page History

Scroll Ignore

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

Panel

title	Sommaire

Table of Contents

style	none

Présentation

Un widget météo permet d'afficher des informations clés sur un service en particulier ( hôte ou cluster ).

Un widget météo est composé de ces informations :

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

Code Block

language	js
title	Exemple d'un widget météo

...    
"grid_elements": [
	{
		"position_x": 30,
        "position_y": 3,
        "width"     : 15,
        "height"    : 3,
		"content" : {
			"type" : "weather_widget",
            "item": { 
				"item_uuid" : "50589d91a4ff11e7b9eff8bc12640001",
				"item_type" : "host",
				"item_name" : "MVP_VMWARE_VCENTER_HEALTH_SUDOUEST"
			}
		}
	}
]
...

Positionnement et Dimensionnement

Code Block

language	js
title	Positionnement du widget

...    
"grid_elements": [
	{
		"position_x": 30,
        "position_y": 3,
        "width"     : 15,
        "height"    : 3,
		...
    }
]
...

Nom

Type

Défaut

Commentaire

Code Block
position_x

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.

Code Block
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.

Code Block
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 HIDDEN - V02.08.02 - 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".

Code Block
height

Nombre de cellules

---

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

language	js
title	Contenu d'un widget météo

...    
"grid_elements": [
	{
		...
        "content"   : {
        	"type"   : "weather_widget",
            "item": {
				...
		 	}
        }
    }
]
...

Nom

Type

Défaut

Valeur attendue

Code Block
type

String

---

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

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

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

Anchor

	identificationpart
	identificationpart

Identification du service de la widget

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

Nom

Type

Défaut

Valeur attendue

Code Block
item_uuid

String

---

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

Code Block
item_type

String

---

Le type du service ( host ou cluster );

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

Exemple

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" : "50589d91a4ff11e7b9eff8bc12640001",
				"item_type" : "host",
				"item_name" : "MVP_VMWARE_VCENTER_HEALTH_SUDOUEST" 
			} 
		} 
	},
	...
] 
...

La configuration ci-dessus correspond à la configuration du widget météo encadré en bleu dans l'image ci-dessous.

Panel

Anchor

	ConfigurationLayoutWidgetWeather
	ConfigurationLayoutWidgetWeather

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

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_name
- state_icon
- background
- display_sla
Si 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".
- 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
		}
	},
...

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

Code Block
default

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 - Météo ).

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.

Code Block
state_icon

Texte

from_webui

Permet de configurer le type d'affichage des icônes du statut et du contexte.
5 valeurs possibles :

Nom

Commentaire

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

Code Block
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 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.

Code Block
only_status

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

Code Block
background

Texte

from_webui

Permet de configurer la couleur de fond du widget par rapport au statut et au contexte.
6 valeurs possibles :

Nom

Commentaire

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

Code Block
from_webui

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

Code Block
only_status

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

Code Block
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 blanche.

Code Block
display_sla

Booléen

true

Permet d'activer ou désactiver l'affichage du taux SLA.
3 valeurs possibles :

Nom

Commentaire

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

Code Block
false

Désactive l'affichage du taux.

Code Block
true

Active l'affichage du taux.

Page tree

Versions Compared

Old Version 3

New Version 4

Key

Présentation

Description

Configuration

Positionnement et Dimensionnement

Contenu du widget météo

Identification du service de la widget

Exemple

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