Home
Rational® Test Virtualization Server
Administrator Guide
Typically, a user with the administrator role is responsible for certain tasks including installation, configuration, and integration of the product. This guide lists all such topics.
Administering HCL Quality Server
HCL Quality Server is a server-based web application providing a central repository for virtualized services. The HCL Quality Server allows you to use virtual services published with HCL OneTest™ API to create, share, and deploy virtualized test environments in HCL OneTest Virtualization.
Viewing HCL Quality Server logs
If you are an HCL Quality Server administrator, you can view the audit, activity, and diagnostic logs of HCL Quality Server.
Configuring logging for metrics storage (KairosDB)
You can use the server configuration file of HCL Quality Server to configure the level and location of logging for metrics that are stored by using KairosDB.

Rational® Test Virtualization Server
- Release Notes
  This document contains information about What's new, installation, known issues, and contact information of IBM Support.
- System Requirements
  This document includes information about hardware and software requirements for HCL OneTest™ Virtualization.
- Getting Started
  This guide provides an overview and describes the tasks to get you started with Rational® Test Virtualization Server.
- Administrator Guide
  Typically, a user with the administrator role is responsible for certain tasks including installation, configuration, and integration of the product. This guide lists all such topics.
  - Installation of Rational® Integration Tester Agent
    You can find information about installing IBM® Rational® Integration Tester Agent from the IBM Rational Test Workbench, IBM Rational Test Virtualization Server, or package.
  - Installation of Rational® Test Control Panel
    You can find information about installing IBM® Rational® Test Control Panel from the IBM Rational Test Workbench, IBM Rational Test Virtualization Server, or IBM Rational Performance Test Server package.
  - Upgrading HCL OneTest™ API Agent
    In general, you can upgrade from earlier versions of HCL OneTest™ API Agent to the most recent version without having to uninstall the software. Use the IBM® Installation Manager Update option to upgrade the software.
  - License management
    As a purchaser of an IBM® Rational® software product, you can choose from the different types of product licenses that you can deploy to use the product.
  - Configuring HCL OneTest™ API Agent
    After you install HCL OneTest™ API Agent, you must edit or modify the attributes in the Agent.config file for the features that you want to test by using the agent. You need to configure the libraries to enable testing the SUT based on certain technologies and also set up the required proxies for enabling testing.
  - Running HCL OneTest™ API Agent on Microsoft™ Windows™
    On computers running Microsoft™ Windows™, the agent is typically installed and run as a Windows service.
  - Running HCL OneTest™ API Agent on Unix-like systems
    On Unix-like systems, you can start HCL OneTest™ API Agent by running the Agent executable in the root of the HCL OneTest API Agent installation directory (for example, /opt/IBM/RIT-Agent/).
  - HCL OneTest™ API Agent
    You can use workarounds to common problems that you might encounter when you install and run the HCL OneTest™ API Agent.
  - HTTP/TCP proxy setup
    The process of configuring applications to use the HTTP/TCP proxy varies according to the application.
  - Setting up the JDBC proxy
    After you install the JDBC proxy, you must deploy the proxy into the Java™ virtual machine (JVM) of the relevant applications, set up the proxy for use, and verify that it is deployed.
  - Administering HCL Quality Server
    HCL Quality Server is a server-based web application providing a central repository for virtualized services. The HCL Quality Server allows you to use virtual services published with HCL OneTest™ API to create, share, and deploy virtualized test environments in HCL OneTest Virtualization.
    - Configuring HCL Quality Server
      You might need to configure the HCL Quality Server after the application is installed.
    - Getting started
      Start using the HCL Quality Server.
    - Task flow: Working with the HCL Quality Server Environments dashboard
      You can use the HCL Quality Server Environments dashboard to perform various tasks such as starting, stopping stubs and scenarios, and modifying stub configurations after you have published stubs to HCL Quality Server. You can also lock the environment that contain the published stubs.
    - Task flow: Working with the HCL Quality Server Infrastructure dashboard
      You can use the HCL Quality Server Infrastructure dashboard to perform administrative tasks such as viewing agents and proxies registered with HCL Quality Server.
    - Task flow: Working with the HCL Quality Server Network dashboard
      You can use the HCL Quality Server Network dashboard to perform administrative tasks such as viewing recording or routing rules configured for agents and proxies.
    - Managing users
      HCL Quality Server has multiple choices associated with its security model. Depending on the security option selected during installation of the HCL Quality Server, different options are available based on the user accounts.
    - Managing domains
      How to create and manage domains in HCL Quality Server.
    - Working with HCL Quality Server dashboards
      You can filter, search, sort, and choose the number of items to be displayed in HCL Quality Server dashboards.
    - Deleting environments
      This topic explains how to delete environments.
    - Agent and Proxy administration
      Use HCL Quality Server to view and control any of the HCL OneTest™ API agents or proxies.
    - Viewing HCL Quality Server logs
      If you are an HCL Quality Server administrator, you can view the audit, activity, and diagnostic logs of HCL Quality Server.
      - Locating the logs
        HCL Quality Server produces two types of logs: messages.log and console.log. These logs provide information about the execution of the server. If the server fails to start, this is the only information that you have to debug the failure. The logs also include information about migration of the workspace, ports that it cannot listen on, files that it cannot find, or about HTTP requests sent to the server that it cannot understand. These logs are available on your hard disk, but not viewable on the HCL Quality Server web UI. The messages.log file contains the same log entries as console.log, but provides additional information (for example, what package logged the entry).
      - Viewing the audit log
        If you are an HCL Quality Server administrator, you can view the contents of the audit log. The audit log provides information about your overall activity in HCL Quality Server (for example, failed login attempts, starting and stopping stubs, creating and deleting environments, and creating and deleting domains). These data may be useful for security reasons and for finding out who initiated a particular change (for example, who stopped a stub or who deleted a domain). You can view the audit log on the HCL Quality Server web UI.
      - Viewing the activity log
        If you are an HCL Quality Server administrator, you can view, download, and share the contents of the activity log. The activity log provides information about your activity across the various components of HCL OneTest™ Virtualization. The data is particularly about the communication between, or control of these components; for example, recording and routing rules sent to proxies. You can view the activity log on the HCL Quality Server web UI.
      - Enabling and disabling remote diagnostic logging for the JDBC proxy
        To facilitate troubleshooting, HCL Quality Server administrators can view, download, and share detailed log events information for the JDBC proxy. The capability to display this information in HCL Quality Server requires enabling remote diagnostic logging for the proxy.
      - Enabling and disabling remote diagnostic logging for the HTTP/TCP proxy
        To facilitate troubleshooting, HCL Quality Server administrators can view, download, and share detailed log events information for the HTTP/TCP proxy. The capability to display this information in HCL Quality Server requires enabling remote diagnostic logging for the proxy.
      - Viewing the diagnostic log
        If you are an HCL Quality Server administrator, you can view, download, and share the contents of the diagnostic log of HCL Quality Server. The diagnostic log provides information about the execution of the HCL OneTest™ Virtualization components. When enabled for a given proxy, this log records the same information as is contained in the log files that proxy writes to the disk, for example, information about how the HTTP proxy matches requests against the rules it has and whether it sends requests to a stub or to the live system. It might also include information about the execution of HCL Quality Server itself. You can view the diagnostic log on the server web UI.
      - Setting the log level
        The logging element in the server configuration file of HCL Quality Server defines the log level.
      - Configuring logging for metrics storage (KairosDB)
        You can use the server configuration file of HCL Quality Server to configure the level and location of logging for metrics that are stored by using KairosDB.
        Using the KairosDB UI
        You can use the KairosDB UI to query the data store and graphically view stub metrics for virtual services across HCL OneTest™ Virtualization and HCL OneTest API as reported to HCL Quality Server.
    - Viewing reports in HCL OneTest™ Server
      All the project stakeholders can view test reports for multiple testing products from the Results page on HCL OneTest™ Server. You can access the Results page from a web browser. Therefore, there is no need to install the desktop client.
    - Configuring stubs to connect to HCL Quality Server and the HTTP proxy
      A stub running on its own may not be sufficient in some cases, because it might have dependencies on services such as HCL Quality Server or the HTTP proxy. If the stub is running on the public cloud and the services are running in the enterprise, you must configure the stub to connect to these services.
    - Troubleshooting: HCL Quality Server
      You can use workarounds to troubleshoot common problems that you might encounter when you use HCL Quality Server.
- Tester Guide
  This guide describes the tasks that you can perform for testing various domains, technologies, and applications. To enable testing, you must configure and enable the environment for testing.
- Test Manager Guide
  This guide describes the tasks that you can perform for tracking the quality of the application. This guide is intended for Test Managers.
- Security Considerations
  You can take certain actions to ensure that your installation is secure, customize your security settings, and set up user access controls.
- Notices
  This document provides information about copyright, trademarks, terms and conditions for product documentation.

Configuring logging for metrics storage (KairosDB)

You can use the server configuration file of HCL Quality Server to configure the level and location of logging for metrics that are stored by using KairosDB.

Go to the HCL Quality Server installation folder and locate the server configuration file. Typically, on Windows computers, the file is in <HCL Quality Server installation directory>\config and on non Windows computers, in /opt/<HCL Quality Server installation directory/config.
Open server.custom.xml in a text editor.

Add the following lines to the file.

<!--The directory to which the kairosdb server should write logs-->
<jndiEntry id="kairosdb/logs/dir" jndiName="kairosdb/logs/dir" value="&quot;${wlp.install.dir}/logs&quot;"/>
<!--To what level of detail the kairosdb server should write its logs (TRACE, DEBUG, INFO, WARN or ERROR)-->
<jndiEntry id="kairosdb/logs/level" jndiName="kairosdb/logs/level" value="&quot;DEBUG&quot;"/>

The logs are then written to

<HCL Quality Server installation
directory>\logs\kairosdb.log

, rolling over each day, keeping 30 days history, and logging statements at DEBUG level or above. The logs are also included in

<HCL Quality Server installation
directory>\logs\console.log

.