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.
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.
Recording from an ad hoc monitor
Create an ad hoc monitor to record events from a transport rather than from an operation.

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.
  - 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.
    - Capturing events
      You can use the Recording Studio to capture events. The Events View can be used with the Event Monitors view to select events and record them. You can define the destination for recorded events by using tags in the message header properties of selected operation.
    - Recording from an ad hoc monitor
      Create an ad hoc monitor to record events from a transport rather than from an operation.
    - Creating an operation from recorded events
      You can save events, including information from the monitor on which they were recorded, as a new operation.
    - Recording HTTP and HTTPS traffic
      Use the HTTP proxy in the HCL® Quality Server to record all HTTP and HTTPS traffic that is routed through the proxy.
    - Recording TCP traffic
      The HCL OneTest HTTP/TCP Proxy, enables HCL OneTest™ API to record general TCP traffic that is routed through the proxy or to route TCP traffic to stubs automatically when they start instead of routing traffic through the live system.
    - Recording Java™ Message Service (JMS) traffic
      You can use HCL OneTest™ API to record JMS Traffic.
    - Recording MQ telemetry traffic
      You can use HCL OneTest™ API to record MQ telemetry transport traffic by connecting to the MQ telemetry transport broker that you want to use and subscribing directly to topics communicated from that broker.
    - Recording RabbitMQ transport traffic
      The RabbitMQ proxy recording feature (this is not HTTP based) enables HCL OneTest™ API to record RabbitMQ transport traffic that is routed through the proxy.
    - Recording WebSphere® MQ and TIBCO EMS Server events
      Recording for WebSphere® MQ transports is carried out in a different way than other transports. The WebSphere MQ transport does not provide a native method for watching a queue in a non-destructive manner. In other words, events cannot be captured without taking them off the queue.
    - Recording and virtualizing RFCs
      You can record and virtualize SAP application resources. If you are testing a Java™ application that uses the SAP Java Connector (JCo) to make remote function calls (RFCs) to an SAP application server, use HCL OneTest™ API to record and virtualize those calls.
    - Configuring the Recording Studio settings of logical SAP application servers
      You can record SAP application resources by configuring a logical SAP application server to record IDocs. Use the Recording Studio perspective of HCL OneTest™ API to record incoming and outgoing intermediate documents (IDocs).
    - Configuring subscribe operations to record IDoc types
      You can record and virtualize SAP application resources by creating a subscribe operation for a logical SAP application server and configuring it to record a specific IDoc type.
    - Creating event monitors for SAP recordable resources
      Before you can start a recording session, you must create an event monitor in Recording Studio. Do this task after specifying the Recording Studio settings of a logical SAP application server to record intermediate documents (IDocs), or after configuring a subscribe operation for a logical SAP application server to record IDoc types.
    - Recording SQL events
      When the HCL OneTest™ API JDBC proxy is installed, you can use HCL OneTest API and HCL OneTest Virtualization to record SQL events that are executed against databases from applications that use JDBC. There are two methods of selecting a database for recording: Architecture School method and Recording Studio method. Both methods achieve the same result but the Architecture School method is a more direct method.
    - Recording FIX traffic
      You can use HCL OneTest™ API and an HTTP/TCP proxy to record FIX traffic.
    - Recording Java™ method calls
      To record Java™ method calls, you use the Java application that you want to record, an instance of the Java virtualization agent as applicable installed into the application, and a Java method transport in HCL OneTest™ API.
    - Playing back recorded events
      You can select recorded events and replay them in the Recording Studio perspective. You can specify the pacing speed with which the messages are published (as-fast-as-possible, defined interval, or as-original). Rules and functions in the Rule Cache can be used to make basic modifications to message contents as they are published. Playback works on events that have been exported and re-imported.
  - 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.

Recording from an ad hoc monitor

Create an ad hoc monitor to record events from a transport rather than from an operation.

Before you begin

In the early stages of a project, you might not yet have much of the logical architecture of the system. Use this feature to record messages that you can use to build the architecture, tests, and stubs.

To use this feature, you must have a logical transport with a valid binding to a physical transport in the current working environment.

About this task

In some cases, you can record events directly from a transport. Where this option is not available, or where extra software is needed to record directly from the transport, you can create an ad hoc monitor.

Procedure

In the Recording Studio perspective, click the Ad Hoc Monitor icon on the Event Monitors toolbar.
In the Ad Hoc Monitor wizard, provide the following information:

Name

Enter a name to be displayed in the list of Event Monitors.

Transport

Click Browse to display a list of available logical transports in the current project.

Message Type

The available values depend on the value of the Transport field.

Header Information

The available values depend on the value of the Transport field. For more information, see the documentation for the appropriate transport type.

Display Color

Choose a unique color to identify the events that are associated with this monitor.
Click OK.
In the Event Monitor window, select the new ad hoc monitor.
In the Events View window, click Start Recording.

What to do next

After recording from this monitor, you can use the messages in the same way that you use any other recordings, including the following tasks:

Create a test, stub, trigger, or requirement. See Creating test resources from recorded or imported events.
Save messages as a new operation. See Creating an operation from recorded events.