Aller au contenu principal

Rapport technique

L'onglet Rapport technique de la page Rapports produit la documentation développeur de la version : comment NomaUBL est construit, à quoi sert chaque table et chaque clé de configuration, quels flux les utilisent, ce que propose l'API. Il est produit à partir des analyses du code intégrées à l'application à la construction — les mêmes sources que la référence développeur — et il est donc identique sur toutes les instances d'une même version, quel que soit le système source (JD Edwards, SAP, NetSuite ou un ERP personnalisé).

Il complète les deux autres documents de la page : le rapport d'implémentation décrit le paramétrage de cette instance, le rapport d'audit l'activité d'une période.

Vue d'ensemble​

Statistiques statutsIntégritéRequêteurRapport d'auditRapport d'implémentationRapport techniqueDocumentation développeur de la version, produite à partir des analyses du code embarquées. Identique sur toutes les instances d'une version.LangueFrançais ▾Libellé de date (garde)par défaut : aujourd'huiSectionsPérimètrescopeArchitecturearchitectureModèle de donnéesdataFluxflowsRéférence de configurationconfigurationModèle de statutsstatusesMatrice d'impactimpactRéférence de l'APIapiLigne de commandecliCompilation et paquetagebuildAnnexe : références dans le codeappendixDétailler chaque opération de l'API (description et paramètres)Inclure les extraits de code en annexe (long)⬇ Télécharger le PDF⬇ Télécharger le Markdown6e onglet des Rapportsaprès le rapport d'implémentationOnze sectionstoutes cochées par défautIdentique partoutproduit à partir de la versionDeux optionsdétail de l'API · extraits de codePDF ou Markdowncopie dans reports/

Contrôles​

ContrôleDescription
LangueFrançais ou anglais ; par défaut, la langue de l'interface.
Libellé de date (page de garde)Texte libre imprimé sur la page de garde ; vide = date du jour.
SectionsLes onze sections, toutes cochées par défaut ; chacune affiche son identifiant.
Détailler chaque opération de l'API (description et paramètres)Visible quand Référence de l'API est cochée. Décochée par défaut : la référence liste alors les opérations avec leur accès seulement.
Inclure les extraits de code en annexe (long)Visible quand Annexe : références dans le code est cochée. Décochée par défaut.
Télécharger le PDF / Télécharger le MarkdownProduit le fichier et le télécharge (nomaubl-technical-<date>-<heure>.pdf ou .md). Une copie est conservée dans le dossier reports de l'environnement.

Sections​

Section (identifiant)Contenu
Périmètre (scope)La version de NomaUBL, sa date de compilation, l'analyse du code à l'origine du document, la date et l'auteur de la génération, et l'environnement dont les noms de tables sont résolus.
Architecture (architecture)Composants (interface, serveur, clients de plateforme, rapports), exécution (un dossier et un serveur par environnement) et sécurité (authentification, sessions).
Modèle de données (data)Chaque table avec ses colonnes, les clés de configuration, flux et appels qui les utilisent, et le nom retenu dans cette instance quand il diffère.
Flux (flows)Les documents de flux — traiter un fichier, suivi des imports, récupération des statuts, e-reporting, dossiers surveillés, retraitement — chacun complété des tables, statuts et clés que son code utilise.
Référence de configuration (configuration)Chaque clé avec son champ de paramétrage, l'endroit où elle se modifie, les flux qui la lisent, ses appels et son état, avec une synthèse des écarts.
Modèle de statuts (statuses)Statuts des factures et de l'e-reporting : noms, codes, libellés, groupes et flux qui les attribuent.
Matrice d'impact (impact)Pour chaque flux, les colonnes et clés les plus référencées.
Référence de l'API (api)Les opérations de l'API avec l'accès que chacune demande ; avec l'option, leur description et leurs paramètres.
Ligne de commande (cli)Les options, tirées de l'aide intégrée.
Compilation et paquetage (build)Les étapes de construction, les éléments produits et l'organisation du jar.
Annexe : références dans le code (appendix)Les références du code qui fondent les sections ; avec l'option, les extraits.

Ligne de commande et API​

java -jar nomaubl.jar -techreport /opt/nomaubl/demo/config/config.json [--lang fr|en] [--format md|pdf] [--out <fichier>] [--date <libellé>] [--sections a,b,...] [--api-detail] [--snippets]

Par défaut : toutes les sections, Markdown, français, fichier nomaubl-technical-<langue>.md dans le dossier courant (la ligne de commande ne conserve pas de copie dans reports). Voir Ligne de commande.

La route de l'API est GET /api/reports/technical, avec les paramètres lang, format, date, sections, apiDetail et snippets.

Accès​

L'onglet fait partie de la page Rapports : accorder Rapports sur la page Rôles. La génération demande en outre la fonctionnalité Settings access.

Conseils & bonnes pratiques​

  • Le produire à chaque mise à jour et le conserver avec les notes de version : c'est la vue développeur de ce qui a changé.
  • Le remettre à un intégrateur avec le rapport d'implémentation de l'instance : le premier explique le produit, le second son paramétrage.
  • Ne cocher que les sections utiles pour un document ciblé — modèle de données et référence de configuration pour une question de base ou de réglage, référence de l'API pour une intégration.