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.
Schemas
Test Integrations and APIs 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.
Record layouts
You can use record layouts in Test Integrations and APIs to define a file schema to process and validate messages that use a customized schema or format.

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.
- DevOps Test Integrations and APIs overview
  This section provides an overview of HCL DevOps Test Integrations and APIs (Test Integrations and APIs), including information about projects and files, the Test Integrations and APIs 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 Test Integrations and APIs, 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 Test Integrations and APIs. 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
  Test Integrations and APIs 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
  Test Integrations and APIs 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.
  - Adding a schema
    You can add a single schema or a directory that contains multiple schemas to the Schema Library view after which you can apply the schema to messages in your tests. You can specify the type of schema to add or use Test Integrations and APIs to determine the type.
  - ISO 8583 schemas: Overview and structure
    Test Integrations and APIs supports the ISO 8583 standard for messages that originate in financial transaction cards.
  - Adding SWIFT schemas
    When you want to apply SWIFT schema to messages in your tests, you can add additional SWIFT schemas to the Schema Library in the Architecture School perspective of Test Integrations and APIs.
  - COBOL Copybooks overview
    Use COBOL Copybooks in HCL DevOps Test Integrations and APIs (Test Integrations and APIs) to test COBOL data files or the applications that produce and consume them.
  - PL/I source file overview
    Use PL/I source files in Test Integrations and APIs to test PL/I data files or the applications that produce and use them.
  - Creating a DFDL schema
    You can use the DFDL schema utility that is provided with Test Integrations and APIs to create a DFDL schema file and apply it to messages. This utility helps you to quickly create a schema with valid format and to specify elements and values by using the DFDL editor.
  - ISO 20022 schema overview
    Test Integrations and APIs supports the ISO 20022 standard, which is the next generation messaging standard for the Society for Worldwide Interbank Financial Telecommunication (SWIFT).
  - Protocol Buffer overview
    Protocol Buffer (also known as protobuf) is a Google framework for efficiently serializing objects for transfer, typically between network endpoints.
  - Creating a Web URL schema
    You can create a Web URL schema to use with REST services by adding URLs to the Schema Library.
  - Creating file schemas
    File schemas can be used to define the contents of one or more files that you intend to write to (publish) or read from (subscribe) in Test Integrations and APIs tests.
  - Applying schemas and formats to messages
    Built-in or custom message formats can be applied to any message within Test Integrations and APIs in the same way that schemas can be applied.
  - Applying Integra message handlers
    If you migrated to Test Integrations and APIs from Solstice Integra Suite, you can apply Integra message handlers to Test Integrations and APIs messages.
  - GraphQL schema overview
    Test Integrations and APIs supports the use of either the built-in GraphQL schemas or the GraphQL schemas that you import into Test Integrations and APIs when you want to test a GraphQL endpoint.
  - SWIFT messages
    At any given time, Test Integrations and APIs uses a single version of the Society for Worldwide Interbank Financial Telecommunication (SWIFT) message format standard.
  - Changing schemas
    Over time, it is likely that a schema in use for message construction will change. To update the schema in the Test Integrations and APIs project, use the Synchronization view in Architecture School.
  - Analyzing schemas
    You can analyze certain schema resources, such as XSD or WSDL documents, after they are imported into Test Integrations and APIs.
  - Record layouts
    You can use record layouts in Test Integrations and APIs to define a file schema to process and validate messages that use a customized schema or format.
    - Creating a record layout
      You can create a record layout to define a file schema to process and validate messages that use a customized schema or format.
    - Importing record layouts
      If there are fixed width record layouts that are specified in a Microsoft™ Excel spreadsheet, you can import the specification and define rules for parsing it using the Import feature for new or existing layouts.
    - Example: Importing a profile for a record layout
      You can use an import profile to create a record layout from a simple schema specification.
    - Editing the profile of a record layout
      You can edit an existing profile (including its copies) in the profile editor.
    - Edit rules for record layouts
      Use these rules to extract information from a spreadsheet and generate record layouts.
- Database resources, connections, and bindings
  Test Integrations and APIs 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 DevOps Test Integrations and APIs (Test Integrations and APIs) 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 Test Integrations and APIs that include the Test Integrations and APIs legacy scripting language, ECMAScript (such as JavaScript™), Chai, or any third-party scripting language that you install.
- External tools
  Test Integrations and APIs is primarily GUI-based, but you can also run or view tests, suites, and stubs outside of the Test Integrations and APIs.
- 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 Test Integrations and APIs, 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 DevOps Test Integrations and APIs (Test Integrations and APIs), provides a simple way to generate messages that you can observe with topology discovery or capture in Recording Studio.

Record layouts

You can use record layouts in Test Integrations and APIs to define a file schema to process and validate messages that use a customized schema or format.

While Test Integrations and APIs built-in support for schema types and message formats is extensive, customers must process and validate messages that use a customized schema or format. For such messages, Test Integrations and APIs provides record layouts, which can be used to define a file schema that is composed of fixed width, custom, or delimited fields. The customized schema can then be applied to a bytes field in a Test Integrations and APIs message.

Record layouts are managed under the Record Layouts tab in the Schema Library.

Existing schemas (record layouts) can be sorted or filtered as usual. The details of any selected schema can be viewed in the Config tab on the right side of the view. The details can be modified, if required.