Page History

Présentation

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.

Vous allez pouvoir définir :

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

Description

Ajout d'un nouveau lien externe

Dans le format, JSON, Le le rajout d'un nouveau widget lien 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 ("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 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

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 "links_default" ( ce qui servira de valeur par défaut pour ce paramètre dans cette météo ) ;
• Dans les fichiers de configurations 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 l'ordre jusqu'à ce qu'une valeur définie soit trouvée : 

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

1. le niveau "lien" ;

1. le niveau "links_default"

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

1. le niveau "lien" ;
2. le niveau "links_default" ;
3. le niveau "fichier de configuration".

La configuration des liens

1. ;
2. le niveau "fichier de configuration".

La configuration des liens

link_name

link_uuid

authenticationlink_neededprotocol

protocol_from_webui

https

http

1 ou true

0 ou false

infoauthentication_barneeded

Booléen

default

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.

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