Modelli personalizzati per l'esportazione dei documenti

La procedura guidata di esportazione dei documenti di Requirements Portal consente di creare rapidamente file Microsoft Word *.docx modificabili direttamente dai requisiti e dalle attività di V&V. Puoi utilizzare modelli predefiniti o caricare i tuoi modelli. La procedura guidata si basa sulla libreria Python-Docx-Template, che a sua volta sfrutta il motore di template Jinja. Questa combinazione ti permette di creare modelli personalizzati.

Libreria Python-Docx-Template

La libreria Python-Docx-Template è un potente strumento che estende le funzionalità della libreria Python-Docx. Integra il motore di template Jinja, consentendo la generazione dinamica di contenuti nei file Word. Questo significa che puoi utilizzare variabili, cicli e condizioni per popolare il documento con dati in tempo reale. In pratica, è come dare una carica di energia al tuo documento Word.

Nota che, per i campi in formato rich text, è necessario utilizzare il prefisso r nel modello di esportazione. Ad esempio, il campo di testo del requisito deve essere incluso nel modello come r requirement.text.

Gestione dei modelli di esportazione

I modelli disponibili per la tua istanza di Requirements Portal sono elencati nella pagina Settings – Export templates (accessibile facendo clic sull'icona  in alto a destra, selezionando Settings dal menu visualizzato e quindi selezionando Export templates dall'elenco nel riquadro a sinistra).

  • Per impostazione predefinita, sono disponibili sei modelli: tre per l'esportazione dei documenti dei requisiti e tre per l'esportazione dei documenti delle attività di V&V.

  • Per aggiungere un nuovo modello definito dall'utente, fai clic sul pulsante  in alto a sinistra nella pagina. Nella finestra Add template visualizzata, scegli se il nuovo modello deve essere applicato a Requirements o V&V Activities utilizzando il menu a discesa Applicable objects, quindi utilizza l'area Select template per selezionare il file del modello.

    Fai clic sul pulsante  nella finestra di dialogo per aggiungere il modello. Verrà visualizzato nell'elenco della pagina Export templates e potrà quindi essere utilizzato per l'esportazione dei documenti.

  • È possibile scaricare il file di qualsiasi modello. Per farlo, fai clic sul pulsante  nella colonna Name del modello desiderato e seleziona il comando Download. In base alle impostazioni personali del browser, il file verrà scaricato automaticamente in una posizione predefinita oppure ti verrà chiesto dove salvarlo sul disco rigido.

  • Un modello definito dall'utente può essere sovrascritto con un nuovo file di modello. Per farlo, fai clic sul pulsante  nella colonna Name del modello desiderato e seleziona il comando Overwrite Template dal menu visualizzato. Utilizza la finestra Overwrite template che si apre per definire l'ambito di applicazione del modello e selezionare il nuovo file. Abilita l'opzione I confirm I want to overwrite e fai clic sul pulsante  per completare la procedura.

Appendice – Struttura dell'oggetto dati dei modelli di esportazione dei requisiti

In un'istanza di Requirements Portal sono disponibili diversi modelli predefiniti per l'esportazione dei requisiti:

  • Specification Doc.docx – questo modello genera ed esporta i requisiti in modo simile alla funzionalità Vista documento.

  • Specification Table.docx – il nostro modello originale presenta gli attributi più rilevanti dei requisiti in un formato tabellare ordinato.

  • Requirement Traceability and Verification Matrix.docx – questo modello consente di generare un file doc che include informazioni sui requisiti padre e figlio e sui riferimenti di progettazione del requisito, nonché sull'intento e sullo stato di verifica e validazione.

  • Requirements Verification Matrix.docx – questo modello consente di generare un file doc che include informazioni sull'intento e sullo stato di verifica e validazione del requisito.

Puoi aggiungere, rimuovere o modificare le sezioni per adattarle al meglio alle tue esigenze di documentazione. Dopo aver esaminato i file dei modelli predefiniti nell'ordine indicato sopra, potresti voler esplorare tutte le possibilità di inclusione dei contenuti nei tuoi report.

Di seguito è riportata la struttura di base dell'oggetto da cui i modelli di esportazione dei requisiti estraggono le informazioni.

Ordinamento dei campi

Puoi ordinare i requisiti utilizzando la funzione Sort nel documento del modello Jinja. Ad esempio, puoi aggiungere |sort(attribute='identifier') per ordinare i requisiti in modo alfanumerico in base alla colonna dell'identificatore.

Esempio:

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

Colonne personalizzate

Con l'attuale strumento di esportazione dei documenti, puoi esportare facilmente i valori delle colonne personalizzate. Per una semplice colonna personalizzata di tipo testuale, puoi utilizzare la seguente struttura generica:

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

Assicurati di sostituire il testo Name of Custom Column con il nome effettivo della colonna indicato nell'intestazione.

Se la colonna personalizzata non è di tipo testuale ma contiene opzioni a selezione multipla, puoi utilizzare il seguente codice e adattarlo al tuo caso d'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 -%}

Appendice – Struttura dell'oggetto dati dei modelli di esportazione delle attività di V&V

In un'istanza di Requirements Portal sono disponibili diversi modelli predefiniti per l'esportazione delle attività di V&V:

  • V&V Activity Document.docx – include informazioni sulle attività selezionate come contesto di esportazione.

  • V&V Matrix.docx – collegamenti tra le attività selezionate come contesto di esportazione, i requisiti e i blocchi associati.

  • V&V Runs Document.docx – include informazioni sulle esecuzioni delle attività selezionate come contesto di esportazione.

Di seguito è riportata la struttura di base dell'oggetto da cui i modelli di esportazione delle attività di V&V estraggono le informazioni.

AI-LocalizedLocalizzato tramite A
Se trovi un problema, seleziona il testo/l’immagine e premi Ctrl + Enter per inviarci il tuo feedback.
Contents
Disponibilità delle funzionalità

Le funzionalità a tua disposizione dipendono dalla soluzione Altium di cui disponi: Altium Develop, Altium Agile Teams, Altium Agile Enterprise oppure Altium Designer (con abbonamento attivo).

Se non vedi una funzionalità documentata nel software che stai effettivamente utilizzando, contatta il reparto vendite di Altium per saperne di più.

Contents