Introduction
An introduction to the event-logging XML Schema and what it records.
Documentation
Documentation on how to use the event-logging XML Schema.
Applicable Schema version: “4.0”
Documentation generated on: 29 Nov 2023, 23:36 UTC
Documentation release version: SNAPSHOTTo see the documentation for other versions of the schema click the version drop-down at the top of the screen.
Event Modelling
In order for the benefits of event normalisation to be realised, it is necessary for similar events to be represented consistently within the schema.
Basic Structure
Every XML instance that conforms to the schema must have a root element named <Events> and reference the schema, see the following example.
Schema Actions
The verb or action in an event, e.g. Import, Copy, Authenticate, etc.
Object Types
Object types used to describe the entity or entities that are the subject of an event.
Unstructured Data
When producing schema compliant data, each and every data field from an event should populate the most appropriate element in the schema.
Data Types
Various common data types used in the schema.
Meta Element
An element to allow extensibility of events.
Complete Examples
A number of examples of complete events are provided below, in order to illustrate use of the schema.
Glossary
Glossary of common words, terms and abreviations used in Stroom.
Last modified November 29, 2023: Update oxygen_schema_docs.md (85e195a)