Klaros-Testmanagement User Manual

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. 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 Results of Executed Test Cases

2.10. Requirement – Properties of the System under Test

2.11. Iteration - Subdividing a Project into Phases

2.12. Job - Planning the Test Process

2.13. User - Users and their Rights

2.14. Overview of Objects

2.15. Issue - Reporting and Resolving Defects

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. Log Files

3.10.2. Database Settings

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.11.5. Apache Derby

3.11.6. Setting up the Database Instance

3.12. Installing as a System Service

3.12.1. Installing as a Linux Service

3.12.2. Installing as a Windows Service

3.13. Monitoring

3.14. Configuring External Issue-Management-Systems

3.14.1. Jira Configuration

3.14.2. Redmine Configuration

3.14.3. Trac 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. Automatic Database Version Detection

3.16.6. Oracle Database no Longer Supported

3.17. Uninstall

4. Customization

4.1. Languages

4.1.1. Defining Language Files

4.2. Quote of the Day

5. Functional Overview

5.1. Login

5.2. Page Overview

5.2.1. Side Menu

5.2.2. Page Header

5.2.3. Content

5.3. Main Functions

5.3.1. Resolving save conflicts

5.3.2. Deleting, Purging and Restoring Objects

5.3.3. Referencing Object Properties

5.3.4. Referencing Attachments

6. Define

6.1. Projects

6.1.1. Overview Page

6.1.2. Details Page

6.2. Iterations

6.2.1. Overview Page

6.2.2. Details Page

6.3. Requirements

6.3.1. Overview Page

6.3.2. Details Page

6.4. Test Environments

6.4.1. Overview Page

6.4.2. Details Page

6.5. Systems under Test

6.5.1. Overview Page

6.5.2. Details Page

6.6. Test Segments

6.6.1. Overview Page

6.6.2. Details Page

6.7. Test Cases

6.7.1. Overview Page

6.7.2. Details Page

6.8. Test Suites

6.8.1. Overview Page

6.8.2. Detail Page

7. Plan

7.1. Jobs

7.1.1. Overview Page

7.1.2. 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.1.1. Action

8.1.2. Table Operations

8.1.3. Executing a Job

8.2. Run Test Case

8.2.1. Action

8.2.2. Table Operations

8.2.3. Executing a Test Case

8.3. Run Test Suite

8.3.1. Action

8.3.2. Table Operations

8.3.3. Executing a Test Suite

8.4. Continue Test Run

8.4.1. Action

8.4.2. Bulk Actions

8.4.3. Table Operations

8.4.4. Continue test run

8.5. Import Test Results

8.5.1. Supported Frameworks

9. Evaluate

9.1. The Dashboard

9.1.1. Default Dashboard

9.1.2. Editing a Dashboard Report

9.1.3. Report Types

9.2. Reports

9.2.1. Predefined Reports

9.3. Test Runs

9.3.1. Action

9.3.2. Bulk Actions

9.3.3. Table Operations

9.3.4. The Test Run Report

9.3.5. Details Page

9.3.6. Changes

9.4. Test Case Results

9.4.1. Action

9.4.2. Bulk Actions

9.4.3. Table Operations

9.4.4. Single Test Case Results

9.5. Test Suite Results

9.5.1. Action

9.5.2. Table Operations

9.5.3. Single Test Suite Results

9.6. Issues

9.6.1. Overview Page

9.6.2. Action

9.6.3. Bulk Actions

9.6.4. Table Operations

9.6.5. Details Page

9.6.6. Issue Details (Creating a new Issue)

9.6.7. Link Issue

10. Configure

10.1. Overview

10.2. Report Templates

10.2.1. Action

10.2.2. Report Templates Details

10.3. Users

10.3.1. Overview Page

10.3.2. Details Page

10.4. System

10.4.1. Miscellaneous

10.4.2. Notifications

10.4.3. Test Execution

10.4.4. Interface

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. The Context Object

11.2. Creating a Report Template

11.2.1. Supported Parameter Types

11.2.2. Dealing with Parameters

11.3. Generating a Report

11.4. Example Report

11.4.1. Creating the Report Script

11.4.2. Creating a PDF Report Template

11.5. Creating a Chart

11.5.1. Pie Chart Report Script

11.5.2. Pie Chart Report Template

11.5.3. Embedding Images

11.5.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.4.3. Synchronization

12.5. Importing Test Results

12.5.1. The JUnit XML++ format

12.5.2. Prerequisites

12.5.3. Execution

12.5.4. Jenkins Plugin

12.6. Exporting Test Results

12.6.1. Execution

12.7. Exporting Table Content

12.8. Backup/Recovery

12.8.1. Backup via REST

13. The Remote API

13.1. Overview

13.2. REST Clients

13.3. Documentation

A. Access Permissions

A.1. Role Permission Overview – Community Edition

A.2. Role Permission Overview – Enterprise Edition

B. The 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.model

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. <category>

C.8. <categoryTree>

C.9. <container>

C.10. <testcases>

C.11. <testcase>

C.12. <testsuite>

C.13. <externalId>

C.14. <areatopic>

C.15. <depends>

C.16. <description>

C.17. <docbase>

C.18. <estimatedDuration>

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>

C.37. <categoryName>

C.38. <categoryDescription>

D. Requirement Import File Specification

D.1. <attachments>

D.2. <attachment>

D.3. <attributes>

D.4. <attribute>

D.5. <category>

D.6. <categoryTree>

D.7. <container>

D.8. <requirements>

D.9. <requirement>

D.10. <externalTestCaseIds>

D.11. <externalId>

D.12. <externalRevision>

D.13. <description>

D.14. <priority>

D.15. <revision>

D.16. <shortname>

D.17. <summary>

D.18. <name>

D.19. <value>

D.20. <content>

D.21. <categoryName>

D.22. <categoryDescription>

E. The Reporting Context API

E.1. The Klaros Report Context

E.2. KlarosScript Interface

E.3. Example Layout Template

F. Icon Index

F.1. Sections

F.2. Actions

F.2.1. Actions

F.2.2. Execution Actions

F.2.3. Test Execution Actions

F.2.4. Arranging Actions

F.3. Table Operations

F.4. Information

F.5. Properties

F.5.1. Results

F.5.2. Priorities

F.6. Document Formats

Glossary

Index