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.
HCL OneTest™ API provides a few well-known content formats as built-in schemas while a few are generated during synchronization, and other supported schemas can be manually added.
Built-in schemas
The following schemas are provided with HCL OneTest™ API. Some are described by a single schema, while other types of content are associated with multiple schemas.
Content associated with a single, predefined
schema are these:
- XML
- Base64
- Bytes
- CHIPS
- DIME
- Fedwire
- GraphQL
- Hex String
- INACHA
- Integra
- JSON
- MIME
- OFAC
- SWIFT
Content associated with multiple, pre-defined schemas are as follows:
- ANSI ASC X12
- ISO 20022
- UN EDIFACT
Generated schemas
Some
schemas can be added to the Schema Library during the synchronization
process. For more information on synchronization, see Synchronization. Some
schemas are specifically generated as part of a resource import process.
- Active Enterprise is obtained from the TIBCO BusinessWorks projects that are added in the Logical view.
- BusinessWorks Private Processes is obtained from the TIBCO BusinessWorks projects that are added in the Logical view.
- SAP BAPI/RFC is added after these resources are imported or defined in an SAP system that is configured in the Logical View.
- SAP IDocs is added after these resources are imported or defined in an SAP system that is configured in the Logical View.
- Sofware AG webMethods.
Manually added schemas
The
following schemas can be added manually:
- COBOL Copybooks
- DFDL
- DTD
- File Schemas
- FIX Dictionary
- GraphQL Schema
- ISO 8583
- Java™ Objects
- JSON Schema
- .NET Objects
- Protocol BuffersNote: While importing the protocol buffer schemas, the definition files are searched in the specified import directory path. If the definition file is not found in the specified directory, the parent directory is searched. The search operation continues until the file system root path is reached.
- Record Layouts
- Web URL
- Web Form
- WSDL
- XSD
Important:
- Where possible, put the schema source data into your HCL OneTest™ API project. This helps with portability of your project.
- HCL OneTest™ API caches the external WSDL, XSD, JSON, GraphQL, and Copybook schema sources, their external dependencies, or both into a /Schemas/ folder inside a JAR file.
- Changes to the external schema data source are not reflected in the project test artifacts until the project is manually synchronized with the schema source. Schema source data that is stored inside the project is loaded upon first use.