Page History

Concept

Cette page vous décrit comment définir dans le format JSON les liens externes qui permettront d'accéder à la météo de l’extérieur.sans passer par l'Interface de Visualisation de Shinken .

Elle permet de Vous allez pouvoir définir :

• Le comportement par défaut des liens de votre la météo,
• Les paramètres de chaque lien, si vous souhaitez avoir un comportement spécifique par lien.

Description

• Le style et le contenu d'une barre d'information optionnelle qui peut être adaptée pour chaque lien, pour permettre une intégration optimale ( voir la page La vue météo hors de Shinken )

Exemple

Ajout d'un nouveau lien externe

Dans le format, JSON, Le rajout d'un nouveau widget se fait au niveau de la partie "links".

Définition d'un lien externe

Paramètres des liens externe

Les liens vont être définis à l'aide de paramètres composés :

• Du nom ;
• De la valeur ;

...
    {
		"link_name": "external portal display", "link_external_part_url" : "default",
        "authentication_needed" : "default",
        "info_bar" : {
            "authenticationbackground_neededcolor" : true"default",
          ...
  "logo_displayed" : "default",
         }
	},
...

Un paramètre peut être non défini, mais avoir une valeur :

• Si le paramètre n'est pas présent dans le JSON ou si elle existe, mais que sa valeur est égale à "default", la météo va le considérer comme ayant une valeur non définie et va calculer sa valeur par défaut ( voir le chapitre Calcul de la valeur d'un paramètre en cascade ).
  • Dans la définition des liens, choisir si vous préférez supprimer un paramètre pour qu'il soit à la valeur par défaut, ou explicitement écrire "default" dépendra uniquement de ce que vous trouvez le plus confortable :
    • Ne pas garder un champ réduira la longueur du JSON ;
    • Mettre les champs à "default" vous permettra de ne pas chercher le nom d'un paramètre, si vous voulez lui mettre une valeur ;

Calcul de la valeur d'un paramètre en cascade

La configuration des liens

Description

link_name

---

---

Le nom est obligatoire.
Les caractères suivants sont interdits :

• ', ", <, >

link_uuid

---

---

Correspond à l'identifiant unique du lien. Ne pas changer.

Est automatiquement ajouté au lien si manquant.

authentication_needed

Booléen

1

1 ou true

0 ou false

info_bar

Permet de définir un paramétrage pour la barre d'information uniquement pour ce lien. Voir ci-dessous pour le paramétrage d'une barre d'information.

link_base_url

Cette option vous permet de modifier la base URL d'accès aux liens externes.

Ajout d'un nouveau lien externe

Dans le format, JSON, le rajout d'un nouveau lien se fait au niveau de la section "links" .

Définition d'un lien externe

Paramètres des liens externes

Les liens vont être définis à l'aide de paramètres composés ( "clé" : "valeur" )

• du nom,
• de la valeur.

...
    {
		"link_name": "external portal display",
        "authentication_needed": true,
	},
...

Un paramètre peut être non défini, mais avoir une valeur :

• Si le paramètre n'est pas présent dans le JSON ou que sa valeur est "default", la météo va le considérer comme ayant une valeur non définie et elle va calculer sa valeur par défaut

• ( voir le chapitre Calcul de la valeur d'un paramètre en cascade )

Où :

• http://localhost:7767 est la valeur de ce paramètre,
  
• external est la valeur du paramètre external_part_url,
  
• abcd01 est l'uuid de la météo du service,
• xyz009 est l'uuid de configuration du lien externe

Le caractère / et les autres caractères interdits dans les URL ne sont pas autorisés dans ce paramètre.

Exemple de caractères interdit : !,#,$,&,',(,),*,+,,/,:,;,=,?,@,[,],<,>, caractères avec des accents, ...

link_external_part_url

La valeur du paramètre :
links__default_external_part_url

Cette option vous permet de modifier le chemin d'accès aux liens externes.

Où :

• http://localhost:7767 est la valeur de la base URL,
• external est la valeur de ce paramètre,
• abcd01 est l'uuid de la météo du service,
• xyz009 est l'uuid de configuration du lien externe

Le caractère / et les autres caractères interdits dans les URL ne sont pas autorisés dans ce paramètre.
Exemple de caractères interdit : !,#,$,&,',(,),*,+,,/,:,;,=,?,@,[,],<,>, caractères avec des accents, ...

{
...     
   "info_bar": {
      "position"        : "top",
        "background_color": "#343434",
        "logo_displayed"    : false,
        "refresh"         : {
            "chrono_displayed": true,
            "generation_time_displayed"  : false
      	}
    }
...
}

• .

Calcul de la valeur d'un paramètre en cascade

La valeur d'un paramètre peut être définie à 3 niveaux différents :

• Dans le lien ( ce qui servira pour ce lien uniquement ) ;
• Dans le niveau "default_link" ( ce qui servira de valeur par défaut pour ce paramètre dans cette météo ) ;
• Dans les fichiers de configuration de la météo ( ces valeurs serviront alors de valeur par défaut de toutes les météos ) ;

La valeur d'un paramètre sera déterminée en parcourant les 3 niveaux dans cet ordre jusqu'à ce qu'une valeur définie soit trouvée : 

1. dans la partie JSON de la configuration du "link" ;
2. dans la partie JSON de la configuration du "default_link" ;
3. dans le "fichier de configuration".

La configuration des liens

La configuration du niveau "links_default" des liens

Anchor
infoBar infoBar

La configuration de la barre d'information des liens

Anchor
Notifications Notifications

La configuration des notifications

Le paramétrage des notifications suit un héritage particulier :

• En priorité, le paramétrage du lien est utilisé ;
• Si celui-ci n'est pas présent, celui du lien par défaut est utilisé ;
• Si celui-ci n'est pas présent, celui de la météo est utilisé ;

Il est possible de paramétrer les notifications sonores de la météo en modifiant "sound" de la partie "notifications" du JSON.

...
"notifications" : {
    "sound": {
		"enabled": "default"
    },
...
}
...

enabled

true

false

default

Il est possible de paramétrer les notifications visuelles de la météo sur ce lien en modifiant "visual" de la partie "notifications" du JSON. Ces notifications apparaissent sous la forme d'un clignotement de 3 secondes sur les éléments concernés par un changement d'état.

...
"notifications" : {
	...
    "visual": {
		"blink": {
		 	"enabled": "default"
		}
    },
...
}
...

enabled

true

false

default

La configuration du niveau "default_link" des liens

Gestion de l'identification

Afin de limiter l'accès à la vue météo, il est possible de définir si le lien d'export externe est accessible aux personnes non authentifiéesidentifiées par l'Interface de Visualisation de Shinken. 

Afin Un ensemble d'options permettant de paramétrer ce système , un ensemble d'options est disponible dans le fichier JSON de la vue :

{
...
	"users"        : {	
		"owner_user"                     : {
	    	"uuid": "user_uuid",
			"name": "user_name"
    	},
	},
	"external_links": {
		"default_link" : {
	        "default_links__"authentication_needed" : true
		},
        "links": [
		    {
			    ...
   			    "authentication_needed": true
		    }
	    ]
    }
...
}

Le champ qui nous intéresse intéressant est authentication_needed ( paramétrable dans chaque lien ).

Exemples de

Lien externe avec barre

Lien externe avec barre orange en