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.
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.
The Logical View
The Logical View provides an abstract model of the system under test. You can visualize the Service and Infrastructure Components, their dependencies, inputs and outputs, and the interface patterns in this view. Use the toolbar to add resources. Use the right side of the toolbar above the drawing palette to build and modify the system under test.
External synchronization resources
You can add Infrastructure Components such as WSDL, webMethods Integration Server, TIBCO BusinessWorks Project or Design Time Library, SAP System, and SCA Domain (Oracle Fusion) as synchronization resources that can be synchronized with your HCL OneTest™ API project.

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.
  - The Logical View
    The Logical View provides an abstract model of the system under test. You can visualize the Service and Infrastructure Components, their dependencies, inputs and outputs, and the interface patterns in this view. Use the toolbar to add resources. Use the right side of the toolbar above the drawing palette to build and modify the system under test.
    - Creating a service component
      Service components serve as a container for all the other elements. You can house other service components within a service component to build complex logical structures.
    - Creating and monitoring an infrastructure component
      Infrastructure Components help you communicate with the operations defined in the system. You can create an infrastructure component either from the toolbar or the menu. You can also associate a log file with an infrastructure component for monitoring purposes.
    - Creating dependencies
      Dependencies are references between one operation and another, or between an operation and an infrastructure component. You can create dependencies within the same service component or extend them to include other elements as well. Outgoing dependencies are displayed in lavender, and incoming dependencies are displayed in green. Follow these steps to create dependencies between items in the logical view:
    - Editing and viewing component details
      You can modify a component's name, parent, bindings, and description. You can also expand and collapse components. If an infrastructure component is bound to a physical resource in the current environment, you can view the component's physical resources.
    - Creating an operation
      You can create an operation by using the menu or toolbar of the service component that can contain the operation.
    - Editing an operation
      You can edit the component details of an operation in the operations editor.
    - Setting the focus on a specific component
      For some projects (even for a simple BusinessWorks or web services project), you can quickly accumulate many operations, components, and dependencies in the Architecture School Logical View and set the focus.
    - Hiding dependencies
      You can hide dependencies or filter them out of your view in a number of different ways.
    - External synchronization resources
      You can add Infrastructure Components such as WSDL, webMethods Integration Server, TIBCO BusinessWorks Project or Design Time Library, SAP System, and SCA Domain (Oracle Fusion) as synchronization resources that can be synchronized with your HCL OneTest™ API project.
  - The Physical View
    The Physical View displays available physical resources and their location within the enterprise. Resources in this view are organized by subnet and host. If a resource is not associated with a subnet or host, it is displayed under Unconnected Resources.
  - Synchronization view
    Synchronization enables you to add external resources to your project, view resources that were added, and synchronize those resources with your local system. The biggest benefit of synchronization is that it can create many test artifacts in a short time without errors. If you are testing one of the supported resources, synchronization does all the work of building the system under test automatically.
  - Schema Library overview
    In the Schema Library, you can view and manage the schemas and message formats that are available in your project. You can add, rebuild, and delete schemas, and apply schema-specific data masks.
  - The Data Model view
    A data model stores a small quantity of data from the system under test and keeps it in memory at run time. It provides many of the features of a database while requiring a much smaller overhead.
  - Rule Cache view
    When validation errors are repaired and cached, the repair method is saved as a validation rule. These rules are applied to the same field from which they are created when the same schema is in use. You manage the rules in the Rule Cache view in Architecture School. You also use the Rule Cache view to view, modify, or delete non-schema-specific data masks.
  - Environment Tasks view
    Use the Environment Tasks view to configure test environments. You can define environment configuration tasks by adding and configuring a limited set of actions. You can then associate these environment tasks with stubs. Doing so ensures that test environments are set up correctly before stubs or scenarios are run, and that environments are closed down properly.
  - Topology Discovery overview
    Topology discovery is the process of observing and modeling the components of a system under test.
- 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 synchronization resources

You can add Infrastructure Components such as WSDL, webMethods Integration Server, TIBCO BusinessWorks Project or Design Time Library, SAP System, and SCA Domain (Oracle Fusion) as synchronization resources that can be synchronized with your HCL OneTest™ API project.

For more information about external resources and synchronization, see Synchronization view.