Niestandardowe szablony eksportu dokumentów

Updated: Wrzesień 21, 2026

Kreator eksportu dokumentów w Requirements Portal pozwala szybko tworzyć edytowalne pliki Microsoft Word *.docx bezpośrednio na podstawie wymagań i działań V&V. Możesz korzystać z gotowych szablonów lub przesyłać własne. Kreator wykorzystuje bibliotekę Python-Docx-Template, która z kolei korzysta z silnika szablonów Jinja. To połączenie umożliwia tworzenie niestandardowych szablonów.

Biblioteka Python-Docx-Template

Biblioteka Python-Docx-Template to zaawansowane narzędzie rozszerzające funkcjonalność biblioteki Python-Docx. Wykorzystuje silnik szablonów Jinja, umożliwiając dynamiczne generowanie treści w plikach Word. Dzięki temu możesz używać zmiennych, pętli i instrukcji warunkowych do wypełniania dokumentu danymi na bieżąco. To tak, jakby Twój dokument Word dostał zastrzyk energii.

Pamiętaj, że w przypadku pól zawierających tekst sformatowany w szablonie eksportu należy użyć prefiksu r. Na przykład pole tekstu wymagania musi zostać uwzględnione w szablonie jako r requirement.text.

Zarządzanie szablonami eksportu

Szablony dostępne w Twojej instancji Requirements Portal są wyświetlane na stronie Settings – Export templates (aby ją otworzyć, kliknij ikonę w prawym górnym rogu, wybierz Settings z wyświetlonego menu, a następnie wybierz Export templates z listy w lewym panelu).

Domyślnie dostępnych jest sześć szablonów — trzy do eksportu dokumentów wymagań i trzy do eksportu dokumentów działań V&V.
- Więcej informacji o szablonach eksportu wymagań znajdziesz na stronie Eksport dokumentów.
- Więcej informacji o szablonach eksportu działań V&V znajdziesz na stronie Eksport dokumentów.
Aby dodać nowy szablon użytkownika, kliknij przycisk w lewym górnym rogu strony. W wyświetlonym oknie Add template wybierz z listy rozwijanej Applicable objects, czy nowy szablon ma być stosowany do Requirements czy V&V Activities, a następnie w obszarze Select template wybierz 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żywać do eksportu dokumentów.
Możesz pobrać plik dowolnego szablonu. Aby to zrobić, kliknij przycisk w kolumnie Name wybranego szablonu i wybierz polecenie Download. W zależności od ustawień przeglądarki plik zostanie automatycznie pobrany do określonej lokalizacji lub pojawi się pytanie, gdzie zapisać go na dysku.
Szablon użytkownika można zastąpić nowym plikiem szablonu. Aby to zrobić, kliknij przycisk w kolumnie Name wybranego szablonu i wybierz polecenie Overwrite Template z wyświetlonego menu. W otwartym oknie Overwrite template określ zastosowanie szablonu i wybierz nowy plik. Włącz opcję I confirm I want to overwrite i kliknij przycisk , aby zakończyć proces.

Dodatek — struktura obiektu danych w szablonach eksportu wymagań

W instancji Requirements Portal dostępnych jest kilka domyślnych szablonów eksportu wymagań:

Specification Doc.docx — ten szablon generuje i eksportuje wymagania w sposób podobny do funkcji Widok dokumentu.
Specification Table.docx — nasz pierwotny szablon przedstawia najważniejsze atrybuty wymagań w przejrzystym układzie tabelarycznym.
Requirement Traceability and Verification Matrix.docx — ten szablon umożliwia wygenerowanie pliku doc zawierającego informacje o wymaganiach nadrzędnych i podrzędnych oraz odniesieniach do projektu, a także o założeniach i statusie weryfikacji i walidacji.
Requirements Verification Matrix.docx — ten szablon umożliwia wygenerowanie pliku doc zawierającego informacje o założeniach i statusie weryfikacji i walidacji wymagania.

Możesz dowolnie dodawać, usuwać lub modyfikować sekcje, aby lepiej dostosować dokumentację do swoich potrzeb. Po zapoznaniu się z domyślnymi plikami szablonów w podanej powyżej kolejności możesz zechcieć sprawdzić, jak wiele informacji da się uwzględnić w raportach.

Poniżej przedstawiono podstawową strukturę obiektu, z którego szablony eksportu wymagań pobierają informacje.

Szablony eksportu wymagań — struktura obiektu danych

{
  "specifications": [
    {
      "id": "number",
      "name": "string",
      "description": "string",
      "requirements": [
        {
          "id": "string",
          "identifier": "string",
          "text": "RichText",
          "title": "string",
          "rationale": "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",
          "compliance": "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",
            "tags": ["string"],
            "activity": {
              "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",
              "formula": "string"
            }],
            "textvalis": [{
              "id": "number",
              "name": "string",
              "text": "string"
            }],
            "matrices": [{
              "id": "number",
              "name": "string",
              "value": "string",
              "formula": "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"
      }
    }
  ],
  "requirements": [
    {
      "id": "string",
      "identifier": "string",
      "text": "RichText",
      "title": "string",
      "rationale": "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",
      "compliance": "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",
        "tags": ["string"],
        "activity": {
          "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",
          "formula": "string"
        }],
        "textvalis": [{
          "id": "number",
          "name": "string",
          "text": "string"
        }],
        "matrices": [{
          "id": "number",
          "name": "string",
          "value": "string",
          "formula": "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",
          "rationale": "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",
          "compliance": "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",
            "tags": ["string"],
            "activity": {
              "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",
              "formula": "string"
            }],
            "textvalis": [{
              "id": "number",
              "name": "string",
              "text": "string"
            }],
            "matrices": [{
              "id": "number",
              "name": "string",
              "value": "string",
              "formula": "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

Możesz sortować wymagania za pomocą funkcji Sort w dokumencie szablonu Jinja. Na przykład możesz dodać |sort(attribute='identifier') , aby posortować wymagania alfanumerycznie według kolumny identyfikatora.

Przykład:

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

Kolumny niestandardowe

Obecne narzędzie do eksportu dokumentów umożliwia łatwy eksport wartości kolumn niestandardowych. W przypadku prostej kolumny niestandardowej zawierającej tekst możesz użyć następującej ogólnej struktury:

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

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

Jeśli kolumna niestandardowa nie zawiera tekstu, lecz opcje wielokrotnego wyboru, możesz użyć poniższego kodu i dostosować go do swoich potrzeb.

{%- 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 obiektu danych w szablonach eksportu działań V&V

W instancji Requirements Portal dostępnych jest kilka domyślnych szablonów eksportu działań V&V:

V&V Activity Document.docx — zawiera informacje o działaniach wybranych jako kontekst eksportu.
V&V Matrix.docx — przedstawia powiązania między działaniami wybranymi jako kontekst eksportu a wymaganiami i powiązanymi z nimi blokami.
V&V Runs Document.docx — zawiera informacje o wykonaniach działań wybranych jako kontekst eksportu.

Poniżej przedstawiono podstawową strukturę obiektu, z którego szablony eksportu działań V&V pobierają informacje.

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

# TOP LEVEL
{
   activities: [{}] # List of all Activities
   folders: [{
      name: string
      activities: [{}] # List of Activities
   }]
   timestamp: datetime
   template_name: string
}
# Activity
{
   id: number
   name: string
   description: string
   expected_results: string
   tags: [string]
   verification_methods: [{
      name: string
      description: string
   }]
   owner: User or Group
   custom_fields: [] # List of CustomFields
   approvals: boolean
   items: [{}] # List of VVItems
   step_definitions: [{}] # List of StepDefinitions
   runs: [{}] # List of ActivityRuns
}
# VVItem
{
   id: number
   requirement_identifier: string
   component: { # Same as linked components in the reqs doc export
      id: number
      name: string
      valis: [{
         id: number
         name: string
         value: string
         formula: string
      }]
      textvalis: [{
         id: number
         name: string
         text: string
      }]
      matrices: [{
         id: number
         name: string
         value: string
         formula: string
      }]
      datevalis: [{
         id: number
         name: string
         date: string
      }]
      creator: string
      attachments: [{
         name: string
         description: string
         version: string
         is_reference: boolean
         tags: [string]
      }]
   }
   compliance: string
   compliance_comment: string
   last_item_run: {} # VVItemRun
   last_item_run_status: str
   item_runs: [{}] # List of 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: [] # List of VVItems ids
}
# ActivityRun
{
   id: int
   name: string
   description: string
   timestamp: string
   start_date: string # Format use same as in reqs doc export
   finish_date: string
   completion_state: int
   completed_on: string
   completed_by: User
   activity_id: int
   default_run: bool
   position: float
   steps_synced: bool
   expected_results: string
   evidence: string # File/Doc name
   custom_fields: [] # List of CustomFields
   tags: [string]
   run_executor: {} # User or Group
   approver: {} # User or Group
   approved: boolean
   approved_by: User
   approved_at: string
   item_runs: [] # List of VVItemRuns
   step_runs: [{}] # List of VVStepRuns
}
# VVItemRun
{
   id: int
   status: string
   verified_by: User
   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: str
   step_number: int
   position: float
   full_step_run_path: str
   parent_step_run_id: int
   expected_results: string
   tags: [string]
   item_run_ids: [] # List of VVItemRun ids
   item_requirement_identifiers: str
}

Wersja do wydruku

Tłumaczenie SI

Jeśli znajdziesz błąd, zaznacz tekst/obraz i naciśnij Ctrl + Enter aby wysłać nam wiadomość.