Home
Rational® Integration Tester
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.
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.
Running or scheduling the running of a test
You initiate a test execution in the Test Factory, but the test is run in the Test Lab perspective. After you start a test, the Test Lab perspective is displayed, from where you monitor the tests execution. A test can be run either in the current environment or in any other environment.

Rational® Integration Tester
- Release Notes
  This document contains information about What's new, installation, known issues, and contact information of IBM Support.
- System Requirements
  This document includes information about hardware and software requirements for HCL OneTest™ API.
- Getting Started
  This guide provides an overview and describes the tasks to get you started with HCL OneTest™ API.
- Administrator Guide
  This guide describes how to install HCL OneTest™ API. After you install the software, you can perform administration tasks such as configuration and integration of the product. This guide is intended for administrators.
- Tester Guide
  This guide describes the tasks that you can perform for testing various domains, technologies, and applications. To enable testing, you must configure and enable the environment for testing.
- Test Manager Guide
  This guide describes the tasks that you can perform for tracking the quality of the application. This guide is intended for Test Managers.
- Troubleshooting HCL OneTest™ API
  While working with HCL OneTest™ API, you might encounter some problems that you can easily troubleshoot.
- 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 phases
        A new, empty test always consists of three basic phases: Initialize, Test Steps and Tear-down.
      - Test views
        Two views are available for a test, the Technical View and the Business View .
      - Creating a single empty test
        You can create a single empty test in HCL OneTest™ API,
      - Creating a single test by using MEP
        An operations Message Exchange Pattern (MEP) defines the pattern, schema, and binding for messages that are exchanged by the operation. You can use this information to create a test that adheres to the rules defined in the MEP.
      - Creating multiple tests by using MEP
        An operations Message Exchange Pattern (MEP) defines the pattern, schema, and binding for messages that are exchanged by the operation. Use this information to create multiple tests with the help of the MEP wizard.
      - Creating a test from a template
        After you create a test template, you can quickly create new tests from it.
      - Creating tests by pasting
        You can create one or more tests by pasting one or more lines of text that are currently on the clipboard. New tests are named according to the pasted text. Each line of text on the clipboard creates a unique test, and the tests are created within the component or folder that is selected when pasting.
      - Creating tests from recorded events
        Tests can be created by using events that are captured in the Recording Studio.
      - Setting the Test properties by the input and output tags
        Use the Properties tab to define which tags are to be available on the input and output interface for the selected test.
      - Overriding the inherited integration for change management applications
        HCL OneTest™ API can be integrated with OSLC-compliant change management systems for raising defects within the context of a HCL OneTest API test asset.
      - Changing the contents of a test
        You can add or edit test actions, change the test action type, enable or disable test actions, and save messages as requirements.
      - Filtering header values
        If you are using a stub to test more than one web service from a single URL, you can use header values to distinguish between the services.
      - Monitoring a log file during a test
        If a log file is configured on any of the bound infrastructure components of the project, that file can be monitored during the execution of a test.
      - Example: Monitoring a remote log file
        In this example, you add a log file to a database server. With the log file added, you can then monitor that file when you run a test.
      - The Tag Data Store
        The Tag Data Store, which is accessed from the menu anywhere within a test, is the repository and access point for all of the data tags that are available to a test.
      - Message cases
        Message cases are used in Message Switch actions. To add a message case to an existing message switch, right-click the message switch and select Add Message Case from the menu.
      - Pass paths
        You can define action sequences to be carried out when a subscription-based action passes (that is, Subscribe, Receive Request, and Receive Reply).
      - Failure paths
        To specify that a test take different steps when a specific action fails, you can create a failure path and define sequences of actions for it. For example, a Publish action can fail to publish a message, or a subscriber can fail to subscriber properly or an incoming message might not pass validation.
      - Running or scheduling the running of a test
        You initiate a test execution in the Test Factory, but the test is run in the Test Lab perspective. After you start a test, the Test Lab perspective is displayed, from where you monitor the tests execution. A test can be run either in the current environment or in any other environment.
      - Creating performance tests
        A performance test includes one or more instances of a HCL OneTest™ API test plus a number of probes that measure the load on external systems (for example, messaging servers). The following describes how to create a performance test.
    - 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.
    - 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, error, and performance 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™), 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.
- Security Considerations
  You can take certain actions to ensure that your installation is secure, customize your security settings, and set up user access controls.
- Notices
  This document provides information about copyright, trademarks, terms and conditions for product documentation.

Running or scheduling the running of a test

You initiate a test execution in the Test Factory, but the test is run in the Test Lab perspective. After you start a test, the Test Lab perspective is displayed, from where you monitor the tests execution. A test can be run either in the current environment or in any other environment.

About this task

Note: For the tests that pass, you can avoid storing the messages that are sent and received during the test execution in memory. To do this, open the Properties page in the Test editor and select the Free up memory associated with messages sent and received when test execution passes option. If a Test Cycle is used to store the tests in a database, the messages of the passed tests can still be viewed in the Results Gallery.

Running tests in the current environment

Depending on the current Run Resources preferences, the test is run from its current state (including any unsaved changes) or from its last saved state.

About this task

To change the state from which a test is run, see Changing preferences.

A test can be run in any of the following ways:

Procedure

Select one or more tests, and press F5.
Right-click one or more tests, and select Run from the menu.
Select one or more tests, and click the Run icon in the main HCL OneTest™ API toolbar.
If the test was run recently, click the small arrow next to the Run icon in the main toolbar and select the test to run.

Scheduling the running of a test

To run a test in an environment other than the current environment, or to schedule the running of the test, use the custom execution dialog box.

Procedure

Open the custom execution dialog in one of the following ways:
- Select a test and press Shift + F5.
- Right-click a test and select Run from the menu.
- Select a test, click the small arrow next to the Run icon in the main toolbar, then select the Run option.
  The Run test window is displayed.
Select the environment in which the test is to be run from the Environment list.
In the Execution Preference section, select one of the following options:
Run now locally

No further options are required.

Run later
- Select items for the Attributes field. These attributes are used to determine the engine to run the test at the scheduled time or times.
- Provide information in the Schedule section to specify when the test is run.
Click Run to run the test.