ReqView presents structured information about the project and the current document in the left pane, a structured table view of the document in the center pane, and detailed information about the selected document object in the right panes.
The left panes show information about the project and the current document. The Project pane shows all the documents in the project and their status. To toggle it, click View and select Project Pane, or press CtrlAltP.
The Document pane shows the table of contents to help you navigate the document structure. To toggle it, click View and select Document Pane, or press CtrlAltT.
The right panes show details of the selected object. The Instructions pane displays help text related to the current document object, see Custom Attributes > Template Instructions for an example. To toggle it, click View and select Instructions Pane, or press CtrlAltI.
The Attributes pane lists the custom attributes of the current document object. To toggle it, click View and select Attributes Pane, or press CtrlAltA.
The Discussion pane shows discussion comments related to the current document object. To toggle it, click View and select Discussion Pane, or press CtrlAltD.
The Links pane shows traceability links related to the current document object grouped by link type. To toggle it, click View and select Links Pane, or press CtrlAltL.
The History pane shows the history of changes to the current document object. To toggle it, click View and select History Pane, or press CtrlAltH.
The center pane shows the Requirements Table which combines a tree view of the current document structure and a table view with columns displaying additional information for each object. The Requirements Table displays the following columns and information:
To refresh the table view, click View and select Refresh Table, or press F5.
When you open a project, the visible columns and their widths are set up for each document according to the Default View saved in the Project File or Project Folder.
You can customize the table view for each document:
The current table view given by order, widths, and display status of all table columns is persistently saved and restored after each application restart.
To save your current document view to the Project File or Project Folder as the Default View, click Document, mouseover Default View, and select Set Default View. To save the project, click File and select Save.
To restore the Default View saved in the Project File or Project Folder, click Document, mouseover Default View, and select Restore Default View.
The ID column can display the following status icons:
|Unsaved change||The object was changed since the last time the current document was opened and has not yet been saved to a file.|
|Comment||The object is commented on.|
|Attachment||The object has at least one attachment.|
|Link||The object is linked with another requirement or object.|
|Deleted||The object is marked as deleted, but not yet purged (completely removed from the document). The object can be undeleted.|
|Cut||The object is cut in the clipboard and will be moved on a paste operation.|
|Copied||The object is copied in the clipboard and will be copied on a paste operation.|
A ReqView document is structured into numbered sections. A section number is automatically generated for an object either if the object has a heading attribute set or if the object has at least one child.
Tip: To assign a section number to an object with only text description, set the heading attribute to an empty space (“ ”).
To collapse or expand a selected document section, click the / icons on the right of the section name, or press CtrlSpace.
To collapse all document sections, click View and select Collapse All menu, or to expand them click View and select Expand All.
Document objects can have image or file attachments. To open an attachment in your browser, click the attachment link in the Description column. If your browser cannot display the attachment, it will be automatically downloaded.
To show or hide an image attachment, right-click on the image and select Show Image or Hide Image in the context menu.
To show or hide all image attachments, click View, mouseover Image Attachments, and select Show All Images or Hide All Images. To automatically load images after opening a project, click Edit, select Preferences, and tick Show images.
Tip: Hiding image attachments in large documents or documents with a large number of attachments usually significantly improves application performance.
To jump directly to an object with a specific ID, click Document and select Go To, or press CtrlG. In the Go To dialog, enter the object ID, including the document ID prefix if the object is from a different document.
To sort the Requirements Table, click on a chosen column heading. If you click on the same column heading again, then you change the sort order. To reset to the default sorting with the natural document order, click on the Description column heading.
Note: You cannot sort by Custom Attributes and Links columns or columns corresponding to custom attributes of xhtml type.
Enter a filter condition in the filter field that is displayed in the top right corner of the screen to filter the Requirements Table. You can quickly move to this field by pressing CtrlShiftF.
To activate or deactivate the current filter, click the icon, or press CtrlAltF.
Note: When the current filter is active, then the Requirements Table does not show the document hierarchy. For example, the Description column is not shown indented according to the section level.
To filter all objects with a given value of a Boolean (bool) attribute, choose an attribute item from the filter suggestions list.
To filter all objects with a given value of a numeric (int, real and date) custom attribute, choose an attribute item from the filter suggestions list and enter one of these <, >, <=, >=, = conditions.
To filter all objects matching a given text condition in a text (int, real and date) attribute or in a Template Column, choose an attribute or template column item from the filter suggestions list, and choose a keyword from the list or enter a “substring” or a /regular expression/ condition.
Note: If you choose a keyword from the list without first specifying an attribute, the keyword is matched in all text attributes.
To filter all objects with a given value of an enumeration (enum) custom attribute, choose attribute and then an enumeration value from the filter suggestions list.
You can filter all objects with a null value of a numeric or text attribute. Choose attribute from the filter suggestions list and press Enter without entering a value.
To filter all objects from the given section, choose Section from the filter suggestion list and enter a section number.
To filter all objects with outgoing or incoming links of a given type, choose link type or link type respectively from the filter suggestions list.
Similarly, you can filter all objects with a reference origin (see Inherited Links). Choose Origin or Copies item respectively from the filter suggestion list.
Optionally, to add condition that the given link type should have Suspect Link Flag set, choose Suspect from the filter suggestion list before a link type.
To filter a combination of several conditions, use AND, OR and NOT logical operators in disjunctive normal Form (DNF) according to the following rules:
Let’s assume that we want to filter all document objects with attribute type set to “User Story” AND attribute status set to “Verified”.
Follow these steps:
The following image shows a filter matching all user stories in which an editor can open or save, or an architect can create:
Search for a keyword using the search input field next to the filter. To focus this field, click Document and select Search, or press CtrlF. Navigate to the next or previous object containing the searched keyword by clicking on the icon on the right of the search input field or pressing F3 or ShiftF3 respectively.
Extend the Requirements Table with Template Columns to render a live, dynamic view on the current project data. For instance, you can define new columns to:
To define a new Template Column, click Document and select Add Template Column… which opens the Template Column dialog.
Enter a column label displayed in the table header and a template definition using Handlebars syntax the same way as custom export templates. Note: Template Columns are rendered using document object context, therefore you can directly use document object attributes.
Press Check to validate the template definition. Its output is displayed for the current document object. Press OK to add the Template Column to the current table view.
Template Columns are persisted in the Default View in your Project File or Project Folder.
Edit or delete an existing Template Column by right-clicking on the column heading and selecting Edit Template Column or Delete Template Column:
Let’s create a Template Column which calculates the risk priority number as a product of severity, probability, and determinability custom attributes for each Risk or Action object in the RISKS document of the ReqView Demo Project.
Template Column Definition:
Template Column Output:
Let’s create a Template Column which displays downstream traceability coverage of each top-level user story in the NEEDS document of the ReqView Demo Project by linked SRS requirements and their TESTS:
Template Column Definition:
Template Column Output:
Open one or more documents in the Project pane, you can then choose the displayed Requirements Table by clicking on the tabs showing the document IDs under the Requirements Table. Tip: Quickly switch to other open documents. Click Project and select Next Document or Project and select Previous Document**, or press CtrlShiftPgDn / CtrlShiftPgUp or Ctrl1, Ctrl2, …, Ctrl9.
To print the current document, click View and select Print, or press CtrlP.
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 printed document by changing page orientation, margins, and add a custom header or footer:
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.
To copy the selected text from the ReqView UI to the system clipboard, press CtrlC:
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:
And then you can paste the data into other applications (MS Word, MS Excel or your email client) in HTML or CSV text format: