Sommaire

Concept

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

Elle permet de définir :

  • Le comportement par défaut des liens de la météo,
  • Les paramètres de chaque lien,
  • 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

"external_links" : {
    "default_link" : {
        "link_protocol" : "default",
        "link_base_url" : "default",
        "link_external_part_url" : "default",
        "authentication_needed" : "default",
        "info_bar" : {
            "background_color" : "default",
            "logo_displayed" : "default",
            "position" : "default",
            "refresh" : {
                "chrono_displayed" : "default",
                "generation_time_displayed" : "default"
            }
        }
    },
    "links" : [
        {
            "link_name" : "Mon nom de lien",
            "link_protocol" : "default",
            "link_base_url" : "default",
            "link_external_part_url" : "default",
            "authentication_needed" : "default",
            "info_bar" : {
                "background_color" : "default",
                "logo_displayed" : "default",
                "position" : "default",
                "refresh" : {
                    "chrono_displayed" : "default",
                    "generation_time_displayed" : "default"
                }
            }          
        }
    ]
}

Description

Les URL des liens ont le format suivant : <link_protocol>://<link_base_url>/service-weather/<link_external_part_url>/<weather_uuid>/<link_uuid>

Ajout d'un nouveau lien externe

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

...
"external_links" : {
	...
    "links": [
		{
			DEFINITION DU LIEN 1
    	 },
		{
        	DEFINITION DU LIEN 2
    	 },
    	...
   ]
...
}
...

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

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


  • Si le paramètre n'est défini à aucun des trois niveaux précédents, le module de météo dispose de valeur par défaut.
  • Il est déconseillé de se baser dessus, car au fil des livraisons, Shinken pourrait être amené à changer ces valeurs.

Pour les notifications, il y a un quatrième niveau qui est celui de la météo. En effet si aucune configuration n'est présente sur le lien ou sur le niveau "default_link", alors il prendra la configuration, si existante, de la météo.

La configuration des liens

{
... 
   
	"links": [ 
    	{
        	"link_name" : "external portal display",
            "link_uuid" : "e214ce6ac1580cef86ddf7479ba9bf1d",
            "link_protocol" : "protocol_from_webui",
            "link_base_url" : "my.proxy:8080",
            "link_external_part_url": "external",
            "authentication_needed": true,
            "info_bar": { 
            },
            "notifications": {
			}
		}, 
	... 
    ] 
...
}
NomTypeUnitéDéfautCommentaire
link_name
Texte

---

---

Le nom est obligatoire.

Les caractères suivants sont interdits :

  • ', ", <, >


Limité à 300 caractères.

link_uuid
Texte

---

---

Correspond à l'identifiant unique du lien.

Est automatiquement ajouté au lien si manquant.

Il peut être personnalisé, mais il doit impérativement être unique parmi les liens de cette météo.

Les caractères suivants sont interdits :

  • !,#,$,&,',(,),*,+,,/,:,;,=,?,@,[,],<,>
  • caractères avec des accent
  • espace
  • émoji 


Limité à 300 caractères.

link_protocol
Texte--- protocol_from_webui 

Cette option permet de choisir le protocole qui va être utilisé pour le lien externe.

NomCommentaire
protocol_from_webui
Le lien utilisera le même protocole que l'Interface de Visualisation
https
Le lien utilisera le protocole sécurisé HTTPS
http
Le lien utilisera le protocole non sécurisé HTTP
Si la valeur default est définie, voir le chapitre Calcul de la valeur d'un paramètre en cascade


authentication_needed

Booléen

---

default

NomCommentaire
true
Le lien ne sera accessible que pour les utilisateurs identifiés par l'Interface de Visualisation
false
Le lien sera accessible par tout le monde
Si la valeur " default" est définie,  voir le chapitre Calcul de la valeur d'un paramètre en cascade


link_base_url
Texte---

default

Cette option permet de modifier la base URL  ( adresse IP ou nom du serveur, et éventuellement son port ) d'accès du lien externe.

Elle peut correspondre à l'identifiant du système sur lequel est hébergé Shinken ou à un serveur proxy.


Exemple d'URL : http://localhost:7767/service-weather/external/abcd01/xyz009

Où :

  • http:// est la valeur du paramètre link_protocol
  • 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…


Si la valeur default est définie, voir le chapitre Calcul de la valeur d'un paramètre en cascade.



Limité à 300 caractères.

link_external_part_url
Texte---

default

Cette option permet de modifier le chemin d'accès du lien, c'est une partie personnalisable de l'url qui sera partagée.

Elle peut permettre de rediriger les utilisateurs accédant au lien externe vers les différentes météos des services d'un serveur proxy.


Exemple d'URL : http://localhost:7767/service-weather/external/abcd01/xyz009

Où :

  • http:// est la valeur du paramètre link_protocol
  • 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…


Si la valeur default est définie, voir le chapitre Calcul de la valeur d'un paramètre en cascade.


Limité à 300 caractères.

info_bar
Objet------

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

notifications
Objet------Permet de définir les paramètres de notifications de ce lien. Voir ci dessous pour le paramétrage des notifications.
La configuration de la barre d'information des liens
{
...     
   "info_bar": {
        "position"        : "top",
        "background_color": "#343434",
        "logo_displayed"    : false,
        "refresh"         : {
            "chrono_displayed": true,
            "generation_time_displayed"  : false
      	}
    }
...
}
NomTypeUnitéDéfautCommentaire
position
Texte--- default

Position de la barre d'information .
 Les valeurs possibles sont :

  • top ( affichage en haut de la vue ),
  • bottom ( affichage en bas de la vue )

Si la valeur default est définie, voir le chapitre Calcul de la valeur d'un paramètre en cascade.



background_color
Couleur Web--- default

Couleur de la barre d'information.

Le format de la valeur est une couleur web ( au format hécadécimal, en anglais, ou en rgb ) ( Voir :  https://en.wikipedia.org/wiki/Web_colors )

Si la valeur default est définie, voir le chapitre Calcul de la valeur d'un paramètre en cascade.


logo_displayed
Booléen--- default

Option d'affichage du logo Shinken.
Les valeurs possibles sont :

  • false ( le logo n'est pas affiché )
  • true ( le logo est affiché avec son texte en noir )

Si la valeur default est définie, voir le chapitre Calcul de la valeur d'un paramètre en cascade


refresh
------ --- Options d'affichage des informations de rafraichissement ( voir le paragraphe Option d'affichage des informations de rafraichissement )

Si la barre d'information est vide ( tous les éléments qui peuvent être affichés sont à hidden ou false ), elle ne sera pas présente.

La configuration des informations de rafraichissement dans la barre d'information des liens
{
...     
   "refresh"         : {
       "chrono_displayed": true,
       "generation_time_displayed"  : false
   }
...
}
NomTypeUnitéDéfautCommentaire
chrono_displayed
Booléen--- default

Affiche sur la barre d'information ( à droite ) l'icône d'horloge indiquant le temps restant avant le prochain rafraichissement ( heure de génération de la page ).


Si la valeur default est définie, voir le chapitre Calcul de la valeur d'un paramètre en cascade


generation_time_displayed
Booléen--- default

Affiche sur la barre d'information ( à droite ) le texte indiquant l'heure du dernier rafraichissement ( heure de génération de la page ).


Si la valeur default est définie, voir le chapitre Calcul de la valeur d'un paramètre en cascade


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é ;
...
"notifications": {
    "sound": {
      "enabled": "default"
    },
    "visual": {
      "blink": {
        "enabled": "default"
      }
    }
  }
...
Définition des notifications sonores

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



NomTypeUnitéDéfautCommentaire
enabled
Booléen

---

default

NomCommentaire
true
Les notifications sonores sont actives sur ce lien.
false
Les notifications sonores ne sont pas actives sur ce lien.
default
Si cette valeur est définie, voir le chapitre Calcul de la valeur d'un paramètre en cascade.
Définition des notifications visuelles

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"
		}
    },
...
}
...
NomTypeUnitéDéfautCommentaire
enabled
Booléen

---

default

NomCommentaire
true
Les notifications visuelles de type "Clignotement" sont actives sur ce lien.
false
Les notifications visuelles de type "Clignotement" ne sont pas actives sur ce lien.
default
Si cette valeur est définie, voir le chapitre Calcul de la valeur d'un paramètre en cascade.

La configuration du niveau "default_link" des liens

{
...     
    "default_link" : {
        "link_protocol" : "protocol_from_webui",
        "link_base_url" : "my.proxy:8080",
        "link_external_part_url" : "external",
        "authentication_needed" : true,
        "links": [],
        "info_bar": {
            "position" : "top", 
			"background_color": "#343434",
            "logo_displayed" : true,
            "refresh" : {
                "chrono_displayed": true,
                "generation_time_displayed" : false
            }
        },
        "notifications": {}
...
}
NomTypeUnitéDéfautCommentaire
link_protocol


 protocol_from_webui

Cette option permet de choisir quel protocole utiliser pour les liens externes par défaut.

NomCommentaire
protocol_from_webui
Les liens utiliseront le même protocole que l'Interface de Visualisation.
https
Les liens utiliseront le protocole sécurisé HTTPS.
http
Les liens utiliseront le protocole non sécurisé HTTP.

Si la valeur default est définie, voir le chapitre Calcul de la valeur d'un paramètre en cascade.

link_base_url
Texte--- L'url du Broker

Cette option permet de modifier la base de l'URL   ( adresse IP ou nom du serveur, et éventuellement son port ) d'accès aux liens externes.

Elle peut correspondre à l'identifiant du système sur lequel est hébergé Shinken ou à un serveur proxy.

Exemple d'URL : http://localhost:7767/service-weather/external/abcd01/xyz009

Où :

  • http:// est la valeur du paramètre link_protocol,
  • 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…


Si la valeur default est définie, voir le chapitre Calcul de la valeur d'un paramètre en cascade.

Limité à 300 caractères.

link_external_part_url
Texte--- external

Cette option permet de modifier le chemin d'accès aux liens externes, c'est une partie personnalisable de l'url qui sera partagée.

Elle peut permettre de rediriger les utilisateurs de ces liens externes vers les différentes météos des services du serveur proxy.


Exemple d'URL : http://localhost:7767/service-weather/external/abcd01/xyz009
Où :

  • http:// est la valeur du paramètre link_protocol,
  • 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…


 Si la valeur default est définie, voir le chapitre Calcul de la valeur d'un paramètre en cascade.

Limité à 300 caractères.

authentication_needed
Booléen--- default

Cette option permet de définir si une identification est nécessaire pour accéder aux liens externes par défaut. Ce paramètre peut être surchargé dans la configuration de chaque lien.

NomCommentaire
true
Les liens ne seront accessibles que pour les utilisateurs identifiés par l'Interface de Visualisation.
false
Les liens seront accessibles par tout le monde.
Si la valeur default est définie, voir le chapitre Calcul de la valeur d'un paramètre en cascade.


info_bar
Objet------

Configuration qui sera utilisée par défaut par tous les liens externes.

Il est possible pour chaque lien de redéfinir sa propre configuration afin de ne pas utiliser celle-ci.

Pour plus d'informations sur la configuration d'une barre d'information, voir le chapitre La configuration de la barre d'information des liens.

notifications



Objet------

Configuration qui sera utilisée par défaut par tous les liens externes.

Il est possible pour chaque lien de redéfinir sa propre configuration afin de ne pas utiliser celle-ci.

Pour plus d'informations sur la configuration des notifications, voir le chapitre La configuration des notifications.

Gestion de l'identification pour l'accès aux liens externes

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

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

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


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

Le champ "owner_user" n'est pas encore pris en compte dans cette version ( En cours de développement ).


Exemples de disposition de la barre information 

Lien externe avec barre barre en bas, chrono et texte visibles

"position"        : "bottom",
"background_color": "#000000",
"logo_displayed"    : true,
"refresh"         : {
	"chrono_displayed": true,
	"generation_time_displayed"  : true
}

Lien externe avec barre orange en haut, chrono et texte visibles

"position"        : "top",
"background_color": "orange",
"logo_displayed"    : true,
"refresh"         : {
	"chrono_displayed": true,
	"generation_time_displayed"  : true
}