Creating logical Apache Kafka transport connections

In HCL OneTest™ API, tests and stubs reference the logical resources in a project. Therefore, you must create at least one logical Kafka transport connection for each Kafka transport to be used.

Before you begin

You must have at least one environment in your project. If there are no environments, you must create one. See Creating an environment.

Procedure

  1. Open the Logical View of the Architecture School perspective.
  2. On the toolbar of the Logical View, click General > Kafka Connection.

    The New Kafka Connection window is displayed.

  3. Enter a name for the connection in the Name field.
    Image of the New Kafka Connection window.
  4. Click OK.

    The New Kafka Connection window is closed and the new logical Kafka connection is displayed in the canvas of the Logical View.

  5. When a logical connection is created, a new physical resource is also created and bound to the logical connection. To view or edit this physical resource, right-click the new connection and click Physical Resource.
  6. Double-click the new logical Kafka connection.

    The Kafka Connection window is displayed.

    Alternatively, right-click the logical Kafka connection and then click Open.

  7. To associate the new logical Kafka connection with a different logical resource, complete the following tasks:
    1. Click Parent.

      The Select a Resource window is displayed.

    2. Under Logical, select a different parent resource.
    3. Click OK.

      The Resource Path field on the Properties tab of the Kafka Connection window displays the updated resource path information.

  8. Optionally, click the Bindings tab. Alternatively, click Project > Edit Environments in the menu bar to open the Environment Editor window and click the Bindings tab to modify the bindings of the selected environment.

    If you did not bind the Kafka connection to a physical Kafka broker, UNBOUND is displayed under Binding and you must complete the following tasks:

    1. When you click UNBOUND, it displays a list of all physical Kafka brokers in your project.
    2. Select a physical Kafka broker. If there are no physical Kafka brokers displayed, you must create one.
  9. Optionally, to add a log file for the new logical Kafka connection, click the Monitoring tab.

    You can monitor the log file during the execution of a test that involves the new logical Kafka connection.

  10. Optionally, to enter additional information about the new logical Kafka connection, click the Documentation tab. Although this additional information is optional, it might help with the maintenance of the resources in the project or help future users of the project.
  11. Optionally, to specify the name of the topics or pattern of topics that should be recorded when using a Kafka broker as a source, click the Recording tab.
    Restriction: The specified pattern for topics to be recorded is not supported when the recording is enabled through the configured proxy.
  12. Click OK.

Results

The new logical Kafka connection is added to the project.