Klaros-Testmanagement User Manual

Caroline Albuquerque

Selcuk Akgünlü

Heiko Bott

Claudia Könnecke

Klaus Mandola

Christian Petry

Patrick Reilly

Tobias Schmitt

Torsten Stolpmann

verit Informationssysteme GmbH

Version 3.4.10

Legal Notice

February 03 2012

Abstract

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


Table of Contents

1. Key Features
1.1. Klaros-Testmanagement Community Edition Features
1.2. Klaros-Testmanagement Enterprise Edition Features
2. Introduction
2.1. Overview
2.2. Roles
3. Installation
3.1. Prerequisites
3.1.1. Client Prerequisites
3.1.2. Server Prerequisites
3.2. Installation Process
3.2.1. Step 1: Welcome
3.2.2. Step 2: Information
3.2.3. Step 3: Licensing Agreements
3.2.4. Step 4: Target Path
3.2.5. Step 5: Select Installation Packages
3.2.6. Step 6: User Data
3.2.7. Step 7: Installation
3.2.8. Step 8: Perform External Processes
3.2.9. Step 9: Setup Shortcuts
3.2.10. Step 10: Installation Finished
3.3. Console based installation
3.4. Update Process
3.4.1. Database Migration
3.5. Running Klaros-Testmanagement
3.6. Changing the Database
3.7. Installing Klaros-Testmanagement as a service
3.7.1. Installing Klaros-Testmanagement as a Linux service
3.7.2. Installing Klaros-Testmanagement as a Windows service
3.8. Monitoring Klaros-Testmanagement
3.9. Configuring External Issue Management Systems
3.9.1. Bugzilla Configuration
3.9.2. JIRA Configuration
3.9.3. Mantis Configuration
3.9.4. Redmine Configuration
3.9.5. Trac Configuration
3.9.6. SSL Support
4. Customization
4.1. Languages
4.1.1. Defining Language Files
4.1.2. Custom Quotes
5. Functional Overview
5.1. Login
5.2. Main Functions
6. Define
6.1. Defining a Project
6.1.1. Maintaining a Project
6.2. Test Environments
6.2.1. Maintaining Test Environments
6.3. Maintaining Systems Under Test
6.3.1. Maintain Systems Under Test
6.4. Test Cases
6.4.1. Maintain Test Cases
6.5. Test Suites
6.5.1. Maintain Test Suites
7. Plan
7.1. Maintaining Jobs
7.1.1. Creating a Job
7.1.2. Editing a Job
7.1.3. Executing a Job
7.1.4. Searching and Sorting Jobs
7.2. Generating Jobs from Test Cases
7.2.1. Searching and Sorting Test Cases
7.3. Generating Jobs from Test Suites
7.3.1. Searching and Sorting Test Suites
7.4. Jobs By User
7.4.1. Searching and Sorting Users
8. Execute
8.1. Start New Run
8.1.1. Run Single Test Case
8.1.2. Run Test Suite
8.2. Continue Run
8.2.1. Continue Test Suite
8.3. Import Results
8.4. Creating an issue
9. Evaluate
9.1. Reports
9.1.1. Dashboard
9.1.2. Report Templates
9.1.3. Single Test Run Report
9.1.4. Test Run History Report
9.2. Test Results
9.2.1. Test Case Results
9.2.2. Test Suite Results
9.3. Issues
9.3.1. Issues by Test Case
9.3.2. Link Issues
9.3.3. Create Issues
9.4. Bookmarking Results
10. Configure
10.1. System Information
10.2. Report Templates
10.2.1. Report Details
10.3. User Administration
10.3.1. Create User
10.3.2. Search User
10.4. Authentication
10.4.1. LDAP
10.5. System Parameters
10.5.1. E-Mail
10.5.2. Logging
10.5.3. General Settings
10.5.4. Issue Management
10.5.5. Network
10.5.6. Languages
10.6. Backup/Recovery
10.6.1. Backup Projects
10.6.2. Restore Projects
11. Reports
11.1. Create A New Report Template
11.1.1. 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. Export Table Content to Excel
12.2. Backup/Recovery
12.3. Integration With Other Frameworks
12.3.1. Jenkins/Hudson Plugin for Klaros-Testmanagement
12.3.2. QF-Test and JUnit Import
Glossary
Index
A. Role Permission Overview
B. Model API Reference
B.1. Klaros-Core API Reference
B.1.1. Package de.­verit.­klaros.­core.­model
B.2. Klaros-Scripting API Reference
B.2.1. Package de.­verit.­klaros.­scripting
B.2.2. Package de.­verit.­klaros.­scripting.­context
B.2.3. Package de.­verit.­klaros.­scripting.­model
C. Dump File Specification
C.1. <configurationList>
C.2. <configuration>
C.3. <classInitialStates>
C.4. <value>
C.5. <entry>
C.6. <classStates>
C.7. <envs>
C.8. <propertyDefs>
C.9. <enumValues>
C.10. <suts>
C.11. <testCases>
C.12. <testRuns>
C.13. <testSuites>
C.14. <executables>
C.15. <testCaseStepFragments>
C.16. <testCaseStep>
C.17. <testCaseResults>
C.18. <testSuiteResult>
C.19. <propertiesOwner>
C.20. <stringProperties>
C.21. <relatedClass>
C.22. <namedEntity>
C.23. <resultReference>
C.24. <key>
C.25. <created>
C.26. <enabled>
C.27. <secured>
C.28. <lastUpdated>
C.29. <description>
C.30. <mappedToClass>
C.31. <userDefined>
C.32. <mandatory>
C.33. <productversion>
C.34. <revisionId>
C.35. <root>
C.36. <trunkRoot>
C.37. <areatopic>
C.38. <cut>
C.39. <depends>
C.40. <docbase>
C.41. <equiclass>
C.42. <evalutation>
C.43. <execution>
C.44. <expectedResult>
C.45. <generalState>
C.46. <inputvalues>
C.47. <level>
C.48. <message>
C.49. <method>
C.50. <note>
C.51. <postcondition>
C.52. <precondition>
C.53. <predecessor>
C.54. <priority>
C.55. <shortname>
C.56. <successor>
C.57. <team>
C.58. <traceability>
C.59. <variety>
C.60. <testMethod>
C.61. <env>
C.62. <runId>
C.63. <sut>
C.64. <timestamp>
C.65. <revisionComment>
C.66. <summary>
C.67. <type>
C.68. <running>
C.69. <testSuitePassed>
C.70. <currentTestCase>
C.71. <executionTime>
C.72. <action>
C.73. <propertyType>
C.74. <propertyOwnerReference>
C.75. <propertyDefReference>
C.76. <testCasePassed>
C.77. <propertyName>
C.78. <propertyValue>
C.79. <propertyDisplayName>
C.80. <propertySystemName>
C.81. <sortorder>
C.82. <configurationReference>
C.83. <testCaseReference>
C.84. <testRunReference>
C.85. <testResultReference>
C.86. <testSuiteReference>
C.87. <testSuiteResultReference>
C.88. <name>
C.89. <uuid>
D. Reporting Resources
D.1. Context Variables
D.2. KlarosScript Interface
D.3. Example report template