Référence développeur
La page Développeur répond aux questions de ceux qui maintiennent, étendent ou auditent NomaUBL : que contient cette table, qui écrit cette colonne, où se modifie ce réglage et qui le lit, par quels flux passe ce statut, que renvoie cette API. Tout son contenu est produit à la construction de l'application, à partir du DDL de la base, de la configuration des tables et des colonnes, des éditeurs de paramètres, des sources Java et du document OpenAPI : il correspond toujours à la version en service.
Accès : Documentation → Développeur.
Vue d'ensemble
Tables
Le dictionnaire des seize tables NomaUBL, regroupées par flux — Cycle de vie de la facture, E-reporting, Notifications, Sécurité — avec une recherche sur les noms de tables, les colonnes, les commentaires et les codes BT.
- La fiche de table donne le rôle et les notes issus du DDL, la clé primaire et les index, l'accesseur et sa clé de configuration, le nom actuellement configuré dans les réglages de la base NomaUBL quand la table est renommée (Renommée en), et les flux qui l'écrivent et la lisent. Les tables de facture portent un bandeau cliquable du cycle de vie à travers les tables, de l'archive au journal des traitements.
- La grille des colonnes — colonne, nom remplacé, type, description (en ligne et
COMMENT ONdu DDL), code BT, accesseur, clé de configuration, écrans qui l'affichent, flux, nombre d'écritures et de lectures, nullable, défaut. Une ligne ouvre les références dans le code, écritures d'abord, regroupées par flux : traitement, import PA, statuts PA, factures reçues, e-reporting, entrée, tâches, notifications, authentification, API, écrans, base de données, ligne de commande. La grille est la table de données partagée ; sa vue figure dans l'éditeur des vues de liste.
La référence complète des tables est aussi publiée dans Tables de base de données.
Configuration
Chaque clé de configuration, avec l'endroit où elle se modifie et le code qui la lit. Les modèles sont listés à gauche, regroupés comme la navigation des paramètres — réglages globaux, documents, modèles PDF, connecteurs API et SQL, e-invoicing, e-reporting, tâches et entrées… — avec leur nombre de clés et d'écarts. La grille présente les clés du modèle choisi :
| Colonne | Description |
|---|---|
| Clé | La clé de configuration. |
| Libellé | Le libellé du champ dans l'éditeur de paramètres. |
| Modifiée dans | Modèle, onglet et groupe du champ dans l'éditeur. |
| Lue par | Les flux dont le code lit la clé. |
| Appels | Nombre de lectures Java. Une ligne ouvre le champ de l'éditeur et le code. |
| État | modifiable, lue · modifiable, jamais lue · lue, non modifiable. |
| Modèles | Les modèles qui portent la clé. |
| Aide | Le texte d'aide du champ. |
Deux cases à cocher, exclusives l'une de l'autre, isolent les écarts : Lues mais non modifiables (une clé lue par le code qu'aucun écran ne propose) et Modifiables mais jamais lues (un champ sans effet). Les clés construites à l'exécution — fetchAll.N.*, folder.N.*, filter.* — ne figurent pas littéralement dans le code et apparaissent comme modifiables seulement.
Flux
Une page courte par flux : traiter un fichier, suivi des imports, récupération des statuts, e-reporting, dossiers surveillés, retraitement. Chacune indique le déclencheur, la commande en ligne de commande, le module de journal, les tables touchées, les statuts écrits, les réglages lus et les étapes dans l'ordre. Choisir un flux à gauche pour le lire.
Impact
Ce qu'atteint une modification. Le sélecteur procède par étapes :
- le type — Colonne, Clé de configuration ou Statut ;
- la table ou le modèle ;
- l'élément, dans une liste large qui affiche d'abord le libellé.
Le résultat liste les flux, les écrans, les points d'API et les commandes que l'élément atteint, le champ d'éditeur qui permet de le modifier, puis le code. Les points d'API viennent d'une analyse des routes du serveur jusqu'à leur classe de traitement ; codes et libellés de statut viennent du catalogue des statuts de l'instance.
API
L'API de l'instance, présentée comme les autres vues :
- groupes et étiquettes à gauche avec leur nombre d'opérations — Invoices & documents, Processing, Platforms, Operations, Administration, Developer ;
- une ligne par opération dans la table de données partagée : méthode, chemin, résumé, étiquette, groupe, accès (public, tout utilisateur connecté, ou l'action qu'un rôle doit accorder) ;
- une fenêtre par opération avec la description, les paramètres et des exemples de requête et de réponse construits à partir des schémas, références résolues.
Prise en main ouvre l'introduction du document (session et jeton, droits, réponses, clé de facture, dates, pagination, exécutions en arrière-plan). Ouvrir la référence publique (Redoc) ouvre le même document dans Redoc, qui sert aussi les lecteurs extérieurs à l'application — voir la référence API de ce site.
Accès
Accorder Développeur dans le groupe Documentation de la page Rôles. La page lit les fichiers produits à la construction et, pour le champ Renommée en, les noms de tables des réglages courants ; elle n'interroge pas les tables de facture.
Conseils & bonnes pratiques
- Consulter Impact avant de renommer une colonne ou de retirer un réglage. Les flux et points d'API listés sont ceux à retester.
- Revoir les écarts de la vue Configuration après une mise à jour. Une clé modifiable, jamais lue est un champ à nettoyer ; une clé lue, non modifiable n'est accessible qu'en modifiant le fichier.
- Faire lire les pages Flux à un nouvel arrivant avant le code : chacune décrit une chaîne en une page.