Niestandardowe szablony eksportu dokumentów

Created: Lipiec 14, 2025 | Updated: Październik 31, 2025

Kreator eksportu dokumentów w portalu Requirements Portal umożliwia tworzenie edytowalnych plików Microsoft Word *.docx bezpośrednio z wymagań i działań V&V. Możesz użyć predefiniowanych szablonów lub przesłać własne szablony. Kreator jest zasilany przez bibliotekę Python-Docx-Template, która z kolei wykorzystuje silnik szablonów Jinja. Ten dynamiczny duet umożliwia tworzenie niestandardowych szablonów.

Biblioteka Python-Docx-Template

Biblioteka Python-Docx-Template to potężne narzędzie, które rozszerza funkcjonalność biblioteki Python-Docx. Zawiera ona silnik szablonów Jinja, umożliwiając dynamiczne generowanie treści w plikach programu Word. Oznacza to, że można używać zmiennych, pętli i instrukcji warunkowych do wypełniania dokumentu danymi w locie. Zasadniczo jest to jak dodanie do dokumentu Worda porcji espresso.

Należy pamiętać, że w przypadku pól, które są tekstem sformatowanym, w szablonie eksportu należy użyć prefiksu r. Na przykład pole tekstowe wymagań musi być zawarte w szablonie jako r requirement.text.

Zarządzanie szablonami eksportu

Szablony dostępne dla instancji portalu wymagań są wymienione na stronie Export templates ( » Settings » Export templates ).

Domyślnie dostępnych jest sześć szablonów - trzy dla eksportu dokumentu wymagań i trzy dla eksportu dokumentu działań V&V.
- Więcej informacji na temat szablonów eksportu wymagań można znaleźć na stronie Eksport dokumentów.
- Więcej informacji na temat szablonów eksportu działań V&V można znaleźć na stronie Eksport dokumentów.
Aby dodać nowy szablon zdefiniowany przez użytkownika, kliknij przycisk w prawym górnym rogu strony. W wyświetlonym oknie Add template wybierz, czy nowy szablon ma zostać zastosowany do Requirements czy V&V Activities za pomocą listy rozwijanej Applicable objects, a następnie użyj regionu Select template, aby wybrać plik szablonu.

Kliknij przycisk w oknie dialogowym, aby dodać szablon. Zostanie on wyświetlony na liście na stronie Export templates i będzie można go użyć podczas eksportu dokumentu.
Plik dowolnego szablonu można pobrać. W tym celu należy kliknąć przycisk w kolumnie Name żądanego szablonu i wybrać polecenie Download. Zgodnie z osobistymi ustawieniami przeglądarki, przeglądarka automatycznie pobierze plik do predefiniowanej lokalizacji lub zapyta, gdzie zapisać go na dysku twardym.
Szablon zdefiniowany przez użytkownika można zastąpić nowym plikiem szablonu. W tym celu należy kliknąć przycisk w kolumnie Name wymaganego szablonu i wybrać polecenie Overwrite Template z wyświetlonego menu. Użyj okna Overwrite template, które zostanie otwarte, aby zdefiniować zastosowanie szablonu i wybrać nowy plik. Włącz opcję I confirm I want to overwrite i kliknij przycisk , aby zakończyć proces.

Dodatek - Struktura obiektów danych szablonów eksportu wymagań

W instancji portalu wymagań dostępne są trzy domyślne szablony eksportu wymagań, z których każdy jest stopniowo bardziej złożony od poprzedniego. Jeśli więc chcesz ulepszyć swoją grę szablonową, mądrym posunięciem jest zajęcie się nimi w kolejności. Oto ich lista:

spec_doc.docx - Ten szablon jest prostym, standardowym szablonem, którego zadaniem jest generowanie identycznych danych wyjściowych jak w przypadku widoku dokumentu wymagań. Jest doskonały dla początkujących i obejmuje proste pętle i zmienne.
spec_table.docx - Podnosząc poziom, szablon ten wprowadza warunki i filtry. To jest miejsce, w którym rzeczy zaczynają się robić pikantne. Jest to wersja Jinja naszego opartego na skryptach szablonu Word z polami scalania.
req_verification.docx - arcymistrz naszych szablonów. Ten szablon jest bogaty w zagnieżdżone pętle i instrukcje warunkowe, a nawet zawiera tabele. Jeśli potrafisz go opanować, jesteś w zasadzie Jedi szablonów dokumentów.

Możesz dodawać, usuwać lub modyfikować sekcje, aby lepiej dopasować je do swoich potrzeb dokumentacyjnych. Po przejściu przez domyślne pliki szablonów w podanej powyżej kolejności, możesz poczuć się na tyle odważny, aby przetestować granice tego, co możesz zawrzeć w swoich raportach.

Oto podstawowa struktura obiektu, z którego szablony eksportu wymagań będą pobierać informacje.

Szablony eksportu wymagań - struktura obiektu danych


{
  "specyfikacje": [
    {
      "id": "number",
      "name": "string",
      "description": "string",
      "wymagania": [
        {
          "id": "string",
          "identifier": "string",
          "text": "RichText",
          "title": "string",
          "uzasadnienie": "RichText",
          "images": ["image"],
          "type": "string",
          "verification_methods": [{
            "name": "string",
            "text": "string",
            "component_vms": [{
              "name": "string",
              "closeout_reference": "string"
            }]
          }],
          "specification_id": "number",
          "group_id": "number",
          "applicability_conditions": ["string"],
          "content_type": {
            "id": "string",
            "name": "string"
          },
          "state": "string",
          "zgodność": "string",
          "compliance_comment": "string",
          "tags": ["string"],
          "parents": [{
            "id": "string",
            "identifier": "string",
            "text": "RichText",
            "title": "string"
          }],
          "children": [{
            "id": "string",
            "identifier": "string",
            "text": "RichText",
            "title": "string"
          }],
          "owner": {
            "user": {
              "username": "string",
              "first_name": "string",
              "last_name": "string",
              "groups": ["string"]
            },
            "group": {
              "name": "string",
              "users": ["string"]
            }
          },
          "files": [{
            "name": "string",
            "description": "string",
            "version": "string",
            "is_reference": "boolean",
            "tags": ["string"]
          }],
          "custom_fields": [{
            "field": "string",
            "value": ["string"]
          }],
          "position": "number",
          "verification_items_verified": "number",
          "verification_items_total": "number",
          "verification_items": [{
            "status": "string",
            "component": "string",
            "tagi": ["string"],
            "aktywność": {
              "name": "string",
              "verification_methods": ["string"]
            },
            "last_item_run": {
              "status": "string",
              "comment": "string"
            }
          }],
          "linked_components": [{
            "id": "number",
            "name": "string",
            "description": "string",
            "valis": [{
              "id": "number",
              "name": "string",
              "value": "string",
              "formuła": "string"
            }],
            "textvalis": [{
              "id": "number",
              "name": "string",
              "text": "string"
            }],
            "matrices": [{
              "id": "number",
              "name": "string",
              "value": "string",
              "formuła": "string"
            }],
            "datevalis": [{
              "id": "number",
              "name": "string",
              "date": "string"
            }],
            "creator": "string",
            "attachments": [{
              "name": "string",
              "description": "string",
              "version": "string",
              "is_reference": "boolean",
              "tags": ["string"]
            }]
          }]
        }
      ],
      "content_type": {
        "id": "number",
        "name": "string"
      }
    }
  ],
  "wymagania": [
    {
      "id": "string",
      "identifier": "string",
      "text": "RichText",
      "title": "string",
      "uzasadnienie": "RichText",
      "images": ["image"],
      "type": "string",
      "verification_methods": [{
        "name": "string",
        "text": "string",
        "component_vms": [{
          "name": "string",
          "closeout_reference": "string"
        }]
      }],
      "specification_id": "number",
      "group_id": "number",
      "applicability_conditions": ["string"],
      "content_type": {
        "id": "string",
        "name": "string"
      },
      "state": "string",
      "zgodność": "string",
      "compliance_comment": "string",
      "tags": ["string"],
      "parents": [{
        "id": "string",
        "identifier": "string",
        "text": "RichText",
        "title": "string"
      }],
      "children": [{
        "id": "string",
        "identifier": "string",
        "text": "RichText",
        "title": "string"
      }],
      "owner": {
        "user": {
          "username": "string",
          "first_name": "string",
          "last_name": "string",
          "groups": ["string"]
        },
        "group": {
          "name": "string",
          "users": ["string"]
        }
      },
      "files": [{
        "name": "string",
        "description": "string",
        "version": "string",
        "is_reference": "boolean",
        "tags": ["string"]
      }],
      "custom_fields": [{
        "field": "string",
        "value": ["string"]
      }],
      "position": "number",
      "verification_items_verified": "number",
      "verification_items_total": "number",
      "verification_items": [{
        "status": "string",
        "component": "string",
        "tagi": ["string"],
        "aktywność": {
          "name": "string",
          "verification_methods": ["string"]
        },
        "last_item_run": {
          "status": "string",
          "comment": "string"
        }
      }],
      "linked_components": [{
        "id": "number",
        "name": "string",
        "valis": [{
          "id": "number",
          "name": "string",
          "value": "string",
          "formuła": "string"
        }],
        "textvalis": [{
          "id": "number",
          "name": "string",
          "text": "string"
        }],
        "matrices": [{
          "id": "number",
          "name": "string",
          "value": "string",
          "formuła": "string"
        }],
        "datevalis": [{
          "id": "number",
          "name": "string",
          "date": "string"
        }],
        "creator": "string",
        "attachments": [{
          "name": "string",
          "description": "string",
          "version": "string",
          "is_reference": "boolean",
          "tags": ["string"]
        }]
      }]
    }
  ],
  "requirements_groups": [
    {
      "id": "number",
      "name": "string",
      "description": "string",
      "specification_id": "number",
      "requirements": [
        {
          "id": "string",
          "identifier": "string",
          "text": "RichText",
          "title": "string",
          "uzasadnienie": "RichText",
          "images": ["image"],
          "type": "string",
          "verification_methods": [{
            "name": "string",
            "text": "string",
            "component_vms": [{
              "name": "string",
              "closeout_reference": "string"
            }]
          }],
          "specification_id": "number",
          "group_id": "number",
          "applicability_conditions": ["string"],
          "content_type": {
            "id": "string",
            "name": "string"
          },
          "state": "string",
          "zgodność": "string",
          "compliance_comment": "string",
          "tags": ["string"],
          "parents": [{
            "id": "string",
            "identifier": "string",
            "text": "RichText",
            "title": "string"
          }],
          "children": [{
            "id": "string",
            "identifier": "string",
            "text": "RichText",
            "title": "string"
          }],
          "owner": {
            "user": {
              "username": "string",
              "first_name": "string",
              "last_name": "string",
              "groups": ["string"]
            },
            "group": {
              "name": "string",
              "users": ["string"]
            }
          },
          "files": [{
            "name": "string",
            "description": "string",
            "version": "string",
            "is_reference": "boolean",
            "tags": ["string"]
          }],
          "custom_fields": [{
            "field": "string",
            "value": ["string"]
          }],
          "position": "number",
          "verification_items_verified": "number",
          "verification_items_total": "number",
          "verification_items": [{
            "status": "string",
            "component": "string",
            "tagi": ["string"],
            "aktywność": {
              "name": "string",
              "verification_methods": ["string"]
            },
            "last_item_run": {
              "status": "string",
              "comment": "string"
            }
          }],
          "linked_components": [{
            "id": "number",
            "name": "string",
            "valis": [{
              "id": "number",
              "name": "string",
              "value": "string",
              "formuła": "string"
            }],
            "textvalis": [{
              "id": "number",
              "name": "string",
              "text": "string"
            }],
            "matrices": [{
              "id": "number",
              "name": "string",
              "value": "string",
              "formuła": "string"
            }],
            "datevalis": [{
              "id": "number",
              "name": "string",
              "date": "string"
            }],
            "creator": "string",
            "attachments": [{
              "name": "string",
              "description": "string",
              "version": "string",
              "is_reference": "boolean",
              "tags": ["string"]
            }]
          }]
        }
      ],
      "content_type": {
        "id": "number",
        "name": "string"
      }
    }
  ],
  "timestamp": "datetime",
  "template_name": "string",
  "verification_and_validation_methods": [{
    "id": "number",
    "name": "string",
    "description": "string"
  }]
}

Sortowanie pól

Wymagania można sortować za pomocą funkcji Sort w dokumencie szablonu Jinja. Na przykład można dodać |sort(attribute='identifier'), gdzie wymagania są sortowane alfanumerycznie w kolumnie identyfikatora.

Przykład:

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

Kolumny niestandardowe

Dzięki obecnemu eksporterowi dokumentów można łatwo eksportować wartości kolumn niestandardowych. W przypadku prostej kolumny niestandardowej opartej na tekście można użyć następującej ogólnej struktury:

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

Pamiętaj, aby zastąpić tekst Name of Custom Column rzeczywistą nazwą kolumny wskazaną w nagłówku kolumny.

Jeśli kolumna niestandardowa nie jest tekstem i jest opcją wielokrotnego wyboru, użytkownik może użyć następującego kodu i zaktualizować go dla swojego przypadku użycia.

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

Dodatek - Struktura obiektów danych szablonów eksportu działań V&V

Oto podstawowa struktura obiektu, z którego szablony eksportu działań V&V będą pobierać informacje.

Szablony eksportu działań V&V - struktura obiektu danych


# TOP LEVEL
{
   działania: [{}] # Lista wszystkich działań
   foldery: [{
      name: string
      activities: [{}] # Lista działań
   }]
   timestamp: datetime
   template_name: string
}
# Aktywność
{
   id: liczba
   name: string
   description: string
   expected_results: ciąg znaków
   tags: [string]
   verification_methods: [{
      name: string
      description: string
   }]
   właściciel: użytkownik lub grupa
   custom_fields: [] # Lista pól niestandardowych
   approvals: boolean
   items: [{}] # Lista VVItems
   step_definitions: [{}] # Lista StepDefinitions
   runs: [{}] # Lista ActivityRuns
}
# VVItem
{
   id: liczba
   requirement_identifier: string
   component: { # Taki sam jak połączone komponenty w dokumencie reqs export
      id: liczba
      name: string
      valis: [{
         id: liczba
         name: string
         wartość: ciąg znaków
         formuła: ciąg znaków
      }]
      textvalis: [{
         id: liczba
         name: string
         text: string
      }]
      matrices: [{
         id: liczba
         name: string
         wartość: łańcuch
         formuła: łańcuch
      }]
      datevalis: [{
         id: liczba
         nazwa: ciąg znaków
         data: ciąg znaków
      }]
      twórca: ciąg znaków
      załączniki: [{
         nazwa: ciąg znaków
         opis: ciąg znaków
         version: string
         is_reference: boolean
         tags: [string]
      }]
   }
   compliance: string
   compliance_comment: string
   last_item_run: {} # VVItemRun
   last_item_run_status: str
   item_runs: [{}] # Lista VVItemRuns
}
# StepDefinition
{
   id: int
   activity_id: int
   step_number: int
   position: float
   full_step_number: str
   full_step_path: str
   parent_step_id: int
   name: string
   description: string
   expected_results: string
   tags: [string]
   item_ids: [] # Lista identyfikatorów VVItems
}
# ActivityRun
{
   id: int
   name: string
   description: string
   timestamp: string
   start_date: string # Format taki sam jak w eksportowanym dokumencie reqs
   finish_date: string
   completion_state: int
   completed_on: string
   completed_by: Użytkownik
   activity_id: int
   default_run: bool
   position: float
   steps_synced: bool
   expected_results: string
   evidence: string # Nazwa pliku/dokumentu
   custom_fields: [] # Lista CustomFields
   tags: [string]
   run_executor: {} # Użytkownik lub grupa
   approver: {} # Użytkownik lub grupa
   approved: boolean
   approved_by: Użytkownik
   approved_at: string
   item_runs: [] # Lista VVItemRuns
   step_runs: [{}] # Lista VVStepRuns
}
# VVItemRun
{
   id: int
   status: string
   verified_by: Użytkownik
   activity_run_id: int
   status: "status-display-name"
   comment: string
   serial_number: string
   step_run_id: int # StepRun
   verification_item:{} # VVItem
   verification_item_requirement_identifier: string
   verification_item_component_name: string
}
# StepRun
{
   id: int
   name: string
   comment: string
   status: string
   description: string
   activity_run_id: int
   full_step_number: string
   step_number: int
   position: float
   full_step_run_path: str
   parent_step_run_id: int
   expected_results: string
   tags: [string]
   item_run_ids: [] # Lista identyfikatorów VVItemRun
   item_requirement_identifiers: str
}

Wersja do wydruku

AI-localized

If you find an issue, select the text/image and pressCtrl + Enterto send us your feedback.