Kafka recording options

Enables you to customize the recording settings for Kafka protocol scripts.

Recording Kafka scripts is available from VuGen 2022 R1.

To access
Record > Recording Options

Recording Options > Log Options

Enables you to define the log level for your script.

UI element Description
Log Level

Define log level for script generation. Default value: Brief.

  • None. No log is generated.
  • Brief. Generates a standard recording log.
  • Extended. Generates a detailed log for methods, arguments, and return values.

Kafka > Code Generation

Enables you to configure the code generation related to the producer and optional consumer in a recorded Kafka script.

UI Element
Producer Configurations

Defines where the producer configuration code is saved.

  • Save in script folder as a new file: Creates a new .properties file in the script folder and saves the producer configuration in the new file.

    File name: Enter a name for the .properties file created for the producer configuration. If you do not enter a file name, a new .properties file is not created, and the producer configuration is instead inserted into the script.

  • Insert in script: (Default) Inserts the producer configuration into the script.
Consumer Settings

Create consumer: Initiates an optional consumer instance at the end of the recorded script, which polls for all records sent by the producer during replay.

Commit records: When this option is selected, the consumer initiated at the end of the script commits the records sent by the producer during replay. When the records are committed, they will not be consumed again by any subsequent consumers that poll for records.

Back to top

Kafka > Configuration Files

Enables you to create, edit, import and export configuration files of the file type .properties.

When you record a Kafka script, you select a configuration file for the consumer instance that VuGen creates for the recording. The configuration file contains properties that define the behavior of the consumer. Each property consists of a key-value pair. Certain properties are mandatory and must be included in order to record a script.

For details on the mandatory properties and other properties available for consumer configuration, see Kafka consumer and producer properties.

User interface elements are described below (unlabeled elements are shown in angle brackets):

UI Element

In the left pane: Creates a new configuration file.

In the right pane: Adds a new line to enter a property in the selected configuration file.


In the left pane: Deletes the selected configuration file.

In the right pane: Deletes the selected property from the configuration file.

Enables you to import the contents of an existing .properties file into the selected configuration file.
Enables you to export and save the selected configuration file as a .properties file.
<Mandatory keys>

Inserts the mandatory consumer property keys into the selected configuration file. You must enter a value for each key.

Note: This overwrites any existing properties in the configuration file.

Back to top

Java recording options

For details on the Java recording options, see:

See also: