Plantillas personalizadas de exportación de documentos

El asistente de exportación de documentos de Requirements & Systems Portal es la herramienta ideal para generar archivos editables de Microsoft Word *.docx directamente a partir de sus requisitos y actividades de V&V. Puede usar plantillas predefinidas o cargar sus propias plantillas. El asistente funciona con la biblioteca Python-Docx-Template, que, a su vez, utiliza el motor de plantillas Jinja. Este dúo dinámico le permite crear plantillas personalizadas.

Biblioteca Python-Docx-Template

La biblioteca Python-Docx-Template es una herramienta potente que amplía la funcionalidad de la biblioteca Python-Docx. Incorpora el motor de plantillas Jinja, lo que permite la generación dinámica de contenido en sus archivos de Word. Esto significa que puede usar variables, bucles y condicionales para completar 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 que son texto enriquecido, debe usarse 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 & Systems Portal se muestran en la página Export templates (  » Settings » Export templates).

  • 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 Document Export.

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

  • Para agregar una nueva plantilla definida por el usuario, haga clic en el botón  situado en la esquina superior derecha 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 la lista desplegable Applicable objects y luego use la región Select template para seleccionar el archivo de plantilla.

    Haga clic en el botón  del cuadro de diálogo para agregar la plantilla. Se mostrará en la lista de la página Export templates y luego podrá usarse en la exportación de documentos.

  • El archivo de cualquier plantilla puede descargarse. Para ello, haga clic en el botón  en la columna Name de la plantilla requerida y seleccione el comando Download. Según la configuración personal de su navegador, este descargará automáticamente el archivo en una ubicación predefinida o le preguntará dónde desea 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  en la columna Name de la plantilla requerida y seleccione el comando Overwrite Template en el menú que aparece. Use 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 del objeto de datos de las plantillas de exportación de requisitos

Hay disponibles tres plantillas predeterminadas de exportación de requisitos en una instancia de Requirements & Systems Portal, cada una progresivamente más compleja que la anterior. Por lo tanto, si desea mejorar sus habilidades con plantillas, abordarlas en secuencia es una buena idea. Esta es la lista:

  • spec_doc.docx – esta es su plantilla sencilla y estándar, pensada para producir un resultado idéntico a la Vista de documento de requisitos. Es excelente para principiantes y cubre bucles y variables simples.

  • spec_table.docx – subiendo un nivel, esta plantilla introduce condicionales y filtros. Aquí es donde la cosa se pone interesante. Es la versión Jinja de nuestra plantilla de Word basada en scripts con campos de combinación.

  • req_verification.docx – la gran maestra de nuestras plantillas. Esta es rica en bucles anidados y condicionales, e incluso incorpora tablas. Si puede dominarla, prácticamente será un Jedi de las plantillas de documentos.

Puede agregar, eliminar o modificar secciones libremente para ajustarlas mejor a sus necesidades de documentación. Después de revisar los archivos de plantilla predeterminados en el orden indicado anteriormente, quizá se sienta lo bastante aventurero como para poner a prueba los límites de lo que puede incluir en sus informes.

A continuación se muestra 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 usando la función Sort en el documento de plantilla Jinja. Por ejemplo, puede agregar |sort(attribute='identifier') donde los requisitos se ordenan alfanuméricamente por la columna de 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 sencilla basada en texto, puede usar 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 el encabezado de la columna.

Si la columna personalizada no es de texto y es una opción de selección múltiple, el usuario puede usar 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

A continuación se muestra 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.
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.

Contenido