Review Requirements Documents

Documentation / Get Started

Requirements Documents

You can open documents using the Project pane, see Open and Close Documents.

The content of the current document is displayed in the requirements table placed in the center application pane. The table highlights the tree structure of the document and shows information about requirements in the following predefined columns:

You can configure the table to display additional custom attribute columns or template columns.

To display or hide table columns, click View and select Columns, or click the button on the upper right-hand corner of the Requirements Table. To reorder or resize columns, drag & drop column headers.

To sort the current document by a chosen column, click on the column heading. To change the sort order, click on the same column heading again. To reset to the default sorting with the natural document order, click on the Description column heading. Note that you cannot sort by the Discussion and Links columns.

Requirements document table view in ReqView

The current table layout given by order, widths, and display status of all table columns is persistently saved and restored after each application restart, see Table Views for more information.

Document Sections

You can structure requirements into document sections with a tree hierarchy. Document sections are numbered automatically for document objects with the heading attribute set or for document objects with at least one child. See Move Objects for more information on how to organize requirements into document sections.

You can also display sections of the current document in the Document pane, see Project Workspace.

To collapse or expand a selected document section, click the / icons on the right of the section name or press Space.

To collapse document sections by level, click View and select Collapse Sections menu, or click icon on the toolbar. To expand document sections by level, click View and select Expand Sections menu, or click the icon on the toolbar.

Tip: You can also assign a section number to an object if you set its heading attribute to an empty space (“ ”).

ID Column

The ID column displays the unique ID of each document object. Document object IDs are prefixed by the document ID by default, e.g. “NEEDS-123”.

To show only numeric document object IDs, click Edit, select Preferences, and uncheck Show document ID prefix in ID column.

The column can also display the following status icons:

IconDescriptionAppears When
Unsaved changeThe object was changed since the last time the current document was opened and has not yet been saved to a file.
CommentThe object is commented on.
AttachmentThe object has at least one attachment.
LinkThe object is linked with another requirement or object.
DeletedThe object is marked as deleted, but not yet purged (completely removed from the document). The object can be undeleted.
CutThe object is cut in the clipboard and will be moved on a paste operation.
CopiedThe object is copied in the clipboard and will be copied on a paste operation.

Description Column

You can show the Description column displaying the document section number, values of heading and text attributes, and file attachments. For more information, see Edit Description and Attach Files.

There are no restrictions on the attachment file type, however, only image attachments are displayed in the Description column:

Flowchart image attachment displayed in the Description column

You can right-click on an attachment displayed in the Description column and select the appropriate action from the menu:

  • Show Image / Hide Image — show / hide the image in the table view.
  • View in Dialog — preview the image in the Image Preview dialog.
  • View in External Application — preview a read-only temporary copy of the attachment file in the default application set by the operating system.
  • Save As — save a copy of the attachment file to a selected folder in ReqView native application, or to the browser download folder in ReqView web application.

You can also preview image attachments by clicking on their ID. Image attachments are opened using the View in Dialog action, other types of attachments are opened using the View in External Application action available in the context menu.

To show or hide all image attachments in a document, click View, mouseover Image Attachments, and select Show All Images or Hide All Images. To show images after opening a project automatically, click Edit, select Preferences, and tick Show images.

Tip: Hiding image attachments in large documents or documents with a large number of attachments can significantly improve application performance. and attachments

See Attach Files for more information how to add and edit attachments.

You can show the Links column displaying outgoing and incoming links grouped by relationship type. For more information, see Display Links.

Discussion Column

You can show the Discussion column displaying requirement comments. For more information see Control Project Changes.

Attribute Columns

You can show a separate attribute column for each custom attribute defined in the current document to display or edit its value for more document objects. For more information, see Edit Custom Attributes.

Template Columns

You can customize the table view with template columns displaying calculated expressions, attribute values, or traceability information about linked objects. Template columns are persisted in the Table Views in your Project File or Project Folder, see the next section.

Calculated Columns

Calculated columns display a text output using template expressions, template helpers and attribute values.

To add a new calculated template column, click Document, mouseover Add Template Column and select Custom Template. In the Template Column dialog, enter a column label displayed in the table header and a template code. The dialog instantly displays a preview of the template column for the currently selected document object. Press OK to add the template column to the current table view.

Add a new template column using code

For more information on how to write template code, see section Export Using Custom Templates. Note that template columns are rendered using document object context, therefore you can directly use document object attributes, for instance, {{id}}, {{heading}}, or {{{text}}}.

Example: In the RISKS document of the DEMO Project, create the RPN column calculating the Risk Priority Number as a product of custom attributes severity, probability, and determinability for each Risk or Action object using the following template code:

{{#if (eval (eval type "==" "Risk") "||" (eval type "==" "Action"))}}
{{eval (eval detectability "*" probability) "*" severity}}
{{/if}}
Template column calculating Risk Priority Number (RPN)

Attributes Summary Columns

Attributes summary columns display values set for the selected custom attributes. To add a new attributes summary column, click Document, mouseover Add Template Column, click Attributes Column and finally select:

  • All Attributes — to create the Custom Attributes column displaying all custom attributes in the current document,
  • Visible Attributes — to create an attributes summary column displaying all visible attributes in the current view, or
  • Hidden Attributes — to create an attributes summary column displaying all hidden attributes in the current view.

You can edit an attributes summary column if you need to adjust its output.

Example: In the NEEDS document of the DEMO Project, create the Custom Attributes column summarizing values of custom attributes asAn, iWant, soThat, and acceptanceCriteria.

Attributes summary column in ReqView

Traceability Columns

Traceability columns display linked objects across one or more traceability levels in live Requirements Traceability Matrix (RTM) views. You can create new traceability columns using the Traceability Column Wizard easily:

Traceability column wizard in ReqView

To open the wizard, click Document, mouseover Add Template Column, and select Traceability Wizard. You can edit a template column if you need to adjust its output.

Example: In the NEEDS document of the DEMO Project, create the Downstream Traceability column displaying traceability coverage of user needs in the NEEDS document by linked SW requirements in the SRS document and test cases in the TESTS document using the following template code:

{{#ifEqual type "STORY"}}
{{#ifHasInlinks "satisfaction"}}
{{#eachInlinkWith type="satisfaction"}}
<p>&blacktriangleleft; <em>{{docObjId}}:</em> {{shortDescription maxLength=80}}
{{#ifHasInlinks "verification"}}
{{#eachInlinkWith type="verification"}}
<br>&emsp;&blacktriangleleft; <em>{{docObjId}}:</em> {{shortDescription maxLength=80}}
{{/eachInlinkWith}}
{{else}}
<br>&emsp;&#9888; Missing verification links
{{/ifHasInlinks}}
</p>
{{/eachInlinkWith}}
{{else}}
<p>&#9888; Missing satisfaction links</p>
{{/ifHasInlinks}}
{{/ifEqual}}
Downstream Traceability Coverage referencing tests, indicating missing verification links

Note: Changed object attributes are automatically propagated to displayed traceability columns for directly linked objects only. For instance, if you change the heading of TESTS-21 then the traceability column Is Verified By for SW requirement SRS-53 displays the new heading value. However, the traceability column Downstream Traceability for user story NEEDS-58 still displays the old heading. Select the NEEDS document and press F5 to refresh the view and see the change of TESTS-21.

Edit Template Columns

To edit or delete an existing template column, right-click on the column heading and select Edit Template Column or Delete Template Column from the context menu:

Edit Template Column context menu

Then, edit the template code in the Template Column dialog as described in section Calculated Columns.

Table Views

The requirements table layout stores information about order, widths, and visibility of table columns. It is persistently saved and restored after each application restart.

You can save the table layout, sort criteria, and filter condition for any document as a named table view persisted in the Project File or Project Folder. This allows you to configure table views for specific tasks and reuse them by all team members. For instance, each requirements document can have separate table views for capturing requirements, linking with upstream requirements or tests, traceability analysis, exporting, or printing.

Example: The SRS document in the Demo Project storing SW requirements defines the following table views:

  • 1. Primary — is the default view used when the document is opened and gives a brief overview of the document. It displays columns ID, Description, Rationale, and Status.
  • 2. Capture — is used for capturing SW requirements. It displays columns ID, Type, Description, Rationale, and Source.
  • 3. Review — is used for reviewing SW requirements. It displays columns ID, Description, Rationale, and Discussion.
  • 4. Traceability — is used for requirements traceability analysis by a traceability matrix. It displays columns ID, Type, Satisfies, Description, Is Verified By, and Is Implemented By.
  • 5. Export — is used for exporting SW requirements into MS Word. It displays columns ID and Description.
Reuse table views in requirements documents in ReqView

You can manage table views for the current document in the Table Views pane. To toggle it, click View, mouseover Left Panes, and select Table Views Pane. Or press CtrlAltV.

To create a new table view, click icon in the toolbar of the Table Views pane. In the Create Table View dialog, enter a name of the new table view. The new table view contains the ID and Description columns by default. Check Duplicate current document view option to preserve the current table layout, filter and sort.

To duplicate an existing table view, click on the right of a chosen table view name and select Duplicate from the menu.

To switch between table views, click on the selected table view name.

Local changes of table layout, filter or sort of the current table view are restored when the application is restarted. To propagate local changes to the shared table view, click on the right of a chosen table view name and select Confirm Changes from the menu. To restore a shared table view with discarding local changes, select Discard Changes from the menu.

To use a table view automatically when a document is open, click on the right of a chosen table view name and select Set as Default from the menu. The default view has the icon displayed next to its name.

To edit the name of a table view, click on the right of a chosen table view name, select Rename from the menu, and finally, enter a new name in the Rename Table View dialog.

To delete a table view, click on the right of a chosen table view name and select Delete from the menu. The default view cannot be deleted.

Project Windows

You can improve your review and edit workflow using multiple project windows:

  • View different documents from the same project at the same time.
  • View linked requirements in other project windows.
  • Edit requirements in multiple project windows.
  • Copy & paste requirements between project windows.
  • Create links between project windows.
  • Compare the project with a baseline in another window.

To edit the current project in another application window, click Project and select New Project Window. Windows showing the same project are identified by an index in square brackets in the window title. Move the new window to another display or place the project windows side-by-side:

Working on different documents of the same project in multiple windows

Changes done in any project window are propagated to other project windows automatically. However, some operations block other project windows to ensure data consistency. Saving can be done in any project window.

Closing a project opened in multiple windows will close it in all windows and will leave only the current window open.

You can share the URL link to a ReqView requirement by email or company chat, reference it in a document or a ticket, etc. Or, paste the URL link into the ReqView rich text editor to link requirements between ReqView projects.

Paste a ReqView URL into an email

To copy a URL link to the selected document object into the clipboard, click button in the toolbar or press CtrlK.

Then, paste the URL link to a chosen application. If the application supports pasting of HTML content (MS Word, web browser, most email clients, etc.) then the pasted URL link will show the document object ID (e.g. DEMO-SRS-62), otherwise (like in plain text editors) it will show the URL (e.g. reqview:open?projectId=DEMO#SRS-62).

The protocol (scheme) of the generated URLs is always reqview:. ReqView URL links are not pointing to websites on the internet but to project data stored by the ReqView application.

Note: Do not add http:// or https:// in front of ReqView URL links, as that would make them not work.

You can click on a pasted URL link to navigate to the related document object in the ReqView application for Windows, Linux, or Mac. However, you need to enable the OS association with reqview: protocol by ReqView application first. Click Edit, click Preferences, and check Register file and protocol handlers option before using this feature. When this option is enabled, click on a ReqView URL link to start the ReqView application or focus one of its windows if it is already running.

If the referenced project is open in multiple project windows then the window that has the referenced document open is focused. Otherwise, the document is opened in a new tab in one of the windows. If the referenced project is not loaded in any ReqView window, choose the referenced project using the Open Project From URL dialog:

Open Project From URL

Tip: Paste URL Links into ReqView rich text editor of an xhtml attribute to reference requirements from another ReqView project. See Traceability Between Projects.

Note: URL links cannot be handled by the ReqView web application.

Copy to Other Applications

To copy the selected text from the ReqView UI to the system clipboard, press CtrlC:

Selected text to copy to the system clipboard

You can also select one or more document objects and copy to the system clipboard a table containing information in the visible columns by clicking Edit and selecting Copy, clicking the toolbar button, or pressing CtrlC:

Object copied to the system clipboard, indicator displayed bellow object ID

And then you can paste the data into other applications (MS Word, MS Excel or your email client) in HTML or CSV text format:

Object pasted in an email client

To print the current document, click File and select Print, or press CtrlP.

Print options dialog: columns, sorting, folding, save as PDF

In the Print Options dialog, you can select if the displayed custom attribute columns will be compacted into the single Custom Attributes column if printed data will be filtered and sorted the same way as the Requirements Table, and if section folding will be preserved. Click OK.

After confirming Print Options, the WebApp opens the browser Print dialog displaying a print preview. In this dialog you can select a target printer and further customize a printed document by changing page orientation, margins, and adding a custom header or footer:

Print document options

Note: In case you need to export multiple documents and clickable links within the exported PDF please use export to PDF directly.

In a Chrome browser, you can export the opened document into PDF format using Print dialog by setting “Save as PDF”. In a Mozilla browser, you must install the Save as PDF add-on first and then select Save as PDF.

Updated for version 2.18.2