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.
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.
Events view
The Events View displays events that are captured by enabled event monitors. The perspective at the right of Recording Studio is divided into two views: a list of captured events on top and details for the selected event at the bottom. Within the view, you can send a response to selected events or run and manage triggers.

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.
  - Monitor Configuration view
    After you set up the system under test for recording, you can choose what you want to record in the Recording Studio. You can do this by selecting Monitor Configuration (in the upper-left portion of the Recording Studio perspective) that specifies what you want to record. It shares space with the Triggers view. To show the Monitor Configuration view, click the Monitor Configuration tab at the bottom of the view.
  - Events Monitors Properties view
    The Event Monitor Properties view, located directly below the Event Monitors and Triggers view, displays information about the operation that is selected in the Event Monitors view.
  - Events view
    The Events View displays events that are captured by enabled event monitors. The perspective at the right of Recording Studio is divided into two views: a list of captured events on top and details for the selected event at the bottom. Within the view, you can send a response to selected events or run and manage triggers.
    - Specifying the display options in the Events view
      The Events View displays events that are captured in monitored operations, including the details of message bodies and headers for selected events. Several options are available for managing the way information is displayed in the view.
    - Automatically stopping a recording
      By default, the recording operation is manually stopped. However, you can use the Schedule Recording option to automatically stop the recording based on the limit that is set for received messages and the memory usage.
    - Adding or removing columns in the event table
      By default, the event table displays the time stamp, source, and description for each captured event. You can add message fields from a selected event as columns in the event table. You can also remove any custom columns.
    - Sorting data in the events table
      By default, the events in the event table are displayed top to bottom in the order in which they were captured. You can sort the events by the values that are contained in any of the displayed columns.
    - Filtering data in the events table
      You can filter the contents of the event table that is based on existing values in the columns that are displayed in the table, and multiple columns can be filtered at one time.
    - Exporting recorded events
      To save the recorded events, you can export them to a Recording Studio history file or to HCL® Quality Server (HCL Quality Server).
    - Importing recorded events
      When you have recorded events in HCL OneTest™ API, HCL® Quality Server, or any other application and saved it as an HTTP archive file (HAR file) , you can use the Recording Studio feature to import the events. You can then create tests or stubs from the events to run them in HCL OneTest API.
    - Creating test resources from recorded or imported events
      After events are recorded in a monitored operation or if recorded events are imported, you can create a test, stub, trigger, requirement, operation, or test data sources from the selected events in the Events View pane.
    - Adding recorded events to an existing test or stub
      You can add recorded events to an existing test or stub. Adding events can be used to augment a test, or stub, during development.
    - Managing recorded events data
      HCL® Quality Server can be used to manage and share recorded events data exported from HCL OneTest™ API.
  - Triggers view
    A trigger is essentially a publisher that is used to send an event to the system under test. Existing triggers are displayed in the Triggers view, which is in the upper-left portion of the Recording Studio perspective. It shares space with the Event Monitors view. To show the Triggers view, click the Triggers tab at the bottom of the view.
  - Using the Recording Studio
    Use the Recording Studio to monitor and capture events, and use captured events for tests and other artifacts for use within your HCL OneTest™ API project.
  - Data masking concepts, methods, and types
    Use HCL OneTest™ API to add a data mask to particular fields in recorded messages that may contain sensitive data. When you add a mask, you prevent that sensitive data from appearing in any assets created from those messages, such as tests, test data, stubs, and data models.
- 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.

Events view

The Events View displays events that are captured by enabled event monitors. The perspective at the right of Recording Studio is divided into two views: a list of captured events on top and details for the selected event at the bottom. Within the view, you can send a response to selected events or run and manage triggers.

The events table displays the captured events and includes the event sequence ID, the event type, the time when the event was captured, the source of the event, and the event description. The event sequence ID indicates the order in which the selected event was captured during this HCL OneTest™ API session, relative to other events. Captured events can be saved as tests, stubs, triggers, requirements, operations, and test data sets. Within the view, you can send a response to selected events or run and manage triggers.

The displayed details vary according to the type of event.

For message-based events, the message body and header contents are displayed. To apply a new schema to a message-based event, right-click the root node and click Schema.
In the Schema Selector window, select a category, type, schema, and root. The schema need not be a HCL OneTest™ API schema, or a schema that is already available in the Schema Library. For more information, see Applying schemas and formats to messages.
For SQL events, Overview and Result Set tabs are displayed, depending on the type of SQL statement.

The following table lists the details that are displayed for SQL statements.

Table 1. SQL events details
SQL statement	Details displayed
INSERT, UPDATE or DELETE	Overview. SQL Statement. Number of affected rows. Input parameters (for prepared statements only). Optional.
SELECT	Overview. SQL Statement. Input parameters (for prepared statements only). Optional. A result set.
CALL	Overview. SQL Statement. Input parameters. Optional. Output parameters. Optional. Zero, or more, result sets. Note: If an Input parameter and Output parameter have the same index, it indicates that the parameter is an Input/Output parameter.