Métadonnée calculée

Métadonnée calculée

Une métadonnée calculée permet de calculer une valeur automatiquement à partir d'autres métadonnées. Lorsqu'une des métadonnées référencées est modifiée, la métadonnée calculée est automatiquement calculée à nouveau.

1. Créer une métadonnée calculée

1. Aller dans le formulaire de création de métadonnée;
2. Dans le formulaire, sélectionnez le type d'entrée de donnée «Calculé»;
3. Remplir les métadonnées et «Enregistrer».

2. Éditer le calculateur

1. Naviguer dans la page de consultation de la liste d'un schéma particulier;
2. Cliquer sur le bouton «Éditer le calculateur».

2.1 Basculer entre le mode simple et avancée

1. Dans la page «Éditer le calculateur», cliquez sur l'option «Mode avancé»;
2. Un message de confirmation s'affiche indiquant qu'il sera impossible de revenir à l'expression du mode simple et que le contenu sera réinitialisé. 

Lorsqu'il y a eu bascule entre les modes, il est toujours possible de cliquer sur le bouton «Annuler» pour revenir à la page précédente. Ainsi, le calculateur reviendra au dernier état enregistré.

2.2 Éditer en mode simple

Le mode simple permet d'éditer le calculateur sans aucune connaissance JEXL. Il permet de faire des concaténations de plusieurs métadonnées avec des caractères insérés entre chacune d'elle.

2.2.1 Ajouter une métadonnée simple

Il y a deux façons d'ajouter une métadonnée simple : 

• Pour ajouter une métadonnée simple (non-référencée), il est possible de la saisir textuellement dans le champ de gauche en tapant le symbole $ suivi du nom de la métadonnée, selon la langue sélectionnée. Ex : $Titre, $Auteur, $Chemin principal, etc. 
• Il est possible aussi de double-cliquer sur le nom de la métadonnée dans la liste de droite. À ce moment, la métadonnée sera insérée à la position du curseur, dans le champs de gauche. Une métadonnée simple bien saisie sera colorée en bleu.

2.2.2 Ajouter une métadonnée référencée

Il y a deux façons d'ajouter une métadonnée référencée : 

• Pour ajouter une métadonnée référencée, il est possible de la saisir textuellement dans le champ de gauche en tapant le symbole $ suivi, selon la langue sélectionnée, du nom de la métadonnée locale et finalement du nom de la métadonnée référencée, entre parenthèses. Ex : $Créé par(Nom d'utilisateur)
• Il est possible aussi de double-cliquer sur le nom de la métadonnée locale dans la liste de droite. Une fenêtre modale apparaîtra afin de sélectionner la métadonnée référencée. À ce moment, la métadonnée sera insérée à la position du curseur, dans le champs de gauche. Une métadonnée référencée bien saisie sera colorée en bleu.

2.3 Éditer en mode avancé

Le mode avancé permet d'écrire directement un script JEXL. Ce mode permet un plus grand contrôle sur le résultat calculé, car il est possible, entre autres, de faire des conditions.

2.3.1 Ajouter une métadonnée simple

• Il suffit de taper le code local de la métadonnée. Ex. : title, author, path.OU
• Il est aussi possible de cliquer sur le nom de la métadonnée dans la liste de droite. À ce moment, le code de la métadonnée sera inséré à la position du curseur dans le champs de gauche. La méthode .toString() sera aussi ajoutée selon le type de la métadonnée sélectionnée. Ex. : Date. 

2.3.2 Ajouter une métadonnée référencée

• Pour ajouter une métadonnée référencée, il suffit d'écrire le code de la métadonnée locale suivi du symbole « . » et finalement le code de la métadonnée référencée ex. : createdBy.username .
  OU
• Il est possible aussi de double-cliquer sur le nom de la métadonnée locale dans la liste de droite. Une fenêtre modale apparaîtra afin de sélectionner la métadonnée référencée. À ce moment, le code de la métadonnée locale et le code de la métadonnée référencée seront insérés à la position du curseur dans le champ de gauche. La méthode .toString() sera aussi ajoutée selon le type de la métadonnée sélectionnée. Ex. : Date.

2.3.3 Afficher l'aide à la complétion

À tout moment, il est possible de saisir simultanément les touches CTRL et ESPACE pour afficher la liste d'aide à la complétion. Cette liste affiche les métadonnées disponibles selon le contexte (métadonnées locales ou métadonnées de la référence). La liste affichée fonctionne selon un filtre qui permet de circonscrire els choix selon ce qui a déjà été saisi (ex. : « au » a déjà été saisi, alors seulement les métadonnées contenant « au » dans le code ou le titre seront listées).

2.3.4 Détection d'erreur de compilation

Le script JEXL est recompilé à la volée par le serveur et, lorsqu'il y a une erreur de compilation, un message s'affiche en rouge. À ce moment, il n'est plus possible d'enregistrer le calculateur ni de prévisualiser les résultats tant que l'erreur n'a pas été résolue.

3. Calculateur d'un schéma personnalisé déviant du calculateur par défaut

C'est le calculateur défini dans el schéma par défaut qui est utilisé pour tous les schémas du type, sauf si le calculateur d'un schéma personnalisé est spécifiquement défini. Dans ce cas, on dit que le calculateur du schéma spécialisé dévie du calculateur par défaut. Un calculateur qui dévie de celui par défaut reste inchangé lorsque le calculateur par défaut est modifiée.

Un message apparaît dans le haut de la page de l'éditeur de calculateur indiquant que celui-ci dévie du calculateur par défaut. Il faut cliquer sur le bouton Cliquer ici du message pour réinitialiser le calculateur à celui par défaut. Un message de confirmation s'affiche afin de valider la réinitialisation du calculateur.

4. Prévisualiser les résultats

Dans la page d'édition du calculateur, il y a un bouton «Afficher la prévisualisation». Cliquer sur ce bouton pour afficher le formulaire de prévisualisation des résultats. Le formulaire est composé d'un champ pour sélectionner manuellement des enregistrements à calculer et d'un tableau de résultats. 

Lorsque le bouton «Prévisualiser» est cliqué, le système sélectionne jusqu'à mille enregistrements (dont ceux sélectionnés manuellement), à calculer. 

Le tableau des résultats liste, pour chaque enregistrement, le titre, la valeur précédement calculée et la nouvelle valeur calculée selon le nouveau calculateur. Les enregistrements choisis manuellement sont en caractères gras et afficheront toujours dans le haut du tableau, et ce, même après un tri sur une colonne. Lorsque le calculateur ne réussit pas à calculer une valeur, la ligne de l'enregistrement erroné s'affiche en rouge.