2.1.Option – Project’s preview
It displays the elements of the project and provides options for managing them. In order to use this option, choose the Project’s preview option from the Requirements Management text menu or use the Alt+P shortcut.
Project’s preview option will allow you to preview selected elements of the project included in the repository of the project of Enterprise Architect application. Moreover, you will be able to manage the requirements, use cases and project’s authors. Please notice that the main emphasis is put on the management of the project’s requirements.
Project’s preview will allow you to:
a) preview the structure of the project
b) manage the requirements, use cases and actors defined in the project, in particular:
- display their properties
- edit the properties
- add
- delete
track the history of changes of requirements
2.1.2. Project structure browsing
Using the Project’s Preview option you can browse the structure of the Enterprise Architect project.
The project’s tree is displayed in the left part of the Project’s Preview window. Packages of the Enterprise Architect program are presented in the form of the tree of folders. Only the elements of “requirement”, “use case” and “actor” types are presented in the package structure.
Figure 12. Project’s Preview window. Visible project’s structure together with the properties of the selected requirement.
2.1.3. Displaying the properties of the element
All properties of the element indicated in the project’s tree are displayed in the right part of Project’s Preview window. These are successively:
· short description,
· alias,
· status,
· difficulty,
· priority,
· author,
· key words,
· stereotype,
· phase,
· version,
· date of creation,
· date of last change.
Those properties are presented in the “read-only” form.
2.1.4. Editing the properties of an element
In order to edit the properties of the element indicated in the project’s tree:
· click the Edit button which is located at the bottom of the Project’s preview window (see Figure 13) or
· click twice on the particular element or
· select Edit option in the context menu which is available from the indicated requirement of the project’s tree.
Figure 13. Editing the requirement’s properties.
Now you can:
· change any value of the property of indicated element,
· delete the element.
If you changed any property of the particular element and you want to save this fact in the project, click Save button. If you selected the “Save changes in the elements” option in the application’s configuration, then you will be asked for the reason of the introduced changes. You should enter the appropriate comment informing about the changes you have made in the properties of the element in the Change Description window (see Figure 14). Finish the whole operation by clicking Save button.
Tormigo allows you to save the already entered comment in order to re-use it, e.g. when editing other element. In order to do that, select the Save Description option after entering the comment in the Change Description window and before saving the data in the repository using Save button. You may also enter the title of the comment in the drop-down list located under the field with the author’s name, which later may be used in order to identify the comment. In order to select the saved comment later, select the comment with the appropriate title from the drop-down list. If you do not want the comment to be further stored in the project’s repository, click Delete button after choosing the comment from the drop-down list.
Figure 14. The reason for the changes introduced in the element.
After a successful update of the project, you will see the message confirming that changes of the indicated element have been saved.
Figure 15. Information about updating the requirement.
Please notice that each saved change will result in the change (enlargement) of the requirement’s version.
In order to add new element in the Tormigo application, indicate the element of the tree in the project’s tree to which you want to add this element. Then select the appropriate option: Add requirement, Add Use Case or Add the Actor (see Figure 16) for the indicated element in the context menu. Next fill in the fields of the element’s properties, it is necessary to fill in the short description field which will be used as the element’s name displayed in the project’s tree. In order to save the changes in the project, click Add button.
Figure 16. Adding new requirement.
Project updating will be confirmed by the following the message.
Figure 17. Message informing about adding the requirement to the project.
In order to delete an element from the Enterprise Architect project you have to enter the editing mode (see section 2.1.4) and click ) button at the bottom of the Project’s preview window. Then you will be asked to confirm that you want to delete the selected object. If you click Yes the element will be deleted from the project, otherwise (No button) the element will remain in the project.
Important! In case of deleting the element, all elements depending on it will be also removed.
Figure 18. Deleting an element from the project.
Project updating will be confirmed by the following message.
Figure 19. Message informing about deleting an element from the project.
2.1.7. Tracing the history of the element changes
In order to see the history of corrections and changes to the elements, indicate the element in the project’s tree and select Show History option. Upon enabling the Show History option the table with the history of changes of the selected element will be displayed at the bottom part of the Project’s preview window. The table with the history of changes includes:
· version,
· date of change,
· author making the change,
· description of change.
Figure 20. History of an element changes.
After clicking on the selected line, the values of the properties of an element for the selected version are displayed in the form.
2.1.8. Transferring elements within the project
Apart from editing the elements’ properties, Tormigo allows you also to transfer elements and their packages within the project. This option is available by using the “Drag and drop” technique. In order to transfer the selected element, place the mouse cursor on it, click the left mouse button and then keeping the button clicked move the cursor with the mouse to the designated place and release the mouse button. If the application does not allow for the transfer of the given element to the selected place, the Tormigo will inform you about it by displaying the appropriate mouse cursor icon.
2.2. Option – Requirements mapping
It displays the elements of the project and provides the option for mapping the requirements into the use cases. In order to use this Tormigo option, select Requirements mapping option from the Requirements management text menu or use Alt + M shortcut.
The Requirements mapping option will allow you to browse the project requirements and the use cases included in the repository of the application of Enterprise Architect project. Moreover, you will be able to manage the requirements mapping into the use cases – to define the new requirements mapping into the use cases or to delete mapping.
2.2.2. Defining new requirement’s mapping into the use case
Figure 21. Requirements mapping – indicating the elements for mapping.
In order to define mapping of the requirement into the use case, use the Requirement mapping option from the Requirements management text menu and then:
· in the left part of the window indicate the requirement to be mapped,
· in the right part of the window indicate the use case into which the indicated requirement is to be mapped,
· click “>” button to define the mapping between the selected elements.
Figure 22. Requirements’ mapping – the requirement mapped into the use case.
You may also use the “Drag and drop” option described in the section 2.1.8. In order to map the selected requirement, drag it on top of the appropriate use case.
In order to limit the number of use cases you may use the filter by entering the fragment or the full name of the use case in Search the element field.
Figure 23. Filtering use cases.
2.2.3. What happened in Enterprise Architect project?
If you use the requirements mapping into the use cases in Tormigo application, you should remember that your activities will influence the repository of the Enterprise Architect project.
Figure 24. Objects before mapping.
If, for example, you map the ”Reports should be in grayscale” non-functional requirement into the “Generate report” use case in the repository of the Enterprise Architect project, the relation of Realize type will be created between the mapped elements.
Figure 25. Objects after mapping.
2.2.4. Deleting the existing mapping between the requirements and use case
In order to delete mapping of the requirement into the use case, use the Requirements mapping option from Requirements management text menu and then:
· indicate the requirement that is “connected” to the use case (it means that the particular use case realizes particular requirement) in the right part of the window
· click “<” button to delete realization relation between the connected elements.
In such a case, as in the case of defining the new requirement, you may use the “Drag and drop” option. All you have to do is to drag the selected requirements from the right part of the window to the left side.
2.3.Option – Enable the support for OpenOffice.org
This option allows you to enable/ disable the function of adding the requirement on the basis of selected text from OpenOffice.org.
Figure 26. Enabling the support for the OpenOffice.org.
2.4.Option – Configuration of support for OpenOffice.org
Configuration of support for OpenOffice.org allows you to configure the support for OpenOffice.org.
It allows you to configure the Tormigo parameters for cooperation with OpenOffice.org. in the context of acquiring the requirements from the OpenOffice.org. document to the repository of the Enterprise Architect project.
2.4.2. Configuration of support for OpenOffice.org
Figure 27. Form of configuration of support for OpenOffice.org.
You can configure the support for OpenOffice.org using the following options:
· detect a short description of the element from the selected text in OpenOffice.org – the selected text will be transferred as a note for the new requirement in the repository of the EA project, and if this option is selected, the Tormigo will try to detect short description for the element from the selected text,
· add information before the selected text – the text entered into the Text to be added before the selected text field will be added to the OpenOffice.org document,
· add the information after the selected text – the text entered into the Text to be added after the selected text field will be added to the OpenOffice.org document,
· add information to the history of the object – this option displays the window allowing to add comment to the history of the object, after adding it from OpenOffice.org,
· save changes in the document automatically – it will automatically save the last change introduced in the OpenOffice.org document,
· the text to be entered before the selected text – enter here the text which is to be added before the selected requirement in the OpenOffice.org document. The text will be put in brackets ‘[' i ']‘. You may use the defined variables in the text, such as:
- $GUID$ – unique object’s identifier with which the element was added to the database
- $DATE$ – the date with which the object in the YYYY-MM-DD form was added,
- $TIME$ – the time with which the object in the HH:MM:SS form was added,
· the text to be entered after the selected text – similarly as in the case of the previous option, but here the text will be added after the selected text.
2.4.3. How to add the requirement from the text selected in OpenOffice.org
In order to add the requirement from the selected text to the repository of Enterprise Architect project in OpenOffice.org, you should:
· enable the support for OpenOffice.org – this option is disabled by default (in order to be sure, check the Enable/Disable the support for OpenOffice.org option available from the Requirements management text menu)
· localize and select the text in the block that is to become the requirement,
Figure 28. The selected text which is to become the requirement in the EA project.
· and then:
o localize and click the Tormigo icon – Support for OpenOffice.org in the Windows system tray, or
Figure 29. Localization of the Tormigo icon for support for OpenOffice.org – system tray.
- select Requirements Management à Add requirement from the OpenOffice.org from the Tormigo text menu, or
- use Ctrl+Shift+O shortcut in the window of Tormigo application,
· indicate the package of EA project to which the requirement downloaded from the OpenOffice.org document is to be added in the automatically opened Project preview window of Tormigo application,
Figure 30. Edition of the requirement in Tormigo application which has been downloaded from the OpenOffice.org document.
· you may also edit the other properties of the requirement (see Figure 30)
· in order to save changes in the EA project, click Add button, the appropriate message informing you about the result will be displayed, and the Project’s Preview window will switch to the Preview of requirements of the project’s repository mode (see figure 31),
Figure 31. Preview of new requirement downloaded from the OpenOffice.org document.
· if you selected “Add information to the history of the object” option in the configuration of support for OpenOffice.org, Tormigo will display the dialogue box allowing you to enter the comment to this operation, as in the case of edition of elements,
Figure 32. Possibility to introduce the description for the operation.
· the text in square brackets informing about the definition of the requirement which was copied to the repository of EA project and has been added before and after the selected text in the OpenOffice.org document.
Figure 33. The text of the tray which will be added before and after the selected text of the requirement.
