Klaros-Testmanagement User Manual

Talal Arif

Sabrina Gidley

Fabian Klaffke

Claudia Könnecke

Klaus Mandola

Patrick Reilly

Torsten Stolpmann

verit Informationssysteme GmbH

Version 5.0.9

Legal Notice

May 05 2021

Abstract

This document serves as the reference documentation for the Klaros-Test­management application. It gives a detailed description of the user interface and the provided functionality.


Table of Contents

1. Feature Overview
1.1. Test Data Management
1.2. Test Planning
1.3. Test Execution
1.4. Evaluation, Statistics, Reports
1.5. Configuration
2. Introduction
2.1. What is Klaros-Test­management? Structure and Objects
2.2. Project - Managing a Test Project
2.3. Test Case - Defining a Test
2.4. Test Step - Determine the Test Activity Sequence
2.4.1. Test Step Result
2.4.2. Automated Test Cases
2.5. Test Segment - Reusing Test Steps
2.6. Test Suite - Arranging Test Cases
2.7. System under Test - The Test Object
2.8. Test Environment - The External Influence on the Test Result
2.9. Test Run - The Executed Test Cases and their Results
2.10. Requirements – Meeting Quality Standards
2.11. Iteration - Subdividing a Project into Phases
2.12. Job - Planning the Test Process
2.13. User Roles - Users and their Rights
2.14. Overview of Objects
2.15. Issues - Reporting and Resolving Errors
3. Installation
3.1. License Model for Community and Enterprise Edition
3.2. System Prerequisites
3.2.1. Client Prerequisites
3.2.2. Server Prerequisites
3.3. Installation
3.3.1. Language Selection
3.3.2. Step 1: Welcome
3.3.3. Step 2: Information
3.3.4. Step 3: Licensing Agreements
3.3.5. Step 4: Target Path
3.3.6. Step 5: Select Installation Packages
3.3.7. Step 6: User Data
3.3.8. Step 7: Installation
3.3.9. Step 8: Perform External Processes
3.3.10. Step 9: Setup Shortcuts
3.3.11. Step 10: Installation Finished
3.4. Console-based Installation
3.4.1. Step 1: Language
3.4.2. Step 2: Welcome
3.4.3. Step 3: Information
3.4.4. Step 4: Licensing Agreements
3.4.5. Step 5: Target Path
3.4.6. Step 6: Select Installation Packages
3.4.7. Step 7: User Data
3.4.8. Step 8: Installation
3.4.9. Step 9: Perform External Processes
3.4.10. Step 10: Setup Shortcuts
3.4.11. Step 11: Installation Finished
3.5. Automated Installation Script
3.6. Starting the application
3.7. Stopping the application
3.8. Accessing the application
3.9. Update Process
3.10. Important Files and their Locations
3.10.1. The Log Files
3.10.2. The Hibernate Properties File
3.10.3. Language Files
3.10.4. The Quotes File
3.10.5. The Derby Database
3.10.6. The Content Repository
3.11. Changing the Default Database
3.11.1. MariaDB
3.11.2. Microsoft SQL-Server
3.11.3. MySQL
3.11.4. PostgreSQL
3.12. Installing Klaros-Test­management as a System Service
3.12.1. Installing Klaros-Test­management as a Linux Service
3.12.2. Installing Klaros-Test­management as a Windows Service
3.13. Monitoring Klaros-Test­management
3.14. Configuring External Issue Management Systems
3.14.1. Jira Configuration
3.14.2. Redmine Configuration
3.14.3. Trac Server Configuration
3.15. SSL Support
3.16. Upgrading from Version 4
3.16.1. Required Version for Upgrade
3.16.2. Unattended Database Upgrade
3.16.3. Startup Time for Initial Upgrade to Version 5
3.16.4. Embedded Java Runtime Environment
3.16.5. Oracle Database no Longer Supported
3.17. Uninstall
4. Customization
4.1. Languages
4.1.1. Defining Language Files
4.2. Custom Quotes
5. Functional Overview
5.1. Login
5.2. Main Sections
5.3. Main Functions
5.3.1. The Help Menu
5.3.2. The Log Panel
5.3.3. The User Menu
5.3.4. Search / Quick-Select
5.3.5. Quick Table Filtering
5.3.6. Filtering and Sorting
5.3.7. The Print Pages
5.3.8. Categorization
5.3.9. Conflict Handling
5.3.10. Deleting Objects
5.3.11. Bulk Actions
5.3.12. Attachments
5.3.13. User Defined Properties
5.3.14. Referencing Object Properties
5.3.15. Referencing Attachments
5.3.16. Revisions
5.3.17. Related Test Runs and Results
5.3.18. Change History
5.3.19. Overview Tabs
6. Define
6.1. Projects
6.1.1. Creating a Project
6.1.2. Deleting a Project
6.1.3. Restoring a Project
6.1.4. Purging a Project
6.1.5. Editing a Project
6.1.6. Project Details
6.2. Iterations
6.2.1. Bulk Actions
6.2.2. Creating an Iteration
6.2.3. Iteration Details
6.3. Requirements
6.3.1. Remote Requirements Management System Synchronization
6.3.2. Bulk Actions
6.3.3. Creating a Requirement
6.3.4. Requirement Details
6.4. Test Environments
6.4.1. Bulk Actions
6.4.2. Creating a Test Environment
6.4.3. Test Environment Details
6.5. Systems under Test
6.5.1. Bulk Actions
6.5.2. Creating a System under Test
6.5.3. System under Test Details
6.6. Test Cases
6.6.1. Bulk Actions
6.6.2. Creating Test Cases
6.6.3. Test Case Details
6.7. Test Segments
6.7.1. Bulk Actions
6.7.2. Creating Test Segments
6.7.3. Test Segment Details
6.8. Test Suites
6.8.1. Bulk Actions
6.8.2. Create Test Suites
6.8.3. Test Suite Details
7. Plan
7.1. Maintain Jobs
7.1.1. Bulk Actions
7.1.2. Creating Jobs
7.1.3. Arranging Sub-Jobs
7.1.4. Executing Jobs
7.1.5. Job - Details
7.2. Jobs from Test Cases
7.3. Jobs from Test Suites
7.4. Jobs by User
7.4.1. Jobs by User - Details
8. Execute
8.1. My Jobs
8.2. Run a Test Case
8.2.1. Executing a Single Test Case
8.3. Run Test Suite
8.3.1. Executing a Test Suite
8.4. Permanently Skipping Test Cases
8.5. Continue Test Run
8.5.1. Continuing a Suspended Test Run
8.6. Import Test Results
8.7. Creating Issues
8.7.1. Creating a Bugzilla Issue
8.7.2. Creating a GitHub Issue
8.7.3. Creating a GitLab Issue
8.7.4. Creating a Jira Issue
8.7.5. Creating a Mantis Issue
8.7.6. Creating a Redmine Issue
8.7.7. Creating a Trac Issue
8.8. Creating Review Jobs
9. Evaluate
9.1. The Dashboard
9.1.1. Default Dashboard
9.1.2. Editing a Dashboard Report
9.1.3. Report Types
9.1.4. The Project Overview Report
9.1.5. The Latest Success Rate Report
9.1.6. The Test Activity Report
9.1.7. The System under Test Overview Report
9.1.8. The Test Environment Overview Report
9.1.9. The Test Progress Report
9.1.10. The Test Progress History Report
9.2. Reports
9.3. Configurable Reports
9.4. The Predefined Reports
9.5. Test Runs
9.5.1. The Test Run Report
9.6. Test Case Results
9.7. Single Test Case Results
9.8. The Test Case Result Page
9.9. Test Suite Results
9.10. Single Test Suite Results
9.11. Reasons for Skipped Test Cases
9.12. Issues
9.13. Issues by Test Case
9.14. Issue Details (Creating a new Issue)
9.15. Issue Details (Editing an Existing Issue)
9.16. Issues by Test Case Details
9.16.1. Link Issue
9.17. Bookmarking Results
10. Configure
10.1. Overview
10.2. Report Templates
10.2.1. Report Templates - Details
10.3. Users
10.3.1. Creating a User
10.3.2. Deleting a User
10.3.3. User Details
10.4. System
10.4.1. Miscellaneous Settings
10.4.2. Notification Settings
10.4.3. Test Execution Settings
10.4.4. Interface Settings
10.4.5. The Language tab
10.5. Integration
10.5.1. Issue Management Settings
10.5.2. Requirements Management Settings
10.5.3. E-Mail Settings
10.5.4. Network Settings
10.5.5. LDAP Settings
10.5.6. CAS Settings
10.6. Backup
10.6.1. Export
10.6.2. Import
11. Custom Reports
11.1. The Context Object
11.2. Creating a Report
11.3. Supported Parameter Types
11.4. Dealing with Parameters
11.5. Generating a Report
11.6. Example Report
11.6.1. Creating the Report Script
11.6.2. Creating a PDF Report Template
11.7. Creating a Chart
11.7.1. Pie Chart Report Script
11.7.2. Pie Chart Report Template
11.7.3. Embedding Images
11.7.4. Creating an Excel Report Template
12. Import/Export
12.1. Importing Test Cases from Excel
12.1.1. Import Format
12.1.2. Prerequisites
12.1.3. Execution
12.2. Importing Test Cases from XML
12.2.1. Prerequisites
12.2.2. Execution
12.3. Importing Requirements from Excel
12.3.1. Import Format
12.3.2. Prerequisites
12.3.3. Execution
12.4. Importing and Synchronizing Requirements from XML
12.4.1. Prerequisites
12.4.2. Importing
12.5. Importing Test Results
12.5.1. Prerequisites
12.5.2. Execution
12.6. Exporting Table Content
12.7. Backup/Recovery
12.7.1. Backup via REST
13. The Remote API
13.1. Overview
13.2. REST Clients
13.3. Documentation
Glossary
A. Role Permission Overview
A.1. Role Permission Overview Community Edition
A.2. Role Permission Overview Enterprise Edition
B. Klaros Object Model API Reference
B.1. Klaros Object Model API Reference
B.1.1. de.verit.klaros.core.model
B.2. Scripting API Reference
B.2.1. de.verit.klaros.scripting
B.2.2. de.verit.klaros.scripting.context
B.2.3. de.verit.klaros.scripting.custom
B.2.4. de.verit.klaros.scripting.custom.scratchpad
B.2.5. de.verit.klaros.scripting.exception
B.2.6. de.verit.klaros.scripting.model
B.2.7. Constant field values
C. Test Case Import File Specification
C.1. <step>
C.2. <steps>
C.3. <attachments>
C.4. <attachment>
C.5. <attribute>
C.6. <attributes>
C.7. <container>
C.8. <testcases>
C.9. <testcase>
C.10. <triggers>
C.11. <testsuite>
C.12. <externalId>
C.13. <externalRevision>
C.14. <trigger>
C.15. <areatopic>
C.16. <depends>
C.17. <description>
C.18. <docbase>
C.19. <evaluation>
C.20. <execution>
C.21. <expectedResult>
C.22. <level>
C.23. <method>
C.24. <note>
C.25. <postcondition>
C.26. <precondition>
C.27. <revision>
C.28. <priority>
C.29. <shortname>
C.30. <state>
C.31. <team>
C.32. <traceability>
C.33. <variety>
C.34. <name>
C.35. <value>
C.36. <content>
D. Requirement Import File Specification
D.1. <attachments>
D.2. <attachment>
D.3. <attributes>
D.4. <attribute>
D.5. <container>
D.6. <requirements>
D.7. <requirement>
D.8. <triggers>
D.9. <externalId>
D.10. <externalRevision>
D.11. <trigger>
D.12. <description>
D.13. <priority>
D.14. <revision>
D.15. <shortname>
D.16. <summary>
D.17. <name>
D.18. <value>
D.19. <content>
E. Reporting Context API
E.1. The Klaros Report Context
E.2. KlarosScript Interface
E.3. Example
F. Icon Index
F.1. Sections
F.2. Actions
F.2.1. Actions
F.2.2. Test Execution Actions
F.2.3. Arranging Actions
F.3. Information
F.4. Properties
F.4.1. Results
F.4.2. Priorities
F.5. Document Formats
Index