Pages d’inspection, debug et audit

Les pages d'inspection sont des pages spécifiques pour aider à comprendre et à débugguer les demandes, les formulaires et les workflows.
Elles s'adressent aux administrateurs fonctionnels de Publik, pour mettre en qualité une démarche ou identifier l'origine d'un dysfonctionnement. 

Inspecteur de formulaire

La page d'inspection d'un formulaire est accessible en cliquant sur le bouton « Inspecteur » à droite depuis la page d'accueil du formulaire.

Elle est composée de 5 rubriques :

• Informations : Affiche les métadonnées du formulaire (Titre, Description, Mots-clés, Catégorie)
• Workflow : Affiche un résumé du paramétrage du workflow et de ses options
• Options : Affiche un résumé des options de paramétrage du formulaire (gabarits, publication, suivi, etc.)
• Champs : Affiche un résumé sur l'ensemble du paramétrage de tous les éléments composant le formulaire (pages, champs, blocs)
• Brouillons : Affiche des statistiques sur les brouillons des usagers et calcule le taux d’achèvement de la démarche

À quoi ça sert ? 

L'onglet Champs est le plus important : couplé à la fonction de recherche du navigateur, il va simplifier l'administration fonctionnelle du formulaire : 

• Faciliter le renommage de l'identifiant d'un champ qui serait utilisé dans des conditions (on peut les identifier/surligner en un coup d'oeil pour les mettre à jour)
• Vérifier les paramètres d'anonymisation de tous les champs (indispensable avant une mise en production)
• Repérer des styles ou des paramètres manquants sur certains champs (pour homogénéiser ou sécuriser le formulaire)
• Mettre à jour une condition utilisée à plusieurs endroits 

Inspecteur de workflow

La page d'inspection d'un workflow est accessible en cliquant sur le bouton « Inspecteur » à droite depuis la page d'accueil du workflow.

Elle est composée de 5 rubriques :

• Statuts : Affiche un résumé technique complet du paramétrage de tous les statuts et de toutes les actions composant le workflow 
• Actions globales : Affiche un résumé technique complet du paramétrage des actions globales
• Fonctions : Affiche un résumé des fonctions définies sur le workflow
• Variables du workflow : Affiche un résumé des variables définies sur le workflow
• Données de traitement : Affiche un résumé des données de traitement définies sur le workflow

À quoi ça sert ? 

La page d'inspection du workflow offre une vue synthétique particulièrement utile pour réorganiser ou mettre au propre un workflow après la phase d'expérimentation ou de développement. Elle permet notamment de :

• Simplifier le renommage de l'identifiant d'un champ de formulaire de workflow, d'une donnée de traitement, ou d'une option partout où il est utilisé dans le workflow
• Vérifier les paramètres d'anonymisation des données de traitement (indispensable avant une mise en production)
• Mettre à jour une condition utilisée à plusieurs endroits 
• Contrôler le paramétrage de toutes les actions globales du formulaire en un coup d'oeil (pour vérifier qu'elles ont toutes le bon déclencheur par exemple)
• Etc.

Inspecteur d'une demande ou d'une fiche

Cette page n'est accessible que lorsqu'une demande ou une fiche a été remplie pour le formulaire concerné. Il faut donc s'assurer au préalable qu'il y a bien une demande/fiche existante pour le formulaire ou le modèle de fiche concerné.

Pour chaque demande/fiche, la page d'inspection de celle-ci est accessible en cliquant sur le lien « Inspection des données » en marge droite.

Il existe une alerte visuelle lorsqu'une valeur contient une succession d'espaces, ce qui permet de détecter plus facilement les incohérences dans les recherches, l'utilisation de filtres de requête ou l'écriture de conditions.

Outils de test

Cet outil va vous permettre de tester le résultat de conditions et de gabarit utilisant différentes syntaxes :

• Condition (Django)
• Gabarit / Expression Django
• Gabarit HTML (WYSIWYG)

Cela facilite grandement la compréhension du fonctionnement des conditions.

Onglet « Variables »

Sous l'outil de test, on trouvera :

• Dans la première colonne : l'ensemble des variables utilisées pour cette demande
• Dans la deuxième colonne : la valeur de ces variables au moment où on regarde cet écran (et parfois leur type entre parenthèses).

Cet écran permet donc de vérifier la valeur d'une variable à un instant t du traitement et facilite ainsi la recherche et l'identification des problèmes.

Onglet « Fonctions »

La page d'inspection d'un formulaire est accessible en cliquant sur le lien « Inspecteur » à droite depuis la page d'accueil du workflow.

Inspecteur d'un blocs de champs

La page d'inspection d'un bloc de champs est accessible en cliquant sur le lien « Inspecteur » à droite depuis la page d'accueil du bloc.

L'onglet « Champs  » offre une vue technique sur l'ensemble du paramétrage des champs.

Portail - Outil de test de gabarit

Permet de tester un gabarit Django et d'ajouter une URL récupérant les variables de la page.

Journal d'audit (liste des accès à une demande ou à une fiche)

Consulter la page dédiée au journal d'audit dans w.c.s.

Journal des erreurs

Chaque fois qu’une erreur est générée, la trace apparaît dans le backoffice (sur la page du workflow et sur la page du formulaire concernés, ainsi que sur la page d’accueil « studio »).
Le journal contient un lien vers la page d'inspection de la demande.