Home
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.
API Tester Reference
This guide provides the topics to help the API tester use the product by using the user interface, commands or scripts. This guide is intended for API testers.
Working in non-GUI mode
Many test actions can be completed in non-GUI mode by using the command line, Ant, or REST interfaces.
Managing scenarios
Use HCL Quality Server to manage scenarios with command-line, Ant, and REST APIs.
Stop a scenario by using an Ant task
You can stop a scenario by using the HCL Quality Server Ant tasks.

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.
- API Tester Reference
  This guide provides the topics to help the API tester use the product by using the user interface, commands or scripts. This guide is intended for API testers.
  - API 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. This guide is intended for API testers.
  - Extending HCL OneTest™ API functionality by using custom functions
    You can add more calculations and operations to tests by using the HCL OneTest™ API custom function class. HCL OneTest API custom function is a Java™ class that extends the com.ghc.ghTester.expressions function.
  - Working in non-GUI mode
    Many test actions can be completed in non-GUI mode by using the command line, Ant, or REST interfaces.
    - Command-line interfaces
      HCL OneTest™ API command-line client is available in HCL OneTest API 8.0.1 or later.
    - Ant tasks
      Support for the environment, scenario and stub Ant tasks is supplied with HCL Quality Server.
    - REST services
      Representational state transfer (REST) is a simple stateless architecture that generally runs over HTTP. When used in conjunction with HCL Quality Server, HTTP methods (such as GET and POST) are mapped to actions on domains, environments, scenarios, stubs and other resource types.
    - Running tests
      Use HCL OneTest™ API to run tests with command-line and Ant APIs.
    - Managing test results
      Use HCL Quality Server to manage test results with command-line APIs.
    - Managing domains
      You can create, list, update, and delete domains with the HCL Quality Server REST API.
    - Managing environments
      Locking a HCL Quality Server environment prevents other users from changing the state of that environment, for example, starting or stopping stubs.
    - Managing scenarios
      Use HCL Quality Server to manage scenarios with command-line, Ant, and REST APIs.
      - Start a scenario by using the command line
        You can start a scenario by using the HCL OneTest™ API command line. This option is useful in situations where Ant is not available.
      - Stop a scenario by using the command line
        You can stop a scenario by using the HCL OneTest™ API command line, optionally waiting for the scenario to stop before exiting. This option is useful in situations where Ant is not available.
      - Start a scenario by using an Ant task
        You can start a scenario by using the HCL Quality Server Ant tasks.
      - Stop a scenario by using an Ant task
        You can stop a scenario by using the HCL Quality Server Ant tasks.
      - REST services
        Representational state transfer (REST) is a simple stateless architecture that generally runs over HTTP. When used in conjunction with HCL Quality Server, HTTP methods (such as GET and POST) are mapped to actions on domains, environments, scenarios, stubs and other resource types.
    - Managing stubs
      You can manage stubs by using the command-line, Ant, and REST APIs.
- API Tester Guide (Service Virtualization)
  This guide describes the tasks that you can perform for using virtual services or stubs to simulate parts of an environment if the real services are not yet available or because they are difficult or expensive to use. This guide is intended for API Testers.

Stop a scenario by using an Ant task

You can stop a scenario by using the HCL Quality Server Ant tasks.

Here is an example syntax:

<taskdef name="stopScenario" classname="com.ghc.ghTester.ant.StopScenario" classpathref="tasklib" />

<stopScenario domain="<Domain name>" 
environment="<Environment name>" name="<Scenario name>" 
serverUrl="https://Host name or IP address:5443/" />

The following example usage files for the Ant tasks are available in the AntClient.zip package that can be downloaded from HCL Quality Server. For more information, see HCL OneTest™ API tool packages.

create-update-delete-environment.xml
lock-unlock-environment.xml
publish-stubs.xml
start-stop-scenario.xml
start-stop-stub.xml

The following table lists the attributes that you can use with the stopScenario Ant task for stopping a scenario.

Table 1. List of available attributes
Attribute	Description	Required
serverUrl	URL of the HCL Quality Server	Yes
domain	Domain name	Yes
environment	Environment name	Yes
name	The name of the target scenario to start.	No
owner	Filters the scenarios by owner.	No
async	Run asynchronously (flag).	No, default is synchronous.
username	Specify the user name to authenticate with the server if the environment is locked and the domain security is disabled.	No
securityToken	Specify the security token generated for you to authenticate with HCL Quality Server when the domain security is enabled. In the locked environment mode, the operation can be performed by the user who locked the environment.	No, default is to send no token.
haltOnFailure	Set to true to fail the Ant script if the scenario fails to stop (flag).	No, default is false.
failureProperty	The name of a property that is set in the event of a failure.	No

Scenario selection

For a description of how to select a scenario, see Scenario selection.

Error codes

For details of any error codes, see Exit codes for Command-line client and Ant client.