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.
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.
Repairing validation failures
If a message fails validation, you can repair the differences directly from the Console. Right-click the Console entry that details the failure and select a repair option.

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.
  - Open a test asset for editing
    Use Test Factory to open test assets can be opened for editing, either directly from the Test Execution tree or from a test assets entry in the Task Monitor.
  - Executing a test asset
    Test assets can be executed in the Test Lab in several ways.
  - Stopping the execution of a test asset
    If the execution of a test asset is in progress, you can stop it at any time by clicking the Stop selected icon in the Task Monitor toolbar.
  - Copying the resource execution URL of an asset
    To copy the resource execution URL for any test or test suite that has an entry in the Task Monitor of the Test Lab, right-click the entry and click Copy Link.
  - Viewing message differences to repair validation errors
    After a message passes or fails validation, you can view the expected message and the received message in the Message Differences window. To open the window, click the entry in the console that details the difference or the passed assertion, or right-click the Console entry and click Show Differences.
  - Repairing validation failures
    If a message fails validation, you can repair the differences directly from the Console. Right-click the Console entry that details the failure and select a repair option.
  - Opening a failed test action
    If a test fails because of a failed test action, you can open the failed test action directly from the Console. An example could be a message that is not received within the timeout period.
  - Overwriting messages that use validation rules
    If an expected message contains one or more fields that use validation rules, you must specify how to handle the rules when you overwrite the message from the Test Repair Wizard or from the console.
  - The Test Repair wizard
    The Test Repair wizard can be used to fix validation errors in one or more executed tests. To launch the wizard, select the entries of the tests to repair in the Task Monitor and click the Launch Test Repair Wizard icon in the toolbar.
- 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.

Repairing validation failures

If a message fails validation, you can repair the differences directly from the Console. Right-click the Console entry that details the failure and select a repair option.

Overwrite Expected Field: Replaces the value in the expected message with the value from the corresponding field in the received message.
Replace With Regular Expression Match: Replaces the value in the expected message with a regular expression. For example, A004532 would be replaced by ^A\d{6}, which would match the letter "A" followed by any six digits. If a regex match does not apply to the selected message fields, the option is not displayed.
Replace With Regular Expression Match and Cache: Replaces the value with a regular expression, and creates a rule to apply the same expression when a similar field is encountered. Similarity is computed according to its path relative to the root of the message. If a regex match does not apply to the selected message fields, the option is not displayed. A star is displayed in the affected field in the message editor. For more information, see Rule Cache overview.
Disable Field Validation: Modifies the test action, disabling validation of the field that was different.
Disable Field Validation and Cache: Disables field validation and creates a rule to disable validation when a similar field is encountered. For more information, see Rule Cache overview.
Overwrite Expected Message: Replaces the entire expected message with the contents of the message that was received. During the Overwrite Expected Message action, the filter field values specified for the messages are still maintained except while replacing the schema.