Pré-requis : pour gérer les métriques calculées, il faut avoir le rôle d'Administrateur Fonctionnel dans io-base.
Accéder au module Formules (menu disponible depuis la page d'accueil du portail).
Cet écran "Formules" va vous permettre de créer de nouvelles métriques, dont les valeurs seront calculées automatiquement par rapport aux valeurs d'autres métriques. On parle de "Métriques calculées".
Ces métriques sont ajoutées à votre base de données, au même titre que les métriques remontant des instruments de mesure.
Ajouter une nouvelle métrique revient à ajouter une formule.
Pour ajouter une formule, cliquer sur le bouton Ajouter une formule.
L'ajout d'une formule se décompose en trois parties :
définition de la métrique qui sera ajoutée à la base de données
mise en place de la périodicité de calcul des valeurs de la métrique
écriture de la formule de calcul des valeurs
Une fois les trois parties saisies, il suffit de cliquer sur le bouton Ajouter la formule.
La nouvelle formule apparaîtra dans le tableau, et la métrique sera créée dans la base de données et disponible dans les différents outils (Indaba Explorer...).
Remarque : pour que le bouton Ajouter la formule soit disponible, il faut que toutes les zones de saisies soient valides (notamment l'expression de la formule et le nom de la métrique).
Définition de la métrique
La zone Définition vous permet de donner les informations générales sur la nouvelle métrique :
Nom de la métrique : les caractères spéciaux, et espaces ne sont pas autorisés
Base de données : la base de données dans laquelle sera créée la métrique
Description : permet de donner des indications sur la métrique
Unité : unité des valeurs de la métrique
Par défaut, la métrique sera associée à l'autorisation par défaut. Se référer à la documentation sur les autorisations pour plus de détails.
Remarque : les champs Nom de la métrique et Base de données cible ne seront pas modifiables après la création de la métrique. Si vous voulez les modifier, il faudra supprimer et recréer la métrique.
Périodicité de calcul
La zone Périodicité vous permet de définir la fréquence à laquelle les valeurs de la métrique vont être calculées. Il y a trois options possibles :
En continu : les valeurs se calculeront en permanence, si une valeur d'une métrique utilisée dans la formule change.
Simplifiée : permet de définir un nombre de secondes/minutes/heures entre le calcul de deux valeurs
Avancé : permet de définir une fréquence plus complexe, en utilisant les "Expressions CRON". Un lien d'aide est disponible dans l'écran, pour vous aider à écrire cette fréquence.
Pour résumer, la fréquence va se définir par 5 caractères.
minute
heure
jour du mois
mois
jour de la semaine
Il est possible de saisir des caractères spéciaux :
* : n'importe quelle valeurs
, : séparateur de valeur pour une liste
- : séparateur pour une plage de valeur
/ : valeur pas à pas
Exemple : 50*8* veut dire "A 00:05 en août"
Remarque : pour une périodicité simplifiée, il n'est pas possible de saisir une valeur en dessous de 10 secondes.
Renseignez également le fuseau horaire sur lequel vous souhaitez paramétrer votre formule.
Une aide à la saisie est proposée, il vous suffit de taper le début de votre saisie, et les fuseaux horaires disponibles s'affichent :
Lors de votre saisie, commencez par indiquer le continent puis la capitale (ou la capitale économique) du pays, séparés par un "/".
exemples :
Remarque : Vous avez la possibilité de décaler la date à laquelle le résultat de votre formule est stocké en base.
Pour ce faire, il vous suffit d'indiquer le décalage à appliquer :
Si vous saisissez 1h, par exemple, la valeur de votre formule sera inscrite dans la base de données une heure avant son calcul.
Ainsi, si le calcul a lieu à 12h, la valeur sera horodatée à 11h.
Définition de la formule
Cette dernière zone consiste à définir la formule qui sera appliquée pour calculer les valeurs de la nouvelle métrique. Elle contient les champs suivants :
validité des données en seconde : cette valeur permet de s'assurer que les valeurs calculées sont basées sur des données valides.
Par exemple, si l'expression est main@tag + 5, et que la durée de validité est à 60 secondes. Au moment où la formule doit se recalculer, cela va regarder quelle est la date de la dernière valeur en base pour main@tag. Si cette date est plus ancienne que 60 secondes, alors on estime que la valeur n'est pas fiable. On ne va donc pas recalculer la formule, et aucune nouvelle valeur ne sera insérée pour l'instant.
Si vous souhaitez recalculer une valeur quoi qu'il arrive à chaque fois, et ignorer cette fonctionnalité, il suffit de mettre 0 dans ce champ.
type de résultat : indique sous quel format les valeurs calculées vont être stockées dans la base de donnée :
BOOL : booléen
INT : entier
REAL : décimal
expression : c'est le champ qui va contenir la formule.
Vous pouvez taper directement dans la zone de texte, ou vous servir des différents boutons pour vous aider.
Avec le bouton Recherche de métrique, vous pouvez aller chercher une métrique existante dans la base pour éviter de la saisir.
Les boutons en dessous présentent la liste des opérateurs qu'il est possible d'utiliser dans l'expression.
Le bouton ? disponible sur le champ Expression vous donne des explications complémentaires sur la saisie d'une formule. Un article est dédié aux Expressions et formules.
Une fois que vous avez saisi votre expression de formule, vous devez la tester en cliquant sur le bouton Tester l'expression. Si la formule est juste, le champ expression s'encadre en vert. Sinon, il sera rouge.
Exemple d'expression valide :
Exemple d'expression invalide :
Si l'expression est invalide, en passant la souris sur le rond rouge ? une indication apparaît pour expliquer d'où vient l'erreur.
Le bouton Effacer permet d'effacer le contenu du champ Expression pour recommencer la saisie.