Start a stub by using an Ant task

You can start a stub by using the HCL Quality Server Ant tasks.
Here is an example syntax:
<taskdef name="startStub" classname="com.ghc.ghTester.ant.StartStub" classpathref="tasklib" />

<startStub domain="<Domain name>" environment="<Environment name>" 
component="<Component name>" operation="<Operation name>" 
name="<Stub name>" version="<Stub version number>" 
serverUrl="https://<Host name or IP address>:5443/RTCP/"/>
The following example usage files for the Ant tasks are available in the 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
Note: Starting in V9.1.1 the Ant Client file was renamed to from
The following table lists the attributes that you can use with the startStub Ant task for starting a stub.
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
component Component the stub exists within. No
operation The operation the stub exists within on the server. No
name The name of the target stub to start. Yes
version Version of the target stub to start.
Note: If you are using HCL OneTest API or later, and the HCL Quality Server command line or Apache Ant tasks are used to start a stub, and if no stub version information is provided, it is the latest version of a stub that is run. If you are using 8.5.0 or earlier, and the HCL Quality Server command line or Apache Ant tasks are used to start a stub, and if no stub version information is provided, it is the earliest version of a stub that is run.
attributes Comma-separated list of agent attributes identifying the agent to run on. No
async Run asynchronously (flag). No, default is synchronous.
username Specify the user name to authenticate with HCL Quality Server if the environment is locked and the domain security is disabled. No

Specify the security token generated for the user 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. For more information, see Domain level security and Managing environments.

No, default is to send no token.
disablePerformanceOptimisations Specify the value "true" to disable performance optimization when starting the stub (optional). No
workerThreadCount The amount of worker threads used to service requests to the stub (optional). No
haltOnFailure Set to true to fail the Ant script if the stub fails to start (flag). No, default is false.
failureProperty The name of a property that is set in the event of a failure. No

Use this option to run the stub by using a dedicated engine that is not used to run other stubs even if they are published from the same project. You can specify the JVM options by using the dedicatedEngineJvmOptions parameter and specify the values such as the maximum memory, initial memory, and the garbage collection policy for the engine.

The JVM options can be specified only if you set this option to "true".
<taskdef name="startStub" classname="com.ghc.ghTester.ant.StartStub" classpathref="tasklib" />

<startStub domain="default" environment="local" name="ReqRepStub" version="1.0" 
serverUrl="https://localhost:5443/RTCP/" dedicatedEngine="true" 
dedicatedEngineJvmOptions="-Xmx2g -Xms256m -Dmy.option=\"my\ value\"" />
  • Use spaces to separate the JVM parameters.
  • The quotations and the space in the value must be escaped with a backslash as specified in the example.
  • force
  • forceIf
  • forceUnless
Use the force option to start the stub by attempting to ignore any warnings or errors that might occur.
  • force: To ignore all the problems that occur when you start the stub.
  • forceIf: Specify a space-separated list of problem identifiers to ignore when you start a stub.
  • forceUnless: Specify a space-separated list of problem identifiers to not ignore when you start a stub. If the parameter list is empty, the force setting is not considered and none of the errors are ignored.
You can specify if a specific problem identifier must either be ignored or considered when the stub is started. The problem identifier parameters are:
  • agent-criteria-unsatisfied: Indicates that there were not enough agents available to run the stub or the specified agents were not found.
  • reused-agent: Indicates that the selected agent is already running that stub. Running multiple instances of that stub at the same time on the same agent does not provide any benefit over running it a single time on that agent.
  • engine-criteria-unsatisfied: Indicates that none of the agents could satisfy the engine requirements to start the stub on. This might occur if none of the agents support dedicated stub deployments.
<startStub ... force="true"/>
<startStub ... forceIf="reused-agent agent-criteria-unsatisfied"/>
<startStub ... forceUnless="engine-criteria-unsatisfied"/>

User offline token for authorizing the client to access HCL OneTest Server.

For example, the command to start a stub that uses the secretsAuthorization attribute follows:
<startStub ... secretsAuthorization="USER_OFFLINE_TOKEN"/>

For more information, see Accessing HCL OneTest Server from IntegrationTesterCmd, ANT CLI, Maven CLI, or in a REST API call.


Error codes

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