Klaros-Testmanagement User Manual

Selcuk Akgünlü

Caroline Albuquerque

Talal Arif

Sabrina Gidley

Fabian Klaffke

Claudia Könnecke

Klaus Mandola

Patrick Reilly

Tobias Schmitt

Torsten Stolpmann

Heiner Westphal

verit Informationssysteme GmbH

Version 4.11.1

Legal Notice

May 16 2019

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. Key Features
1.1. Klaros-Test­management Community Edition Features
1.2. Klaros-Test­management Enterprise Edition Features
2. Introduction
2.1. What is Klaros-Test­management
2.2. Test Cases - The Basis of Testing
2.3. Test Segments - Reusable Test Case Steps
2.4. Test Suites - Organizing Test Cases
2.5. Test Runs - Executed Tests with their Results
2.6. Test Environment and System under Test - Influences of Test Results
2.7. Iterations - Subdividing your project into phases
2.8. Requirements – Meeting Quality Standards
2.9. Jobs - Planning the test process
2.10. User Roles - Every User has his Rights
2.11. Overview of Artifacts
2.12. Issue Management Systems
3. Installation
3.1. License Model
3.1.1. License Model (Users)
3.2. Prerequisites
3.2.1. Client Prerequisites
3.2.2. Server Prerequisites
3.3. Installation Process
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. Update Process
3.6.1. Incompatible Installation Detected
3.6.2. Manual Changes
3.6.3. Database Migration
3.7. Important File Locations
3.7.1. Log Files
3.7.2. The Hibernate Properties File
3.7.3. Language Files
3.7.4. The Quotes File
3.7.5. The Derby Database
3.7.6. The Attachment Repository
3.8. Running Klaros-Test­management
3.9. Changing the Default Database
3.10. Installing Klaros-Test­management as a Service
3.10.1. Installing Klaros-Test­management as a Linux service
3.10.2. Installing Klaros-Test­management as a Windows service
3.11. Monitoring Klaros-Test­management
3.12. Configuring External Issue Management Systems
3.12.1. Jira Configuration
3.12.2. Redmine Configuration
3.12.3. Trac Server Configuration
3.13. SSL Support
3.14. 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 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
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 the Description of 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. Creating a System under Test
6.5.2. Bulk Actions
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 Jobs
7.1.4. Executing a Job
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 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 Jira Issue
8.7.3. Creating a Mantis Issue
8.7.4. Creating a Redmine Issue
8.7.5. Creating a Trac Issue
8.8. Creating Review Jobs
9. Evaluate
9.1. Dashboard
9.1.1. The Overview Reports
9.1.2. The Dashboard Reports
9.2. Report Templates
9.3. Test Run History Report
9.4. Test Runs
9.4.1. The Test Run Report
9.5. Test Case Results
9.5.1. Single Test Case Results
9.6. Test Suite Results
9.6.1. Single Test Suite Results
9.7. Viewing Reasons of Skipped Test Cases
9.8. Issues
9.8.1. Issues by Test Case
9.8.2. Issue Details (Creating a new Issue)
9.8.3. Link Issues
9.9. Bookmarking Results
10. Configure
10.1. Overview
10.2. Report Templates
10.2.1. Report 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
10.4.4. Interface Settings
10.4.5. Languages
10.5. Integration
10.5.1. Issue Management
10.5.2. Requirements Management
10.5.3. E-Mail
10.5.4. Network
10.5.5. LDAP
10.5.6. CAS
10.6. Backup
10.6.1. Export
10.6.2. Import
11. Custom Reports
11.1. Create A New Report Template
11.1.1. Supported Parameter Types
11.1.2. Dealing with Parameters
11.2. Applying a Report Template
11.3. Example Report
11.3.1. Creating the Groovy Script
11.3.2. Creating a SeamPDF Report Template
11.3.3. Creating a Chart
11.3.4. Including Images
11.3.5. Creating a SeamExcel 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.4.3. Synchronizing
12.5. Importing Test Results
12.5.1. Prerequisites
12.5.2. Execution
12.6. Exporting Table Content to Excel
12.7. Backup/Recovery
12.7.1. Backup via REST
13. The Klaros-Test­management Remote API
13.1. Overview
13.2. REST Clients
13.3. Documentation
Glossary
A. Role Permission Overview
B. Klaros Object Model API Reference
B.1. Klaros Object Model API-Reference
B.1.1. de.verit.klaros.core.model
B.1.2. Deprecated API
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.model
B.2.5. Constant field values
C. Test Case Import File Specification
C.1. <step>
C.2. <steps>
C.3. <attribute>
C.4. <attributes>
C.5. <container>
C.6. <testcases>
C.7. <testcase>
C.8. <triggers>
C.9. <testsuite>
C.10. <externalId>
C.11. <externalRevision>
C.12. <trigger>
C.13. <areatopic>
C.14. <depends>
C.15. <description>
C.16. <docbase>
C.17. <evaluation>
C.18. <execution>
C.19. <expectedResult>
C.20. <level>
C.21. <method>
C.22. <note>
C.23. <postcondition>
C.24. <precondition>
C.25. <revision>
C.26. <priority>
C.27. <shortname>
C.28. <state>
C.29. <team>
C.30. <traceability>
C.31. <variety>
C.32. <name>
C.33. <value>
D. Requirement Import File Specification
D.1. <attribute>
D.2. <attributes>
D.3. <container>
D.4. <requirements>
D.5. <requirement>
D.6. <triggers>
D.7. <externalId>
D.8. <externalRevision>
D.9. <trigger>
D.10. <description>
D.11. <priority>
D.12. <revision>
D.13. <shortname>
D.14. <summary>
D.15. <name>
D.16. <value>
E. Reporting Resources
E.1. Context Variables
E.2. KlarosScript Interface
E.3. Example
Index