Aller au contenu

Paramètres d'un profil

Les informations qu'un profil demande à l'opérateur au démarrage — types disponibles, contraintes, et usage dans les règles.

Un profil peut demander des informations à l’opérateur au moment où il démarre une surveillance : un site, un étage, un identifiant, un oui/non. Ce sont ses paramètres.

Ils appartiennent au profil, entièrement. Tibius WiFi ne connaît d’avance ni leur nombre, ni leur nom, ni leur sens, ni leurs valeurs possibles — et ne traite aucun d’eux différemment des autres.

Le principe, en une phrase. Tibius WiFi est agnostique au domaine. Les notions métier appartiennent aux profils et ne doivent pas entrer dans le cœur de l’application.

Un profil qui n’en déclare aucun

C’est un cas normal, et probablement le plus fréquent. Si tous vos réseaux portent un nom fixe, il n’y a rien à demander : l’écran de démarrage n’affiche alors aucun formulaire, et passe directement au choix de la règle.

Ce que porte un paramètre

Champ Obligatoire Rôle
identifiant oui référence stable, citée par les règles et enregistrée dans chaque session
libellé oui ce que lit l’opérateur au-dessus du champ
type oui text, number, choice ou boolean
obligatoire non, vaut oui une valeur est-elle exigée avant de démarrer ?
description non aide affichée sous le champ
valeur par défaut non pré-remplit le champ

L’identifiant ne peut contenir que lettres, chiffres, _, - et .. Ce n’est pas une contrainte de sens — nommez vos paramètres comme vous l’entendez — mais de syntaxe : il apparaît entre accolades dans un gabarit de SSID, et un espace y rendrait la référence ambiguë.

Il est aussi stable : c’est lui qui voyage dans les sessions enregistrées. Le renommer délie les règles qui le citent, et rend les anciennes campagnes moins lisibles.

Les quatre types

text

Du texte libre. Contraintes possibles : longueur minimale, longueur maximale, motif (expression régulière), exemple affiché sous le champ, et type de clavier suggéré (text ou numeric).

Le clavier n’est qu’une commodité : un identifiant composé de chiffres reste un texte, parce que 0042 et 42 ne désignent pas le même réseau.

number

Un nombre. Contraintes possibles : minimum, maximum, et l’autorisation ou non d’une partie décimale — refusée par défaut.

choice

Un choix dans une liste que le profil définit entièrement. Chaque option porte une value — ce qui est enregistré, et ce qu’un gabarit insère — et, facultativement, un label affiché. Sans libellé, la valeur est affichée telle quelle.

{
  "id": "site",
  "label": "Site",
  "type": "choice",
  "required": true,
  "default": "nord",
  "options": [
    { "value": "nord", "label": "Site Nord" },
    { "value": "sud",  "label": "Site Sud" }
  ]
}

boolean

Oui ou non. La valeur par défaut s’écrit "true" ou "false".

Les utiliser dans une règle

Une règle référence un paramètre de deux manières, qui se cumulent.

Dans son gabarit de SSID, entre accolades. Le paramètre est alors exigé au démarrage, et il doit être obligatoire.

CORP-{site}-{etage}

Une référence peut apparaître n’importe où — au début, au milieu, à la fin — et plusieurs fois. Pour écrire une accolade littérale, doublez-la : {{ donne {.

Dans sa liste parameters, pour collecter une valeur qui n’entre pas dans le nom du réseau. Le cas existe pour étiqueter les mesures sans fausser la surveillance : sans lui, la seule façon de collecter une valeur serait de l’insérer dans le SSID.

Ce qui est refusé

  • un gabarit qui cite un paramètre que le profil ne déclare pas ;
  • un gabarit qui cite un paramètre facultatif — sans valeur, le SSID obtenu serait incomplet, et la surveillance tournerait sans rien voir ;
  • deux paramètres portant le même identifiant ;
  • un choice sans option, ou deux options de même valeur ;
  • des bornes qu’aucune valeur ne satisfait (min supérieur à max) ;
  • une valeur par défaut que les contraintes du paramètre refusent.

Ce que devient une saisie

Elle est enregistrée avec la session, accompagnée de son libellé. Une campagne relue des mois plus tard affiche donc « Site : Site Nord », même si le profil a été renommé, réimporté ou supprimé entre-temps.

Elle est recopiée sur chaque point de mesure, pour qu’un point exporté reste interprétable seul, et elle figure dans l’export JSON sous la clé parameters.

Venir d’un fichier antérieur

Les profils écrits avant la version 5 du schéma décrivaient au plus une saisie par règle, sous une clé identifier. Elle est traduite automatiquement à la lecture : elle devient un paramètre text du profil, portant le même libellé, le même motif et le même clavier — et le préfixe de la règle devient un gabarit qui produit exactement le même SSID.

Voir Version du schéma.