FAQ - Frequently Asked Questions and Answers - Klaros Test Management
Support FAQ - Frequently asked Questions
This page covers answers to frequently asked questions about Klaros-Testmanagement to help you get started quickly.
Please note that this page is currently only available in English.
Basic Topics
- Is Klaros-Testmanagement an open source test management tool?
- Is a trial license for Klaros-Testmanagement Enterprise Edition available?
- Where do I find licensing and pricing information for Klaros-Testmanagement?
- I have problems downloading Klaros-Testmanagement from the download page
- Where do I send bug reports or feature requests concerning Klaros-Testmanagement?
- What information should I provide in my bug report/email?
- Where do I find the log files in Klaros-Testmanagement?
Is Klaros-Testmanagement an open source test management tool?
Klaros-Testmanagement is not published as open source but a free of charge community edition is available. The Community Edition is unrestricted in terms of amount of users or projects allowed but is lacking some features of the commercially supported Enterprise Edition. For a detailed overview on the abilities of the different editions please check our Feature Matrix.
Is a trial license for Klaros-Testmanagement Enterprise Edition available?
It is possible to upgrade the Community Edition with an enterprise trial license which is valid for a period of 30 days. You can order the trial license here or directly from within the Klaros-Testmanagement UI on the System information page.
Where do I find licensing and pricing information for Klaros-Testmanagement?
Please check out our FAQ. If you have questions please feel free to contact us at sales@verit.de.
I have problems downloading Klaros-Testmanagement from the download page
Please check your local security settings and ask your system administrator for assistance. It is possible that a firewall or proxy is preventing the download. Anti virus software may also block the download.
Where do I send bug reports or feature requests concerning Klaros-Testmanagement?
You can either use our forum or send an email to support@verit.de.
What information should I provide in my bug report/email?
To support us in solving the issue quickly, please provide the following information in your bug report:
- A Screenshot if it is a problem visible in the UI
- The Klaros-Testmanagement log files. See the User Manual for the locations of these files
- If you are not running Klaros-Testmanagement as a service under Windows, please provide the console output too
- The versions of your installed software components (Klaros, database, operating system, browser)
- The version of your issue tracker in case you have a problem connecting to your issue tracking software
Where do I find the log files in Klaros-Testmanagement?
The log files for Klaros-Testmanagement can be found in the logs folder in the installation directory and also in condensed form the logs folder within the .klaros directory.
Database Topics
- Where does Klaros-Testmanagement store its data, I see no database to configure?
- Derby file access is slow, is it possible to use a full blown SQL-Database Server?
- What other databases are supported at the moment?
- How do I change the Klaros-Testmanagement database installation?
- I already have test data entered in my current database, will this data be lost when I migrate to a new database?
- Since I moved Klaros-Testmanagement to a windows service I can no longer login to my created database. Whats wrong?
- What is the recommended way to back up the Klaros-Testmanagement database?
Where does Klaros-Testmanagement store its data, I see no database to configure?
Klaros-Testmanagement is able to use different types of SQL databases. The Community Edition comes with a
preconfigured Apache Derby
database which stores its data in the home directory of the user which runs the web application in the
folder .klaros/klarosDerby.
Derby file access is slow, is it possible to use a full blown SQL database server?
Yes. See below for a list of supported databases. We strongly discourage the use of Derby for production data, due to lack of performance and missing transaction support.
What other databases are supported at the moment?
See the User Manual for details.
How do I change the Klaros-Testmanagement database installation?
See the User Manual for details.
I already have test data entered in my current database, will this data be lost when I migrate to a new database?
In order to migrate data to a new database you should use the Backup functionality. This allows you to export and import projects to an XML format.
See the User Manual for details of the backup process.
Since I moved Klaros-Testmanagement to a windows service I can no longer login to my created database. Whats wrong?
Make sure that the .klaros directory is made available in the home of the user running the service.
What is the recommended way to back up the Klaros-Testmanagement database?
To back up the data stored in Klaros-Testmanagement please use the tools that are provided by your database distribution. The XML Import/Export feature should only be used to export to or import from foreign systems.
Installation
- What are the installation requirements?
- What are the client requirements?
- Does Klaros-Testmanagement run on Mac OS X?
- The installer complains about a missing JAVA_HOME/JRE_HOME, what am I missing?
- The Windows installer does not do anything after extracting the files, what is wrong?
- The installer crashes under Linux, what am I missing?
- During Installation/Startup I find something like INFO: Port busy 18009 java.net.BindException: Address already in use in the logs
- How do I install Klaros-Testmanagement under Linux using the console only?
- How do I install Klaros-Testmanagement as a Linux service?
- How do I install Klaros-Testmanagement as a Windows service?
- The installed Klaros-Testmanagement Windows Service is running out of memory
- How do I upgrade to a newer version of Klaros-Testmanagement?
- I upgraded to a new version, the version number is still the old one, what am I missing?
- I already have an Application Server running, can I install Klaros-Testmanagement there instead of using the provided Tomcat?
- Does Klaros-Testmanagement run in a 64 bit Linux environment?
- How do I uninstall Klaros-Testmanagement?
What are the installation requirements?
See the online User Manual for details.
Please note that under Windows Vista and Windows 7/8 some restrictions apply regarding the target path, as shown here.
What are the client requirements?
To access Klaros-Testmanagement you need a fairly up to date web browser. The online documentation shows the supported browsers here. Other browsers like Opera are not supported but may work as well. If not please drop us a note on the forum).
Does Klaros-Testmanagement run on Mac OS X?
As of version 3.4.4 Klaros-Testmanagement should run without problems on OS X. Yet we do not officially support this platform.
The installer complains about a missing JAVA_HOME/JRE_HOME, what am I missing?
Klaros-Testmanagement requires an installation of OpenJDK or Oracle Java Standard Edition 8 for operation. Additionally the environment variable JAVA_HOME (for Java SDK installations) or JRE_HOME (for Java Runtime Environment installations) has to be defined. The online documentation shows how to do this under Windows.
The Windows installer does not do anything after extracting the files, what is wrong?
The reason for this behaviour might be a missing PATH entry on your system. Please ensure that the bin folder in your JAVA_HOME/JRE_HOME is added to your PATH variable. (see above question)
The installer crashes under Linux, what am I missing?
Klaros-Testmanagement requires an installation of OpenJDK or Oracle Java Standard Edition 8 for operation. Most Linux distributions come with an alternative Java implementation like GNU Java Runtime or OpenJDK. Klaros-Testmanagement is not supported in such an environment, so you should download an Oracle Runtime and modify the environment to use this runtime instead.
During Installation/Startup I find something like INFO: Port busy 18009 java.net.BindException: Address already in use in the logs
There is a process running that already blocks the port 18009. Please check that there are no running
processes that block the ports that Klaros-Testmanagement uses. For the default ports see the
User Manual.
If you changed these ports during your installation process, please verify that there is no other process
blocking the ports you entered. For other ports please check your $TOMCAT_HOME/conf/server.xml
file or refer to the
Tomcat Manual.
How do I install Klaros-Testmanagement under Linux using the console only?
Since version 3.4 Klaros-Testmanagement provides a command line installer. For further information see the User Manual.
How do I install Klaros-Testmanagement as a Linux service?
Please check the User Manual on that topic.
How do I install Klaros-Testmanagement as a Windows service?
Please check the User Manual on that topic.
The installed Klaros-Testmanagement Windows Service is running out of memory
Please check the User Manual on that topic.
How do I upgrade to a newer version of Klaros-Testmanagement?
The Klaros-Testmanagement installer will take care of the complete upgrading process. For more information please consult the User Manual.
I upgraded to a new version, the version number is still the old one, what am I missing?
Please make sure to stop the tomcat server before upgrading to a new Klaros-Testmanagement version.
I already have an Application Server running, can I install Klaros-Testmanagement there instead of using the provided Tomcat?
Yes, but you do this on your own risk, as we cannot test Klaros-Testmanagement on every application server out in the wild. If you need further information we will try to help you, send us an email at support@verit.de.
Does Klaros-Testmanagement run in a 64 bit Linux environment?
Yes, Klaros-Testmanagement works fine with 64 bit installations. You might want to consider the advice in the prerequisite section in the manual.
How do I uninstall Klaros-Testmanagement?
To uninstall Klaros-Testmanagement select Uninstall Klaros-Testmanagement Server from the start menu (if running under Windows) or just delete the installation folder manually.
Usage
- I cannot change any Issue Management System definition in the online demo. What am I missing?
- I cannot connect to my issue management system (e.g. JIRA) via HTTPS. Yet it works from the browser, what's wrong?
- I get an authentication error while validating the issue management system URL even though my login details are correct, what's wrong?
- How can I copy objects between projects?
- I cannot execute the tests I have defined. What am I missing?
- Can I execute scripts to run test cases from inside Klaros-Testmanagement?
- How do I execute a test case from the job view?
- Is it possible to pause the execution of a Test Run?
- I have problems attaching files during a test run, what am I missing?
- Can I get rid of the Klaros logo in the generated reports?
- Is it possible to create personalized reports with Klaros-Testmanagement?
- Does Klaros-Testmanagement provide its own user management?
- Using Active Directory for LDAP access does not work correctly
I cannot change any Issue Management System definition in the online demo. What am I missing?
The online demo runs in a special restricted mode which does not allow to change these parameters. The Community/Enterprise edition which you can download has no such restriction.
I cannot connect to my issue management system (e.g. JIRA) via HTTPS. Yet it works from the browser, what's wrong?
This may happen if you are using a self signed certificate in your SSL Server. See this Oracle Blog Entry for a solution.
I get an authentication error while validating the issue management system URL even though my login details are correct, what's wrong?
If this happens, you should check to see if the addition or removal of a trailing slash in the URL resolves
the issue. For some network setups, this can be significant. Note that for Redmine, the Authentication
Required checkbox in Settings > Authentication
must be checked.
How can I copy objects between projects?
You can copy requirements, test environments, systems under test, test cases and test suites from one project to another via the Maintain Projects menu. Click on the destination project's edit button an then activate the Copy Objects tab to select the source project and then the objects to copy. For detailed information please refer to the User Manual.
I cannot execute the tests I have defined. What am I missing?
To execute a manual test the following preconditions have to be met:
- At least one Test Environment has to be defined for the test project
- At least one System Under Test (SUT) has to be defined for the test project
- The execution type of the Test Case must be Manual and it must have at least one Test Step defined
For additional information please refer to the User Manual.
Can I execute scripts to run test cases from inside Klaros-Testmanagement?
No, Klaros-Testmanagement does currently not support the execution of scripts. Klaros-Testmanagement does support the import of the results of several test frameworks though. For detailed information on the supported frameworks please refer to the User Manual.
How do I execute a test case from the job view?
Click on the Plan icon and then on the Maintain Jobs menu entry to the left. If the execution type of the test case is Manual in the list of the displayed jobs, click on the Execute icon to execute the test case. If the execution type is Automated click on the Upload results icon and upload the results of the test run. Keep in mind that Test Cases their execution type set to Manual require at least one test step in order to be executed.
Is it possible to pause the execution of a Test Run?
Yes, you may resume test execution using the Continue Test Run menu entry. The test execution client saves its state after every single step in a test case. For additional information please refer to the User Manual.
I have problems attaching files during a test run, what am I missing?
- Please check if the permissions for the folder you stored the file in are valid
- Please check if the file size is smaller than the amount specified in the configuration. Check the Online Manual for details.
Can I get rid of the Klaros logo in the generated reports?
This is currently not possible. A feature to replace the logo with a user defined logo is planned for a future release. With the enterprise version of Klaros-Testmanagement you can define your own reports and you are able to include your own graphics. You can order a 30 day enterprise trial license here.
Is it possible to create personalized reports with Klaros-Testmanagement?
The creation of personalized reports is possible with the enterprise version of Klaros-Testmanagement. For more information please consult the User Manual.
Does Klaros-Testmanagement provide its own user management?
Klaros-Testmanagement features its own user management (see
Configure > Users
after logging in with admin/admin to the
online demo).
The Enterprise Edition allows you to choose between the authentication domains LDAP and Klaros. The default
authentication domain is configurable in the web interface. The Community Edition is bound to use the Klaros
domain.
Using Active Directory for LDAP access does not work correctly
By default, Active Directory does not respond to LDAP based queries which return more than 1000 results. If you have more than 1000 users configured in Active Directory, it is necessary to increase the maximum page size (MaxPageSize) using the Ntdsutil.exe tool. More information on this issue can be found here.
Troubleshooting
- I am running out of heap space and Klaros-Testmanagement slows down, can I change the heap settings?
- Running under Linux, I find entries in the log saying that I have too many open files. How can I fix this?
- Klaros-Testmanagement does not perform very well though I didn't create that many Test Cases. What can I do?
- I get an error message about an invalid certification path, what is wrong?
- I am missing the flag icons to switch languages. Did the installation go wrong?
- Missing dashboard or overview page diagrams with AdoptOpenJDK running under Linux
I am running out of heap space and Klaros-Testmanagement slows down, can I change the heap settings?
If you are running Klaros-Testmanagement as a service on Windows, please see this question.
Otherwise you should change the startup scripts of Klaros-Testmanagement. These are located in the
bin
folder of the Klaros-Testmanagement installation directory. If you are running Klaros-Testmanagement on a
Unix based system please modify setenv.sh.
CATALINA_OPTS="$CATALINA_OPTS -XX:MaxPermSize=192m -Xms256m -Xmx1024m"
If you are running Klaros-Testmanagement on a Windows system please modify setenv.bat.
set CATALINA_OPTS=%CATALINA_OPTS% -XX:MaxPermSize=192m -Xms256m -Xmx1024m
For more information about the Java VM and the correct syntax of the parameters please check the Oracle Java documentation.
Running under Linux, I find entries in the log saying that I have too many open files. How can I fix this?
Many Linux distributions limit the amount of open files per process to 1024, which may be not enough during operation. You can check this value with the following command entered in a shell (look for 'open files'):
ulimit -a
To permanently raise this value, add the following lines to /etc/security/limits.conf,
assuming that klaros is the account id of the process running Klaros-Testmanagement:
# allow user klaros more open files klaros soft nofile 16000 klaros hard nofile 16000
Do not forget to restart Klaros-Testmanagement after changing this.
Klaros-Testmanagement does not perform very well though I didn't create that many Test Cases. What can I do?
You may need to raise the amount of memory available for Klaros-Testmanagement. See this question for details.
I get an error message about an invalid certification path, what is wrong?
The reason might be the usage of a self signed certificate in your SSL Server. Please check for more information at the following places:
I am missing the flag icons to switch languages. Did the installation go wrong?
No, the installation worked fine. The problem might be that you are using a reverse proxy in your Klaros-Testmanagement environment. Please check if you set the Application URL in the General Settings section of your Klaros-Testmanagement installation. You can find more information in the online documentation here or on our forum here.
Missing dashboard or overview page diagrams with AdoptOpenJDK running under Linux
This error typically relates to an incomplete Linux X11 font configuration leading to an error during diagram creation. In this case the log file will contain the following exception:
To resolve this problem check if thejava.lang.NullPointerException at sun.awt.FontConfiguration.getVersion(FontConfiguration.java:1264)
fontconfig and urw-fonts
packages are present and install the if missing.
Miscellaneous
- What is the difference between a SUT and a Test Environment?
- Klaros-Testmanagement is logging me out after a while, can I influence the session timeout?
- Does Klaros-Testmanagement support any languages other than German and English?
- Is there a possibility to modify Klaros-Testmanagement code?
- Can I modify the quote of the day?
What is the difference between a SUT and a Test Environment?
The SUT (system under test) defines the artifact to be tested, usually your piece of software, e.g. Klaros-Testmanagement v3.4.7. The Test Environment specifies the parameters on where the SUT is running, e.g. the hardware, the OS version, even peripheral units. These two parts can both influence the Test Results, e.g. the test might succeed on OS1, but might fail on OS2. Example: Klaros-Testmanagement 3.4.7 (SUT 1) on Windows 7 (Test Environment 1) und Redhat Linux (Test Environment 2).
Klaros-Testmanagement is logging me out after a while, can I influence the session timeout?
Under
Configure > System
you can deactivate the
Use the default container session timeout?
checkmark and enter the desired session timeout in minutes.
Does Klaros-Testmanagement support any languages other than German and English?
Klaros-Testmanagement currently fully supports German and English. Thanks to a user contribution a Chinese translation is avaliable here for an older release. If you want to contribute other translations, your help is highly appreciated. Since version 3.4.3 you can change the available languages in the configuration section. For more information please consult the User Manual.
Is there a possibility to modify Klaros-Testmanagement code?
No. The only code that can be modified is the code for the report generation. This feature is only available in the enterprise version of Klaros-Testmanagement.
Can I modify the quote of the day?
Yes. More information on changing it can be found in the User Manual.