Home
Reference Guide
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.
Results Gallery
You use the Results Gallery perspective to view an execution summary and detailed coverage, and error reports for executed test suites and for test cases that were executed within a suite or as part of a test cycle.
Viewing the execution results of stubs
Summary and detailed reports can be displayed for one stub at a time. Results that are specific to a stub can be listed in the Results Gallery.

Reference Guide
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.
- HCL OneTest™ API overview
  This section provides an overview of HCL OneTest™ API, including information about projects and files, the HCL OneTest API user interface, environments, and project settings and preferences.
- Architecture School
  Use the Architecture School perspective to build a system under test by using the logical, physical, and synchronization views. You can also use this perspective to manage the schemas available in your project.
- Recording Studio
  With HCL OneTest™ API, you can record events (messages or database interactions) sent to and from the system under test. Use Recording Studio to control what parts of the system should be recorded. These parts could be specific parts of the system infrastructure or specific services using that infrastructure. You can then use the recorded events as a source of tests and other interactions with the system. In Recording Studio, you can record the traffic over a number of different transports.
- Test Factory
  The Test Factory perspective is one of the main areas in HCL OneTest™ API. You can create all the tests and the required artifacts/data to support them.
- Test Lab
  You use the Test Lab to execute test assets, repair tests, and open test assets for editing directly from this perspective. You can execute all of the tests, test suites, and stubs that are created in Test Factory.
- Results Gallery
  You use the Results Gallery perspective to view an execution summary and detailed coverage, and error reports for executed test suites and for test cases that were executed within a suite or as part of a test cycle.
  - Viewing the execution results of a test suite
    Summary and detailed reports can be displayed for one test suite instance at a time. An execution summary for the selected test suite instance is displayed at the top of the Results Gallery perspective. Results that are specific to a test suite instance can be listed in the Results Gallery. The results of one or more test suite instances can be deleted from the results database directly within the Results Gallery or from the command line.
  - Viewing the execution results of test cases and test case instances
    Execution results can be displayed for test cases that were executed as part of a test suite. Summary and detailed reports can be displayed for one test case at a time. An execution summary for the selected test case is displayed at the top of the Results Gallery perspective. Results that are specific to a test case instance can be listed in the Results Gallery.
  - Viewing the execution results of stubs
    Summary and detailed reports can be displayed for one stub at a time. Results that are specific to a stub can be listed in the Results Gallery.
  - Viewing the results of test cycles
    Summary and detailed reports can be displayed for one test cycle at a time. An execution summary for the selected test cycle is displayed at the top of the Results Gallery perspective.
  - Detailed reports
    You will find a collection of detailed reports below the suite execution summary that you can view for any selected test instance. If you are using Test Cycles and want coverage reports, you must still execute the applicable tests from within a test suite. In other words, coverage reports are not produced for tests that are executed outside of a test suite.
  - Reports, console output, and notes
    In HCL OneTest™ API, you can save, print, and copy reports by using the icons that are displayed above the current report.
  - Notes®
    Under the Notes tab, you can apply a label to the selected test suite instance, making it easier to identify a specific run, other than the date, or time of the test run in the Results view. You can also enable the Keep result option for the selected instance, which designates that results for the selected instance must not be deleted. The ID of the current user and the current date are stored when this option is enabled.
  - Populating the suite details for past test runs
    If you use a database schema earlier than version 1.9.24.b, detailed reports for tests that were executed against that schema from within a suite are not available in the Results Gallery. If you are now using schema version 1.9.24.b or later, the containing suite details for such tests can be populated in the database.
- Messages
  HCL OneTest™ API can publish and subscribe to messages as part of a test. A message normally consists of two parts: a header and a body. The header usually adheres to a predefined logical construction, while the structure of the body can be more arbitrary.
- Schemas
  HCL OneTest™ API can handle many types of content. For the product to be able to interpret the variety of content types, it must associate a content format description, or schema with the content.
- Database resources, connections, and bindings
  HCL OneTest™ API can interact with any database that supports connectivity through the JDBC specification. These interactions can be used to extract or update data where necessary, and test data sets can be taken directly from database table content.
- Identity stores and SSL
  An identity store can group a collection of one or more certificates that can be used in HCL OneTest™ API to validate and authenticate connections that use SSL. After you create an identity store, you can use it to enable SSL communications in various messaging transports.
- Scripting within tests and stubs
  You can use scripts in HCL OneTest™ API that include the HCL OneTest API legacy scripting language, ECMAScript (such as JavaScript™), Chai, or any third-party scripting language that you install.
- External tools
  HCL OneTest™ API is primarily GUI-based, but you can also run or view tests, suites, and stubs outside of the HCL OneTest API.
- Test actions
  Actions are the building blocks of a test. A test consists of a series of steps and each step is an action. Actions can be defined for tests and stubs.
- Formatting and parsing date-time patterns
  For some fields in HCL OneTest™ API, you can define patterns for date-time formatting. Pattern letters are repeated, as their number determines the exact presentation of the date-time information that they represent.
- The Add Numbers service
  The Add Numbers service, included with HCL OneTest™ API, provides a simple way to generate messages that you can observe with topology discovery or capture in Recording Studio.

Viewing the execution results of stubs

Summary and detailed reports can be displayed for one stub at a time. Results that are specific to a stub can be listed in the Results Gallery.

Follow the steps to select a stub in the Results Gallery. A list of results that are related to this stub can then be viewed or deleted. If you select a stub in Test Factory or Test Lab perspective, and you switch to the Results Gallery perspective, the selected stub's results are displayed automatically.

Select Stub as the resource type and click Browse next to the Resource field.
Locate and select the stub in the project resource dialog then click OK. The selected stub is displayed, containing results for all resources that were executed against it. If you do not see an expected instance, click the Reload icon to refresh the contents of the menu.

The results of one or more stubs can be deleted from the results database directly within the Results Gallery or from the command line.

Orphaned stub results are stub results that are not produced from running a suite or when produced as part of a test cycle. These orphan stub results can be deleted from the Results Gallery by clicking the Delete icon

on the main toolbar of HCL OneTest™ API. After you click the icon, the Delete Results dialog is displayed, providing you several options for how to delete result data.

To delete only the selected results (that is, the results selected from the current stub), enable the Delete currently shown results option.
To delete multiple result sets for the selected stub, enable the Delete results up to and including option. Enter the date for which all results and all earlier results are to be deleted. You can use wildcard options to delete a broader range of data:
- For ALL stubs, you can delete results for all stubs before and including the selected date.
- For ALL projects, you can delete all stub results in all projects within the database before and including the selected date.

Warning: After you delete all test results and project data in the results database, you must restart any HCL OneTest™ API workbench instances or HCL OneTest™ API Agent instances that were using that results database.

For more information on the commands that delete orphan stub results, see Deleting historical test results data by using the command line