Starting stubs by using the HCL Quality Server method

When you want to start stubs that are published to HCL Quality Server, you can do so from the Environments Dashboard. Also, when you cannot use or access HCL OneTest API to control stubs, you can use the Environments Dashboard of HCL Quality Server to start the stubs.

About this task

The Environments Dashboard also enables you to perform the following tasks:

  • Override a stubs tag setting.
  • Adjust a stubs response time.
  • Start scenarios, which are collections of configured stubs. This action starts all stubs in the scenario.
Note: If you have multiple engines set up on HCL OneTest API Agent on which you intend to run the stubs, you can configure the number of engines that you want to start concurrently. You can edit the Agent.config file to set the values of the following attributes:
Attribute Description Default value
maxConcurrentStarts Specifies the number of engines that must be started concurrently. 10 engines
concurrencyPeriodSecs Specifies the duration in seconds within which time the engines that were specified must be started after the first engine is started. 60 seconds


  1. Log in to HCL Quality Server.
  2. Click the Environments icon Image of the environments icon. or navigation link from the landing page.
    The Environments Dashboard is displayed.
    Note: You can change the domain and environment that you want to view by clicking the <domain>:<environment> link, and from the <domain>:<environment> selection dialog displayed, select the domain, and then select the Environment.
  3. Select the domain, and then select the Environment that contains the stubs.
    The Environments Dashboard is displayed for the selected environment and domain.
    Note: If you are using or later, and domain-level security is enabled, you can use only the domains to which you were granted access.
  4. Click the Start icon image of the icon of the stub that you want to start.
    Note: If the stub fails to start and displays a Broken state, then you can find the possible cause by hovering over the stub.


After the stub has started, the status changes from Stopped to Starting, and then the status changes to Running. After the stub runs, you can view the following details about the stub in a tabular format:




Displays the state of the stub.

For example, the status of a stub that is started is displayed as Starting and the status changes to Running when the stub runs.


Displays the name of the stub that was published to HCL Quality Server.


Displays the version of the stub that was published to HCL Quality Server.


Displays the name of the service component in HCL OneTest API in which the stub was created.


Displays the name of the operation in HCL OneTest API in which the stub was created.


Displays the count of the messages or calls received by the stub after the stub was started.

For example, when you start a stub named as McStub with version 1.0 that was created in the Add operation under the AddNumbers service component and that had a hit count of 4, the stub is displayed in the Environments Dashboard as follows:
Image of the stub in the environments dashboard.

Starting from V9.2.1 or later, stubs are automatically restarted if the original instance stops working for any of the following reasons:
  • HCL OneTest API Agent fails.
  • HCL Quality Server fails.
  • A network outage.