Running Event Stream Producer Applications

This section describes running the Event Stream Producer (ESP) and the Event Schema Generator (ESG).

Running the Event Stream Producer (ESP)

The syntax for running the ESP is as follows.

JadeEventProducer <config-file-name> [Producer Name]

The JadeEventProducer parameters are listed in the following table.

Parameter	Description
<config-file-name>	Path to the event stream producer configuration file. If you are running multiple copies of the ESP, you should use different configuration (config.json) files for each Producer, specifying different log files so that multiple producers do not write to the same log file.
Producer name	Optional name for this producer. This is mandatory when running multiple copies of a producer. The default producer name is DEFAULT. If you attempt to run a producer with the same name as an active producer, this is detected, logged, and the producer shuts down.

The following is an example of running the ESP.

JadeEventProducer.exe config\producer.config.json PRODUCER1

Refer to "Event Stream Producer Configuration" in Chapter 3 for details about setting up the Producer configuration file.

Running the Event Schema Generator (ESG)

The command to run the Event Schema Generator (ESG) is as follows.

JadeEventSchemaGenerator <input‑file‑name> 
                         <output‑root‑folder>
                         [<schema‑name>]
                         [<class‑name>]

The ESG parameters are listed in the following table.

Parameter	Specified
<input‑file‑name>	Path to the Jade Audit Access description file that will be used as input
<output‑root‑folder>	Directory where the generated JSON schema files will be saved
<schema‑name>	Optional name of the schema that contains the class that is to be processed
<class‑name>	Optional name of the class for which to generate a specification

Example of Generating a Schema File for One Class

JadeEventSchemaGenerator description20240725135130.txt ./event-schemas MySchema MyClass

In this example, the JadeEventSchemaGenerator reads the description20240725135130.txt file, generates a single JSON schema file for the specified class, and then saves it in ./event‑schemas/MySchema/. The generated file is named MyClass_v0001.schema.json (for version 0001 of the class).

Example of Generating a Schema File for All Classes

JadeEventSchemaGenerator description20240725135130.txt ./event‑schemas

In this example, the JadeEventSchemaGenerator reads the description20240725135130.txt file, generates a JSON schema file for each user class, and then saves them in the ./event‑schemas/ folder structure specified in "Output Files" in the following section.

Output Files

The output files are organized under the following folder structure.

<output‑root‑folder>
   <schema‑name>
   <schema‑name>

Each JSON schema file is stored in the subfolder for its respective Jade schema and has the following file name.

<class‑name>_v<class‑version>.schema.json