Template personalizzati per l’esportazione dei documenti

La procedura guidata di esportazione documenti di Requirements & Systems Portal è lo strumento ideale per generare file Microsoft Word modificabili *.docx direttamente dai requisiti e dalle attività di V&V. Puoi utilizzare modelli predefiniti oppure caricare i tuoi modelli personalizzati. La procedura guidata si basa sulla libreria Python-Docx-Template, che a sua volta sfrutta il motore di templating Jinja. Questa combinazione ti consente di creare modelli personalizzati.

Libreria Python-Docx-Template

La libreria Python-Docx-Template è uno strumento potente che estende le funzionalità della libreria Python-Docx. Integra il motore di templating Jinja, consentendo la generazione dinamica di contenuti all’interno dei file Word. Questo significa che puoi usare variabili, cicli e condizioni per popolare il documento con i dati al volo. In sostanza, è come dare una marcia in più al tuo documento Word.

Si noti che, per i campi con testo RTF, nel modello di esportazione deve essere utilizzato il prefisso r. Ad esempio, il campo del 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 & Systems Portal sono elencati nella pagina Export templates (  » Settings » Export templates).

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

    • Per ulteriori informazioni sui modelli di esportazione dei requisiti, consulta la pagina Document Export.

    • Per ulteriori informazioni sui modelli di esportazione delle attività di V&V, consulta la pagina Document Export.

  • Per aggiungere un nuovo modello definito dall’utente, fai clic sul pulsante  in alto a destra nella pagina. Nella finestra Add template visualizzata, scegli se il nuovo modello deve essere applicato a Requirements o V&V Activities usando l’elenco 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à mostrato nell’elenco nella pagina Export templates e potrà quindi essere utilizzato per l’esportazione dei documenti.

  • Il file di qualsiasi modello può essere scaricato. 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 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’applicabilità del modello e selezionare il nuovo file. Abilita l’opzione I confirm I want to overwrite e fai clic sul pulsante  per completare il processo.

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

In un’istanza di Requirements & Systems Portal sono disponibili tre modelli predefiniti per l’esportazione dei requisiti, ciascuno progressivamente più complesso del precedente. Quindi, se vuoi migliorare nell’uso dei modelli, affrontarli in sequenza è una scelta intelligente. Ecco la panoramica:

  • spec_doc.docx – questo è il modello semplice e standard, pensato per produrre un output identico alla vista documento dei requisiti. È eccellente per i principianti e copre cicli e variabili semplici.

  • spec_table.docx – alza un po’ il livello introducendo condizioni e filtri. È qui che le cose iniziano a farsi interessanti. È la versione Jinja del nostro modello Word basato su script con campi di unione.

  • req_verification.docx – il maestro assoluto dei nostri modelli. È ricco di cicli annidati e condizioni, e include persino tabelle. Se riesci a padroneggiarlo, sei praticamente uno Jedi del templating documentale.

Sentiti libero di aggiungere, rimuovere o modificare sezioni per adattarle meglio alle tue esigenze di documentazione. Dopo aver esaminato i file dei modelli predefiniti nell’ordine indicato sopra, potresti sentirti abbastanza intraprendente da mettere alla prova i limiti di ciò che puoi includere nei tuoi report.

Ecco la struttura di base dell’oggetto da cui i modelli di esportazione dei requisiti estrarranno le informazioni.

Ordinamento dei campi

Puoi ordinare i requisiti utilizzando la funzione Sort nel documento modello Jinja. Ad esempio, puoi aggiungere |sort(attribute='identifier') dove i requisiti vengono ordinati alfanumericamente in base alla colonna identificatore.

Esempio:

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

Colonne personalizzate

Con l’attuale esportatore di documenti, puoi esportare facilmente i valori delle colonne personalizzate. Per una colonna personalizzata semplice basata su testo, 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 della colonna.

Se la colonna personalizzata non è di testo ed è un’opzione a selezione multipla, l’utente può usare il seguente codice e adattarlo al proprio 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

Ecco la struttura di base dell’oggetto da cui i modelli di esportazione delle attività di V&V estrarranno le informazioni.

AI-LocalizedLocalizzato tramite A
Se trovi un problema, seleziona il testo/l’immagine e premi Ctrl + Invio per inviarci il tuo feedback.
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ù.

Contenuto