A new documentation is available for Squash TM 2.0 and later versions, check it here
The Requirement consultation page is composed of two tabs (Informations tab and Attachments tab) and a toolbar.
The page displayed by the Information tab of the selected requirement has four units : "General Information" unit, "Description" unit, "Test cases verifying this requirement" unit, "Edit history" unit.
General information unit
The "General Information" unit displays different key descriptions, which are detailed below :
Version
Gives the version of the requirement. It can not be set manually.
The user can create a new version via [Create a new version] in the top toolbar.
Reference (optional)
It is determined while creating the requirement. Consists of a text field of 50 characters maximum, which remains optional during the creation. It can be completed later, by clicking on the field in the requirement consultation page.
It is displayed before the name in the tree structure, and is the criterion of requirement organization in this tree.
Statut
Determines the status of the requirement (it takes the value Work in progress by default), it can be changed later via the combo box.
Statuses can take the following values :
Work in progress
Under review
Approved
Obsolete
Attributes unit :
The "Attributes" unit displays different important description, detailed below :
Criticality
Is determined while creating the requirement (it takes the value Minor by default).
It is optional during the creation and can be completed later via the combo box.
Criticality can take the following values :
Minor
Major
Critical
Undefined
Category
Determines the category of the requirement (it takes the value Undefined by default), it can be changed later via the combo box.
Categories can take the following values :
Business
Ergonomic
Functional
Non functional
Performance
Security
Technical
Test requirement
Undefined
Use case
User story
Custom fields
It is possible to add custom fields of different kinds (plain text, checkbox, dropdown list, rich text, date, tag, numeric). Please consult the Administrator guide for more information.
Description unit
This unit displays the description of the requirement. It is determined while creating the requirement. Optional during the creation, it can be completed later by clicking on the field in the requirement consultation page. You can also insert a table or a picture in the description since the 1.6.0 version of SQUASH TM was released.
Coverage indicators unit
This unit displays the following indicators:
Coverage rate: requirement coverage e.g. the requirement is associated to at least one test case
Verification rate: percentage of run test cases that are associated to the requirement for a specific perimeter (a campaign or iteration)
Validation rate: percentage of conclusive execution status (success or settled) of test cases associated to the requirement for a specific perimeter
To obtain the verification and validation rates, it is possible to choose or edit the perimeter. To do so, click on Choose a perimeter or on the perimeter label if one is already selected.
Test case verifying this requirement unit
This unit displays an association table containing the information of the test case verifying the requirement. A chapter is dedicated to this function.
Linked requirements unit
This unit displays an association table containing the information of the requirements linked to the current requirement. A chapter is dedicated to this function.
Edit history unit
This unit displays a table of all changes made on the requirement since the status comes from « work in progress » to « under review ».
The Attachments tab is composed of an attachments table which displays those related to the selected requirement.
A chapter is dedicated to it.
The known issues tab enables you to consult issues reported during the execution of the test cases linked to the requirement.
The table is automatically updated and cannot be edited.
The key column contains links to the issue page in the bugtracker.
The Report in execution column contains links to the execution where the issue was reported.
When the requirement has several versions, only the issues linked to the last version will be displayed.
If there are child requirements, every issues linked to the main requirement AND to its children will be displayed in the main requirement 'Known issues' tab.
The Requirement toolbar is composed of 3 buttons:
Rename (detailed here)
Create a new version (detailed here)
Print the requirement (pdf or html)