Niestandardowe szablony eksportu dokumentów

Updated: Marzec 23, 2026

Asystent eksportu dokumentów w Requirements Portal to podstawowe narzędzie do szybkiego tworzenia edytowalnych plików Microsoft Word *.docx bezpośrednio na podstawie wymagań i działań V&V. Możesz korzystać ze wstępnie zdefiniowanych szablonów albo przesyłać własne. Asystent jest oparty na bibliotece Python-Docx-Template, która z kolei wykorzystuje silnik szablonów Jinja. Ten dynamiczny duet pozwala tworzyć własne szablony.

Biblioteka Python-Docx-Template

Biblioteka Python-Docx-Template to potężne narzędzie rozszerzające funkcjonalność biblioteki Python-Docx. Integruje silnik szablonów Jinja, umożliwiając dynamiczne generowanie treści w plikach Word. Oznacza to, że możesz używać zmiennych, pętli i instrukcji warunkowych, aby na bieżąco wypełniać dokument danymi. Innymi słowy, to jak zastrzyk espresso dla dokumentu Word.

Zwróć uwagę, ż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 instancji Requirements Portal są wyświetlane na stronie Export templates ( » Settings » Export templates).

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 Document Export.
- Więcej informacji o szablonach eksportu działań V&V znajdziesz na stronie Document Export.
Aby dodać nowy szablon zdefiniowany przez użytkownika, kliknij przycisk w prawym 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 użyj obszaru 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 następnie użyć podczas eksportu dokumentu.
Plik dowolnego szablonu można pobrać. Aby to zrobić, kliknij przycisk w kolumnie Name wybranego szablonu i wybierz polecenie Download. Zależnie od indywidualnych ustawień przeglądarki plik zostanie automatycznie pobrany do zdefiniowanej lokalizacji albo przeglądarka zapyta, gdzie zapisać go na dysku twardym.
Szablon zdefiniowany przez użytkownika można zastąpić nowym plikiem szablonu. W tym celu kliknij przycisk w kolumnie Name wybranego szablonu i z wyświetlonego menu wybierz polecenie Overwrite Template. 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 szablonów eksportu wymagań

W instancji Requirements Portal dostępne są trzy domyślne szablony eksportu wymagań, a każdy kolejny jest bardziej złożony od poprzedniego. Jeśli więc chcesz rozwinąć swoje umiejętności tworzenia szablonów, najlepiej analizować je po kolei. Oto zestawienie:

spec_doc.docx — to prosty, standardowy szablon przeznaczony do wygenerowania wyniku identycznego z widokiem dokumentu wymagań. Doskonale nadaje się dla początkujących i obejmuje proste pętle oraz zmienne.
spec_table.docx — poziom wyżej: ten szablon wprowadza instrukcje warunkowe i filtry. To tutaj zaczyna się robić ciekawie. Jest to wersja Jinja naszego skryptowego szablonu Word z polami korespondencji seryjnej.
req_verification.docx — arcymistrz wśród naszych szablonów. Ten szablon obfituje w zagnieżdżone pętle i instrukcje warunkowe, a dodatkowo zawiera tabele. Jeśli go opanujesz, będziesz prawdziwym mistrzem szablonów dokumentów.

Możesz swobodnie dodawać, usuwać lub modyfikować sekcje, aby lepiej dopasować je do swoich potrzeb dokumentacyjnych. Po zapoznaniu się z domyślnymi plikami szablonów w podanej wyżej kolejności możesz poczuć się na tyle pewnie, aby testować granice tego, co można uwzględnić w raportach.

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

Requirement Export Templates – Data Object Structure

{
  "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

Wymagania można sortować przy użyciu funkcji Sort w dokumencie szablonu Jinja. Na przykład możesz dodać |sort(attribute='identifier') , gdzie wymagania są sortowane 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

Za pomocą bieżącego eksportera dokumentów możesz łatwo eksportować wartości kolumn niestandardowych. W przypadku prostej kolumny niestandardowej opartej na tekście 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 wskazaną w nagłówku kolumny.

Jeśli kolumna niestandardowa nie jest tekstowa i jest opcją wielokrotnego wyboru, użytkownik może użyć następującego kodu i dostosować go do 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 obiektu 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.

V&V Activity Export Templates – Data Object Structure

# 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ść.