Plantillas personalizadas de exportación de documentos

El Asistente de Exportación de Documentos del Portal de Requisitos es la herramienta ideal para crear archivos editables de Microsoft Word *.docx editables directamente de sus requisitos y actividades de V&V. Puede utilizar plantillas predefinidas o cargar sus propias plantillas. El asistente se nutre de la biblioteca Python-Docx-Template, que, a su vez, aprovecha el motor de plantillas Jinja. Este dúo dinámico permite crear plantillas personalizadas.

Biblioteca Python-Docx-Template

La biblioteca Python-Docx-Template es una potente herramienta que amplía la funcionalidad de la biblioteca Python-Docx. Incorpora el motor de plantillas Jinja, permitiendo la generación de contenido dinámico dentro de tus archivos Word. Esto significa que puedes usar variables, bucles y condicionales para rellenar tu documento con datos sobre la marcha. Esencialmente, es como darle a tu documento Word una dosis de espresso.

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

Gestión de plantillas de exportación

Las plantillas disponibles para su instancia del Portal de Requisitos se enumeran en la página Export templates ( » Settings » Export templates).

  • Por defecto, 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 añadir una nueva plantilla definida por el usuario, haga clic en el botón en la parte superior derecha de la página. En la ventana Add template que aparece, elija si la nueva plantilla debe aplicarse a Requirements o a V&V Activities utilizando el menú desplegable Applicable objects y, a continuación, utilice el botó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. Se mostrará en la lista de la Export templates página y podrá utilizarse en la exportación de documentos.

  • El archivo de cualquier plantilla puede descargarse. Para ello, haga clic en el botón de la columna Name de la plantilla deseada y seleccione el comando Download comando. Según la configuración personal de su navegador, éste descargará automáticamente el archivo en una ubicación predefinida o le preguntará dónde almacenarlo 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 del menú que aparece. Utilice la ventana Overwrite template que se abre para definir la aplicabilidad de 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 de objetos de datos de las plantillas de exportación de requisitos

Una instancia del Portal de Requisitos dispone de tres plantillas de exportación de requisitos predeterminadas, cada una de ellas progresivamente más compleja que la anterior. Por lo tanto, si desea mejorar sus plantillas, es una buena idea abordarlas en secuencia. Esta es la lista:

  • spec_doc.docx - Ésta es una plantilla sencilla y corriente, pensada para producir un resultado idéntico al de la vista de documento de requisitos. Es excelente para principiantes y cubre bucles y variables simples.

  • spec_table.docx - Aumentando el nivel, esta plantilla introduce condicionales y filtros. Aquí es donde las cosas empiezan a ponerse picantes. Es la versión Jinja de nuestra plantilla Word basada en scripts con campos de fusión.

  • req_verification.docx - el gran maestro de nuestras plantillas. Esta es rica en bucles anidados y condicionales, e incluso incorpora tablas. Si puedes dominar esto, eres básicamente un Jedi de las plantillas de documentos.

Siéntete libre de añadir, eliminar o modificar secciones para adaptarlas mejor a tus necesidades de documentación. Después de repasar los archivos de plantilla por defecto en el orden indicado anteriormente, puede que te sientas lo suficientemente aventurero como para probar los límites de lo que puedes incluir en tus informes.

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

Ordenación de los campos

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

Ejemplo:

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

Columnas personalizadas

Con el actual exportador de documentos, puede exportar fácilmente los valores de las columnas personalizadas. Para una columna personalizada simple basada en texto, 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 Name of Custom Column por el nombre real de la columna indicado en la cabecera de la columna.

Si la columna personalizada no es un texto y es una opción de selección múltiple, el usuario puede utilizar el siguiente código y actualizarlo para su caso de uso.

{%- if requisito.campos_personalizados -%}
     {%- set additional_info_values = [] -%}
     {%- set category_values = [] -%}
     {%- set campos_personalizados_adicionales = requisito.campos_personalizados | selectattr('campo', 'iguala', 'Información adicional') -%}
     {% for campo_personalizado in campos_personalizados_adicionales -%}
      {%- set valores_info_adicionales = valores_info_adicionales + valor_campo_personalizado -%}
     {% endfor -%}
     {%- set category_custom_fields = requirement.custom_fields | selectattr('field', 'equalto', 'Category') -%}
     {% for campo_personalizado in campos_personalizados_categoria -%}
           {%- set valores_categoria = valores_categoria + valor_campo_personalizado -%}
     {% endfor -%}
{%- set cadena_info_adicional = cadena_info_adicional | join(';') -%}
{%- set categoria_cadena = categoria_info_valores | join(';') -%}
{%- endif -%}

Apéndice - Estructura de Objetos de Datos de las Plantillas de Exportación de Actividades de V&V

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

AI-LocalizedAI-localized
If you find an issue, select the text/image and pressCtrl + Enterto send us your feedback.
Feature Availability

The features available to you depend on which Altium solution you have – Altium Develop, an edition of Altium Agile (Agile Teams or Agile Enterprise), or Altium Designer (on active term).

If you don’t see a discussed feature in your software, contact Altium Sales to find out more.

Contenido