Пользовательские шаблоны экспорта документов

Мастер экспорта документов в Requirements Portal позволяет быстро создавать редактируемые файлы Microsoft Word *.docx на основе требований и мероприятий по верификации и валидации (V&V). Вы можете использовать готовые шаблоны или загрузить собственные. Мастер работает на базе библиотеки Python-Docx-Template, которая, в свою очередь, использует шаблонизатор Jinja. Вместе они позволяют создавать пользовательские шаблоны.

Библиотека Python-Docx-Template

Python-Docx-Template — мощный инструмент, расширяющий функциональность библиотеки Python-Docx. Он включает шаблонизатор Jinja, позволяющий динамически формировать содержимое файлов Word. Это означает, что вы можете использовать переменные, циклы и условные конструкции для заполнения документа данными на лету. По сути, это как чашка эспрессо для вашего документа Word.

Обратите внимание: для полей с форматированным текстом в шаблоне экспорта необходимо использовать префикс r. Например, поле текста требования должно быть включено в шаблон как r requirement.text.

Управление шаблонами экспорта

Шаблоны, доступные в вашем экземпляре Requirements Portal, перечислены на странице Settings – Export templates (для перехода на нее нажмите значок  в правом верхнем углу, выберите Settings в появившемся меню, а затем выберите Export templates в списке на левой панели).

  • По умолчанию доступны шесть шаблонов: три для экспорта документов с требованиями и три для экспорта документов с мероприятиями V&V.

  • Чтобы добавить новый пользовательский шаблон, нажмите кнопку  в левом верхнем углу страницы. В появившемся окне Add template с помощью раскрывающегося списка Applicable objects укажите, к чему должен применяться новый шаблон: Requirements или V&V Activities. Затем выберите файл шаблона в области Select template.

    Нажмите кнопку  в диалоговом окне, чтобы добавить шаблон. Он появится в списке на странице Export templates и станет доступен для экспорта документов.

  • Файл любого шаблона можно скачать. Для этого нажмите кнопку  в столбце Name нужного шаблона и выберите команду Download. В зависимости от настроек браузера файл будет автоматически сохранен в заданной папке либо браузер предложит выбрать место для сохранения на жестком диске.

  • Пользовательский шаблон можно заменить новым файлом шаблона. Для этого нажмите кнопку  в столбце Name нужного шаблона и выберите команду Overwrite Template в появившемся меню. В открывшемся окне Overwrite template укажите, к чему применяется шаблон, и выберите новый файл. Включите параметр I confirm I want to overwrite и нажмите кнопку , чтобы завершить процесс.

Приложение — структура объекта данных для шаблонов экспорта требований

В экземпляре Requirements Portal доступны несколько стандартных шаблонов экспорта требований:

  • Specification Doc.docx — этот шаблон формирует и экспортирует требования в формате, аналогичном представлению Просмотр документа.

  • Specification Table.docx — наш исходный шаблон содержит наиболее важные атрибуты требований в удобном табличном формате.

  • Requirement Traceability and Verification Matrix.docx — этот шаблон позволяет создать файл doc со сведениями о родительских и дочерних требованиях, ссылках на проект, а также о целях и статусе верификации и валидации.

  • Requirements Verification Matrix.docx — этот шаблон позволяет создать файл doc со сведениями о целях и статусе верификации и валидации требования.

Вы можете добавлять, удалять и изменять разделы в соответствии с потребностями вашей документации. Изучив стандартные файлы шаблонов в указанном выше порядке, вы, возможно, захотите поэкспериментировать с тем, какие данные можно включить в отчеты.

Ниже приведена базовая структура объекта, из которого шаблоны экспорта требований получают данные.

Сортировка полей

Вы можете сортировать требования с помощью функции Sort в документе шаблона Jinja. Например, можно добавить |sort(attribute='identifier') для сортировки требований по столбцу идентификатора в алфавитно-цифровом порядке.

Пример:

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

Пользовательские столбцы

Текущий инструмент экспорта документов позволяет легко экспортировать значения пользовательских столбцов. Для обычного текстового пользовательского столбца можно использовать следующую универсальную конструкцию:

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

Обязательно замените текст Name of Custom Column фактическим названием столбца, указанным в его заголовке.

Если пользовательский столбец содержит не текст, а значения с возможностью множественного выбора, можно использовать следующий код, адаптировав его под свою задачу.

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

Приложение — структура объекта данных для шаблонов экспорта мероприятий V&V

В экземпляре Requirements Portal доступны несколько стандартных шаблонов экспорта мероприятий V&V:

  • V&V Activity Document.docx — включает сведения о мероприятиях, выбранных в качестве контекста экспорта.

  • V&V Matrix.docx — содержит связи между мероприятиями, выбранными в качестве контекста экспорта, требованиями и связанными с ними блоками.

  • V&V Runs Document.docx — включает сведения о выполнениях мероприятий, выбранных в качестве контекста экспорта.

Ниже приведена базовая структура объекта, из которого шаблоны экспорта мероприятий V&V получают данные.

AI-LocalizedЛокализовано с помощью ИИ
Если вы обнаружили проблему, выделите текст/изображение и нажмитеCtrl + Enter, чтобы отправить нам свой отзыв.
Contents
Доступность функций

Доступные вам функции зависят от того, какое решение Altium вы используете: Altium Develop, Altium Agile Teams, Altium Agile Enterprise или Altium Designer (при активной подписке).

Если вы не видите описанную функцию в используемом вами программном обеспечении, свяжитесь с отделом продаж Altium, чтобы узнать больше.

Contents