Home
Getting Started
This guide provides an overview and describes the tasks to get you started with HCL OneTest™ API.
HCL OneTest™ API overview
You can use HCL OneTest™ API to create, modify, and run service tests.
Task flow: Basic test scenario
A diagram is provided to show you a basic task flow that can help you get started with some of the features of the tool to test the system. After you configure the complete setup for testing, you can do the tasks in sequence to test the application.

Getting Started
This guide provides an overview and describes the tasks to get you started with HCL OneTest™ API.
- HCL OneTest™ API overview
  You can use HCL OneTest™ API to create, modify, and run service tests.
  - Interactive Guides
    The home page contains several interactive guides that walks you, step by step, through some of the common tasks.
  - Task flow: Basic test scenario
    A diagram is provided to show you a basic task flow that can help you get started with some of the features of the tool to test the system. After you configure the complete setup for testing, you can do the tasks in sequence to test the application.
  - Task flow: Advanced test data scenario
    A diagram is provided to show you an advanced task flow that can help you get started with resources, environments, schemas, and test suites to test the system. After you configure the complete setup for testing, you can do the tasks in sequence to test the application.
- Testing methodology
  By following four basic guidelines, you can incorporate HCL OneTest™ API into your testing methodology. These guidelines drive efficient and expedient integration testing, and they can be applied to your testing process and infrastructure requirements.
- Service-oriented architecture (SOA) testing
  A SOA consists of business processes that are implemented by linking individual services. The linking can be done programmatically or with tools based on Business Process Execution Language (BPEL). SOA testing can be challenging because there is no GUI; the focus is on testing interfaces and services.
- Getting started with testing
  You can start using HCL OneTest™ API by completing the preliminary tasks such as creating and running a test, creating and running a stub, recording an HTTP proxy, and running a stub in a Docker container.
- HCL® Quality Server overview
  HCL OneTest™ Virtualization stubs designed in HCL OneTest API are published to HCL® Quality Server, which holds them in a repository.
- HCL OneTest™ API accessibility features
  Users who have a physical disability, such as limited vision, can review the available accessibility features to use HCL OneTest™ API.

Task flow: Basic test scenario

A diagram is provided to show you a basic task flow that can help you get started with some of the features of the tool to test the system. After you configure the complete setup for testing, you can do the tasks in sequence to test the application.

Basic test scenario task flow

Create a project: After you have set up the results database and configured the required setup to enable testing the system under test, start HCL OneTest™ API and create a new project. Creating a new project goes through various stages where you must specify the project name and location. You can optionally specify the details for connecting to the results database and HCL® Quality Server, also set up user-based permissions and the change management integration.
Model the system under test: You can use the Synchronization option to build a model of the system under test. This process analyzes the services and infrastructure provided by the system and replicates that within the Architecture School perspective. The synchronization process sets up the logical and physical views, an environment, and any message schemas that are used by the various services in the system. To perform this operation HCL OneTest™ API requires a valid connection and the supported synchronization source to exist within the system under test, so that it can request information on the system.
Record events and create tests: Use the recording studio to record events in the system. You can then create tests from the recorded events in the Events view. You can create Integration tests or Unit tests or both type of tests from the recorded events. The Integration test creates a test that is based on the actions in the selected events, and Unit test creates a test that is based on the message exchange pattern types of the selected operations.
Running or scheduling the running of a test: You can initiate the execution of the test from the Test Factory. The tests run and can be viewed in the Test Lab perspective.
View test results: You can view the execution summary and the detailed coverage, and error reports for executed tests in the Results Gallery perspective.