Requality: user guide


Projects


Create Requality project

  1. To create project select in main menu 'File' → 'New' → 'Project...'
  2. In opened dialog window choose 'Requality' → 'Requality Project' and push 'Next' button.

    Choosу new project type

  3. On the next page input project name and push 'Finish'.


Edit 'Requality' project properties

Global attributes that are available on whole project nodes can be defined in view 'Properties view'. To do so you need to click in 'Requality Explorer' on project name. After that in 'Properties view' you will see the properties of project.

Global attribute can be defined and altered in attributes table. Attribute to be used to define an enum type may be also created there by semi-automatic extraction from existing attributes or manually (see above).


Global attribute to define an enumeration type can be created manually as it is described below, but you also may extract it from attributes of nodes in a project in semi-automatic way. To do so:

  1. In 'Properties view' of project click on 'Extract enum definitions from attributes' button. You will see 'Enum definition extractor dialog'.
  2. In this dialog choose the name of attribute you want to use in enumeration extraction. On the right field 'Values of selected attributes' you will see all values defined in attributes with chosen name from all nodes in a project.
  3. In a field below 'Select a name of ENUM definition' you may define a name of creating 'ENUM_DEFINITION', that will be created from chosen attributes.
  4. Press 'OK' buttons.

Now attribute of 'ENUM_DEFINITION' type was creates and shown in 'Attributes' table with defined name and has the value defines as list of all values you seen in 'Values of selected attributes'. In 'Properties view' of nodes, which has attributes of this name, you will see that type of attribute is changed to name of created 'ENUM_DEFINITION'.


Documents


Import document

If you want to mark requirements in document, first of all you should import the document that contains text of the requirements. The requirements could be written in a free-form. Requality allows importing documents with following extensions: 'doc', 'pdf', 'htm', 'html'. Herewith Requality copies an original document, converts it to 'xhtml' and puts the resulting document to the project. The original document isn’t changed. Resulting 'xhtml' –document is a document that is used in the following work.

Requality allows importing of one document, set of documents, and folders with documents.

  1. To import document select 'Documents'node (or its sub-node). In context menu select 'Import Document...'.

  2. To select source directory push 'Browse...' to the right of the 'From directory:' field in opened 'Document Import Wizard' window and select directory where documents or files with documents are situated.

  3. There are some ways to select required document or folder:

  4. You can use document extension filter. As we wrote above Requality provides import of documents with 4 extensions: 'doc', 'pdf', 'htm' and 'html'. But you can change the default filter and try to import other documents. So if you want to import document with other extension follow these instructions:

    If you selected required extensions push 'OK'. Now documents with selected extensions are available to import.

  5. Now you should select a target folder. The target folder is a folder in Requality-project where you want your documents to be imported to. Select it in 'Into folder:' field. Default target folder is 'Documents' (the root documents folder) or its sub-folder (if you called import on it). Push 'Browse...' to the right of the 'Into folder:' field to select or create other folder. (Read more about document folders in 'Document folder creation'.)

  6. If imported documents have the same names as documents in the project folder you can choose 'Rename existing documents' option. Just select this flag. Now imported documents will be renamed (by adding indexes) if their names are similar to the already imported documents.

  7. When importing a folder with all nested documents and sub-folders, this hierarchy is not transferred in your Requality project as default. All document from the folder and sub-folders are got into the target folder 'Documents'. If you want to save the hierarchy use 'Create folders' option in 'Document Import Wizard' window. Now all importing documents will be transferred by a hierarchy.

  8. Now if you have already chosen importing documents and selected target folder finish import by pushing 'Finish' button in 'Document Import Wizard' window.

After process finish 'xhtml'-documents appear in target folder.
Documents import window

Delete document

  1. To delete a document select it in 'Requality Explorer' view.

    1. In context menu select 'Delete Document'.
    2. Also you can use 'Delete' hotkey.
  2. Push 'OK' in the confirmation dialog to proceed document deletion.

  3. If there are marked locations in the document you want to delete, you will get one more confirmation dialog on this step. This dialog warns you that all marked locations will be deleted together with the document. If you agree and want to proceed push 'OK'. Note! All locations marked in this document will be deleted from the requirements. The requirements will remain without links to these locations.


Update document

'Requality' allows updating documents by transferring requirements locations from an old document version to a new one. You can read about it here: 'Transferring locations to new document version'.


Create documents folder

There is possibility to create folders in 'Documents' node and set documents there. It helps to comfortably organize documents in 'Requality' project.

  1. To create a documents folder select 'Documents' node or any it’s sub-folder (if exists), select 'New → Folder' in the context menu.
  2. In the opened window input folder name to the 'Enter folder name' field.
  3. The name shouldn’t replicate name of folders are on the same hierarchy level in the documents node. Otherwise you get a warning and can’t proceed.
  4. After you input a correct name push 'OK'. Now you can see this folder in 'Requality Explorer'.

And now you can import documents to the new folder.


Delete documents folder

  1. To delete a documents folder choose it in 'Requality Explorer'.

    1. Select 'Delete Folder' in the context menu.
    2. You can also use 'Delete' hotkey.
  2. Note! Folder deletion causes deletion of all nested documents and sub-folders. If you are sure push 'OK' button in a confirmation dialog to proceed.

  3. If folder being deleted or its sub-folders contain documents with marked locations you get one more confirmation dialog on this step. Note! If you delete the folder all nested documents are deleted. Thus all the locations in these documents are deleted too. If you agree and want to proceed push 'OK' button in a confirmation dialog.


Requirements

All requirements in Requality project are situated in 'Requirements' node.


Create requirement

There are several ways to create new requirement: from 'Requality Explorer', from 'UniEditor' and from 'ModuleEditor'. Requiremnts may be created both from scratch and from requirement templates of current project. Note that it is allowed to add new requirements as a child only for requirement and it is disallowed to add them to text node.


Create requirement by copying

Requirement can be created as copy of existing requirement.


Create reference requirement

There are two ways to create reference requirement:

  1. Add 'REFERENCE' attribute to some existing requirement and set target requirement as its value; in this way existing requirement becomes a reference requirement to the target requirement.
  2. Create new requirement as reference requirement to some selected requirement.



Delete requirement

Note! If you delete a requirement all its locations are deleted and all corresponding marks in the documents are deleted too.

  1. To delete the requirement choose it in 'Requality Explorer', select 'Delete Requirement' in the context menu.
  2. You also can delete a requirement in 'UniEditor' and 'ModuleEditor' from drop down menu in the top right corner or node's drop down menu using 'Delete Requirement' menu point.
  3. You can also use 'Delete' hotkey.
  4. In the opened dialog confirm deletion by pushing 'OK'.


Create requirement by selecting location

You can create a requirement in the document editor ('Markup Editor') and add the location to it at the same time.

  1. Open document where you want to mark some location for new requirement.
  2. Choose node 'Requirements' or some sub-requirement in 'Requality Explorer'. Let this requirement be a target.New requirement we want to create will be sub-requirement for the target requirement.
  3. Select text part you want to be a location in 'Markup Editor'. Note! If required location has already been marked for some requirement, you shouldn't select it in document text, just skip this step.
  4. Call context menu on selected text and choose one of two menu items:
  5. As a result, the target requirement gets new sub-requirement with the location. The text of this location is marked in the document.

You can read about simple requirement creation here: 'Create requirement'.


Context menu for marked location

Add location to requirement

A requirement can have some location (some links to text pieces marked in the document). So you can add new location to an empty requirement (which has no locations yet) or to a requirement, which has already have some locations.

  1. Open the document which text fragment you want to mark and add to the requirement.
  2. Select the target requirement in 'Requality Explorer'.
  3. Select needed text location in the document editor. Note! If required location has already been marked for some requirement, you shouldn't select it in document text, just skip this step.
  4. Call the context menu on selected text and choose one of two menu items:
  5. As the result selected location is marked in the text and is added to the target requirement.


Delete location in document editor

To delete a location from the requirement you should delete its selection in the document. Thus location will disappear from the document and from the requirement. Note! If the location belongs to several requirements at the same time, it will be deleted from all these requirements. (If you want to delete the location from the specified requirement only see 'Delete location in Properties view').

  1. Double-click on location in 'Properties view'. The document will be opened and scrolled to the place where the location is situated.
  2. Call the context menu on the location and select 'Remove from Requirement'.
  3. Now you can see that this location is not marked in the document anymore and there is no link to this text in the requirement 'Properties' view ('Description' tab).


Delete location in Properties view

Here is another way how to delete a location from a requirement. This way is suitable if the location belongs to more than one requirement but you want to delete it from the one specified requirement.

  1. Open 'Properties' view for the target requirement, open 'Description' tab (see 'Edit requirement parameters').
  2. Select required location in 'Locations' list.
  3. In context menu select 'Delete' item. Or just use Delete hot-key.


Auto-mark locations in document

'Requality' allows marking locations in document automatically. Select document in в 'Requality Explorer' and in context menu select 'HTML Headers Document Processor'. This processor allows marking HTML-headers (text inside <h1></h1>, <h2></h2> and so on) as locations. Every location is added to a new requirement.


Edit requirement parameters

To edit requirement parameters select the requirement in 'Requality Explorer' or one of its locations in 'Outline'. Now you can see requirement properties in 'Properties' view. Here we describe requirement parameters you can change manually.

  1. Id

  2. Name

  3. Type

  4. Attributes

  5. Alternative Description

  6. Locations

  7. Predicate


Transferring locations to new document version

'Requality' allows transferring locations to a new document version.

If you have a document with locations and you get a new document amended and supplemented than you may want to transfer old locations to the new document. Do the following:

  1. Be sure new document is imported to the project. Otherwise import the document to a recent project.
  2. Select the new document in 'Requality Explorer' view and select 'Update Document' in context menu.
  3. In opened window select old document.
  4. After the processing is complete the window with information about the number of locations found in the old version and the number of locations transferred into a new version will appear.
  5. In any case, user should check transfer of all the requirements: for every requirement user should confirm the correct transfer or modify the requirement. After document processing in 'Requality' perspective you'll see 'Update Processor Tasks' view This view shows recent state of every project catalog requirement and provides the ability to change transferred requirements statuses manually.
    List of tasks to finish requirements transfer to a new document
    In the view user can analyze and modify requirements. For every task there is a related requirement and action to perform. There are 3 types of actions (depends on 3 possible requirement states):
    1. 'Verify' – all requirement locations have been transferred, user should only verify the correctness of the transfer.
    2. 'Add Locations' – requirement locations have been transferred partially, user should find analogues of not-transferred locations or make sure new document doesn't contain these locations.
    3. 'Find Locations' – none of requirement fragments has been transferred. User should find analogues of not-transferred locations or make sure new document doesn't contain these locations or the requirement in a whole.
  6. User can open considered requirement both in the old document and in a new one. In the old document, all requirement locations will be marked in a text. In the new document only transferred requirements will be marked. If none of the requirement locations has been transferred there will be no marked locations.

  7. Note. In case of switched-on synchronization between 'Requality Explorer' and browser (toggled button 'Link with Editor' in the 'Requality Explorer' toolbar) opening of two documents from view 'Update Processor Tasks' may be incorrect for task with none locations in the new document (with red icon). For correct opening of the locations, it is suggested to switch-off the synchronization between browser and 'Requality Explorer'.
  8. Here user can modify the requirement: add or remove locations and mark requirement status as checked. Checked requirements get 'Completed' status, you can customize view to hide checked requirements in the table. For this purpose use the button 'Hide Completed Items' in the toolbar. After all requirements have been checked and modified (if needed) manually you can remove tasks list from the view. It can be done be two ways: delete one current task using button 'Delete Selected Task' or using button 'Delete all Update Processor Tasks' for deleting all update processor tasks for current project. Deletion may be undone from menu 'Edit → Undo …'. In addition, after transfer finished it is recommended to remove old document from the project.
  9. Note. It is assumed to transfer requirements sequentially for different documents. Firstly, requirements from one document are transferred and if necessary corrected. Then proceed to the following documents.


Generate test for requirement

'Requality' allows to add new tests to a test purpose or a requirement by using extending test generator.

'Requality' provides test generation by special pattern.

Tests can be generated from 'Requality Explorer':

It is also possible to add test from 'Coverage' report by pressing "Add test" button in the report view.

Also you can use Eclipse main menu → 'File' → 'New' → 'Other' → folder 'Requality' → 'Create Test'.


Linked requirements

In 'Requality' project different catalog nodes could be linked one to another. The linking is set only in one direction: down up. To you want one node to be linked to another one open 'Main' tab in 'Properties' view and add 'REFERENCE' type attribute and set target node as a value. The target node will not get additional reference attribute but you will see this link in 'Requality Links Explorer' view. Open this view by main menu 'Window' → 'Show View' → 'Other', expand 'Requality' and select 'Requality Links Explorer'.

This view shows nodes linked to a selected node. If selected node has 'REFERENCE' attribute with a link to other node as value you will see it in the view and icon 'down arrow' near it. Nodes that links to this node will be shown with 'up arrow' icon. Near the icon you can see name of 'REFERENCE' attribute in which the link is set. Wherein if recent node links to other one you'll see only attribute name. But if this node links to a recent node you'll see prefix 'Backward_' in attribute name. You can expand or collapse info about linked node by clicking on arrow near the arrow icon. If you click on node name in 'Requality Links Explorer' view the node becomes selected and you'll see info about it in the view..


'Requality Links Explorer' view

You can customize 'Requality Links Explorer' view to show only nodes recent node links to. Just push button 1 (see picture above) one or more times to set it to 'down arrow' state. If you want view to show only nodes that links to recent node set button 1 to 'up arrow' state.

Button 2 (see picture above) allows to filter nodes by names of 'REFERENCE' type attributes. To activate filter push button 2 and select required names in opened window (this window contains all names of 'REFERENCE' attributes of recent project). If you want to show all nodes click on the 'Use all references'.


Requirements filter by attribute name


Node templates

To create a node template in 'Requality' project you need first to open a templates editor:

Please note that in templates editor in field 'List of templates' you may see a list of templates only for that type of node that is selected in 'Select Node Type' list.

To stop working with templates just press the 'OK' button.


Create template

There are two ways to create a node template:


Delete template

To delete a template:

  1. Open a templates editor (how to open it is explained above).
  2. Choose a type of node for which you want to delete a template. In field 'List of templates' you will see all existing template for this project and for choosed type of nodes.
  3. Click in 'List of templates' on template which you want to delete.
  4. Press a button 'Remove' on the right of the list.

After that you will see that this template will dissapear from templates list (that means that it was deleted).


Edit template

To edit a template:

  1. Open a templates editor (how to open it is explained above).
  2. Choose a type of nodes for which you want to edit a template. In field 'List of templates' you will see all available in this project templates of selected type.
  3. Click in list 'List of templates' on template you want to edit.
  4. Press a button 'Edit' on the right of the list (or just double click on template in list).

As a result you will see an edit template dialog. You may edit template attributes in the same way as attributes of corresponding node type in 'Properties'. See:

Select active template

To make one of existing templates active (what is active template is explained here), you need to do the following:

  1. Open a templates editor (how to open it is explained above).
  2. Choose a type of nodes for which you want to select an active template. In field 'List of templates' you will see all existing templates for choosed type of nodes.
  3. Click in 'List of templates' by template you want to make active.
  4. Click on 'Set as active button on the right of list.

After that you will see that selected template in list 'List of templates' is marked as bold. That means that templates is now active. Now all new nodes of the same type will be created from this template.


Text nodes

In Requality project all text nodes are in 'Requirements' subtree. Text node is very similar to requirement (see 'Requirements').


Create text node

You can create text node in the same way as requirement (see 'Create requirement').


Create text node by copying

You can create text node by copying in the same way as requirement by copying (see 'Create requirement by copying').


Delete text node

You can delete text node in the same way as requirement (see 'Delete requirement'). Note that if you delete text node then subtree of its descendants will be also deleted.


Edit text node

You can edit text node in the similar way as you edit requirement (see 'Edit requirement'). Except for:


Test purposes

All test purposes in Requality project are situated in 'Requirements' node in terminal requirements (requirements that have no sub-requirements).


Create test purpose

Note! Test purpose could be added only to terminal requirement

Test purpose can be created in several ways: in 'Requality Explorer' and in 'UniEditor'. Test purposes can be created from scratch and from Test purpose templates of current project.


Create test purpose by copying

Test purpose can be created as copy of existing test purpose.


Edit test purpose properties

To edit test purpose parameters select this test purpose in 'Requality Explorer'. Now you can see its parameters in the 'Properties' view.

Here we describe test purpose parameters you can change manually.

  1. Id
  2. Test target
  3. Status
  4. Author
  5. Attributes

    Attributes of test purposes are identical to requirements attributes. And you can work with it the same way. (Read more here).

  6. Description
  7. Expected Results
  8. Predicate


Delete test purpose

Test purpose can be deleted in 'Requality Explorer'. In this case you need to select it, right click and choose 'Delete Test Purpose' in context menu. In 'UniEditor' test purpose can be removed in drop down menu of node or drop down menu on right top corner of editor by selecting a menu point 'Delete Test Purpose'. Also you can use hot key 'Delete'. In any case you need to confirm deletion in showed dialog by pressing 'OK' button.


Generate test for test purpose

Requality allows to create a new test aimed to check a test purpose in the same way as it made for requirement. Read more here.


Reports


Create report settings

To create report you must first create Report Settings. Report could be generated for some node named Root requirement. Such report contains information about selected node itself and all its subrequirements. A report type depends on selected template.

To create report settings node click on 'Reports' node (or any report folder) and select 'New → Report Settings' in the context menu. Report settings will be created.


Edit report settings parameters

To edit report settings parameters select this report settings in 'Requality Explorer'. Now you can see its parameters in the 'Properties' view.

Here we describe report settings parameters you can change manually.

  1. Root requirement
  2. Template
  3. Attributes

    Attributes of report settings are identical to requirements attributes. And you can work with it the same way (read more here).


Working with 'Coverage' report

'Coverage' report is designed to present information about coverage of requirements and test purposes by tests.


To build coverage report its required to select source of coverage information:

  1. Create a new report.
  2. In Properties view select 'Coverage' template for the report.
  3. Open context menu for the report in 'Requality Explorer' view and select 'Update Coverage Source'.
  4. Then choose one of available coverage sources:
  5. When coverage source is chosen it is possible to generate report as usually.


Working with 'Document Model' report

'Document Model' report is designed to present information about coverage of document locations by tests. Working with 'Document Model' report is similar to 'Coverage' report but as a result you get a document with selected locations where the color of selection shows if this location has been covered or not.


To build coverage report its required to select source of coverage information:

  1. Create a new report.
  2. In Properties view select 'Document Model' template for the report.
  3. Open context menu for the report in 'Requality Explorer' view and select 'Update Coverage Source'.
  4. Then choose one of available coverage sources:
  5. When coverage source is chosen it is possible to generate report as usually.


Working with 'Progress' report

Report template 'Progress' is designed to present information about project’s statistics from SVN.

ATTENTION! To generate 'Progress' report 'Requality Subclipse Connector' plugin should be installed (available by 'update site'). This plugin requires adding address "http://subclipse.tigris.org/update_1.8.x" to 'available software sites'. You can do that by copying the address to the field 'Work with' of the 'Install' dialog. After those actions, the plug in 'Requality Subclipse Connector' may be installed in a usual way.



To build statistic report it is required to :

  1. Create new report settings. In the 'Properties' view set the template 'Progress'.


    Properties view for Progress report


  2. Optionally user may choose one of the available coverage sources. For example to add to the report also the information about coverage by test purposes of by data of other projects. To do this select 'Update Coverage Source' button in 'Properties' view and choose the source. These actions are similar to those described in report generation for 'Coverage' template.


    Coverage Source Selection view for Progress report


  3. In addition, it is available to use additional parameters for this report. To do this in the 'Properties' view push the button 'Open Settings' and in the opened window select 'Progress for selected dates' or 'Progress for all available dates' radio button. In case of 'Progress for selected dates' it will be required to select the beginning and end dates of the intended period and also to state the minimum step between revisions. The step should be stated in the following format: '1 week 2 day' or '5 month'. Also it is allowed to use not full names of period but the short ones, for example 'd' instead of 'day', 'w' instead of 'week', 'm' instead of 'month' and 'y' instead of 'year' (for example '1 w 2 d'). Use 'OK' button to close the dialog window.


    Progress report settings view for Progress report


  4. Then generate report in a usual way.


Working with 'Traceability' report


Report template 'Traceability' is designed to present information about the links-references (of specific type) between nodes in selected part of 'Requality' project catalog.

Report consists of two pages:

'Traceability' report:


'Traceability' report


By default first page is opened. To open second page you should click on reverse link name (mark 2 on the picture below). The name could be set in project properties. To turn back click on direct link name (mark 1 on the picture below).

If collapsing mechanism has been launched in report settings (it is launched by default) then there will be buttons for expanding and collapsing on report pages for all strings (3). And for every string with the initial node name (4) there will be expand/collapse arrow to show if referred (by link 5) nodes are expanded or collapsed.

4 and 6 shows results of values substitution to the primary and secondary patterns (described in 3 below). At the same time there is an information about reverse link for 6 on the second page. So you can click on 'Backward_relates_to' to open the second page.


To generate report do the following:

  1. Create new Report Settings node. In the 'Properties' view set the template 'Traceability' .
  2. Set referense type you want to generate report to. To do this push 'Open Settings' button. In opened window on the leftПосле этого откроется окно настройки отчета в левой части которого (1,2) you'll see a list of available link types (possible names for 'REFERENCE'). In the brackets near the name you can see a number of catalog nodes that has such a link. select one of them and push 'OK'.
    Additional settings of 'Traceability' report
  3. There is an option to customize report in details. Generated report will contain two kinds of strings: information about both initial referred node and target node. Number 3 on the picture is an example of generation where you can see 2 strings: 'Requirements/01 [Backward...]' and 'Requirements/02 [Backward…]'. The first string contains information about initial referred node. Its generation template is marked as 4 and is named 'Primary template'. The second string contains information about target (referred to) node. Its generation template is marked as 5 and is named 'Secondary template'.
  4. Then generate report in a usual way.


Delete report settings

  1. To delete the report settings select it in 'Requality Explorer', select 'Delete Report Settings' in the context menu.
  2. You also can use 'Delete' hot-key.
  3. In the opened dialog window push 'OK'.


Generate report

  1. There are two ways to generate report:
  2. Report is generated near (on the same hierarchy level) the node of report settings on which the report has been generated.
  3. Attribute 'date' is generated automatically in report attributes table. It contains date and time of report generation.


Open and edit report

  1. Select required report in 'Requality Explorer' and double click on it. The report is opened.
  2. Note! In 'Properties' view you can see parameters of report settings that was used to generate this report. But you can change only report identifier.


Delete report

  1. To delete the report select it in 'Requality Explorer', select 'Delete Report' in context menu.
  2. You also can use 'Delete' hot-key.
  3. In the opened dialog window push 'OK'.


Create reports folder

There is possibility to create folders in 'Reports' node and set reports settings and reports there. It helps to comfortably organize reports in 'Requality' project.

  1. To create a reports folder select 'Reports' node or any it’s sub-folder (if exists), select 'New → Folder' in the context menu.
  2. In the opened window input folder name to the 'Enter folder name' field.
  3. The name shouldn’t replicate name of folders are on the same hierarchy level in the reports node. Otherwise you get a warning and can’t proceed.
  4. After you input a correct name push 'OK'. Now you can see this folder in 'Requality Explorer'.

Now you can create report settings and generate reports in the new folder.


Delete reports folder

  1. To delete a reports folder choose it in 'Requality Explorer'.

    1. Select 'Delete Folder' in the context menu.
    2. You can also use 'Delete' hotkey.
  2. Note! If you delete the folder all nested nodes are deleted. If you agree and want to proceed push 'OK' button in a confirmation dialog.


Comments


Create comment

Comment can be create in requirement, test purpose or text node.

Comment can be created in several ways: in 'Requality Explorer', in 'UniEditor' and in 'Review'. Comments can be made from scratch or created from Comment template from current project.


Create comment by copying

Comment can be created as copy of existing comment.


Edit Comment

To edit Comment, click on it in 'Requality Explorer' and you will see its attributes in 'Properties' view.

Below you can find an attribute that can be edited manualy.

  1. Name

  2. Author

  3. Field for text of comment


Delete Comment

You can delete a Comment in 'Requality Explorer'. To do so you need to select target Comment, right-click on it and select a point 'Delete Comment' in context menu. In 'UniEditor' and 'Review' editors Comment can be deleted in drop-down menu of node or drop-down menu on the top-right corner of editor by selecting 'Delete Comment' point. Also you can use hot key 'Delete'. After one of proposed actions you need to confirm Comment removal in displayed dialog by pressing 'OK' button.


Node sorting in Requality project

Nodes in a projects can be sorted in three ways: 'By Locations', 'By Names' and 'By Index'. Default method is 'By Locations'.

Please note the option 'Sort elements types separately'. If activated it will cause the different types of nodes in requirements tree to be sorted separetly. If this option is disabled then different types of nodes will be sorted without separation by type. Option is enabled by default but it is recommended to disable it if you want to work with selected "By Index" sorting.

Sorting settings of Requality project

To change a sorting settings you need to:

  1. Open a context menu in 'Requality Explorer' on target project and select a point 'Properties'. An settings dialog will be shown.
  2. At the left side of dialog choose 'Requality'. After that at the right side you will see an 'Requality' settings.
  3. To change sorting mechanism('By Locations', 'By Names' or 'By Index') you may open a drop-down list 'Sort method', select one you needed and then press 'Apply'.
  4. You also can change an 'Sort elements types separately' option by clicking on corresponding Combo Box.


Requality sorting settings


After that the changes on sorting will be applied to project.


UniEditor


Open UniEditor

In 'UniEditor' you can open requirements tree (with test purposes and comments). The root node of this tree is a requirement on which you called 'UniEditor'. Thus in UniEditor you can open whole requirements tree (just call 'UniEditor' on root 'Requirements' node) or some sub-tree (call it on some sub-requirement).

You need to do the following to open an editor:


  1. Select target requirement in 'Requality Explorer', in context menu select 'Edit in UniEditor'.


Note! In 'UniEditor' you can use hot keys for you convenience. See 'Keyboard in UniEditor, Review and Module Editor: hot keys'.


Add new requirements in UniEditor

The procedure of adding new requirements is described in 'Create requirement'.

The procedure of adding new requirements by copying is described in 'Create requirement by copying'.


Delete requirement in UniEditor

The procedure of requirement deletion is described in 'Delete requirement'.


Edit requirement in UniEditor

Requirement field consists of two parts. The upper one contains requirement name, the lower one contains requirement alternative description.

  1. To edit requirement name double-click on the upper part of the field. The field becomes editable. To finish editing click somewhere else on the screen.
  2. To edit requirement text double-click on the lower part of the field. The field becomes editable. Here you can see control panel to edit the text. It includes buttons for text formatting, for adding symbols, pictures, links, etc. To save changes push 'Save' button in this menu. Also you can use button to undo editing.
  3. You can also edit requirement in node editor. Move mouse pointer to triangle in top right corner of node and choose menu point 'Open Editor'. Then you can change attributes of requirement in showed editor. To save changes please press 'OK' button.
  4. To change requirement status click on status-icon on the left side of the requirement name. When clicking, the status changes from 'in process' to 'complete' and vice versa.


Add new text node to UniEditor

The procedure of adding new text node is described in 'Add text node' section.

The procedure of adding new text node by copying is described in 'Add text node by copying' section.


Delete text node in UniEditor

The procedure of text node delete is described in 'Delete text node' section.


Edit text node in UniEditor

Text node has two fields. At the left of top field you can see button. It can be used to change node type from 'Text' to 'Header' and vise versa.

  1. Text node contents can be edited by double-clicking on bottom field. You will see a panel with different buttons for text formatting, for adding a symbols, images and so on. To save changes please press button with folder icon. To cances changes you can press button with cross icon.
  2. To change type of text node click on image at the left of text node. Type will be changed from 'Text' to 'Header' and vise versa.
  3. You can also edit text node in node editor. Then you need to hover a triangle at the top right corner of node and select menu point 'Open Editor'. Then you can change attributes of text node in shown editor. To save changes please press 'OK' button.


Add new test purpose in UniEditor

The procedure of adding new test purpose is described in 'Create test purpose' section.

The procedure of adding new test purpose by copying is described in 'Create test purpose by copying' section.


Delete test purpose in UniEditor

The procedure of test purpose removal is described om 'Delete test purpose' section.


Edit test purpose in UniEditor

The field of the test purpose consists of two parts. The upper part contains the name of the test purpose; the lower part contains the text of the test purpose.

  1. To edit test purpose name double-click on the upper part of the test purpose field. The field becomes editable, and you can make changes. To finish editing click anywhere else on the screen.
  2. To edit test purpose text double-click on the lower part of the test purpose field. Here you can see control panel to edit the text. It includes buttons for text formatting, for adding symbols, pictures, links, etc. To save changes push 'Save' button in this menu. Also you can use button to undo editing.
  3. You can also edit test purpose in node editor. Move mouse pointer to triangle in top right corner of node and choose menu point 'Open Editor'. Then you can change attributes of test purpose in shown editor. When you done just press 'OK'.
  4. To change test purpose statuse, click on status-icon on the left side of the requirement name. When clicking, the status changes from 'in process' to 'complete' and vice versa.


Add comment in UniEditor

The procedure of adding new comment is described in 'Add a comment' section.

The procedure of adding new comment by copying is described in 'Add a comment by copying' section.


Delete comment in UniEditor

Instructions on how to delete a comment can be found in 'Delete a comment'.


Edit comment in UniEditor

To edit the text of the comment, double click in the comment field. Here you can see control panel to edit the text. It includes buttons for text formatting, for adding symbols, pictures, links, etc. To save changes push 'Save' button in this menu. Also you can use button to undo editing.


Review

Working in 'Review' is similar to working in 'UniEditor', but more limited in functionality. Here you can't add or delete requirements and test purposes, you can only edit their status.

Open Review

In 'Review' editor you can open requirements tree with test purposes and comments. Requirement for which you open 'Review' is displayed as root node. It means that you can open the requirement tree in a whole (by calling them in the 'Requirements' root node) or separate requirements sub-tree (by opening the editor on the several sub-requiremets).

To open ediotor you need to do the following:


  1. In 'Requality Explorer' choose the target requirement, open context menu and chose 'Review'.


Please note! In 'Review' it may be convinient to work with hot keys. You can read more at 'Keyboard in UniEditor, Review and Module Editor: hot keys'.


Edit statuses of the requirements and test purposes in Review

To change the status of requirement/test purpose click on status-icon on the left side of the node name. When clicking, the status is changed in the following order: 'in process''complete''verified' → back 'in process', etc.


Hotkeys in Review

When working in 'Review' you can use hotkeys. In 'Review' there are hotkeys not only for manipulation with comments but for some other usages too. The list of all hotkeys for 'Review' is similar to the list of hotkeys for 'UniEditor', except for the prohibited usages.


Module Editor

'Module Editor' is silimar to 'UniEditor', but has more restricted functionality. You can work here only with requirements and text nodes.

Open Module Editor

In 'Module Editor' you can open requirements tree including text nodes. It uses node you select before calling 'Module Editor' open as root. You can edit full requirements tree if you open 'Module Editor' on root requirements node 'Requirements'). One also can edit subtree of requirements (by calling editor on root of selected subtree).

To open an editor you need to do the following:


  1. In 'Requality Explorer' please select a target requirement or text node, open a context menu and select a point 'Module Editor'.


Keyboard in UniEditor, Review and Module Editor: hot keys

In 'UniEditor', 'Review' and 'Module Editor' editors you can use hot keys to work only from keyboars.

NOTE! In different editors for different node types you can use particular set of hot keys.

Two formats of hot keys are available:

You also can open common menu with mouse. Hover a button on top right corner of editor and menu will be shown. After that you can use shortened varians of hot key without additional 'Ctrl+D', or just click on menu points by mouse.


Common button for node menu opening in editor view


One can also use keyboard to navigate over node editors and nodes.

All related key boundings are listed in table:


Action Hotkey Alternative Hotkey(first press Ctrl+D and then given key)
Create new requirement as child Ctrl+R R
Create new requirement as sibling Ctrl+S S
Create new text node as child Ctrl+J J
Create new text node as sibling Ctrl+I I
Remove node Del Del
Edit selected node in separate window Ctrl+E E
Change node type from Requirement to Text Node and vise versa Alt+M M
Create new test purpose Ctrl+P P
Create comment to selected node Alt+C C
Open template selection\edition dialog Ctrl+T T
Set focus to node below/under Up/down arrows --
Expand/Retract subtree with root on selected node Right/left arrows --
Edit node id\name F2 --
Edit node description (Description field) Enter --
Change focus to next view (for example, Outline). Note. Focus can be changed to tabs on current view and buttons on control panel of current view, for example, to minimize or to fullscreen. Tab --
Change focus to previous view Shift+Tab --
Enter a view (use it to navigate between different views using Tab and Shift+Tab) F12 --
Open editor to requirement below or under when editor is opened. Ctrl+up/down arrows --
Undo Ctrl+Z --
Redo Ctrl+Shift+Z --
Refresh editor F5 --
Open search dialog Ctrl+F --
Close node editor (exit node edit mode) Esc --
Save changes in editor Ctrl+S --
Move to page below current PageUp --
Move to page after current PageDown --
Change focus to first node Home --
Change focus to last node End --
Add test to node Alt+T --
Start to edit node Enter --
Start to edit id\name F2 --
Change status Alt+S --
Expand node Num+ --
Retract node Num- --
Copy node Ctrl+C --
Cut node Ctrl+X --
Paste node as sibling (without sub-nodes) Ctrl+Shift+V --
Paste node as child (without sub-nodes) Ctrl+V --
Paste node with all its subnodes as sibling Ctrl+Alt+Shift+V --
Paste node with all its subnodes as child Ctrl+Alt+V --


Virtual Nodes


Create virtual node

  1. In 'Requality Explorer' select or create a requirement for which you want to create virtual node. Select 'New → Virtual Node' in a context menu for this node. New virtual node will appear.

Create virtual node by copy paste

You can create Virtual node by copying of existing virtual node.

It is possible to create a copy in 'Requality Explorer' with 'Copy' menu point. To Paste virtual node you can use menu points 'Paste into' (to add copy as child of target node) or 'Paste near' (to add copy as sibling of target node). That will create copy in target place of requirements tree. You can also use hot keys 'Ctrl+c' and 'Ctrl+v' for copying. In this case 'Paste near' approach will be applied.


Delete virtual node

  1. To delete virtual node select it in 'Requality Explorer', select 'Delete Virtual Node' in a context menu for this node.
  2. You can also use 'Delete' hotkey.
  3. In the opened dialog confirm deletion by pushing 'OK'.


Edit virtual node parameters

To edit virtual node parameters select it in the 'Requality Explorer', Now you can see requirement properties in the 'Properties' view.

Here we describe parameters of the virtual node you can change manually.

  1. Id

  2. Name

  3. Attributes

  4. Target

  5. Iteration method

  6. It.vars

Hide virtual node

The virtual node will be hided in the project tree, only its subtree (reused elements) will be shown.

Show virtual node

Virtual node will be shown in the project tree.

Checking the project tree

It's possible to check if Requality project tree is correctly set and to find problems in nodes description. Open context menu on the root node of your Requality project and select 'Enable Checkers'. After that all the nodes in which checker finds error are highlighted.


Checker work result


Version Control

For version control Requality allows working with CVS, Subversive, EGit and other Eclipse Team Provider (excluding Subclipse). In 'Requality Explorer' context menu there is a standard item 'Team' to manipulate versions.

SVN

To use 'SVN' you should have SVN-plugin installed to 'Eclipse' and get URL of repository where your project is shared or will be shared (also you should get user login and password if needed). It's recommended to use Subversive plugin. All instructions below are for exactly this plugin.

Export project to SVN

  1. In 'Requality Explorer' view click on the project folder and select 'Team → Share Projects...' in the context menu.
  2. In 'Share Project Wizard' window in 'General' tab input URL of repository where you want to push your project to.


    Input repository URL


  3. Input user login and password in 'User:' and 'Password:' fields. (If you don't want to be asked for password again select 'Save authentication'.) It is not necessary if repository is not protected with a password.
  4. Push 'Finish'.


    Input comment and select elements to push to repository


  5. In 'Commit' window input your comment in 'Comment' field. Verify that all project items are selected in the table below. Push 'OK'.
  6. Wait until files transfer to repository. After that all project nodes in 'Requality Explorer' should be displayed without an angle bracket in front of the name. The angle bracket means that the node has changes are not saved in 'SVN'. All parent nodes of such node are also marked with the angle bracket. If some node is still marked with the angle bracket (after transfer to 'SVN' is finished) try to refresh 'Requality Explorer': click on the project node, then push 'F5' or select 'File → Refresh' in 'Eclipse' main menu. If the angle bracket doesn't disappeare changes are not transferred to 'SVN'.


    Unsaved changes


Commit changes to SVN

Following instructions describe how to transfer local project changes to repository (if this project already exists in 'SVN').

How to know that your local project is connected to 'SVN' (you are working with local copy of repository project): there are version number and repository URL near project name in 'Requality Explorer'. This number is a number of version that was last syncronized with the repository.


Version and repository URL

  1. In 'Requality Explorer' select changed node that you want to push to repository. If you want to push all project changes then select root node of the project.
  2. Opent context menu on it and select 'Team → Commit'.
  3. In 'Commit' window in 'Comment' field input your comment. Check that all needed items are selected in поле выбора файлов. Push 'OK'.


    Input comment


  4. If 'User Credentials' dialog asks you about username and password, input it in 'User:' and 'Password:' fields. If you don't want to be asked for password again select 'Save authentication'.


    Input username and password


Import project from SVN

  1. In 'Requality Explorer' on empty place open context menu and select 'Import...'.
  2. In 'Import' window select 'SVN → Project from SVN' and push 'Next >'.
  3. In 'Checkout from SVN' window look through the list of available repository URLs.
    1. If one of available repositories suits you select 'Use existing repository location:', then select this repository in the table and click 'Next >'.


      Select existing repository in the table


    2. If you didn't find your repository in the list select 'Create a new repository location' and click 'Next >'.


      Select new repository


  4. In 'General' tab input URL of repository where you want to push you project. Also input username and password in 'User:' and 'Password:' fields. (If you don't want to be asked for password again select 'Save authentication'.) It is not necessary if repository is not protected with a password.


    Input repository URL


  5. In 'URL:' field input path to the project in the repository (including project folder). Click 'Finish'.


    Input path to project


  6. In 'Check Out As' window doesn't change anything and click 'Finish'.


    Select latest project revision


Update project from SVN

If project in the repository has been changed you can update your local copy following the instructions below.

  1. First of all it's recommended to close all opened documents. Or you should reopen them after update is finished to see all changes.
  2. In 'Requality Explorer' on you project open context menu and select'Team → Update'.
  3. If 'User Credentials' dialog asks you about username and password, input it in 'User:' and 'Password:' fields. If you don't want to be asked for password again select 'Save authentication'.


    Inpul username and password


Import-export of Requality requirements catalogue into ReqIF format

'Requality' provides importing requirements catalogues from ReqIF format and exporting requirements catalogues created in 'Requality' project into ReqIF format.


Export Requality requirements catalogue into ReqIF

To export the requirements catalogue from 'Requality' project to ReqIF format it is required to:

  1. In 'Requality' project’s context menu select 'Export...'. In the opened dialog window select 'Requality' → 'Export to ReqIF' and press 'Next'.


    Export to ReqIF-format selection


  2. In the opened window, select a path to target folder of the project where the intended ReqIF document should be created, enter the name of intended document and press 'Finish'.


    Select file to export to ReqIF-формат


After those actions, the system will export requirements catalogue into ReqIF format: requirements catalogue from 'Requality' project will be transformed into requirements catalogue in ReqIF format and placed in the specified project as a file with "reqif" extension. This ReqIF file may be used by any requirements management tool supporting ReqIF format.


Import requirements catalogue from ReqIF

To import requirements catalogue from ReqIF format into 'Requality' project it is required to:

  1. In 'Requality' perspective in 'Requality Explorer' window open context menu and select 'Import...'.
  2. In the opened dialog window select 'Requality' → 'Import from ReqIF' and press 'Next'.


    Import from ReqIF-format selection


  3. In new opened window from the file system select required '.reqif' file and press 'Next'.


    Select file to import from ReqIF-format


  4. In next two dialog windows, specify the appropriate elements of ReqIF format for 'Requality' format elements. First, the window for ReqIF and 'Requality' types mapping. For entering the conformity between types, it is required to select the type of ReqIF element in left column and the corresponding type in the middle column and press 'Add mapping'. The created mapping will be represented in the right column; it will be displayed as 'type_ReqIF → type_Requiality'. Also it is possible to map few types of ReqIF elements to one type of 'Requality'element. To do this, in left column instead of selecting one type select few types, the rest of actions are the same.


    Set mapping between types of ReqIF and Requality formats


  5. To delete incorrect mapping it is required to select it in the right column and press 'Remove mapping' button, selected mapping will be removed.


    Remove mapping between types of ReqIF and Requality formats


  6. Then push 'Next' button. The window for mapping ReqIF attributes to 'Requality' attributes will open. To specify the mapping select the name of the ReqIF attribute in the left column and the name of corresponding 'Requality' attribute in the middle column. Then push 'Add mapping' button. The created mapping will be represented in the right column; it will be displayed as 'атрибут_ReqIF → атрибут_Requality'. Also it is possible to map few attributes of ReqIF elements to one attribute of 'Requality' element. To do this, in left column instead of selecting one attribute select few attributes, the rest of actions are the same.


    Set mapping between attributes of ReqIF and Requality formats


  7. To delete incorrect mapping it is required to select it in the right column and press 'Remove mapping' button, selected mapping will be removed.


    Remove mapping between attributes of ReqIF and Requality formats


  8. Then press button 'Finish'.

After those actions, the system will import the selected ReqIF document into 'Requality' project format: new 'Requality' project will be created, with requirements catalogue created in accordance to requirements catalogue in the initial '.reqif' document, specified types and attributes mappings.