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 Guide
Typically, a user with the API Tester role is also responsible 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 tester is also interested in reports, results and statistics for their testing. This guide lists all such topics.
Creating and modifying database stubs
You can create and modify database stubs in HCL OneTest™ API.
Data type support
HCL OneTest™ API 8.0.1 or later supports most built-in data types of supported database management systems. HCL OneTest API 8.5.1 or later supports certain user-defined types of some supported database management systems.

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
  Typically, a user with the API Tester role can work in the user interface, use commands or scripts. This reference lists all such topics to help the API Tester use the product.
- API Tester Guide
  Typically, a user with the API Tester role is also responsible 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 tester is also interested in reports, results and statistics for their testing. This guide lists all such topics.
  - HCL OneTest™ Virtualization overview
    HCL OneTest™ Virtualization is software that is used for creating, maintaining, publishing, and running message-based stubs and database stubs.
  - Task flow: Working with the HCL Quality Server Environments dashboard
    You can use the HCL Quality Server Environments dashboard to perform various tasks such as starting, stopping stubs and scenarios, and modifying stub configurations after you have published stubs to HCL Quality Server. You can also lock the environment that contain the published stubs.
  - Virtualizing HTTP
    You can simulate an HTTP connection with a virtual service, also known as a stub.
  - Virtualizing HTTPS
    You can simulate an HTTPS connection with a virtual service, also known as a stub.
  - Virtualizing TCP
    You can simulate a TCP connection with a virtual service, also known as a stub.
  - Virtualizing a REST API without recording or synchronization
    You can virtualize REST APIs by using the Recording Studio, or by synchronizing WADL, Swagger, or RAML documents. When none of these options is available, you can still manually virtualize REST APIs that use path parameters.
  - Creating message-based stubs
    In HCL OneTest™ API, there are several methods that you can use to create a message-based stub.
  - Modifying message-based stubs
    You can use either the Test Editor or the Stub Editor to create, modify, and enhance any legacy or new stubs created by HCL OneTest™ API.
  - Creating and modifying database stubs
    You can create and modify database stubs in HCL OneTest™ API.
    - Prerequisites for creating database stubs
      Before creating any database stubs, you must complete any required software installation tasks and set up the schema that is used for stubbing a physical database.
    - Database stubs overview
      If you want to create a test or suite of tests for an application that uses a database, you run the test (suite) in a repeatable fashion against a known set of database contents. Therefore, you must stub the database to obtain repeatable conditions. Database stubs enable you to execute tests against some parts of a system under test without affecting a live database.
    - Persistence
      Database stubs created in HCL OneTest™ API can be non-persistent or persistent.
    - JDBC proxy
      The HCL OneTest™ API JDBC proxy package is provided with HCL Quality Server. You must deploy the package on any stand-alone applications, or application servers that host applications that use JDBC to access any live databases that you want to record or virtualize.
    - Stored procedures
      If you are using HCL OneTest™ API 8.0.1 or later, you can record and virtualize most stored procedures.
    - Data type support
      HCL OneTest™ API 8.0.1 or later supports most built-in data types of supported database management systems. HCL OneTest API 8.5.1 or later supports certain user-defined types of some supported database management systems.
    - Synonyms
      A synonym is an alias or alternate name for a table, view, sequence, or other schema object. HCL OneTest™ API 8.5.1 or later supports certain synonyms for some supported database management systems.
    - Creating database stubs by using the Recording Studio
      You use the Recording Studio perspective of the HCL OneTest™ API to create a database stub while SQL events are being recorded from a database.
    - Modifying database stubs
      You can modify database stubs in HCL OneTest™ API.
  - Configuring stubs to connect to HCL Quality Server and the HTTP proxy
    A stub running on its own may not be sufficient in some cases, because it might have dependencies on services such as HCL Quality Server or the HTTP proxy. If the stub is running on the public cloud and the services are running in the enterprise, you must configure the stub to connect to these services.
  - Publishing and running stubs
    You can publish stubs that are created in HCL OneTest™ API to HCL Quality Server, Dockerfile and build context, Kubernetes, or Istio, if the stub is based on a supported transport.
  - Viewing results in HCL Quality Server
    You can use HCL Quality Server to display the results of tests that you run in both HCL OneTest™ API and HCL Quality Server.
  - Viewing usage statistics of virtual services in HCL Quality Server
    HCL Quality Server collects and stores usage metric data. The metric data might include the number and types of actions that are used, the features that are used in the workbench, details about Operating System or languages set while running, and so forth. You cannot view the metric data on the HCL Quality Server user interface, but it is available from the underlying implementation. Storage is either managed by H2 or optionally Apache Cassandra. For more information about the H2 database and its management, see sections A. Server Configuration and D. Deleting Data.
  - Viewing reports in HCL OneTest™ Server
    All the project stakeholders can view test reports for multiple testing products from the Results page on HCL OneTest™ Server. You can access the Results page from a web browser. Therefore, there is no need to install the desktop client.
  - Troubleshooting: HCL OneTest™ Virtualization
    You can use workarounds to common problems that you might encounter when you use HCL OneTest™ Virtualization.

Data type support

HCL OneTest™ API 8.0.1 or later supports most built-in data types of supported database management systems. HCL OneTest™ API 8.5.1 or later supports certain user-defined types of some supported database management systems.

A user-defined type (UDT) is a named data type that is created in a database by a user.

The following table lists the database management systems supported by HCL OneTest™ API and indicates the level, if any, of UDT functionality of each database that is supported by different versions of HCL OneTest™ API.


Database management system (DBMS)	DBMS UDT support (level)	UDT support (level) for versions of HCL OneTest™ API earlier than 8.5.1	HCL OneTest™ API 8.5.1 or later UDT support (level)
IBM® Db2®	Yes (simple and complex)	No	Yes (simple only)
Microsoft™ SQL Server	Yes (simple and complex)	No	Yes (simple only)
MySQL	No	(Not applicable)	(Not applicable)
Oracle	Yes (complex only)	No	No

Specifically, 8.5.1 or later supports UDTs as data types of table columns and in stored procedures that map to a single built-in data type in Db2® for Linux™, UNIX™, and Windows™, Db2® for z/OS®, and Microsoft™ SQL Server.

When 8.5.1 or later processes a table in a "live" (production) database that has complex UDTs or processes a stored procedure that has input and output parameters of UDTs, HCL OneTest™ API does not create UDTs in the simulation database. Instead, HCL OneTest™ API resolves a UDT in the live database to its built-in data type (that is, the source) and uses that built-in data type in the simulation database.

The TIMESTAMP type in Oracle is not supported by Apache Derby when using the integrated simulation database. Hence, when you record Oracle TIMESTAMP values, no rows are inserted into the database stub. To work around this problem, you must use a separate Oracle schema for the database stub.