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.
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.
Storing field data in tags
Storing the value of a field in a tag is most useful when a message is received. You can, however, store a field in a tag when a message is published with dynamically populated field values.

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.
  - 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.
    - Setting a field value
      By using the Value tab, you can change the value of the selected field.
    - Formatting field values
      You can format field values in record layouts or in the message Field Editor.
    - Filtering fields
      User the Filter tab, you can restrict which messages a subscriber receives based on the content of both the header and body of the message.
    - Validating scalar fields
      Validation enables decisions about sent and received messages to be made automatically at test time. A validation is made up of one or more actions.
    - Validating message fields
      For fields that are of the type Message, the contents of the Validate tab changes. The options enables you to validate the structure of a message (or its child elements) rather than its individual attributes.
    - Storing field data in tags
      Storing the value of a field in a tag is most useful when a message is received. You can, however, store a field in a tag when a message is published with dynamically populated field values.
  - 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.

Storing field data in tags

Storing the value of a field in a tag is most useful when a message is received. You can, however, store a field in a tag when a message is published with dynamically populated field values.

Image of the Store tab.

You can store the value under the following action types:

Copy
Regular Expression
Copy Type
XPath Query
JSONPath Query

If you select the Append to list of values option, the tag is updated as a list of values (for example, {val1, val2, val3}) when new values are stored.

The Copy action stores the untransformed value in the specified tag.

If Regular Expression, XPath Query, or JSONPath Query is specified as the action type, you must provide additional details.

Image of the options for the Regular Expression action type.

To store only the field values that match the entered expression or query, select the Match? option.

To store the full response or the complete data that is returned by the Regular Expression, XPath Query, or JSONPath Query, select the Data option.

To extract a portion of repetitive data, the relevant part of which is identified only by its position, select the Instance option and provide an instance number if there are multiple instances. The default value is 1.

For example, if the value of the field is '12:02:05', to extract the minutes portion (02) to be stored in a tag, specify the following regex:


(\d\d)

This expression specifies a group definition that matches the numeric parts of the data. In this case, since you are interested in the minutes entry, you would extract the instance 2.

Note: When you extract data by using regular expressions, use brackets to indicate what is to be extracted rather than what is to be matched.

To help in building regular expressions, XPath queries, or JSONPath queries, a testing utility is available. By clicking Test, you can verify your expression against any arbitrary content without waiting for a full test to run to show the results.

Values to validate against can be entered in the Document field. Alternatively, you can click Browse to locate and select a test document, the contents of which are loaded in the Document field.

Selecting transports and formatters

Message headers

Using repeating and optional elements

Adding attachments to a message

Configuring the XML message properties for test actions

The Field Editor