The first window you will see is the login window. Enter your user name in the username text box, and then type your password in the password text box. Pressing "OK" will cause the application to attempt to verify your credentials. After three unsuccessful attempts, the application will terminate. You may press "Cancel" at any time to terminate the application yourself.
Main User Interface
Once you have successfully logged in, you will be presented with the main user interface for the Requirement Tracker application. Until you open a project you will be unable to perform any useful tasks. To open your first project, click on the File -> Open menu item. You will be presented with a list of projects that you or any of the groups you belong to have permissions to read or edit.
Once a project has been opened, you can begin to create or manipulate requirements based on your user or group level permissions for the project. Figure 1 shows an open project called "Requirement Tracker Project". Several root business requirements are shown belonging to this project; the first is "Common repository for system requirements". In the view shown, this is the only requirement which has more detailed requirements branching out underneath it. This tree represents breaking the business level requirement into its functional and technical requirements.
Note: Several projects may be opened simultaneously, but a bug exists that prevents correct updating of the visual elements of the interface when two projects are open which contain the same requirement. Open additional projects using the same method as the first project.
Figure 1: Information panel
One of the requirements is selected, which is shown by the blue highlighting. The detailed information for this requirement in the tabbed section which takes up the bottom half of the interface. In Figure 1, the Information tab is selected, which shows detailed information about the requirement, its history, and relationships it may have with other requirements.
Figure 2: Create/Edit panel
Figure 2 shows the Create/Edit tab, which allows users to add or change requirements. Only fields which are not controlled by the system are found on this panel, therefore you will not see a way to edit the author, created date, or unique id for the requirements. Clicking on the "Edit" button will allow you to change the information found on this tab.
Clicking on the "New Sibling" button will allow you to add a new requirement at the same level in the tree as the requirement you currently have selected. Similarly, the "New Child" button will allow you to add a new requirement that is a sub-requirement of the requirement that is selected. These options will be covered in a later section.
Figure 3: Relationship panel
Figure 3 shows the Relationships panel. This panel contains detailed information about relationships between requirements in your projects. Additionally, this part of the interface allows you to add or remove relationships in a relatively straightforward manner.
Requirements which are related to the requirement you have selected will be identified by red, blue or purple lettering. Requirements which are affected by the current requirement are shown in red, those that are affecting the requirement you have selected will be shown in blue, and requirements that both affect and are affected by the current requirement show up in purple. At any time you may clear these highlights by pressing the .Clear Highlights. button. Note that this will also clear any searching highlights, which are covered in a later section.
To add a new requirement, select the Create/Edit tab, and click "New Sibling" or "New Child"; this will clear the fields and provide a blank slate for you to work with. Type in the values you wish to use, or select a value from the drop down box where applicable. While you are still editing, the "Edit" and new buttons will be disabled until you have submitted or cancelled your current requirement. When you have finished inputting the information, click "Submit" and the requirement will be added to the repository. If you are editing the requirement and decide you no longer need it, simply press the "Cancel" button.
Shortcuts are available to make adding requirements quick and easy. Simply press ctrl-n to create a new sibling requirement, and ctrl-m to create a new child requirement.
Adding and Removing Relationships
To add relationships to a requirement, select the Relationships tab, and then select the requirement in the tree view and then click the .Edit List. button. While editing the list, simply double click on another requirement to add a relationship to it. If you would like to remove a relationship, simply highlight it (or several of them) in the table shown, and click .Drop Requirement.. When you are done adding relationships, click the .Done Adding. button and the interface will be returned to the previous mode.
Requirements are searchable in the Title and Description fields. To search, select Keyword from the drop down box shown in Figure 6, then type the string you would like to search for in the empty box to the right of keyword. Finally, click the .Find. button. Requirements which include the string you have entered as a substring in either the Title or Description fields will be highlighted in grey, as shown in Figure 6. Highlights may be cleared at any time by pressing the .Clear Highlights. button.
Figure 4: Search Highlighting
If you are logged in as a user with administrative priveliges, you can enter the Administration Tasks section of the application. This allows you to create new users, groups and projects as well as perform other administrative functions such as changing a user's password, adding users to groups and change user or group level permissions for a project.
Figure 5 shows the Users tab of the Administration Tasks window. The list of users on the left contains every user in the database. The tree on the right, titled Groups, contains every group in the database, and shows what users are in each group. Double-clicking on a group name will display the users which belong to that group, if any.
Figure 5: User Panel
To add a user to a group, select the user on the left and the group on the right, then press the "Add" button. If a user needs to be removed from a group, simply select the user name listed under the group, and click the "Remove" button.
Creating new users is as easy as pressing the "New" button on the lower left side of the window. The fields will be cleared and allow you to type in a new username and password; once the username and password have been entered, confirm the password in the provided field and press the "Confirm" button. The user will appear in the list of available users in the database.
To create a new group, click the "New" button on the lower right side of the screen. The fields will be cleared, allowing you to type in a group name and description. To confirm the group, press the "Confirm" button; the group will then be added to the list of available groups.
Figure 6 shows the Projects tab of the Administration Tasks window. The projects are listed on the left side, groups and users are listed on the right side. Selecting a Project on the left and a user or group on the right will allow you to add specific permissions to a project for that user or group by pressing the corresponding "Add" button. Similarly, the "Remove" button will remove a project from a user or group, depending on which button is pressed.
Figure 6: Projects Panel
You may create new projects in the same manner that users and groups were created.
The lower left portion of the tab shows project permissions for the selected project (which is highlighted in either the Groups or Users tree view); the group or user the permission belongs to is shown in the Project Permissions section. To change permissions, simply check (or uncheck) the desired permission, and press the .Confirm. button. If the change does not update immediately in the tree view, double click the user or group and you should see that permissions change (listed at the end of the project name).
When you are done making changes to users, groups and projects, simply close the window.