Requirements Specification Editor User Interface

The Requirements Specification Editor action bar allows you to create new or insert existing chapters, comments, and requirements to the open requirement specification, or to create and open a new requirement specification. You can use it to detach chapters, requirements, and comments from the requirement specification. It also opens the properties of chapters, requirements, and comments. The context menus allow you to detach the selected comment or requirement from the requirement specification's structure or to manage traceability links between requirements. Drag and drop capabilities allow you to reorder the chapters, requirements, and comments in the requirement specification.

Note: Right-click on the Requirements Specification Editor action bar to toggle on and off the display of the menu action labels.

This page discusses:

See Also
Requirements Specification Editor
Editing Rich Content in the Requirements Specification Editor
Reordering the Requirement Specification's Structure in the Requirements Specification Editor
Creating a Traceability Link Between Requirements in the Requirements Specification Editor
Removing a Traceability Link Between Requirements in the Requirements Specification Editor
Configuring Preferences for the Requirements Specification Editor

Identity Card

Column Description
Requirement Specification Name The name of the requirement specification structure that is currently loaded.
Containers The total number of chapters and sub-chapters in the requirement specification.
Objects The total number of requirements and comments in the requirement specification.
Selected The name of the currently selected object in the requirement specification.

Click the selected object's name to navigate to it in the requirement specification structure.

Click to deselect the currently-selected object.
Status

Does not display when the widget is not maximized or is used on a mobile device.

 The current lifecycle state of the requirement specification.
Traceability Scope

May not display when the widget is not maximized or when it is used on a mobile device.

 The traceability scope of the requirement specification, if any.

Edit Menu

New Requirement Specification
Creates a new requirement specification and opens it in the Requirements Specification Editor. Any requirement specification that was already opened in the Requirements Specification Editor is closed, but saved in the database.
Insert a new Chapter
Inserts a new chapter as the last child of the selected object or at the end of the requirement specification if no other object is selected.
Insert Existing Chapter
Opens the Search field so that you can search for and select an existing chapter to add to the requirement specification as the last child of the selected object or at the end of the requirement specification if no other object is selected.
Insert a new Requirement
Inserts a new requirement as the last child of the selected object or at the end of the requirement specification if no other object is selected.
Insert Existing Requirement
Opens the Search field so that you can search for and select an existing requirement to add to the requirement specification as the last child of the selected object or at the end of the requirement specification if no other object is selected.
Insert a new Comment
Inserts a new comment as the last child of the selected object or at the end of the requirement specification if no other object is selected.
Insert Existing Comment
Opens the Search field so that you can search for and select an existing comment to add to the requirement specification as the last child of the selected object or at the end of the requirement specification if no other object is selected.
Detach
Detaches the selected objects from the structure without deleting them from the database.

You can detach multiple requirement objects from the Requirements Structure Editor widget.

The Detach dialog box appears asking you to confirm the action. Once the detach operation is complete, a status report appears. You can view the successful operations in the Success tab and failed operations in the Fail tab. Requirements Structure Editor and Requirements Specification Editor widgets are refreshed after executing the command.

Note: You cannot perform this action on the root object.

Edit Properties
Opens the Properties widget, and displays information about the selected objects in different tabs.
You can edit the properties of the object from the widget.

The available tabs depend on the app the command is launched from, and the type of object that is selected.

For more information, see Properties and Information.
Check Requirement Quality
Opens the requirements quality analyzer tool from The REUSE Company. See Checking the Quality of Requirements.
Note: This action is available only if the Requirements Specification Editor is integrated with the requirements quality analyzer tool.

Tools Menu

Find
Finds your specified text in the requirements and comments of a requirement specification.
Launch Web Application
Launches the Traceable Requirements Management app in a new browser window or tab.
Download MS Office Requirement Capture Installer
Downloads the MS Office Requirement Capture Installer that you can use to install Requirement Capture on your local computer.

Views Menu

Clean View
Removes all roots loaded in the app.

Collaboration Menu

Lock
Prevents other users from modifying the selected objects.
See Locking and Unlocking Objects.
Unlock
Reverses the lock operation and allows users to modify the selected objects.

For more information, see Locking and Unlocking Objects.

Chapter Context Menu

Click to open the chapter's context menu.

Properties
Opens the properties of the chapter in a new widget that can be pinned to the dashboard.
Detach
Removes the chapter from the requirement specification structure, but does not delete it from the database.
Append New Chapter
Adds a new chapter directly after the selected chapter, at the same level (as a sibling).
Append New Requirement
Adds a new requirement directly after the selected chapter, at the same level (as a sibling).
Append New Comment
Adds a new comment directly after the selected chapter, at the same level (as a sibling).
Insert New Chapter
Inserts a new chapter as the last child of the selected chapter.
Insert New Requirement
Inserts a new requirement as the last child of the selected chapter.
Insert New Comment
Inserts a new comment as the last child of the selected chapter.
Insert Existing Object
Opens the Search field so that you can search for and select an existing object to add as the last child of the selected chapter.

Comment Context Menu

Click to open the comment's context menu.

Properties
Opens the properties of the comment in a new widget that can be pinned to the dashboard.
Detach
Removes the comment from the requirement specification structure, but does not delete it from the database.
Append New Chapter
Adds a new chapter directly after the selected comment, at the same level (as a sibling).
Append New Requirement
Adds a new requirement directly after the selected comment, at the same level (as a sibling).
Append New Comment
Adds a new comment directly after the selected comment, at the same level (as a sibling).

Requirement Context Menu

Click to open the requirement's context menu.

Properties
Opens the properties of the chapter in a new widget that can be pinned to the dashboard.
Detach
Removes the chapter from the requirement specification structure, but does not delete it from the database.
Append New Chapter
Adds a new chapter directly after the selected chapter, at the same level (as a sibling).
Append New Requirement
Adds a new requirement directly after the selected chapter, at the same level (as a sibling).
Append New Comment
Adds a new comment directly after the selected chapter, at the same level (as a sibling).
Insert New Requirement
Inserts a new requirement as the last child of the selected requirement.
Insert External New Requirement > Sub Requirement
Opens the creation dialog box from the external system so that you can create a new requirement in the external system to insert as the last child of the selected requirement as a sub requirement.
Note: This command is available only if an external requirements management system is integrated with the Requirements Specification Editor.
Insert External New Requirement > Downstream Requirement
Opens the creation dialog box from the external system so that you can create a new requirement in the external system to insert as the last child of the selected requirement as a downstream requirement.
Note: This command is available only if an external requirements management system is integrated with the Requirements Specification Editor.


Insert Existing Requirement
Opens the Search field so that you can search for and select an existing requirement to add as the last child of the selected requirement.
Insert External Existing Requirement > Sub Requirement
Opens the selection dialog box from the external system so that you can select an existing requirement in the external system to insert as the last child of the selected requirement as a downstream requirement.
Note: This command is available only if an external requirements management system is integrated with the Requirements Specification Editor.
Insert External Existing Requirement > Downstream Requirement
Opens the selection dialog box from the external system so that you can select an existing requirement in the external system to insert as the last child of the selected requirement as a downstream requirement.
Note: This command is available only if an external requirements management system is integrated with the Requirements Specification Editor.
Start Link
Makes the selected requirement the source of the traceability link.


End Link
Makes the selected requirement the target of the traceability link.
Links Management
Opens the Links Management dialog box so that you can manage the traceability links for the requirement.

Keyboard Shortcuts

Alt + G
Inserts a requirement as the first sibling of the selected object.
Alt + I
Inserts a requirement as the child of the selected object.
Alt + J
Inserts a chapter as the child of the selected object.
Alt + K
Inserts a chapter as the first sibling of the selected object.