Modelos personalizados de exportação de documentos

O assistente de Exportação de Documentos do Requirements & Systems Portal é a sua ferramenta ideal para gerar 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 os seus próprios modelos. O assistente é alimentado pela biblioteca Python-Docx-Template que, por sua vez, utiliza o mecanismo de templates Jinja. Essa dupla dinâmica permite criar modelos personalizados.

Biblioteca Python-Docx-Template

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

Observe que, para os campos que são rich text, 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.

Gerenciando Modelos de Exportação

Os modelos disponíveis para a sua instância do Requirements & Systems Portal são listados na página Export templates (  » Settings » Export templates).

  • 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 adicionar um novo modelo definido pelo usuário, clique no botão  no canto superior direito 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  na caixa de diálogo para adicionar o modelo. Ele será exibido na lista da página Export templates e poderá então ser usado na exportação de documentos.

  • O arquivo de qualquer modelo pode ser baixado. Para isso, clique no botão  na coluna Name do modelo desejado e selecione o comando Download. De acordo com as configurações pessoais do seu navegador, o arquivo será baixado automaticamente para um local predefinido ou o navegador perguntará onde você deseja 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 será aberta 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

Três modelos padrão de exportação de requisitos estão disponíveis em uma instância do Requirements & Systems Portal, cada um progressivamente mais complexo que o anterior. Portanto, se você quiser evoluir no uso de modelos, o ideal é abordá-los em sequência. Eis a lista:

  • spec_doc.docx – este é o seu modelo direto e básico, projetado para produzir uma saída idêntica à Visualização de Documento de requisitos. É excelente para iniciantes e cobre loops e variáveis simples.

  • spec_table.docx – elevando o nível, este modelo introduz condicionais e filtros. É aqui que as coisas começam a ficar mais interessantes. É a versão Jinja do nosso modelo Word baseado em script com campos de mesclagem.

  • req_verification.docx – o mestre supremo dos nossos modelos. Este é rico em loops aninhados e condicionais, e até incorpora tabelas. Se você conseguir dominá-lo, será praticamente um Jedi da criação de modelos de documentos.

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

Aqui está a estrutura básica do objeto a partir do qual seus modelos de exportação de requisitos obterão informações.

Ordenação dos Campos

Você pode classificar os requisitos usando a função Sort no documento de modelo Jinja. Por exemplo, você pode adicionar |sort(attribute='identifier') onde os requisitos são classificados alfanumericamente na 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 simples baseada em texto, 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 da coluna.

Se a coluna personalizada não for de texto e for uma opção de seleção múltipla, o usuário poderá usar o código a seguir e atualizá-lo conforme 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

Aqui está a estrutura básica do objeto a partir do qual seus modelos de exportação de atividades de V&V obterão informações.

AI-LocalizedLocalizado por IA
Caso encontre um problema, selecione o texto/imagem e primaCtrl + Enterpara nos enviar o seu feedback.
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.

Conteúdo