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.
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.
Message bodies
The message body is constructed below the message header in publishers and subscribers.
Defining the validation rules (comparison ignores)
Rules can be added to one or more message fields to define default actions to apply when you are processing similar fields.

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.
- 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.
  - Selecting transports and formatters
    The first step in building a message is to select a transport and formatter, available at the top of the message Config tab.
  - Message headers
    Message headers contain metadata about the message itself (for example, sender and destination details, message properties, message type). Headers for different transports contain different types of information.
  - Message bodies
    The message body is constructed below the message header in publishers and subscribers.
    - Publisher/subscriber views
      The structure of a message is defined when you are using the publish/subscribe actions. In each action type, different views of the message can be selected. On selecting a view, information relating to the storage and validation of the message is displayed.
    - Importing and exporting messages
      You can export the current message or import a previously saved or exported message. The import and export icons at the top of all message editors.
    - Quick tags
      A fast way to insert tags into fields is to use quick tags.
    - Defining the validation rules (comparison ignores)
      Rules can be added to one or more message fields to define default actions to apply when you are processing similar fields.
    - Creating message bodies with non-schema transports
      When you are using transports without a defined message schema (for example, TIBCO Rendezvous), the body of the message must be created manually.
    - Example: Publishing simple message bodies
      A simple message body has a specific structure.
    - Example: Creating simple message bodies for subscription
      In this example, you create a message structure with the more powerful features of the field editor, namely, the ability to validate the structure of a message when it is received and the ability to capture field values and save them to tags. Validation is a key aspect of deciding whether a test passes or fails.
    - Converting a flat XML to structured XML
      A powerful feature of the HCL OneTest™ API message editor is the ability to enter XML in String type fields and then edit the XML in a structured way.
    - Editing XML message structures
      Editing XML is similar to editing normal message structures, but with a few enhancements. The following options in the element menu apply specifically to editing XML.
  - Using repeating and optional elements
    You can use HCL OneTest™ API to create repeating elements within a message from a test data set or to read all values from repeating elements in a received message.
  - Formatting a message with MIME, S/MIME, DIME, and multipart content
    When you are working with messages that can contain multiple parts, you must format the message as a Multipurpose Internet Mail Extensions (MIME) message. You can also apply a MIME or a Direct Internet Message Encapsulation (DIME) schema to the message. You can apply the secure MIME (S/MIME) standard to encrypt or digitally sign outbound messages.
  - Adding attachments to a message
    Attachments can be added to parts of a message by right-clicking the wanted node and selecting Add Attachment from the menu.
  - Configuring the XML message properties for test actions
    By using message properties in HCL OneTest™ API, you can configure how message content is treated in test actions (for example, Publish, Subscribe).
  - Creating messages and applying them to tests
    You can create a message that contains requirements and drag that message onto an action in a test. After you create a message, you can build it by specifying the transports and formatters.
  - Messaging transports, formatters, and dynamic formatters
    HCL OneTest™ API uses a decoupled, plug-in architecture to provide maximum flexibility in regards to the messaging transport software in use by a system under test. A formatter translates messages from the native transport format (for example, TIBCO Rendezvous) to the internal format understood by HCL OneTest API, known as A3 (Accelerated Adaptor Architecture).
  - The Field Editor
    Use the Field Editor to specify that a message field (data attribute) be populated by using or fulfilling certain criteria. Open the editor by double-clicking a field or element name within a message or a stub, by or right-clicking the field and selecting Contents > Edit.
  - Troubleshooting: Messages
    You can use a workaround to a problem that you might encounter when you work with message fields.
- 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.

Defining the validation rules (comparison ignores)

Rules can be added to one or more message fields to define default actions to apply when you are processing similar fields.

To add a rule, in the message editor, select the required fields, right-click one of the fields, and select Rule Cache > Add to Cache from the menu.

Add to Rule Cache window

Any field actions can be copied as part of the rule. In the Add to Rule Cache dialog, only the actions that are currently enabled are selected, as follows:

Value The Enable action box must be checked
Filter A filter action must be present and checked
Validate At least one validate action must be checked
Store A store action must be present and checked

To create a rule for the message field that is based only on the structure of the message, enable the All schemas option. To create a rule for the message field that would be applied only when the selected schema is in use, select the Just this schema option. To add a comment to the rule (making it easier to identify in the Rule Cache view), enter it in the Comment field.

If a single selected field is already using a rule, you can open the rule for editing (in the Rule Cache view of the Architecture School perspective) by selecting Edit Rule from the menu. Additionally, you can enable or disable the rule on selected fields by selecting Enable or Disable from the menu.

Note: The context actions available depend on the state of the selected fields and rules. For example, if some fields use a rule but some do not, only the Enable and Disable options are available, and the Add to Cache option is only available if none of the selected fields are using a rule.