Setting up a new synchronization source

You can set up a Swagger document in an IBM z/OS Connect Profile as a synchronization source in an HCL OneTest™ API project.

Before you begin

Before synchronizing with a Swagger document in an IBM z/OS Connect Profile, create a physical HCL OneTest API connection to that IBM z/OS Connect Profile.


  1. Open the Logical View of the Architecture School perspective of HCL OneTest API.
  2. Open the toolbar of Logical View, click Web > Swagger Definition. The Synchronization Source window in the Create a new Synchronization Source wizard is displayed. In the Type list, look for Swagger Definition.
  3. Click Registry next to the Location field. The Browse a Service Registry window is displayed.
  4. Verify that the Service Registry URL list displays the IBM z/OS Connect Profile to be used.
  5. Optionally, you can do these steps:

  1. To search for the Swagger document to import, click Find REST APIs. Depending on the search parameters that you selected, search results are displayed in the Browse a Service Registry window.
  2. Double-click the relevant IBM z/OS Connect Profile. The Swagger documents associated with the selected IBM z/OS Connect Profile are displayed.
  3. Select the Swagger document to import.

    Selecting a Swagger document

  4. Click OK to close the Browse a Service Registry window. The selected Swagger document is displayed in the Configuration area on the Synchronization Source window in the Create a new Synchronization Source window.

    Synchronization source

  5. Click Next. The Generate Assets for Operation window in the Create a new Synchronization Source wizard is displayed. To generate tests and virtual services for the operation, click Create Tests and Create Stubs. You can modify the name of the asset or continue to use the default name.

    Generating assets

  6. Click Next. The Create Test for Operation window of the Create a new Synchronization Source wizard is displayed.
  7. For each test you requested, provide the following information:
    Note: The number of tests to be created is shown in the Test creation progress bar at the bottom of the window.
    1. Select a source option for the Input message:
      Generate message from Schema
      Use the schema information from the source document to generate the Input message.
      Specify a message
      Create your own message. You can enter the message in the text box that is provided, paste it from your copy/paste buffer, or browse to a file that contains the message. The message can be in XML, JSON, or any other supported message format.
    2. Select Include optional schema fields to complete the message with optional fields from the schema that is provided by the source document.
    3. Select a source option for the Output message. The options that are available are the same as the ones for the Input message, with the exception that you can opt to not generate an Output message.
    4. Click Next and repeat this step for each of the generated tests.
    When you have specified sources for all selected tests, a Summary page is displayed with the number of synchronization items, tests and stubs that were created. Starting from HCL OneTest API Version 10.0.0, the Summary page displays all information, warning, and error messages that occurred during synchronization.
  8. Click Finish. The Test Factory perspective is displayed.


HCL OneTest API imports the selected Swagger document and adds it as a synchronization source to the logical model of your project.

What to do next

After the tests and stubs are generated, do the following steps:
  • Configure the physical transport of the web server. For details, see Creating physical web server resources.
  • Open the Schema Library and verify that the schema for the selected API has been imported.
  • Make changes to the generated tests and stubs as required and then start testing against the RESTful APIs or applications.