Chapter 2    Quick Start Guide

This chapter provides a quick start guide to getting started using Jade Event Streaming, as follows.

  1. Obtain the Event Stream Producer (ESP) components.

    The .zip file contains the following executable files and supporting libraries.

    • JadeEventProducer.exe (Event Stream Producer)

    • JadeEventSchemaGenerator.exe (Jade Event Schema Generator utility)

  2. Install the Event Stream Producer.

    1. Extract the .zip file contents to a suitable directory, but not to the main Jade\bin directory.

    2. Ensure the ESP has access to change capture output files created by the source Jade system.

    3. For first-time use and initial testing, we recommend installing the ESP on the same machine as the source Jade system.

    VC++ runtime 14.40.33810.0 provided with JADE 22.0.04 is required to run JadeEventProducer.exe.

  3. Run ESP applications.

    1. 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.
      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.config.json file.

    2. Running the Event Schema Generator (ESG)

      The JadeEventSchemaGenerator is a useful utility for previewing the Event Schema file that corresponds to a specific Event class. The JadeEventProducer itself automatically generates and registers these Event Schema files on demand with the "SchemaRegistry" configuration section if configured to do so. For details, see SchemaRegistry under "Event Stream Producer Configuration" in Chapter 3.

      The syntax of the JadeEventSchemaGenerator ESG command is as follows.

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

      The JadeEventSchemaGenerator command parameters are listed in the following table.

      Parameter Description
      <input-file-name> Path to the Jade Audit Access description file (input)
      <output-root-folder> Directory where generated JSON schema files will be saved
      <schema-name> Optional name of the schema containing the class to be processed
      <class-name> Optional name of the class for which to generate a specification

      Examples

      The following example generates a single JSON schema file for a single class.

      JadeEventSchemaGenerator description20240725135130.txt ./event-schemas MySchema MyClass

      This example generates a single JSON schema file for the specified class and saves it in ./event‑schemas/MySchema/. The generated file is named MyClass_v0001.schema.json (for version 0001 of the class).

      The following example generates a JSON schema file for each user class and saves them in the ./event‑schemas/ folder structure. 

      JadeEventSchemaGenerator description20240725135130.txt ./event-schemas

      This example generates a JSON schema file for each user class and saves them in the ./event‑schemas/ folder structure.

      All collection classes and system classes are ignored.

      Output File Structure

      The output file structure is as follows. 

      <output-root-folder> 
└── <schema-name> 
    └── <class-name>_v<class-version>.schema.json

  4. Next steps.

    1. Review the configuration, by referring to Chapter 3, Configuration, for details about setting up the Producer.config.json file.

    2. For details about advanced usage and troubleshooting, see subsequent chapters of this guide.