Les templates des rapports

Prérequis

Pour ajouter des templates personnalisés, il est nécessaire d'avoir des droits d'écriture sur le répertoire dans lequel se trouvent les templates sur le serveur hébergeant Squash. Il s'agit du répertoire défini par le paramètre de configuration spring.config.location.

Gestion des templates personnalisés

L'ancre Template des rapports permet de gérer les templates personnalisés des rapports éditables. Ces templates peuvent ensuite être sélectionnés lors de la création de rapports depuis l'espace Pilotage.

La rapports concernés sont les suivants :

Cahier des exigences éditable ;
Cahier de test éditable ;
Bilan de campagne ;
Bilan d'itération.

Chaque bloc correspond à un rapport et comporte la liste des templates actuellement disponibles.
Depuis chaque bloc, il est possible :

d'ajouter un template ;
de supprimer un template ;
de télécharger un template .

Info

Les templates doivent être obligatoirement au format .docx.
Lorsqu'un template utilisé dans l'espace Pilotage est supprimé, l'administrateur est averti. Mais s'il procède tout de même à la suppression, le template par défaut sera utilisé lors de la génération du rapport.
Lorsque l'administrateur ajoute un template déjà présent, il est averti qu'il sera écrasé par le nouveau template. Cela permet notamment de gérer les modifications apportées aux templates sans perdre le lien avec les rapports dans l'espace Pilotage.

Personnalisation des templates

Attention

Il est vivement recommandé de tester les templates personnalisés sur une instance de recette avant de les passer en production.
Le contenu des templates personnalisés est de la responsabilité des utilisateurs et n'entre pas dans le cadre du support en cas d'erreur à la génération ou à l'ouverture du rapport.

La personnalisation des templates peut notamment permettre :

d'avoir des rapports avec le logo ou la charte graphique de l'entreprise ;
de modifier l'ordre des parties des rapports ;
de modifier le contenu des parties des rapports.

La modification de l'ordre ou du contenu des parties du rapport peut entraîner des erreurs lors de la génération ou de l'ouverture du rapport.

Afin de minimiser les risques d'erreur, il est recommandé de suivre les étapes suivantes pour mettre à disposition un template personnalisé :

Télécharger le template par défaut du rapport ;
Modifier le template ;
Ajouter le template personnalisé depuis cette page ;
Vérifier l'intégrité du template personnalisé en allant dans l'espace pilotage puis en générant un rapport avec ce template et en l'ouvrant.

Focus

Il est recommandé de nommer les templates de manière claire, précise et non ambiguë afin que l'utilisateur sache à quoi correspond le template. En effet, lors de la création de rapport, l'utilisateur voit une liste avec l'ensemble des templates de l'instance caractérisés par le nom du fichier correspondant.

Montée de version

Lors d'une montée de version, il est possible que des modifications soient apportées sur les templates par défaut. Cela peut éventuellement affecter les templates personnalisés et entraîner des erreurs lors de la génération de rapport avec ces templates.

Afin d'anticiper ces éventuels changements, il est recommandé :

de consulter les release notes des rapports concernés à chaque nouvelle version de Squash ;
de télécharger le template par défaut de Squash dans sa nouvelle version ;
de reporter les modifications dans ce template.