Aller au contenu principal

Modèles de rapport

Un modèle de rapport est un rapport écrit par un opérateur sans code : une requête d'un connecteur fournit les lignes, des paramètres sont demandés à l'exécution, et un modèle Jinja markdown transforme les lignes en document. Une fois enregistré, le rapport figure sur la page Rapports (/reports) à côté des rapports livrés par les applications, et se télécharge en PDF ou en markdown.

Accès : Liberty Next → Analyse → Modèles de rapport (superutilisateurs).


Vue d'ensemble​

Nouveau rapport personnaliséIDENTIFIANT (SEGMENT URL)orders-summaryTITRESynthèse des commandesCONNECTEURsales ▾REQUÊTE NOMMÉEorders_by_status_get ▾DESCRIPTIONCommandes ouvertes et closes, par statutPARAMÈTREScompanySociétéstring ▾requis🗑+ Ajouter un paramètreMODÈLE JINJA MARKDOWNInsérer un exemple :Liste à pucesTableau markdownSections groupéesRésumé + tableau✦ Échafauder depuis la requête1## Synthèse23- Lignes: {{ ctx.data.rows | length }}45{% for row in ctx.data.rows %}6- {{ row.STATUS }} : {{ row.N }}7{% endfor %}3 sur 3 lignes rendues✕Synthèse• Lignes : 3• Ouverte : 98• Close : 3314• Annulée : 12PARAMÈTRES DE TESTcompany00001▷ Tester le renduEnregistrerAnnulerIdentifiantl'adresse du rapportDonnéesune requête d'un connecteurParamètresdemandés à l'exécutionMarkdown Jinjactx.data.rows, ctx.paramsModèles de départexemples, ou tableau des colonnesAperçule rendu sur les vraies lignesTester le rendu200 lignes au plus, rien d'enregistré

La liste​

La page indique le fichier où les modèles sont enregistrés et leur nombre, puis une carte par modèle : son titre, son identifiant (custom:<slug>) et la requête qu'il lit (<connecteur>.<requête>), avec Modifier et Supprimer — une suppression demande confirmation. Nouveau modèle et Recharger la config se trouvent dans l'en-tête de la page.

L'enregistrement valide chaque modèle, les écrit et met aussitôt à jour la liste des rapports : aucun redémarrage n'est nécessaire.


L'éditeur​

Nouveau modèle, ou Modifier sur une carte, ouvre la fenêtre Nouveau rapport personnalisé / Modifier le rapport personnalisé.

ChampUsage
Identifiant (segment URL)L'identifiant du rapport, qui entre dans son adresse : minuscules, chiffres, - et _. Unique parmi les modèles.
TitreLe titre sur la page Rapports et sur la page de garde du PDF.
Connecteur, Requête nomméeLa source des lignes : une requête d'un connecteur. Les deux sont obligatoires.
DescriptionAffichée sous le titre sur la page Rapports.
ParamètresUne ligne par donnée nécessaire à l'exécution : un nom, un libellé, un type (string, int, float, bool) et requis. Ajouter un paramètre en ajoute un. La requête reçoit les paramètres sous leur nom.
Modèle Jinja markdownLe corps du rapport, en markdown avec des balises Jinja.

Écrire le modèle​

Le modèle lit un contexte, ctx :

NomContenu
ctx.data.rowsLes lignes de la requête, chacune un ensemble de colonnes : {{ row.STATUS }}.
ctx.data.columnsLes colonnes de la requête, avec leur nom et leur libellé.
ctx.paramsLes valeurs saisies par l'utilisateur pour les paramètres.

Les filtres Jinja usuels sont disponibles (length, join, sort, selectattr…). Le modèle s'exécute dans un environnement fermé : rien n'est accessible hors de ce contexte. L'éditeur complète les noms de colonnes de la requête au fil de la saisie.

Au-dessus de l'éditeur, Insérer un exemple propose quatre points de départ — Liste à puces, Tableau markdown, Sections groupées, Résumé + tableau —, chacun remplaçant le corps après confirmation. Échafauder depuis la requête écrit un tableau markdown de toutes les colonnes renvoyées par la requête ; il attend un connecteur et une requête.

Tester le rendu​

Sous l'éditeur, Paramètres de test reçoit une valeur par paramètre, et Tester le rendu exécute la requête avec ces valeurs puis affiche le rendu du modèle à côté de l'éditeur — sur 200 lignes au plus, sans rien enregistrer. L'en-tête de l'aperçu indique le nombre de lignes rendues (3 sur 3 lignes rendues) ou l'échec du rendu, avec son motif. Si la requête renvoie davantage de lignes, l'aperçu le signale ; le rapport réel les contient toutes.


Exécuter un rapport​

La page Rapports liste les rapports que l'utilisateur peut exécuter, y compris ceux des opérateurs. Exécuter ouvre un formulaire avec les paramètres et le format (PDF ou markdown) ; Exécuter et télécharger produit le fichier. Le PDF suit la charte de l'installation — Liberty Next → Administrer → App → Charte des PDF.


Accès​

  • Écrire les modèles : les superutilisateurs, dans Liberty Next → Analyse → Modèles de rapport.
  • Les exécuter : un rôle qui détient reports:custom:*:run voit tous les rapports écrits par les opérateurs sur la page Rapports — la permission se saisit sous forme de motif dans l'éditeur de rôles, voir Rôles et permissions.
  • La requête s'exécute dans le périmètre de données de l'utilisateur, comme partout ailleurs.

Conseils & bonnes pratiques​

  • Écrire une requête par rapport, qui renvoie exactement les colonnes imprimées ; laisser la requête trier et totaliser.
  • Partir d'Échafauder depuis la requête ou d'un exemple, puis Tester le rendu avec des paramètres réalistes avant d'enregistrer.
  • Confier chaque valeur variable à un paramètre plutôt qu'à une constante de la requête : le même modèle sert alors chaque société ou chaque période.