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.
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.
Modifying or deleting data masks
To modify a schema specific data mask in your HCL OneTest™ API project, use the Schema Library view of the Architecture School perspective. To delete a schema specific data mask, use the Recording Studio perspective or the Schema Library view. To modify a non-schema specific data mask in your HCL OneTest API project, use the Rule Cache view of the Architecture School perspective. To delete a non-schema specific data mask, use the Recording Studio perspective or the Rule Cache view.

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.
  - 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.
    - Creating non-schema specific data masks
      In the Recording Studio perspective, you can create a non-schema specific data mask in a HCL OneTest™ API project. The mask will replace sensitive data in specified fields in messages recorded against any schema and, thus, prevent that data from appearing in any assets created from those messages.
    - Creating schema-specific data masks
      In the Recording Studio perspective or the Schema Library view of the Architecture School perspective, you can create a schema-specific data mask in your HCL OneTest™ API project. The mask will replace sensitive data in specified fields in messages recorded against the schema and, thus, prevent that data from appearing in any assets created from those messages.
    - Modifying or deleting data masks
      To modify a schema specific data mask in your HCL OneTest™ API project, use the Schema Library view of the Architecture School perspective. To delete a schema specific data mask, use the Recording Studio perspective or the Schema Library view. To modify a non-schema specific data mask in your HCL OneTest API project, use the Rule Cache view of the Architecture School perspective. To delete a non-schema specific data mask, use the Recording Studio perspective or the Rule Cache view.
    - Specifying data masking permissions
      HCL OneTest™ API permissions enable a project administrator to specify which users can create, modify, and delete data masks. This prevents unauthorized users from deleting data masks in a project and using sensitive data to create test assets.
- 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.

Modifying or deleting data masks

To modify a schema specific data mask in your HCL OneTest™ API project, use the Schema Library view of the Architecture School perspective. To delete a schema specific data mask, use the Recording Studio perspective or the Schema Library view. To modify a non-schema specific data mask in your HCL OneTest™ API project, use the Rule Cache view of the Architecture School perspective. To delete a non-schema specific data mask, use the Recording Studio perspective or the Rule Cache view.

About this task

If permissions in HCL OneTest™ API are being used to control which users can create, modify, or delete data masks, you may require permissions before you can modify or delete data masks.

Note: This topic describes only the Schema Library method of modifying or deleting a schema specific data mask and the Rule Cache method of modifying or deleting a non-schema specific data mask.

Procedure

To modify or delete a schema specific data mask, complete the following tasks:
1. Open the Schema Library view of the Architecture School perspective.
2. On the left side of the view, select the relevant schema category.
3. Under Schemas, select the relevant schema.
4. In the Operation list on the Config tab, select the relevant operation.
5. In the Operation list on the Config tab, select the relevant operation.
6. Select the text node of the relevant message element.
7. Click the Data Masking tab (if required).
8. If you want to modify the selected mask:
  - Make your changes on the Technique Configuration area.
  - Click Save.
9. If you want to delete the selected data mask, click Delete.
To modify or delete a non-schema specific data mask, complete the following tasks:
1. Open the Rule Cache view of the Architecture School perspective.
2. On the left side of the view, select the relevant data mask.
3. If you want to modify the selected mask:
  - On the Config tab, enter or edit a comment in the Comment field.
  - Click Save.
4. If you want to delete the selected data mask, click Delete.

Results

If you modified a schema specific or non-schema specific data mask, the configuration of the data mask is updated.

If you deleted a schema specific data mask, the data mask is removed from the Schema Library view window.

If you deleted a non-schema specific data mask, the data mask is removed from the Rule Cache view window.