Benutzerdefinierte Vorlagen für den Dokumentexport

Mit dem Dokumentexport-Assistenten von Requirements Portal erstellen Sie im Handumdrehen bearbeitbare Microsoft Word *.docx-Dateien direkt aus Ihren Anforderungen und V&V-Aktivitäten. Sie können vordefinierte Vorlagen verwenden oder eigene Vorlagen hochladen. Der Assistent basiert auf der Bibliothek Python-Docx-Template, die wiederum die Jinja-Template-Engine nutzt. Mit diesem leistungsstarken Duo können Sie individuelle Vorlagen erstellen.

Python-Docx-Template-Bibliothek

Die Python-Docx-Template-Bibliothek ist ein leistungsstarkes Werkzeug, das den Funktionsumfang der Python-Docx-Bibliothek erweitert. Sie integriert die Jinja-Template-Engine und ermöglicht so die dynamische Generierung von Inhalten in Ihren Word-Dateien. Das bedeutet, dass Sie Variablen, Schleifen und Bedingungen verwenden können, um Ihr Dokument dynamisch mit Daten zu füllen. Im Grunde ist das wie ein Espresso für Ihr Word-Dokument.

Beachten Sie, dass für Rich-Text-Felder das Präfix r in der Exportvorlage verwendet werden muss. Beispielsweise muss das Feld für den Anforderungstext als r requirement.text in die Vorlage aufgenommen werden.

Exportvorlagen verwalten

Die für Ihre Requirements Portal-Instanz verfügbaren Vorlagen werden auf der Seite Settings – Export templates aufgelistet. Sie erreichen diese Seite, indem Sie oben rechts auf das Symbol  klicken, im angezeigten Menü Settings und anschließend in der Liste im linken Bereich Export templates auswählen.

  • Standardmäßig stehen sechs Vorlagen zur Verfügung – drei für den Export von Anforderungsdokumenten und drei für den Export von V&V-Aktivitätsdokumenten.

    • Weitere Informationen zu Exportvorlagen für Anforderungen finden Sie auf der Seite Dokumentexport.

    • Weitere Informationen zu Exportvorlagen für V&V-Aktivitäten finden Sie auf der Seite Dokumentexport.

  • Um eine neue benutzerdefinierte Vorlage hinzuzufügen, klicken Sie oben links auf der Seite auf die Schaltfläche . Wählen Sie im daraufhin angezeigten Fenster Add template über das Dropdown-Menü Applicable objects aus, ob die neue Vorlage auf Requirements oder V&V Activities angewendet werden soll, und wählen Sie anschließend im Bereich Select template die Vorlagendatei aus.

    Klicken Sie im Dialog auf die Schaltfläche , um die Vorlage hinzuzufügen. Sie wird in der Liste auf der Seite Export templates angezeigt und kann anschließend für den Dokumentexport verwendet werden.

  • Die Datei jeder Vorlage kann heruntergeladen werden. Klicken Sie dazu in der Spalte Name der gewünschten Vorlage auf die Schaltfläche  und wählen Sie den Befehl Download aus. Je nach Ihren persönlichen Browsereinstellungen lädt Ihr Browser die Datei entweder automatisch an einen vordefinierten Speicherort herunter oder fragt Sie, wo Sie sie auf Ihrer Festplatte speichern möchten.

  • Eine benutzerdefinierte Vorlage kann durch eine neue Vorlagendatei überschrieben werden. Klicken Sie dazu in der Spalte Name der gewünschten Vorlage auf die Schaltfläche  und wählen Sie im angezeigten Menü den Befehl Overwrite Template aus. Legen Sie im daraufhin geöffneten Fenster Overwrite template den Anwendungsbereich der Vorlage fest und wählen Sie die neue Datei aus. Aktivieren Sie die Option I confirm I want to overwrite und klicken Sie auf die Schaltfläche , um den Vorgang abzuschließen.

Anhang – Datenobjektstruktur der Exportvorlagen für Anforderungen

In einer Requirements Portal-Instanz stehen mehrere Standardvorlagen für den Export von Anforderungen zur Verfügung:

  • Specification Doc.docx – diese Vorlage generiert und exportiert die Anforderungen ähnlich wie die Funktion Dokumentansicht.

  • Specification Table.docx – unsere ursprüngliche Vorlage enthält die wichtigsten Anforderungsattribute in einem übersichtlichen Tabellenformat.

  • Requirement Traceability and Verification Matrix.docx – mit dieser Vorlage können Sie eine DOC-Datei erstellen, die Informationen zu übergeordneten und untergeordneten Anforderungen sowie zu Designreferenzen enthält. Außerdem werden die geplante Verifizierung und Validierung sowie deren Status aufgeführt.

  • Requirements Verification Matrix.docx – mit dieser Vorlage können Sie eine DOC-Datei erstellen, die Informationen zur geplanten Verifizierung und Validierung einer Anforderung sowie zu deren Status enthält.

Sie können Abschnitte nach Bedarf hinzufügen, entfernen oder ändern, um die Vorlage besser an Ihre Dokumentationsanforderungen anzupassen. Nachdem Sie die Standardvorlagendateien in der oben angegebenen Reihenfolge durchgesehen haben, möchten Sie vielleicht selbst ausprobieren, welche weiteren Informationen Sie in Ihre Berichte aufnehmen können.

Hier sehen Sie die grundlegende Struktur des Objekts, aus dem Ihre Exportvorlagen für Anforderungen Informationen abrufen.

Felder sortieren

Sie können die Anforderungen mithilfe der Funktion Sort im Jinja-Vorlagendokument sortieren. Beispielsweise können Sie |sort(attribute='identifier') hinzufügen, um die Anforderungen anhand der Kennungsspalte alphanumerisch zu sortieren.

Beispiel:

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

Benutzerdefinierte Spalten

Mit dem aktuellen Dokumentexporter können Sie die Werte benutzerdefinierter Spalten ganz einfach exportieren. Für eine einfache textbasierte benutzerdefinierte Spalte können Sie die folgende allgemeine Struktur verwenden:

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

Ersetzen Sie den Text Name of Custom Column unbedingt durch den tatsächlichen Namen der Spalte, der in der Spaltenüberschrift angegeben ist.

Wenn die benutzerdefinierte Spalte keinen Text, sondern eine Mehrfachauswahl enthält, können Sie den folgenden Code verwenden und an Ihren Anwendungsfall anpassen.

{%- 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 -%}

Anhang – Datenobjektstruktur der Exportvorlagen für V&V-Aktivitäten

In einer Requirements Portal-Instanz stehen mehrere Standardvorlagen für den Export von V&V-Aktivitäten zur Verfügung:

  • V&V Activity Document.docx – enthält Informationen zu den Aktivitäten, die als Exportkontext ausgewählt wurden.

  • V&V Matrix.docx – enthält Verknüpfungen zwischen den als Exportkontext ausgewählten Aktivitäten und den Anforderungen sowie deren zugehörigen Blöcken.

  • V&V Runs Document.docx – enthält Informationen zu den Durchläufen der Aktivitäten, die als Exportkontext ausgewählt wurden.

Hier sehen Sie die grundlegende Struktur des Objekts, aus dem Ihre Exportvorlagen für V&V-Aktivitäten Informationen abrufen.

AI-LocalizedKI-lokalisiert
Wenn Sie ein Problem feststellen, wählen Sie den Text/das Bild aus und drücken SieCtrl + Enter, um uns Ihr Feedback zu senden.
Contents
Funktionsverfügbarkeit

Die Ihnen zur Verfügung stehenden Funktionen hängen davon ab, über welche Altium-Lösung Sie verfügen – Altium Develop, Altium Agile Teams, Altium Agile Enterprise oder Altium Designer (mit aktivem Laufzeitvertrag).

Wenn Sie eine dokumentierte Funktion in Ihrer tatsächlich verwendeten Software nicht sehen, wenden Sie sich an den Altium-Vertrieb, um mehr zu erfahren.

Contents