Modèles personnalisés d’exportation de documents

L’assistant d’exportation de documents de Requirements Portal vous permet de créer rapidement des fichiers Microsoft Word *.docx modifiables directement à partir de vos exigences et de vos activités de V&V. Vous pouvez utiliser des modèles prédéfinis ou importer vos propres modèles. L’assistant s’appuie sur la bibliothèque Python-Docx-Template, qui utilise elle-même le moteur de modèles Jinja. Cette combinaison vous permet de créer des modèles personnalisés.

Bibliothèque Python-Docx-Template

La bibliothèque Python-Docx-Template est un outil puissant qui étend les fonctionnalités de la bibliothèque Python-Docx. Elle intègre le moteur de modèles Jinja, permettant de générer du contenu dynamique dans vos fichiers Word. Vous pouvez ainsi utiliser des variables, des boucles et des conditions pour remplir votre document avec des données à la volée. En somme, c’est comme donner un coup de fouet à votre document Word.

Notez que, pour les champs au format texte enrichi, le préfixe r doit être utilisé dans le modèle d’exportation. Par exemple, le champ de texte de l’exigence doit être inclus dans le modèle sous la forme r requirement.text.

Gestion des modèles d’exportation

Les modèles disponibles dans votre instance de Requirements Portal sont répertoriés sur la page Settings – Export templates (accessible en cliquant sur l’icône  en haut à droite, en sélectionnant Settings dans le menu qui s’affiche, puis en sélectionnant Export templates dans la liste du volet de gauche).

  • Par défaut, six modèles sont fournis : trois pour l’exportation de documents d’exigences et trois pour l’exportation de documents d’activités de V&V.

    • Pour plus d’informations sur les modèles d’exportation d’exigences, consultez la page Exportation de documents.

    • Pour plus d’informations sur les modèles d’exportation d’activités de V&V, consultez la page Exportation de documents.

  • Pour ajouter un nouveau modèle personnalisé, cliquez sur le bouton  en haut à gauche de la page. Dans la fenêtre Add template qui s’affiche, choisissez si le nouveau modèle doit s’appliquer à Requirements ou à V&V Activities à l’aide de la liste déroulante Applicable objects, puis utilisez la zone Select template pour sélectionner le fichier du modèle.

    Cliquez sur le bouton  dans la boîte de dialogue pour ajouter le modèle. Il apparaîtra dans la liste de la page Export templates et pourra ensuite être utilisé pour l’exportation de documents.

  • Le fichier de n’importe quel modèle peut être téléchargé. Pour ce faire, cliquez sur le bouton  dans la colonne Name du modèle souhaité et sélectionnez la commande Download. Selon les paramètres de votre navigateur, celui-ci téléchargera automatiquement le fichier vers un emplacement prédéfini ou vous demandera où l’enregistrer sur votre disque dur.

  • Un modèle personnalisé peut être remplacé par un nouveau fichier de modèle. Pour ce faire, cliquez sur le bouton  dans la colonne Name du modèle souhaité et sélectionnez la commande Overwrite Template dans le menu qui s’affiche. Utilisez la fenêtre Overwrite template qui s’ouvre pour définir à quoi s’applique le modèle et sélectionner le nouveau fichier. Activez l’option I confirm I want to overwrite et cliquez sur le bouton  pour terminer l’opération.

Annexe – Structure de l’objet de données des modèles d’exportation d’exigences

Plusieurs modèles d’exportation d’exigences par défaut sont disponibles dans une instance de Requirements Portal :

  • Specification Doc.docx – ce modèle génère et exporte les exigences de manière similaire à la fonctionnalité Vue Document.

  • Specification Table.docx – notre modèle d’origine présente les attributs d’exigence les plus pertinents dans un tableau clair.

  • Requirement Traceability and Verification Matrix.docx – ce modèle vous permet de générer un fichier doc contenant des informations sur les parents, les enfants et les références de conception de l’exigence, ainsi que sur l’intention et le statut de vérification et de validation.

  • Requirements Verification Matrix.docx – ce modèle vous permet de générer un fichier doc contenant des informations sur l’intention et le statut de vérification et de validation de l’exigence.

N’hésitez pas à ajouter, supprimer ou modifier des sections pour mieux répondre à vos besoins de documentation. Après avoir parcouru les fichiers de modèles par défaut dans l’ordre indiqué ci-dessus, vous aurez peut-être envie d’explorer toutes les possibilités de contenu pour vos rapports.

Voici la structure de base de l’objet dont vos modèles d’exportation d’exigences extrairont les informations.

Tri des champs

Vous pouvez trier les exigences à l’aide de la fonction Sort dans le document de modèle Jinja. Par exemple, vous pouvez ajouter |sort(attribute='identifier') pour trier les exigences par ordre alphanumérique selon la colonne des identifiants.

Exemple :

{% for requirement in requirements|selectattr("specification_id", "equalto", specification.id)|selectattr("group_id", "none") |sort(attribute='identifier') -%}

Colonnes personnalisées

L’outil actuel d’exportation de documents vous permet d’exporter facilement les valeurs des colonnes personnalisées. Pour une colonne personnalisée contenant du texte simple, vous pouvez utiliser la structure générique suivante :

{% for custom_field in requirement.custom_fields|selectattr(“field”, “equalto”, “Name of Custom Column”) %}{{r custom_field.value }}{% endfor %}

Veillez à remplacer le texte Name of Custom Column par le nom réel de la colonne indiqué dans son en-tête.

Si la colonne personnalisée ne contient pas de texte, mais propose une sélection multiple, l’utilisateur peut utiliser le code suivant et l’adapter à son cas d’utilisation.

{%- if requirement.custom_fields -%}
     {%- set additional_info_values = [] -%}
     {%- set category_values = [] -%}
     {%- set additional_info_custom_fields = requirement.custom_fields | selectattr('field', 'equalto', 'Additional Information') -%}
     {% for custom_field in additional_info_custom_fields -%}
      {%- set additional_info_values = additional_info_values + custom_field.value -%}
     {% endfor -%}
     {%- set category_custom_fields = requirement.custom_fields | selectattr('field', 'equalto', 'Category') -%}
     {% for custom_field in category_custom_fields -%}
           {%- set category_values = category_values + custom_field.value -%}
     {% endfor -%}
{%- set additional_info_string = additional_info_values | join(';') -%}
{%- set category_string = category_info_values | join(';') -%}
{%- endif -%}

Annexe – Structure de l’objet de données des modèles d’exportation d’activités de V&V

Plusieurs modèles d’exportation d’activités de V&V par défaut sont disponibles dans une instance de Requirements Portal :

  • V&V Activity Document.docx – contient des informations sur les activités sélectionnées comme contexte d’exportation.

  • V&V Matrix.docx – présente les liens entre les activités sélectionnées comme contexte d’exportation et les exigences, ainsi que leurs blocs associés.

  • V&V Runs Document.docx – contient des informations sur les exécutions des activités sélectionnées comme contexte d’exportation.

Voici la structure de base de l’objet dont vos modèles d’exportation d’activités de V&V extrairont les informations.

AI-LocalizedLocalisé par IA
Si vous trouvez un problème, sélectionnez le texte/l’image et appuyez surCtrl + Enterpour nous envoyer vos commentaires.
Contents
Disponibilité des fonctionnalités

Les fonctionnalités auxquelles vous avez accès dépendent de la solution Altium dont vous disposez – Altium Develop, Altium Agile Teams, Altium Agile Enterprise, ou Altium Designer (avec un abonnement actif).

Si vous ne voyez pas une fonctionnalité documentée dans votre logiciel actuel, contactez le service commercial d’Altium pour en savoir plus.

Contents