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.
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.
Test cycles overview and management
A test cycle is a container for tests and test suites that spans multiple users and projects. The result of each test that is executed inside a Test Cycle is persisted to the database, regardless of whether the test is inside a suite or not. To work with test cycles, you use the Test Cycle Manager window.
Joining and unjoining a test cycle
The current project can be associated with a new or existing Test Cycle by using the Test Cycle Manager. Also, the association between the current project and a Test Cycle can be removed by using the Test Cycle Manager.

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.
  - HCL OneTest™ API projects
    When you launch HCL OneTest™ API, a welcome dialog is displayed that you can use to create a new project or open an existing one. All work is organized into individual projects, similar to a development IDE. This organization allows for simpler organization of complex test scenarios.
  - HCL OneTest™ API workbench
    The main window of HCL OneTest™ API is a workbench that contains several dockable windows. These windows are organized in a logical way, providing an intuitive, easy-to-use central workspace. You can view the workbench from one of several perspectives: Architecture School, Recording Studio, Test Factory, Test Lab, and Results Gallery.
  - Test artifact documentation
    All HCL OneTest™ API test artifacts (for example, tests, suites, messages, test templates) contain a Documentation tab in their respective editors.
  - Tags for dynamic data access
    Tags are like data variables in HCL OneTest™ API, consisting of a name and a default value. Tags can be used throughout the application to allow for dynamic data access. Tags can be used in most fields within HCL OneTest API (for example, message headers, body elements, function definitions).
  - Environment properties, bindings, and tasks
    Environments are typically used to create configurations for different parts of a product workflow (for example, Development, QA, UAT).
  - Test cycles overview and management
    A test cycle is a container for tests and test suites that spans multiple users and projects. The result of each test that is executed inside a Test Cycle is persisted to the database, regardless of whether the test is inside a suite or not. To work with test cycles, you use the Test Cycle Manager window.
    - Creating and editing test cycles
      You can create and modify test cycles from the Test Cycle Manager.
    - Joining and unjoining a test cycle
      The current project can be associated with a new or existing Test Cycle by using the Test Cycle Manager. Also, the association between the current project and a Test Cycle can be removed by using the Test Cycle Manager.
    - Closing, deleting, and reopening test cycles
      Closing a test cycle removes any associations immediately for the current user. Inactive (closed) test cycles can be reopened at any time. Deleting an inactive test cycle deletes all results stored with it.
    - Pausing test cycles
      You can pause the projects currently associated test cycle at any time, temporarily disabling the test cycle functionality (that is, any tests that are executed while paused are not stored with the test cycle).
  - Changing preferences
    You can customize much of HCL OneTest™ API behavior by changing the default settings for the application preferences.
  - Refreshing a project
    When you are working in a project in HCL OneTest™ API and you click Project > Refresh to refresh the project, the Save Resources dialog is displayed that prompts you to save or discard unsaved changes in the editors that are open.
  - Creating an email publisher
    You can set up an email as a result publisher.
- 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.
- 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.

Joining and unjoining a test cycle

The current project can be associated with a new or existing Test Cycle by using the Test Cycle Manager. Also, the association between the current project and a Test Cycle can be removed by using the Test Cycle Manager.

Joining a test cycle

To join a new test cycle to a project, see Creating and editing test cycles.
To join an existing test cycle, select it in the Test Cycle Manager and click Join.

After the current project is joined to a test cycle, you can specify which environments to use under the Environments panel in the Test Cycle Manager.

To see more details about the test cycle (that is, current and previously associated projects and joined users), select the test cycle and click Details.

Unjoining a test cycle

To remove the association between the current project and a Test Cycle, in the Test Cycle Manager, select the projects current Test Cycle (displayed in bold and italicized type) and click Unjoin .

Note: The removal of the project from the Test Cycle occurs immediately for the current user. For any other users, the change is realized the next time that the project is loaded.

To see more details about the test cycle (that is, current and previously associated projects and joined users), select the test cycle and click Details.