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.
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.

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.
- 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.

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.

Several methods of externally running or viewing HCL OneTest™ API test artifacts are available:

Command-line: After they are created in the GUI, tests, stubs, and suites can be run manually or in an automated fashion from the command line. For details, see Running tests by using the command line.
Apache Ant: HCL OneTest™ API can generate a custom Apache Ant script that runs selected tests or suites as part of your overall build process. For details, see Generating Ant scripts to run tests or suites.
VAPI-XP: HCL OneTest™ API can generate a VAPI-XP Java™ script that can be pasted into HP Quality Center to run the selected test, suite, or stub as part of your Quality Center test plan. For details, see Generating VAPI-XP scripts with HP Quality Center.
HP QuickTest Professional: You can run resources from HCL OneTest™ API from QuickTest Professional (and vice versa) by using scripting and command-line options in both the tools.
Jenkins: You can run or view tests and suites within Jenkins. For details, see HCL OneTest API and Jenkins.
Maven: HCL OneTest™ API can generate a Maven script that runs selected stubs, tests, or suites as part of your Maven build process. For more information, see Generating Maven scripts to run stubs, tests, or suites.

Note: If command line or Apache Ant execution is used in projects that use permissions, single sign-on must be configured. For single sign-on configuration, add a properly configured krb5.ini file (one that includes your realm and key distribution center) to your Windows™ directory (typically C:\WINDOWS). Alternatively, provide these details as arguments in Library Manager (for command line) or within the Apache Ant script (manually added). For more information, see Working with Library Manager.