Viewing the state of stubs that are published to HCL® Quality Server

When you as an administrator of HCL® Quality Server want to view the state of stubs that are published to HCL® Quality Server, you can use the script provided with the product installation package. You can use this information to manage projects in HCL® Quality Server.

Before you begin

You must have completed the following tasks:

Downloaded the product software and installed the product software in a supported operating system. See Installation.
Published stubs to HCL® Quality Server. See Publishing and running stubs.

About this task

At any time after HCL® Quality Server is installed and stubs are published to different projects, you might want to perform any of the following actions to manage HCL® Quality Server:

Stop all running stubs.
Delete projects in HCL® Quality Server.
Restart HCL® Quality Server.
Uninstall HCL® Quality Server.
Reinstall HCL® Quality Server.

You can view the state of all stubs in HCL® Quality Server so that you can decide on your action to manage HCL® Quality Server. You can run the supplied script for your operating system and enter the URL of HCL® Quality Server. The list of stubs and their states in HCL® Quality Server are downloaded to a file on your computer. You can then view the stubs and their state in the downloaded file.

Note: You can use the Environments dashboard to view the stubs that are published to a specific domain or environment but you cannot view all the stubs that are in all the projects in HCL® Quality Server.

Procedure

Browse to the CheckStatusOfStubs folder in the installation directory on the computer on which you installed HCL OneTest™ API.
For example, the path to the folder in the installation directory on Windows can be as follows: C:\Program Files\HCL\HCLProducts\API\examples\CheckStatusOfStubs.
You can find the following scripts that you can use for your operating system:
- getstubdetails.bat to use in Windows.
- getstubdetails.sh to use in Linux.
Double-click the script file.

The command line interface is displayed.
Enter the URL of the computer on which you installed HCL® Quality Server, and then press Enter.

The script runs and compiles the details of the stubs that are on HCL® Quality Server into a file and the path to the file is displayed.
Open the file to view the details of the stubs and their state.

Results

You viewed the stub details and state of all the stubs that are in HCL® Quality Server by using the scripts provided in the product installation package.