Home
HCL OneTest™ API reference
HCL OneTest™ API is a scripting-free environment for developing tests for service-oriented architecture (SOA) messaging and business process integration projects. Tests can be built by recording existing system behaviors or from requirements, by entering the data to send and the data that is expected in return.
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 suites: Overview and tasks
A Test Suite represents a group of tests, test suites, and scenarios. Any combination of these items can be included, but a test suite must always contain at least one scenario and one test. Test suites are used mainly to construct reusable, packaged regression tests that can be run across multiple environments, or repeatedly within the same environment.
Results publishers
To automatically publish the results of a test suite after it is run, use Results Publishers, which is created under Project Settings. Specify the publishers to use and the details of the results to publish and how to publish them on the Results Publishers tab.
Working with file results publishers
To automatically publish the results of a test suite after it is run in HCL OneTest™ API, you can use the Results Publishers feature.

HCL OneTest™ API reference
HCL OneTest™ API is a scripting-free environment for developing tests for service-oriented architecture (SOA) messaging and business process integration projects. Tests can be built by recording existing system behaviors or from requirements, by entering the data to send and the data that is expected in return.
- 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.
  - Tests: Overview and tasks
    Tests are the fundamental building blocks of integration and SOA testing. A test sends an input message to an external service or system in a protocol-specific way and validates the reply against an expected result.
  - Test suites: Overview and tasks
    A Test Suite represents a group of tests, test suites, and scenarios. Any combination of these items can be included, but a test suite must always contain at least one scenario and one test. Test suites are used mainly to construct reusable, packaged regression tests that can be run across multiple environments, or repeatedly within the same environment.
    - Manipulating the contents of a test suite
      Scenarios, test suites, and tests can be added to or removed from an existing test suite. They can be moved up or down within the scenario that contains them. Scenarios can be edited within a test suite. The item trees within a test suite can be expanded or collapsed. All of the test suite actions can be done by using the test suite toolbar or by right-clicking an item and using the menu.
    - Test suite scenarios
      In a test suite, a scenario controls how to execute the items it contains. A scenario can be added to a test suite.
    - Results publishers
      To automatically publish the results of a test suite after it is run, use Results Publishers, which is created under Project Settings. Specify the publishers to use and the details of the results to publish and how to publish them on the Results Publishers tab.
      - Working with file results publishers
        To automatically publish the results of a test suite after it is run in HCL OneTest™ API, you can use the Results Publishers feature.
    - The Continue on Fail option
      By default, all items in a test suite are executed when the suite is executed, regardless of whether previous items pass or fail. Depending on the nature of the tests it contains, however, the execution of a test suite can be terminated if one or more specific test items fail. This behavior is controlled with the Continue on Fail option, which can be set independently for each item in a suite.
    - Test suite execution
      Test suite execution can be initiated in the Test Factory, but the suite is run in the Test Lab perspective.
  - Stubs: Overview and tasks
    Stubs can be used to simulate services that you are unable to use or that are otherwise unavailable.
  - The Action Editor
    The Action Editor is used to modify the actions that are contained within a test or stub.
  - Creating a test template
    To save time when you are creating tests, you can create a template of test sequences that can be used to quickly create a number of pre-defined tests.
  - Test data sources
    You can configure test data sources that can drive a test template or a test by using several different instances of data. In this way, you can parameterize your tests, substituting specific data from a pre-configured source in different test iterations. You can also use test data to validate the results that are returned by different test actions.
- 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 this 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.

Working with file results publishers

To automatically publish the results of a test suite after it is run in HCL OneTest™ API, you can use the Results Publishers feature.

Before you begin

Ensure that the project settings have valid Connection Details for a Results database and the project has a test suite.

Procedure

Open the project and click Tools > Custom Reports.

The Custom Reports Manager window is displayed.
Click Add. The Add Custom Reports window is displayed.
Enter a name for the report and click Add.

The Add Report Segment window is displayed.
Add details of your custom report in the Additional text field.

For example, you can add the name of the custom report, type of the report, the format of the report, and the method of attachment.
Click OK to save the custom report segment.

The Add Custom Reports window displays the report segment you added.
From the menu in HCL OneTest™ API, go to Project > Project Settings, click the Results Publishers tab and then, click Add.

The Add Result Publisher window is displayed.
Complete the following steps in the Add Result Publisher window.
1. Select the Results Publisher Type to File.
2. Provide a name in the Result Publisher Name field and path location to save the published result file.
3. Click OK. In the Project Settings window, click OK.
Edit a Test Suite that passes all its tests. Navigate to the Publish Results tab.
Click Add.
The Add Results Publisher Settings window is displayed.
Select the option you want for the Results Publisher, Custom Report, and When to publish fields, and then click OK.
Save the test suite.
Run the test suite. The console log of the test indicates the results publishers used.

Results

The Custom Report is published as a file in the specified format and is available in the path specified in Step 7. The file name contains the Custom Report name specified and is appended with the date and time stamp when it was generated. For example, the published Custom Report with the name MyReport_Details_Attached_2018-11-27_12-25-43-810 located in the path c:\Reports\Successful.

What to do next

You can navigate to the folder containing the Custom Report published and open the file to view its contents. Ensure that you have installed the associated readers to open such file formats on your system.