Chapter 5. Functional Overview

Table of Contents

5.1. Login
5.2. Main Functions
5.2.1. The Help Menu
5.2.2. The Log Panel
5.2.3. The User Menu
5.2.4. Search / Quick-Select
5.2.5. Quick Table Filtering
5.2.6. Filtering and Sorting
5.2.7. Print Pages
5.2.8. Categorization
5.2.9. Conflict Handling
5.2.10. Deleting Objects
5.2.11. Bulk Actions
5.2.12. Attachments
5.2.13. User Defined Properties
5.2.14. Referencing Artifact Properties
5.2.15. Referencing Attachments
5.2.16. Revisions
5.2.17. Related Test Runs and Results
5.2.18. Change History
5.2.19. Overview Tabs

This chapter gives a coarse overview of the usage of the application.

[Warning] Warning

The browser back button is not supported by Klaros-Test­management. The behavior of the web application is unpredictable when it is used.

5.1. Login

Figure 5.1 shows the login screen of Klaros-Test­management. To login just enter the user name in the User name field and the associated password into the Password field.

Login Screen

Figure 5.1. Login Screen

The Klaros-Test­management database predefines three default users accounts with following roles:

  • Administrator

    Username: admin / Password: admin

  • Manager

    Username: manager / Password: manager

  • Tester

    Username: tester / Password: tester

For a description of the users roles and the permissions associated with each role, see Appendix A, Role Permission Overview.

Confirm the login to Klaros-Test­management by clicking the Login button.

Klaros-Test­management Enterprise Edition supports the login using LDAP. See Section 10.5.5, “LDAP” on how to configure Klaros-Test­management to use an external directory service for authentication.

[Note] Automated creation of Klaros-Test­management users

If a user that isn't registered in the Klaros-Test­management database logs into Klaros-Test­management using LDAP authentication, then a user account of the role 'tester' is automatically created for this user. The fullname and e-mail attributes are transferred from LDAP into the newly created user account then.

[Note] Klaros-Test­management is multilingual

By default Klaros-Test­management chooses the language that is determined by the locale settings of the server Klaros-Test­management is installed on. If you want to choose a different language you may select the corresponding flag at the bottom right corner of the login screen. The language of the user interface changes immediately and the choice will be stored automatically.

After a successful login the Maintain Project page is shown ( Figure 5.2).

Maintain Projects Page

Figure 5.2. Maintain Projects Page

Klaros-Test­management uses a horizontal menu on the top of the screen. These categories resemble activities in the testing project. The function categories presented in this menu are:


In the Define section of Klaros-Test­management all artifacts that are needed in a project can be defined and viewed. These artifacts are the project itself, the test environments, the systems under test, the test cases and the test suites. For the Klaros-Test­management Enterprise Edition and this list also includes project iterations and requirements.


The Plan section of Klaros-Test­management is used to define and maintain jobs, e.g. the execution of tests which can be assigned to individual users and tracked accordingly. This section is only available in Klaros-Test­management Enterprise Edition and .


The Execute section of Klaros-Test­management allows execution of jobs, manual test cases and manual test suites. Before a test is executed, the tester must select a combination of system under test and test environment for which he executes the test. He is then guided step by step through the manual test. Comments can be added at each step.

If the tester is interrupted during the execution of a long test suite, he can stop execution at any time and continue the test suite execution later.


The Evaluate section provides all functionality for analyzing the project. It provides coarse overview reports in the dashboard, as well as fine-grained information, so that each execution of a test can be traced and visualized.


The Configure section contains access to administrative tasks, e.g. the system settings, user management or the import and export of projects.

The following chapters will describe each category in detail.

5.2. Main Functions

This section describes the use of some common features of Klaros-Test­management.

5.2.1. The Help Menu

The Help Menu

Figure 5.3. The Help Menu

The help menu provides quick links to various Klaros-Test­management resources. Pressing the help menu icon opens a menu appears displaying the following links:

The Help Menu


Opens up the section of the Klaros-Test­management documentation corresponding to the currently displayed page.


Opens up the Klaros-Test­management tutorial.

Message Boards

Opens up the Klaros-Test­management message boards.

Contact Support

Prepares an e-mail to be sent to the Klaros-Test­management support team. This option should be used when experiencing an issue using Klaros-Test­management which can't be solved using the documentation or the message boards.

5.2.2. The Log Panel

The Log Panel

Figure 5.4. The Log Panel

The log panel shows status messages (like warnings or information) to the user. Initially, only the latest status message is displayed. By clicking on the + icon on the right side of the log panel, all status messages since the last login are displayed. Clicking the x icon closes the log panel. It can be opened again at any time by clicking on the log panel icon in the navigation bar.

The Log Panel Icon

Figure 5.5. The Log Panel Icon

5.2.3. The User Menu

The Help Menu Button

Figure 5.6. The Help Menu Button

The user menu button on the upper right of Klaros-Test­management displays the full name of the user that is currently logged in.

The Help Menu

Figure 5.7. The Help Menu

Pressing the user menu button opens up the user menu, where the user can change the language and log out of Klaros-Test­management.

5.2.4. Search / Quick-Select

Depending on the Klaros-Test­management edition, the upper right corner (see Figure 5.8) either contains a search field for fast navigation to elements with a given ID or for a fully featured full-text search in the current selected project. These are described in the following sections.

The Search Field

Figure 5.8. The Search Field Full Text Search

The Search field allows the user to search for object ids or words or phrases contained in fields of objects. This search function uses Apache Lucene, which provides a powerful syntax for searching individual fields or with wildcards. This syntax is described on the Apache Lucene website.

The Search Results Page

Figure 5.9. The Search Results Page

Figure 5.9 shows the Search Results page. This page displays each object containing the search term, and highlights the occurrences.

Figure 5.10 shows the message which appears in the log panel upon completion of a search.

The Status Bar Search Report

Figure 5.10. The Status Bar Search Report Quick-Select

Since the full text search is only available in the Klaros-Test­management Enterprise Edition, a quick navigation field for known element ids (like e.g. TC00001) is present in Klaros-Test­management Community Edition instead. It currently supports the following element types:

  • Project
  • Test Environment
  • System under Test
  • Test Case
  • Test Suite
  • Test Case Result
  • Test Suite Result
  • Test Run
  • Issue Management System

Please note, that ids will usually be searched for in the current project only.

[Note] Abbrevation Support

It is possible to use case independent abbreviated forms of IDs, eg. TC00001, TC1 or tc1 will all resolve to the same element.

5.2.5. Quick Table Filtering

It is possible to apply the full text search functionality as shown in Section, “Full Text Search” to many list pages as well.

By entering a search term into the the input field above the table all the text fields of the displayed entries are searched for the given search term and the list is filtered accordingly.

5.2.6. Filtering and Sorting

It is possible to filter and sort the displayed objects on most pages in Klaros-Test­management. The Filter / Sort link above the table opens the panel, which contains two tables. The left-hand table contains the active filters, and the right-hand table contains the active sort orders.

The Filter and Sort Panel

Figure 5.11. The Filter and Sort Panel

Below the two tables are two buttons:


The Apply button applies the filters and orders to the table below.


The Reset button clears the filters and orders from the table so that the table shows all objects again. Specifying Filtering Criteria

Each row in the filter table represents a filter which is applied to the table.

Clicking the icon adds a new, empty filter to the filter table. Each row has four columns:

  • The Field column denotes the field in the table that the criterion filters for. The fields which can be filtered in the Filter / Sort panel vary from page to page, but generally include the main attributes of the objects which are displayed, including user defined properties if available.

  • The Type column denotes the operator that is used for the criterion. The following operators are available in Klaros-Test­management:


    Only the items that exactly match the value of the criterion are shown.

    Not equals

    The items that do not equal the value of the criterion are shown in the result table.

    Greater than or equals

    Items that are greater than or equal the value of the criterion are shown.

    Less than or equals

    Items that are less than or equal the value of the criterion are shown.

    Greater than

    Items that are greater than the value of the criterion are shown.

    Less than

    Items that are less than the value of the criterion are shown.


    Items that have a part that matches value of the criterion are shown.

  • The Value column defines the value for the filtering criterion. This can be a text input field, a boolean selection or a date/time selector. Some fields have instead one or more predefined values available to choose from (e.g. test environments or test case states). In this case one or more of these values can be selected by holding down the Control button (see Figure 5.12).

  • The Action column contains a button ( ) for deleting the criterion on the current line.

Filter Fields that offer Multiple Values

Figure 5.12. Filter Fields that offer Multiple Values Specifying Sorting Criteria

The objects displayed in Klaros-Test­management can be sorted. The criteria for the sorting are specified in the right-hand table in the Filter / Sort panel. It is possible to specify more than one sorting option.

If there is more than one sorting option, the uppermost row in the sorting criterion table has the highest priority and the lowest row has the lowest priority.

When the icon is clicked, a new empty row for a sorting criterion is appended at the bottom of the table. Each row in the sorting options table has a delete button ( ) in the Action column. Pressing this button removes the sorting criterion.

The sorting options table contains three columns:

  • The Order By column denotes the field in the results table that the sorting applies to. The fields that can be sorted vary from page to page, but generally include most attributes of the objects being displayed.

  • The Type column defines the direction of the sorting sequence, i.e. descending or ascending.

  • The Action column contains a button for deleting the sorting criterion.

5.2.7. Print Pages

Most objects in Klaros-Test­management may be viewed on a printer-friendly page. This print page is viewed by clicking on the print icon . This icon appears in the Action column of the table, above tables with bulk options and as a large icon at the top right of Details pages.

The print page displays all of the fields of the object on a single page. The print pages for objects which contain other objects (e.g. test suites contain test cases) also contain print options at the top. These allow the user to limit the information which is printed, e.g. the Details option on the test suite print page limits the displayed test case information to the ID and Name of the test cases contained in the test suite. By selecting the Suppress empty fields checkbox, all fields which do not contain contents are suppressed from the print view. Figure 5.13 shows the print page for a test suite.

[Note] Note

The selected print options will preserved during a user session.

The Test Suite Print Page

Figure 5.13. The Test Suite Print Page

5.2.8. Categorization

In order to manage a large number of artifacts, it is possible to categorize them using arbitrary criteria. This feature can be used with Iterations, Requirements, Systems under Test, Test Environments, Test Cases and Test Suites. The categorization panel is opened by clicking the Categories link above the table in question.

In the categorization panel, users may create Category Groups and Categories. Objects may be assigned to one category in each group. There is no limit on the amount of categories or category groups which can be created.

In order to apply categorization, the Categories panel must be open. The Categories panel contains 3 different views, the Edit view, the Tree view and the Menu view. If no categories have been defined, only the edit view can be used. Each view allows selection of the active category group through the use of a dropdown menu, or selection of the blank category group to disable categorization. The Edit View

The Categorization Edit View

Figure 5.14. The Categorization Edit View

This view allows the creation and naming of category groups and categories, as well as the organization of category hierarchies. Pressing the add button at the top of this view creates a new category group, and enables the use of the category group dropdown menu. If a category group is selected, it can be renamed in this view.

Categories may also be added and edited in this view. Pressing the add button on a category adds a new sub-category. By default, a new category tree contains one category, and all future categories are added as sub-categories of this Root Category. Categories may be renamed by changing the value in the name field and also given a description through use of the edit button.

Changing the hierarchy of categories and ordering them is also possible in the editview through use of the arrow buttons. The Tree View

The Categorization Tree View

Figure 5.15. The Categorization Tree View

This view shows an overview of the category structure. The available categories are represented as a collapsible tree, with the name of each category is shown, along with the number of objects it contains. The description of each category is shown as a tooltip when its name is hovered over with the mouse pointer. The Menu View

The Categorization Menu View

Figure 5.16. The Categorization Menu View

This view allows more compact use of the category panel. It contains a drop-down menu which enables the user to choose any of the available categories, through a submenu system. Moving Objects Between Categories

It is also possible to move objects between categories. For this the category panel must be open and either the Tree view or the Menu view should be active.

Then select the objects whose category you want to change by first activating the category to which the objects are assigned and select the checkboxes to the left of the desired objects. Afterwards, click on the folder icon above the table. A pop up window will appear. Choose the appropriate category to which you want to assign the objects and click on the Assign button. Now the objects are moved to the other category.

Please note, you can not assign objects from multiple categories to a single category at once. In case that the desired objects are assigned to different categories you must repeat the step for each category.

5.2.9. Conflict Handling

Klaros-Test­management allows for conflict resolution in a multi-user environment.

When saving an object, Klaros-Test­management attempts to automatically resolve any possible conflicts with concurrent changes made by other users. Non-conflicting changes (i.e. any changes made by other users which do not affect fields which the current user has changed will be merged with no additional user input.

If there are any conflicting changes, i.e. changes to fields which were also changed in the mean time by another user, the Conflict Resolution Dialog will be displayed to allow the user to choose how the conflicts should be resolved.

Figure 5.17 shows the Conflict Resolution Dialog for a conflicting test case change.

The Conflict Resolution Dialog

Figure 5.17. The Conflict Resolution Dialog

For each conflict, the user has the choice of saving the artifact with the value they previously chose or the current value in the database. In the case of lists, e.g. the list of test steps in a test case, the user has the option to Merge the changes or to use the version which is currently in the database. This is to prevent the inadvertent loss of data through the deletion of objects which were added by other users.

The Merge option builds a list containing all of the elements of both lists (user and database) in an approximation of the correct order.

Clicking the Save button persists the chosen changes to the database, and clicking the Discard button discards the user's changes.

5.2.10. Deleting Objects

Many objects in Klaros-Test­management can be deleted by pressing the icon. If the object to be deleted is linked to other objects (e.g. a requirement which is linked to a test case or contained in other objects (e.g. a test case which is included in a test suite), a popup will be displayed before deleting the object (see Figure 5.18).

The Delete Objects Popup

Figure 5.18. The Delete Objects Popup

5.2.11. Bulk Actions

Pages in Klaros-Test­management which allow editing of a list of objects often also allow bulk actions on these objects. These allow the user to select multiple entries in the list and, e.g., display the print page for them or delete, duplicate or revision them. Assigning objects to a category is also carried out through a bulk action.

In order to use a bulk action, the user must first select one or more objects in the list using the check-boxes to the left of the table. The buttons above and to the left of the table then become active. Figure 5.19 shows the bulk action buttons on the test case list page.

The Bulk Actions on the Test Case List Page

Figure 5.19. The Bulk Actions on the Test Case List Page

Before any bulk action is carried out all changes must be saved. A save changes dialog appears if a bulk action button is pressed while there are unsaved changes.

A bulk action confirmation dialog is displayed once a bulk action button has been clicked and any changes have been saved. These dialogs describe the action which will be carried out and sometimes contain input fields, e.g. to enter the revision comment for the bulk new revision action. All changes are written to the database as soon as this dialog is confirmed. Bulk Edit

It is possible to bulk edit objects in Klaros-Test­management. Pressing the bulk action icon opens up a popup where fields of multiple objects can be edited at once (See Figure 5.20).

Bulk Editing Objects

Figure 5.20. Bulk Editing Objects

5.2.12. Attachments

Attachments may be uploaded and linked to certain objects within Klaros-Test­management. This can be done within the Attachments tab on the relevant details page or during execution of a test case. Clicking the Upload Attachment button opens the upload attachment dialog. Clicking the Browse... button opens the Open File dialog, which allows the user to select a file to upload. Clicking the Upload button uploads the selected file to Klaros-Test­management.

The Assign Attachments Screen

Figure 5.21. The Assign Attachments Screen

After the attachment is saved, it is possible to download the file by clicking on the icon.

Clicking on the icon causes the attachment to be removed from the Klaros-Test­management database. The Save button must be pressed to persist this change.

5.2.13. User Defined Properties

In Klaros-Test­management, Iterations, Requirements, Test Environments, Systems under Test, Test Cases, Test Suites and Test Runs can all be extended by extra fields using user defined properties. These are defined on a per project basis in the User Defined tab of the Project Details page. This tab is shown in Figure 5.22.

The User Defined Tab

Figure 5.22. The User Defined Tab

Pressing the New button adds a new user defined property to the list. After adding a new property, the entity and property type must be chosen.

There are seven possible entity types:

  • Iteration

  • Job

  • Requirement

  • System under Test

  • Test Environment

  • Test Case

  • Test Suite

  • Test Run

The four possible property types are:


The property will be a single-line text field

Text Field

The property will be a multi-line text field


The property will be a simple check box


The property will be a drop down box to select a single entry from a predefined list of values

The default value of the property can also be set here.

After the new property is saved the entity type and property type can no longer be changed. The name of the property and the list of enumeration values can always be changed. Enumeration Values

The Edit button beside the enumeration property names opens the menu to edit the values of the enumeration property as shown in Figure 5.23

Editing an Enumeration Property

Figure 5.23. Editing an Enumeration Property

Once user defined properties are configured, they can be edited in the User Defined tab of the relevant object ( Figure 5.24).

[Note] Note

If no user defined properties are configured for the object type, this tab will only contain a link to the project's user defined tab in order to create some.

The Test Suite User Defined Tab

Figure 5.24. The Test Suite User Defined Tab

The values of user defined properties for test runs are set in the execute dialog as shown in Figure 8.3.

5.2.14. Referencing Artifact Properties

Common and user defined properties ( Section 5.2.13, “User Defined Properties”) can be referenced and resolved in the displayed text fields while executing jobs, test cases or test suites. For example, the following test case precondition references the system under test in which it is executed:

"Please ensure that the operating system shown in /config/os matches %sut:buildnumber% before executing this test case."

When executing this test case, %sut:buildnumber% gets replaced by the value of the user defined property "buildnumber" of the system under test in which the test case is executed. Assuming the this value equals "1.44_alpha3" the text is rendered as follows:

"Please ensure that the operating system shown in /config/os matches 1.44_alpha3 before executing this test case."

Referencing Artifact Property Values

Figure 5.25. Referencing Artifact Property Values

Propery substitution is supported both for the common pre-defined attributes of an artifact (e.g. the name or id) as well as the user defined properties. The name of the common attributes can be derived from the corresponding bean methods defined in de.verit.klaros.core.model.

Properties of the following artifacts are currently supported:

Supported Artifacts





System under Test


Test Case


Test Environment


Test Run


Test Segment


Test Suite


Assume that the following example text is used in the test case precondition:

"Please make sure that your system under test is using version %sut:productversion%."

The attribute name productversion is found in the class documentation for the SUTImplementation class in de.verit.klaros.core.model.KlarosSUTImplementation . Given that the version defined there has a value of 1.0.1, the following output will be rendered when displaying the precondition:

"Please make sure that your system under test is using version 1.0.1."

[Tip] Property references are case insensitive!

The left-hand side of a reference is case insensitive. %sut:productversion%, %SUT:productversion% and %Sut:productversion% will yield the same result

5.2.15. Referencing Attachments

Similar to referencing user defined properties in test case and test case steps ( Section 5.2.14, “Referencing Artifact Properties”), values from binary attachments can be referenced as well. Currently CSV and XLS files are supported.

Binary attachments of the following artifacts are currently supported:

Supported Artifacts





System under Test


Test Case


Test Environment


Test Run


Test Segment


Test Suite


In addition to the above, the wildcard att can be used, which Klaros-Test­management tries to resolve to a binary attachment parsing all contemplable artifacts.

A placeholder can be defined in the form %[object type]:[file name]:[column]:[row]% using the following parameters:

Placeholder Parameters

[object type]

The type of the object that is holding the binary attachment.

[file name]

The name of the binary attachment.


The column number of the value of the binary attachment.


The row number of the value of the binary attachment.

[Note] Note

When referencing xls-files, cells can be addressed using Excel-Coordinates (e.g. C1 or AB24). This shortens the placeholder to %[object type]:[file name]:[coordinate]% .

The file name, column and row parameters can also be defined using user defined properties, e.g. %itr-att:customers.csv:%job:Customer%:%job:CustomerNr.%% will reference the customers.csv attachment of the current iteration, using the value in the column defined in the attribute Customer of the current job and the row defined in the attribute CustomerNr.

[Tip] Attachment references are case insensitive!

The left-hand side of an attachment reference is case insensitive. %itr-att:customers.csv:A1%, %ITR-att:customers.csv:A1% and %ITR-Att:customers.csv:A1% will yield the same result

5.2.16. Revisions

Requirements, Test Cases, Test Segments and Test Suites are revisionable artifacts.

A new revision of an object should be created when a major edit is taking place. An old revision of a test case can, for example, be executed when using a system under test where newly added test steps are not applicable.

Revisioning of objects can be managed from the Revisions tab. This tab shows the revision history for the object, allows the user to change the revision comment associated with each revision and also allows creation of new revisions. The revision history table may also be used to select a revision to display and edit.

The Test Suite Revisions Tab

Figure 5.26. The Test Suite Revisions Tab Relationships in revisionable artifacts

In many cases Artifacts will be related to other artifacts. Some artifacts like e.g. Test Cases or Requirements may exist in different revisions, so one revision of an artifact can be referenced by any revision of other artifacts. Every revision of an artifact may contain its own references to other artifacts, regardless of the relationships of the other revisions. In addition every revision of an artifact can be related to one or more specific revisions of another artifact.

Example: Given is one Test Case: TC0001 and the Requirement REQ0001. Requirement REQ0001 is covered by the Test Case TC0001. Both are still in the initial revision 1.0.

Now a new Revision 1.1 of Requirement REQ0001 is created which is also covered by Test Case TC0001. So TC0001 is now covering the Requirement REQ0001 in both revisions.

Next, a new Revision of Test Case TC0001 is created, since Revision 1.0 of Requirement REQ0001 has become obsolete. Therefore Revision 1.1 of the Test Case will only reference the newest Revision of the Requirement.

After creating the new Revision of Test Case TC0001, we discover that Requirement REQ0002 is also covered by this Test Case Revision. Therefore, we add further coverage between REQ0002 and the Test Case TC0001 in Revision 1.1.

This example shows, that although the Test Case and the Requirement are the same Artifacts, their relationship can change over their revision history. References are defined per revision, and so can be different with each revision. This does not only apply to Test Cases and Requirements, but also for other revisionable Artifacts like Test Suites or Test Segments.

5.2.17. Related Test Runs and Results

Some Details sections show test runs and test results which are related to the artifact being displayed, e.g. executed in the displayed test environment or executed by the displayed user. An example of a Test Results tab is shown in Figure 5.27.

The Results Tab

Figure 5.27. The Results Tab

In both of these tabs, the names of artifacts are links to the Details Pages of the artifacts. The icon displays the Details Page of the corresponding test run or test result.

In the Test Runs tab ( Figure 5.27), reports may also be generated, as described in Section 9.4, “Test Runs”.

5.2.18. Change History

The Details section of each editable object in Klaros-Test­management contains a Changes tab. This shows the change history for the object.

Figure 5.28 shows the Changes tab for a test case.

The Test Case Changes Tab

Figure 5.28. The Test Case Changes Tab

Changes to an object are grouped by edit, i.e. if a user changes two fields and then presses save, the changes to these to fields will be grouped in the Changes tab.

5.2.19. Overview Tabs

For every type of artifact in Klaros-Test­management there is a dedicated overview tab which shows the most important data for this artifact (like the last editor or the the status) at a glance. In addition to raw data, many overview pages are enriched with various useful statistics, like for example the success history for test suites, which helps visualizing the test progress.

The Test Case Overview Tab

Figure 5.29. The Test Case Overview Tab