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 HCL OneTest™ API to determine the type.

Before you begin

You must have opened the HCL OneTest™ API Architecture School perspective and selected the Schema Library view.

Adding a schema explicitly

Procedure

  1. Click the arrow next to the Add button on the toolbar.
  2. Select a schema category from the displayed list.
    Five schema categories are displayed.
    Only a subset of categories and schema types is available when you add a schema.
  3. Select a schema type from the category > subcategory that you want to add.

Results

You have explicitly added a schema to the Schema Library.

What to do next

You can select the category>subcategory and the schema to add. You can use the following table to find information about the tasks to add the different types of schema:
Category Subcategory More information...

Business & Finance
  • FIX Dictionary
  • ISO 8583
  • SWIFT

Mainframe
  • Copybook
  • PL/I

Objects
  • .NET Object
  • Java Object

Other
  • DFDL Schema
  • File Schema
  • Protocol Buffer
  • Record Layout

Web
  • GraphQL Schema
  • JSON Schema
  • WSDL
  • Web URL
  • XSD

Adding a schema without explicitly specifying the type

Procedure

  1. Click Add on the toolbar.

    The Open dialog is displayed.

  2. Select a file or a directory that contains multiple source files that contain the schema by performing the following steps:
    1. Browse to the location where you have the schemas.
    2. Open the folder to select a file or select the folder that contains multiple files.
    3. Click Open.
    Any of the following results can occur:
    • If the selected file has a supported type of file extension and the contents are correctly parsed, the schema is added under the recognized schema type to the Schema Library. You have no further action to perform.
    • If the selected files or directory contains file extensions that are either not recognized or can apply to multiple schema, any of the following dialog boxes can be displayed. You can perform the action as indicated:
      dialog Cause Action

      Unrecognized file extension

      If the selected files cannot be recognized as any of the supported schema types by HCL OneTest™ API.
      You must add the schemas explicitly by performing the following steps:
      1. Click OK.
      2. Go to Adding a schema explicitly.

      Cannot determine the extension type

      If the selected files have file extensions that can apply to different schemas and HCL OneTest™ API cannot determine which schema to apply.
      You must select the schema by performing the following steps:
      1. Select the schema to which the file is to be applied.
      2. Click OK.
      The schemas in the selected files are added to the Schema Library.
      Note: Alternatively, you can click Skip to exclude the selected file. You can then add the schema explicitly.

Results

You have added a schema to the Schema Library without explicitly specifying the type.