Référence développeur
Liberty Next → Documenter → Référence développeur décrit l'installation en service de l'intérieur : ses tables, ses réglages, ses routes d'API, ses lignes de commande et les liens entre les éléments de sa configuration, lus dans le code et la configuration en vigueur. Elle s'adresse à ceux qui assurent le support de l'installation — superutilisateurs uniquement — et ne modifie rien.
La page compte cinq onglets — Modèle de données, Configuration, API, Ligne de commande, Impact ; elle s'ouvre sur Configuration, puis sur le dernier onglet utilisé.
Vue d'ensemble
Modèle de données
Les tables du framework, puis celles que déclare chaque connecteur, groupées par connecteur, chacune avec son nombre de colonnes. La recherche trouve une table, une colonne ou un libellé.
Une table présente sa table physique, sa clé, les requêtes qui la lisent et ce qui l'utilise — écrans, tableaux de bord, graphiques, tâches, modèles de l'explorateur —, ses tables liées, puis ses colonnes : Colonne, Libellé (issu du dictionnaire), Type, Références, Écrans, Description.
Configuration
Chaque réglage de l'installation, par section, avec son type, sa valeur par défaut et sa description.
| Colonne | Signification |
|---|---|
| Clé, Libellé, Type, Défaut | Le réglage. |
| Modifiée dans | La page qui le modifie — Administrer → App → Connexion —, ou Fichier / environnement seulement avec la raison, ou Pas dans l'interface. |
| Lue par | Les emplacements du code qui l'utilisent. |
L'en-tête dénombre les réglages modifiés dans un écran, ceux fixés seulement dans le fichier ou l'environnement, et ceux absents de l'interface ; le filtre d'état n'en garde qu'une catégorie. Un clic sur une ligne en ouvre le détail, avec le code qui la lit.
API
Chaque route du serveur, par module : Méthode, Chemin, Résumé, Module et Accès — public, tout utilisateur connecté, superutilisateur, une permission ou un rôle, lu dans le code. Un clic sur une route en ouvre les paramètres, la requête et la réponse, ainsi que l'emplacement de son traitement. Pour les principales routes de lecture — connecteurs, menus, écrans, adresses externes, explorateur de données, tâches et exécutions Nomaflow —, la section Réponse donne la structure du JSON renvoyé, avec un exemple. Les boutons de l'en-tête ouvrent la documentation interactive de l'API du serveur.
La recherche porte sur tous les modules et indique, par groupe, le nombre de résultats.
Ligne de commande
Chaque commande installée avec le serveur — liberty-admin, liberty-ops, liberty-connectors, liberty-crypto, liberty-license… —, lue dans son analyseur d'arguments. À gauche, les commandes avec une recherche, repliées par défaut, avec Tout déplier / Tout replier.
Une commande présente son rôle, sa syntaxe avec Copier, les Options de toutes les commandes, puis chaque sous-commande avec ses arguments : Argument, Valeur, Défaut, obligatoire, répétable. Sous Docker, ./liberty prend en charge l'installation, la mise à jour, les sauvegardes et la base de données : voir Exploitation. La section « ligne de commande » du rapport technique repose sur la même lecture.
Impact
Chaque entité de la configuration avec ce qu'elle utilise et ce qui l'utilise, de proche en proche : ce qu'atteint la modification d'un pool, d'une requête, d'un écran ou d'un élément du dictionnaire. Les liens sont ceux que suit l'analyse des dépendances du Package.
À gauche, les entités par nature — pools, connecteurs, requêtes, endpoints API, éléments du dictionnaire, listes, séquences, énumérations, écrans, éléments de menu, graphiques, tableaux de bord, actions partagées, modèles Explorer, tâches, règles de notification, blocs IA —, repliées par défaut, avec une recherche (scope.nom). Inutilisées seulement ne garde que les entités auxquelles rien ne fait référence — éléments de menu, tâches, règles de notification, pools, modèles Explorer et éléments du dictionnaire, ouverts ou atteints autrement, ne sont jamais comptés comme inutilisés —, et Référencées mais non définies liste les références à une entité inexistante.
Une entité choisie présente :
| Partie | Contenu |
|---|---|
| En-tête | utilise N · utilisée par N, et Ouvrir dans l'éditeur, qui mène à son éditeur. |
| Une modification ici atteint | Les entités atteintes, comptées par nature : une requête → ses écrans → les éléments de menu qui les ouvrent, les graphiques → leurs tableaux de bord, les tâches et actions qui l'exécutent. |
| Utilisée par | L'arbre de ce qui l'utilise, niveau par niveau (jusqu'à 8 niveaux). |
| Utilise | Ce qu'elle utilise directement. |
| Tout ce dont elle a besoin | Toutes les entités dont elle dépend, de proche en proche. |
Un clic sur une entité de l'arbre recentre la vue sur elle ; Retour revient à la précédente. Un élément du dictionnaire n'a pas de référence explicite : une colonne rejoint son élément par son nom.
Voir aussi
- Rapports de documentation — les mêmes informations sous forme de document PDF.
- API REST — les principales routes, expliquées.