Aura entities definition in Avro format

Aura entities definition version 6.0.0 (entities using Avro format), URM-compliant.

Introduction

The Aura entities definition includes the different entities currently written in Aura in Avro format, URM-compliant.

For further information regarding Kernel Avro datasets access the following links:

Entities generated in Avro URM-compliant format

Entities types Description Generation
Aura_Atria_Message Summary of Aura’s interactions handled by aura-rag-server, aura-groot and aura-bot Generated by aura-gateway-api
Aura_Audit Entity used to store information about the interactions handled by Aura components. It will be used to generate Aura’s invoices. Created by aura-kpis-uploader based on the information received in Groot Message and Gateway Message
Aura_Gateway_Message Entity used to store information about the messages handled by aura-gateway-api. Created by aura-gateway-api.
Aura_Message Entity that contains the summary of Aura’s interactions handled by aura-bridge, aura-groot and aura-bot Created directly by aura-groot and aura-bot
D_Aura_Dimensionals They are Aura’s configuration settings that are needed to understand Aura’s entities Generated directly by aura-kpis-uploader from the content of the aura-configuration-api.

Entities generation

Avro Entities tables nomenclature

  • Position: Field order in the Avro schema definition.
  • Field: Name of the field being defined. Usually, capitalized, although more aliases will be available in the schema definition.
  • PK: Parameter that indicates if the field is a Primary Key or not, that is, a value that uniquely identifies this field.
  • Referenced Entity: When the field references a value from another dataset, indicating that a join must be defined in the schema, this parameter contains the name of the dataset.
  • Referenced Entity Field: When the field references a value from another dataset, indicating that a join must be defined in the schema, this parameter contains the name of the field of the other dataset.
  • Type: Type of the field. It can be one of Avro logical types defined in Kernel.
  • Doc: Brief description of the field.
  • Nullable doc: If the field can be null, it should contain the cases when a null value is valid.