Benutzerdefinierte Vorlagen für den Dokumentexport

Der Assistent für den Dokumentexport im Requirements & Systems Portal ist Ihre erste Anlaufstelle, um bearbeitbare Microsoft Word *.docx-Dateien direkt aus Ihren Anforderungen und V&V-Aktivitäten zu erstellen. Sie können vordefinierte Vorlagen verwenden oder eigene Vorlagen hochladen. Der Assistent basiert auf der Python-Docx-Template-Bibliothek, die wiederum die Jinja Templating Engine nutzt. Dieses leistungsstarke Duo ermöglicht Ihnen die Erstellung benutzerdefinierter Vorlagen.

Python-Docx-Template-Bibliothek

Die Python-Docx-Template-Bibliothek ist ein leistungsstarkes Werkzeug, das die Funktionalität der Python-Docx-Bibliothek erweitert. Sie integriert die Jinja Templating Engine und ermöglicht dadurch die dynamische Generierung von Inhalten in Ihren Word-Dateien. Das bedeutet, dass Sie Variablen, Schleifen und Bedingungen verwenden können, um Ihr Dokument zur Laufzeit mit Daten zu befüllen. Im Grunde ist es, als würden Sie Ihrem Word-Dokument einen Espresso verpassen.

Beachten Sie, dass bei Feldern mit Rich-Text-Inhalt im Export-Template das Präfix r verwendet werden muss. Zum Beispiel muss das Anforderungs-Textfeld im Template als r requirement.text eingefügt werden.

Exportvorlagen verwalten

Die für Ihre Requirements & Systems Portal-Instanz verfügbaren Vorlagen sind auf der Seite Export templates aufgeführt (  » Settings » Export templates).

  • Standardmäßig werden sechs Vorlagen bereitgestellt – 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 Document Export.

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

  • Um eine neue benutzerdefinierte Vorlage hinzuzufügen, klicken Sie oben rechts auf der Seite auf die Schaltfläche . Wählen Sie im daraufhin angezeigten Fenster Add template über die Dropdown-Liste Applicable objects aus, ob die neue Vorlage auf Requirements oder V&V Activities angewendet werden soll, und verwenden Sie dann den Bereich Select template, um die Vorlagendatei auszuwählen.

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

  • Die Datei jeder Vorlage kann heruntergeladen werden. Klicken Sie dazu im Name-Bereich der gewünschten Vorlage auf die Schaltfläche  und wählen Sie den Befehl Download aus. Abhängig von Ihren persönlichen Browsereinstellungen lädt Ihr Browser die Datei entweder automatisch an einen vordefinierten Speicherort herunter oder fragt Sie, wo sie auf Ihrer Festplatte gespeichert werden soll.

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

Anhang – Datenobjektstruktur von Anforderungsexportvorlagen

In einer Requirements & Systems Portal-Instanz sind drei Standardvorlagen für den Anforderungsexport verfügbar, die jeweils schrittweise komplexer werden. Wenn Sie Ihre Vorlagenkenntnisse also erweitern möchten, ist es sinnvoll, sie der Reihe nach durchzugehen. Hier ist die Übersicht:

  • spec_doc.docx – dies ist Ihre einfache Standardvorlage, die eine Ausgabe erzeugt, die mit der Anforderungen-Dokumentansicht identisch ist. Sie eignet sich hervorragend für Einsteiger und deckt einfache Schleifen und Variablen ab.

  • spec_table.docx – diese Vorlage geht einen Schritt weiter und führt Bedingungen und Filter ein. Hier wird es interessanter. Sie ist die Jinja-Version unserer skriptbasierten Word-Vorlage mit Seriendruckfeldern.

  • req_verification.docx – der Großmeister unter unseren Vorlagen. Diese Vorlage enthält zahlreiche verschachtelte Schleifen und Bedingungen und verwendet sogar Tabellen. Wenn Sie diese beherrschen, sind Sie praktisch ein Jedi der Dokumentvorlagenerstellung.

Sie können Abschnitte beliebig hinzufügen, entfernen oder anpassen, damit sie besser zu Ihren Dokumentationsanforderungen passen. Nachdem Sie die Standardvorlagendateien in der oben angegebenen Reihenfolge durchgearbeitet haben, fühlen Sie sich vielleicht abenteuerlustig genug, die Grenzen dessen auszutesten, was Sie in Ihre Berichte aufnehmen können.

Hier ist die Grundstruktur des Objekts, aus dem Ihre Anforderungsexportvorlagen Informationen beziehen.

Sortierung der Felder

Sie können die Anforderungen im Jinja-Vorlagendokument mit der Funktion Sort sortieren. Zum Beispiel können Sie |sort(attribute='identifier') hinzufügen, wobei die Anforderungen alphanumerisch nach der Kennungs-Spalte sortiert werden.

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 einfach exportieren. Für eine benutzerdefinierte Spalte auf Basis von einfachem Text können Sie die folgende generische Struktur verwenden:

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

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

Wenn die benutzerdefinierte Spalte kein Textfeld ist, sondern eine Mehrfachauswahl, kann der Benutzer den folgenden Code verwenden und für seinen 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 von V&V-Aktivitätsexportvorlagen

Hier ist die Grundstruktur des Objekts, aus dem Ihre V&V-Aktivitätsexportvorlagen Informationen beziehen.

AI-LocalizedAI-localized
Wenn Sie ein Problem feststellen, wählen Sie den Text/das Bild aus und drücken SieStrg + Eingabe, um uns Ihr Feedback zu senden.
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.

Inhalt