Plantillas personalizadas de exportación de documentos

El asistente de exportación de documentos de Requirements Portal es la herramienta ideal para crear archivos editables de Microsoft Word *.docx directamente a partir de sus requisitos y actividades de V&V. Puede utilizar plantillas predefinidas o cargar sus propias plantillas. El asistente utiliza la biblioteca Python-Docx-Template, que, a su vez, se basa en el motor de plantillas Jinja. Esta combinación le permite crear plantillas personalizadas.

Biblioteca Python-Docx-Template

La biblioteca Python-Docx-Template es una potente herramienta que amplía las funciones de la biblioteca Python-Docx. Incorpora el motor de plantillas Jinja, lo que permite generar contenido dinámico en sus archivos de Word. Esto significa que puede utilizar variables, bucles y condiciones para rellenar su documento con datos sobre la marcha. En esencia, es como darle una dosis de energía a su documento de Word.

Tenga en cuenta que, para los campos de texto enriquecido, debe utilizarse el prefijo r en la plantilla de exportación. Por ejemplo, el campo de texto del requisito debe incluirse en la plantilla como r requirement.text.

Gestión de plantillas de exportación

Las plantillas disponibles para su instancia de Requirements Portal se muestran en la página Settings – Export templates (a la que se accede haciendo clic en el icono  de la parte superior derecha, seleccionando Settings en el menú que aparece y, a continuación, seleccionando Export templates en la lista del panel izquierdo).

  • De forma predeterminada, se proporcionan seis plantillas: tres para la exportación de documentos de requisitos y tres para la exportación de documentos de actividades de V&V.

    • Para obtener más información sobre las plantillas de exportación de requisitos, consulte la página Exportación de documentos.

    • Para obtener más información sobre las plantillas de exportación de actividades de V&V, consulte la página Exportación de documentos.

  • Para añadir una nueva plantilla definida por el usuario, haga clic en el botón  de la parte superior izquierda de la página. En la ventana Add template que aparece, elija si la nueva plantilla debe aplicarse a Requirements o V&V Activities mediante el menú desplegable Applicable objects y, a continuación, utilice la sección Select template para seleccionar el archivo de plantilla.

    Haga clic en el botón  del cuadro de diálogo para añadir la plantilla. Esta aparecerá en la lista de la página Export templates y podrá utilizarse para exportar documentos.

  • Puede descargar el archivo de cualquier plantilla. Para ello, haga clic en el botón  de la columna Name de la plantilla deseada y seleccione el comando Download. Según la configuración de su navegador, este descargará automáticamente el archivo en una ubicación predefinida o le preguntará dónde guardarlo en su disco duro.

  • Una plantilla definida por el usuario puede sobrescribirse con un nuevo archivo de plantilla. Para ello, haga clic en el botón  de la columna Name de la plantilla deseada y seleccione el comando Overwrite Template en el menú que aparece. Utilice la ventana Overwrite template que se abre para definir a qué se aplica la plantilla y seleccionar el nuevo archivo. Active la opción I confirm I want to overwrite y haga clic en el botón  para completar el proceso.

Apéndice: estructura del objeto de datos de las plantillas de exportación de requisitos

En una instancia de Requirements Portal hay varias plantillas predeterminadas de exportación de requisitos disponibles:

  • Specification Doc.docx – esta plantilla genera y exporta los requisitos de forma similar a la función Vista de documento.

  • Specification Table.docx – nuestra plantilla original presenta los atributos más relevantes de los requisitos en un formato de tabla claro y ordenado.

  • Requirement Traceability and Verification Matrix.docx – esta plantilla permite generar un archivo doc que incluye información sobre los requisitos superiores y subordinados y las referencias de diseño de cada requisito, así como la intención y el estado de verificación y validación.

  • Requirements Verification Matrix.docx – esta plantilla permite generar un archivo doc que incluye información sobre la intención y el estado de verificación y validación de cada requisito.

Puede añadir, eliminar o modificar secciones para adaptarlas mejor a sus necesidades de documentación. Después de revisar los archivos de plantilla predeterminados en el orden indicado anteriormente, quizá se anime a explorar los límites de lo que puede incluir en sus informes.

Esta es la estructura básica del objeto del que sus plantillas de exportación de requisitos extraerán la información.

Ordenación de los campos

Puede ordenar los requisitos mediante la función Sort en el documento de plantilla de Jinja. Por ejemplo, puede añadir |sort(attribute='identifier') para ordenar los requisitos alfanuméricamente por la columna del identificador.

Ejemplo:

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

Columnas personalizadas

Con el exportador de documentos actual, puede exportar fácilmente los valores de las columnas personalizadas. Para una columna personalizada de texto simple, puede utilizar la siguiente estructura genérica:

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

Asegúrese de sustituir el texto Name of Custom Column por el nombre real de la columna indicado en su encabezado.

Si la columna personalizada no es de texto, sino de selección múltiple, el usuario puede utilizar el siguiente código y adaptarlo a su caso de uso.

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

Apéndice: estructura del objeto de datos de las plantillas de exportación de actividades de V&V

En una instancia de Requirements Portal hay varias plantillas predeterminadas de exportación de actividades de V&V disponibles:

  • V&V Activity Document.docx – incluye información sobre las actividades seleccionadas como contexto de exportación.

  • V&V Matrix.docx – muestra los vínculos entre las actividades seleccionadas como contexto de exportación y los requisitos y sus bloques asociados.

  • V&V Runs Document.docx – incluye información sobre las ejecuciones de las actividades seleccionadas como contexto de exportación.

Esta es la estructura básica del objeto del que sus plantillas de exportación de actividades de V&V extraerán la información.

AI-LocalizedLocalizado por IA
Si encuentra un problema, seleccione el texto/imagen y presioneCtrl + Enterpara enviarnos sus comentarios.
Contents
Disponibilidad de funciones

Las funciones disponibles para usted dependen de qué solución de Altium tenga: Altium Develop, Altium Agile Teams, Altium Agile Enterprise o Altium Designer (con suscripción activa).

Si no ve una función documentada en su software actual, contacte con Ventas de Altium para obtener más información.

Contents