Modelos personalizados de exportação de documentos

O assistente de Exportação de Documentos do Requirements Portal é a ferramenta ideal para criar arquivos editáveis do Microsoft Word *.docx diretamente a partir dos seus requisitos e atividades de V&V. Você pode usar modelos predefinidos ou carregar seus próprios modelos. O assistente utiliza a biblioteca Python-Docx-Template, que, por sua vez, utiliza o mecanismo de modelos Jinja. Essa combinação permite criar modelos personalizados.

Biblioteca Python-Docx-Template

A biblioteca Python-Docx-Template é uma ferramenta poderosa que amplia a funcionalidade da biblioteca Python-Docx. Ela incorpora o mecanismo de modelos Jinja, permitindo a geração dinâmica de conteúdo nos seus arquivos do Word. Isso significa que você pode usar variáveis, laços e condicionais para preencher seu documento com dados em tempo real. É como dar uma dose extra de energia ao seu documento do Word.

Observe que, para os campos de texto formatado, o prefixo r deve ser usado no modelo de exportação. Por exemplo, o campo de texto do requisito deve ser incluído no modelo como r requirement.text.

Gerenciamento de modelos de exportação

Os modelos disponíveis na sua instância do Requirements Portal são listados na página Settings – Export templates (acessada clicando no ícone  no canto superior direito, selecionando Settings no menu exibido e, em seguida, selecionando Export templates na lista do painel à esquerda).

  • Por padrão, são fornecidos seis modelos: três para a exportação de documentos de requisitos e três para a exportação de documentos de atividades de V&V.

    • Para obter mais informações sobre os modelos de exportação de requisitos, consulte a página Exportação de Documentos.

    • Para obter mais informações sobre os modelos de exportação de atividades de V&V, consulte a página Exportação de Documentos.

  • Para adicionar um novo modelo definido pelo usuário, clique no botão  no canto superior esquerdo da página. Na janela Add template exibida, escolha se o novo modelo deve ser aplicado a Requirements ou V&V Activities usando a lista suspensa Applicable objects e, em seguida, use a área Select template para selecionar o arquivo do modelo.

    Clique no botão  da caixa de diálogo para adicionar o modelo. Ele será exibido na lista da página Export templates e poderá ser usado na exportação de documentos.

  • É possível baixar o arquivo de qualquer modelo. Para isso, clique no botão  na coluna Name do modelo desejado e selecione o comando Download. De acordo com as configurações do seu navegador, ele baixará automaticamente o arquivo para um local predefinido ou perguntará onde salvá-lo no disco rígido.

  • Um modelo definido pelo usuário pode ser substituído por um novo arquivo de modelo. Para isso, clique no botão  na coluna Name do modelo desejado e selecione o comando Overwrite Template no menu exibido. Use a janela Overwrite template que se abre para definir a aplicabilidade do modelo e selecionar o novo arquivo. Ative a opção I confirm I want to overwrite e clique no botão  para concluir o processo.

Apêndice – Estrutura do objeto de dados dos modelos de exportação de requisitos

Vários modelos padrão de exportação de requisitos estão disponíveis em uma instância do Requirements Portal:

  • Specification Doc.docx – este modelo gera e exporta os requisitos de maneira semelhante ao recurso Visualização de Documento.

  • Specification Table.docx – nosso modelo original apresenta os atributos mais relevantes dos requisitos em um formato de tabela organizado.

  • Requirement Traceability and Verification Matrix.docx – este modelo permite gerar um arquivo doc que inclui informações sobre os requisitos superiores e subordinados e as referências de projeto do requisito, além da intenção e do status de Verificação & Validação.

  • Requirements Verification Matrix.docx – este modelo permite gerar um arquivo doc que inclui informações sobre a intenção e o status de Verificação & Validação do requisito.

Fique à vontade para adicionar, remover ou modificar seções para atender melhor às suas necessidades de documentação. Depois de explorar os arquivos de modelos padrão na ordem indicada acima, você talvez se sinta à vontade para testar os limites do que pode incluir nos seus relatórios.

A seguir está a estrutura básica do objeto do qual seus modelos de exportação de requisitos extrairão informações.

Ordenação dos campos

Você pode ordenar os requisitos usando a função Sort no documento de modelo Jinja. Por exemplo, você pode adicionar |sort(attribute='identifier') para ordenar os requisitos alfanumericamente pela coluna de identificador.

Exemplo:

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

Colunas personalizadas

Com o exportador de documentos atual, você pode exportar facilmente os valores das colunas personalizadas. Para uma coluna personalizada de texto simples, você pode usar a seguinte estrutura genérica:

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

Certifique-se de substituir o texto Name of Custom Column pelo nome real da coluna indicado no cabeçalho.

Se a coluna personalizada não for de texto, mas sim uma opção de seleção múltipla, o usuário poderá usar o código a seguir e adaptá-lo ao seu 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 – Estrutura do objeto de dados dos modelos de exportação de atividades de V&V

Vários modelos padrão de exportação de atividades de V&V estão disponíveis em uma instância do Requirements Portal:

  • V&V Activity Document.docx – inclui informações sobre as atividades selecionadas como contexto de exportação.

  • V&V Matrix.docx – vínculos entre as atividades selecionadas como contexto de exportação e os requisitos e seus blocos associados.

  • V&V Runs Document.docx – inclui informações sobre as execuções das atividades selecionadas como contexto de exportação.

A seguir está a estrutura básica do objeto do qual seus modelos de exportação de atividades de V&V extrairão informações.

AI-LocalizedLocalizado por IA
Caso encontre um problema, selecione o texto/imagem e primaCtrl + Enterpara nos enviar o seu feedback.
Contents
Disponibilidade de Recursos

Os recursos disponíveis para você dependem de qual solução Altium você possui – Altium Develop, Altium Agile Teams, Altium Agile Enterprise ou Altium Designer (com assinatura ativa).

Se você não vir um recurso documentado no software que está usando no momento, entre em contato com a equipe de vendas da Altium para saber mais.

Contents