ReqSuite® Requirements Manager (RM)
The functions of the editing window (also referred to as “All-in-One-Window”) which is used to detail content elements (see Figure 1), are explained below. In order to open the editing window of a content element, double-click on the content element that you want to edit in the table or board view of the content chart and the refinement view of the content bar, respectively.
Note: In addition to the basic “Save” function, the editing window also provides the “Save & New” function to create another one immediately after the current element has been stored along with the “Save & Close” function to close the editing window once the element details have been stored. All three functions are located in the drop-down menu of the button in the bottom part of the editing window.
In the left-hand part of the editing window, you can describe the corresponding content element on the basis of the template stored for the opened project (sentence template, tabular or mixed template). On the right-hand side, there are several embedded collapsible subwindows that contain additional information about the content element and that you can use to further specify the content element and enrich it with additional resources as follows:
Here you can manually manage any existing “links” of the content element. For this purpose, the editing window, that can be opened by clicking on “Manage…”, provides a tab on the left-hand side for each content category whose instances can be linked to this content element (see Figure 2). The creation or removal of a link to another content element is done by selecting or deselecting the respective check box to the left of the link candidates listed in the main display area of the editing window.
In addition to the actual content description, you can also add “comments” for a content element and, depending on the user’s project user role, edit or delete them. To add a comment, simply type the comment text into the free input field, mark the comment as “Open issue” if necessary by means of a check box and confirm the saving process by clicking on “Create”. To edit a comment, click on the “Pencil icon” in the corresponding comment field. The comment text concerned is then displayed in a separate window with input field for editing (see Figure 3).
Removing a comment is done by clicking on the “trashcan icon” and has to be confirmed with “OK” in the subsequent query dialog before the actual deletion is executed. The creation date of a comment can be shown in a short info by hovering the mouse pointer over the respective comment.
Note: Comments marked as “Open issue” are displayed in italics.
As a user you can also assign different document files and even link addresses to online resources as attachments to a content element. In order to create a new attachment, press the “New…” button as highlighted in Figure 4 and fill in the mandatory fields “Name” and “Description” in the editing window that is opened. Using a check box, you determine whether the attachment type is a link or a local file (see Figure 5). In the case of a link, an online address (URL) is expected to be entered under “Path” (Note: local addresses are not supported!). If you do not want a link to be used, however, you must select a local file on your computer using the “Browse…” button. The editing and deleting of an attachment is done analogously to the procedure described for “Comments”. In addition, you have the possibility to download the attachment or open the link via another button that depends on the attachment type (see Figure 4).
In the corresponding subwindow, you can display various metadata of the content element, such as the date and creator of the last change, as well as the user responsible for the content element, and edit any data as provided in the project configuration. Also, all attributes that can be specified for the content element according to the configuration but are not currently part of the description template (unused attributes) are displayed there.
The content of this subwindow displays the change history of a content element in tabular form. This version list can be used to trace which user has changed properties of the content element at which point in time (see Figure 6). Selecting exactly two arbitrary entries from the version list activates the “Compare” button, which allows you to open a detailed overview of the changes made between these two versions (see Figure 7). The description contents of the older version (left) are compared with the newer version on the right side and in case of differences are marked with red text color for the old version and green text color for the new version. Changes to links and to attachments of the content element are indicated in the version comparison in the lower part of the window. Comments, on the other hand, are excluded from change tracking by versioning, so that changes to them are not taken into account.
Note: Changes to the description text of a content element are always handled holistically when comparing versions, i.e. the complete text of a description attribute is always marked, even if only one character has changed. This serves for more effective traceability, so that even small but often important changes are not overlooked.
In order to cancel any of the previously mentioned processes without data transfer, you can close the affected editing or dialog window at any time via the “Cancel” button. After a content element has been completely detailed, the stored data contents can be transferred to the database by clicking on “Save”, whereby the open editing window is then closed.
Contents for an element imported as reference are locked for changes in the editing window, i.e. the description and the graphical representation can only be edited in the original project. To be able to change an imported content element in the current project, it must first be converted into a copy by clicking the “Convert to copy” button.
To store a graphical description (notation) for a content element, you can click on the “Clarify the details“ hyperlink in the corresponding work instructions of the Process Guide, or you can select the corresponding content element directly in the Content Manager by double-click. In both cases, the editing window for the content element opens, in which a graphic file from the file system can be assigned to the content element via the button “Choose <notation>” (see Figure 8). In the case of an already existing graphic, this can be changed in the same way by reassignment. To delete a stored graphic, simply press the button “Delete <notation>” in the editing window for the respective content element.
To store an overview graphic for a content category, you can click on the „Interaction“ hyperlink in the corresponding work instructions when using the Process Guide, or you can select the corresponding content category directly in the Content Manager by left-clicking on it and selecting the “Graphic icon” button in the toolbar. In both cases, the editing window belonging to the content category opens, in which a graphic file from the file system can then be assigned to the content category via the “graphic icon” button (see Figure 9). In case of an existing overview graphic, you can change it in the same way by reassigning it. To delete a stored overview graphic, simply press the “garbage bin symbol” button in the editing window for the respective content category and then use the “Save” button to save it.
Note: The option to graphically describe content elements or categories is only available if this is provided in the project configuration by selecting a notation or overview notation.
For more hands-on details on the editing window of ReqSuite (also referred to as “All-in-One-Window”), please take a look at the following tutorial video: