Listes de données
Une liste de données est un référentiel de valeurs : la liste des pays, des agences, des types de contrat, des codes analytiques.
Elle sert à ce que les utilisateurs choisissent une valeur au lieu de la saisir. La donnée reste alors homogène (pas de « FR », « France » et « france » dans la même métadonnée) et la valeur affichée peut différer de la valeur stockée : on enregistre un code, on montre un libellé. Une liste de données peut aussi porter des ressources, comme des images.
Une même liste alimente autant de métadonnées et de formulaires que nécessaire, et se met à jour à un seul endroit.
Trier les valeurs par ordre alphabétique : trie les valeurs proposées à l'utilisateur, plutôt que de conserver l'ordre de la liste.
Source de données
Le Type détermine d'où viennent les valeurs. Une liste peut être remplie de quatre manières.
Quel que soit le type, les valeurs sont affichées dans une grille en bas de page, avec une colonne Activé : une valeur désactivée est conservée mais n'est plus proposée à l'utilisateur. Les colonnes ne sont modifiables que pour une liste de valeurs. Pour les autres types, elles sont lues depuis la source.
Liste de valeurs
Les valeurs sont saisies dans le module lui-même, directement dans la grille.
Les colonnes s'ajoutent et se suppriment depuis la grille. Un nom de colonne ne peut contenir que des minuscules, des chiffres et des underscores, doit être unique dans la liste, et ne peut pas reprendre un nom réservé : value, data_list_name ou value_column_name.
Deux actions accompagnent ce type de liste :
- Exporter sous Excel : récupérer les valeurs dans un classeur.
- Importer des valeurs depuis un fichier : remplacer les valeurs par celles d'un fichier Excel ou JSON. Les colonnes sont reprises du fichier.
Les deux actions ne sont disponibles ni à la création du module, ni tant que des modifications ne sont pas enregistrées.
Requête GQL
Les valeurs proviennent des contenus de Any eux-mêmes.
Requête ou prédicats GQL : requête qui définit les valeurs. Elle peut porter sur les contenus ou sur les utilisateurs (from users).
Le bouton Prévisualiser les résultats montre ce que la requête retourne. La grille de la page n'affiche que les 500 premières valeurs. La liste elle-même n'est pas limitée.
Java
Les valeurs sont produites par du code.
Classe Java : classe qui fournit les valeurs, choisie parmi les implémentations déployées. Les colonnes et les valeurs sont celles qu'elle retourne.
REST
Les valeurs sont récupérées depuis un service externe, ce qui permet de s'appuyer sur un référentiel déjà tenu ailleurs plutôt que d'en recopier le contenu dans Any.
URL d'accès : URL du service. Elle accepte les jokers, ce qui permet de construire l'appel à partir du contexte et des paramètres décrits plus bas.
Chemin de données : emplacement de la liste des valeurs dans la réponse du service. Laissé vide, la réponse est elle-même la liste.
Autres paramètres REST ouvre le reste de l'appel :
- Type d'appel : GET ou POST.
- En-têtes HTTP : en-têtes à envoyer, par exemple une clé d'API ou un jeton. Les noms comme les valeurs acceptent les jokers.
- Type de contenu et Contenu : uniquement pour un appel POST. Le type de contenu (
application/x-www-form-urlencoded,multipart/form-data,application/jsonouapplication/xml) préremplit le corps de la requête avec les paramètres, qu'il reste à ajuster au service appelé.
Paramètres transmis au service
Any ne se contente pas de récupérer une liste figée : il transmet au service ce que l'utilisateur est en train de faire (ce qu'il a saisi, la page qu'il consulte) sous forme de jokers à placer dans l'URL ou dans le corps de la requête.
| Joker | Contenu |
|---|---|
${filters} | Filtres actifs, en JSON : un tableau d'objets column_name, operator et value. |
${column_names} | Colonnes attendues, en JSON. |
${sort_by} | Tri demandé. |
${include_disabled_values} | true si les valeurs désactivées doivent être retournées. |
${from_index} | Index de la première valeur attendue. |
${size} | Nombre de valeurs attendues. |
Dans une URL en GET, ces valeurs sont automatiquement encodées.
Ce sont ces paramètres qui rendent une liste REST utilisable sur un gros référentiel : le service filtre, trie et pagine lui-même, et ne renvoie que la tranche demandée. Cela suppose de les exploiter réellement : un service qui les ignore et renvoie tout à chaque appel fonctionnera, mais fera transiter l'intégralité du référentiel à chaque ouverture de liste. Le chargement à la demande n'est disponible que pour les appels POST.
Réponse attendue
La réponse est du JSON. Chaque objet trouvé au chemin de données devient une valeur, et chacun de ses champs une colonne :
{
"itemsCount": 240,
"data": [
{ "code": "FR", "label": "France" },
{ "code": "BE", "label": "Belgique", "is_enabled": false }
]
}
Le champ is_enabled d'un objet, s'il est présent, désactive la valeur. Sans lui la valeur est active. Le champ itemsCount à la racine indique le nombre total de valeurs disponibles au-delà de la tranche renvoyée : il est nécessaire à la pagination. En son absence, Any considère que la réponse contient toutes les valeurs.
Limites
Une liste REST, comme une liste Java, n'est pas proposée dans le sélecteur de liste des pages de propriétés ni du module Aspects : ces sources sont trop hétérogènes pour que le filtrage y soit garanti.