Document Export

Note

The features available depend on your Altium product access level. If you don’t see a discussed feature in your software, contact Altium Sales to find out more.

Requirements & Systems Portal has always prided itself in the fact that it reduces the need to manage documentation by housing and connecting the engineering data which typically resides in different document types belonging to different software tools. However, many of users still need to generate documentation for activities such as certification and change control, which should be done quickly with no more than a few clicks.

The Verification & Validation Module includes a self-contained wizard that allows to export a document based on the selected context and template directly from the Module. The Document Export functionality allows you to quickly export verification and validation data into an editable *.docx file based on the selected template. You can quickly export all or selected activities, as shown below.

Accessing the Functionality Copy Link Copied

You can access the document export functionality by clicking the  icon at the top right of the Verification & Validation Module.

Accessing the document export functionality
Accessing the document export functionality

Performing the Export Copy Link Copied

There are several ways to perform an export using the available templates. There are three default templates which you can manage and modify as required, and you can upload your own export templates from the   » Settings » Export templates page.

To learn more about custom templates, refer to the Document Export Custom Templates page.

Selecting the Context

You can choose particular activities to export using the Activities drop-down in the Export context region of the left-hand pane.

Choosing export context
Choosing export context

The default context is defined by what has been selected prior to accessing the export functionality:

  • If the All V&V Activities entry was selected, with no specific activities selected in the list, all activities will be set as the export context by default.

  • If the All V&V Activities entry was selected and some specific activities were selected in the list, these selected activities will be set as the export context by default.

  • If an entry of a specific activity was selected, this activity will be set as the export context by default.

Selecting a Template

Select an available template from the Export templates drop-down in the Select your template region of the left-hand pane. From the drop-down, you can select one of the three default templates or any user-uploaded template applicable to V&V activity export. If you choose one of the default templates, a sample example of an output produced from it will be displayed in the right-hand side preview window.

There are no previews available for user-uploaded templates.

Default Templates Overview

  • activity_doc.docx – includes information about activities selected as the export context (). 

  • vv_matrix.docx – links between activities selected as the export context and requirements and their associated blocks ().

  • run_doc.docx – includes information about runs of activities selected as the export context ().

Exporting and Loading

Once the required context and template are selected, click the  button. The export wizard will close, and a pop-up indicating that the export is in progress will appear.

Once the export is complete, another pop-up notifying that the document is ready will appear.

According to your personal browser settings, your browser will either automatically download the file to a predefined location or ask you where to store it on your hard drive.

The generated files can also be found on the Files Management page accessed by clicking the  icon at the bottom left and selecting Files Management from the menu.

If you find an issue, select the text/image and pressCtrl + Enterto send us your feedback.
Note

The features available depend on your Altium product access level. If you don’t see a discussed feature in your software, contact Altium Sales to find out more.