HCL® Quality Server: Modifying stub information

The Environments Dashboard of HCL® Quality Server has the option to override the stub settings and also, to start the stubs.

The Environments Dashboard displays all the published stubs within a specific environment in a specific domain. Each published stub is displayed as a collapsed card that can be expanded to show the different details in a tabbed view.
Note: For database stubs, only one stub for each database can be run at any given time.
The following information is available for each of the stubs:
  • Statistics
  • Details
  • Activity
  • Configuration

Use the following table to know how you can view or change the information about the stub:

Table 1. Details of stub properties in the Environments DashboardThe following table describes the stub properties displayed for the stub.
Tab Description

Statistics

Displays the calls received and virtualized responses as a graph plotted against time from the time the stub was published.

The count of the messages received by the stub is also displayed against the Hit Count field. The count is reset when the stub is restarted.

Details

Displays information about the following details:
Configuration options Description
Stub ID Displays the ID of the Stub that was assigned to the stub when it was created in a project and published to HCL® Quality Server.
Definition ID Displays the identifier of the stub created in HCL OneTest API and is the same as the Definition ID displayed in the Documentation tab of the Stub Editor in HCL OneTest API.
Operations

Displays the operations performed on the stub.

Created

Displays information about the user who created the stub along with the date and time of stub creation.

Updated

Displays information about the user who last updated the stub along with the date and time of the update.

Documentation

Displays any text that was entered for that stub on the Documentation tab of the Stub Editor in HCL OneTest API.

Deployed On Displays the name of the Agent or Engine that the stub is currently running.

Activity

Displays the log of the activities performed on the stub. You can sort the details in any column in this section in an increasing or decreasing order, by clicking the column header.

Configuration

Displays information about the following details:
Configuration options Description

Name

You can change the name of the published stub and to save your changes, click SAVE.

Version

You can set the version of the stub by selecting the version available in the list.
Note: If 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.

Logging Level

Use the Logging Level option to modify the currently selected stubs log level that determines the level of details that are written to the project results database. By default, logging is disabled when you deploy a stub to improve performance.
Note: The changes to the Logging Level option are immediately applied to the running stub without the stub restarting.
Log level options are as follows:
  • None (default)
  • Normal
  • Debug
Log messages are written to the project results database if you have configured one, and to the HCL OneTest API Agent log file. Normal log messages are saved to the project results database only. With Debug logging, more messages (in addition to those found in the project results database, if any) are written to the HCL OneTest API Agent log file.
Example:
  • Normal:
    [07/03/2018, 15:43:55.642] Instance 1: Message Case: "Text" using schema "Text" Stub input filters passed, continuing to subtree.
  • Debug:
    [07/03/2018, 15:43:55.658] [Debug] Instance 1: Tag write: Value1 (1)
    [07/03/2018, 15:43:55.658] [Debug] Instance 1: Tag write: Value2 (2)
Note: If you observe any delays with the stub response time, set the log level to None. This would avoid any delays due to the time taken to log details to the results database.

Input tags

Displays the input tags of the currently selected version of the stub.

Use this section to override the configured input tag values for the currently selected version of the stub.

Expand Input tags section to list the input tags specified for the selected version of the stub. To override the configured value of an input tag, click Input tags enter a new name under the tag name field and enter the value under the result field associated with it. To force the value of a tag to be null, push the slide-button to the right against the Is Null? field.

Response Time

Use this section to override the currently selected stubs response time behavior. By default, the stub response time behavior will be as it was defined when the stub was published. You can choose to have no delay to responses, or to configure a fixed, uniform or Gaussian delay distribution.
Note: The overridden settings apply to all operations in the stub.
Delay distributions options are as follows:
Option Description

No delay

Select this option for a response time with no delay.

Fixed delay

Select this option for a fixed delay in the response time by entering the required delay in milliseconds (ms).

Uniform distribution

Select this option for a uniformly distributed random time by specifying the minimum and maximum delay, by sliding the pointer to the required delay in milliseconds (ms).

Gaussian distribution

Select this option for a random time with Gaussian distribution by specifying the minimum and maximum delay, by sliding the pointer to the required delay in milliseconds (ms).

Note: After a stub has started, its response time can be modified while it is running.

Agent Tags

You can view and choose the agent tags to restrict agents where the stubs are run.

Dedicated JVM

You can choose to use a dedicated Virtual Machine (VM) to run the stubs that allows for customized JVM arguments to be run on the stubs. If you intend to use this resource, click the Required check box and provide the details of the dedicated JVM.

Performance

You can modify the currently selected stubs performance settings. By default, a stub uses the performance option that is set when the stub was published. This includes specifying the number of requests to the stub that can be handled simultaneously. You can optimize the performance by selecting the Optimize performance check box. You can also enter the number of simultaneous requests in the Worker Threads field or use the increase/decrease button () to change the available threads.

For more information on the Performance optimization settings, see The Properties tab.

Pass-through

You can modify the stubs behavior to respond to messages received. You can select an option from the list that modifies what was set in HCL OneTest API for the stubs responses to messages received:
Simulate Error Use this option to simulate an error when a message is received.
Pass-through Use this option for the stub to pass the message to the next operation. If no other operation exists, the stub moves the message to the application.
Discard Use this option to discard the message.