Versions Compared

Old Version 9

changes.mady.by.user Soubrié Grégoire

Saved on

compared with

New Version Current

changes.mady.by.user Soubrié Grégoire

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Make by tools (01.00.01) - action=clean_macro_parameter
Scroll Ignore
scroll-viewporttrue
scroll-pdftrue
scroll-officetrue
scroll-chmtrue
scroll-docbookhtmltruefalse
scroll-eclipsehelpdocbooktrue
scroll-epubeclipsehelptrue
scroll-htmlepubtrue
Panel
titleSommaire

Table of Contents
stylenone

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 : FOR-MERGE - 002.5 - SEF-8970 - ( 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

Code Block
languagebash
themejsRDark
titleExemple 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
languagebash
themejsRDark
titlePositionnement du widget
...    
"grid_elements": [
	{
		"position_x": 0,
        "position_y": 4,
        "width"     : 15,
        "height"    : 5,
		...
    }
]
...
NomTypeDéfautCommentaire
Code Blocknoformat
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.
Code Blocknoformat
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 Blocknoformat
width
Nombre de cellules ---

Correspond à la largeur du widget :

Si Si le paramètre "width" n'est pas présent dans la configuration du widget, c'est comme s'il valait "default".

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


Anchor
weatherWidgetEditContent
weatherWidgetEditContent



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

Chaque zone possède sa propre configuration.

Panel

zones_08-02-2022.pngImage RemovedImage Added

Code Block
languagebash
themeRDarkjs
titleExemple 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
Code Blocknoformat
type
String -

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

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

Code Blocknoformat
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 )
Code Blocknoformat
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
code
No Format
default

La valeur sera calculée avec le système de "Calcul de la valeur en cascade" ( voir la page

FOR-MERGE - 002.5 - SEF-8970 - Concept et paramétrage des widgets - Edition -

Configurer un widget - Édition JSON - Météo   ).

code
No Format
status_context_from_webui
Scroll Ignore

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 )
Scroll Only

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   )

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

Code Blocknoformat
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)

Pour plus d'information sur ces paramètres  





Anchor
identificationpart
identificationpart

Elément affiché
Zone du nom de l'élément ( propriété : item )
Code Block
languagebash
themeRDarkjs
titleContenu 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
code
No Format
item_uuid
String ---

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

code
No Format
item_type
String ---

Le type du service ( host ou cluster );

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




context
NomTypeDéfautValeur attendue
Code Blocknoformat
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
code
No Format
default
La valeur sera calculée avec le système de "Calcul de la valeur en cascade" ( voir la page
FOR-MERGE - 002.5 - SEF-8970 - Concept et paramétrage des widgets - Edition - Météo 
Configurer un widget - Édition JSON - Météo ).
code
No Format
status_context_from_webui
scroll-ignore
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  )
 Scroll Only
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    )
  Paramétrage de l'interface de Visualisation  )
 No Format
context
 Code Block
_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é. 
code
 No Format
status_then_context
L'icône du statut sera mise en avant par rapport à celle du contexte.
code
 No Format
only_status	
Seule l'icône du statut sera affichée.
code
 No Format
sla_tendency
Affiche la flèche de la tendance SLA en plus 
 grand 
grand.
code
 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.