Event XML Configuration

The event XML format is used by the event XML importer/exporter to manage the set of event configurations in the system. Modifications to the existing system should be made by first exporting the current state, making changes in the outputted XML, and re-importing.

Structure / Full Example

The event configuration consists of a collection of <eventConfig> elements that define the attributes for a particular event type.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<events xmlns="events.xml.ldr.greenbus.io">
    <eventConfigs>
        <eventConfig eventType="System.UserLogin" severity="5" designation="EVENT" initialAlarmState="UNACK_SILENT">User logged in: {user}</eventConfig>
        <eventConfig eventType="VoltageThresholdEvent" severity="5" designation="EVENT" initialAlarmState="UNACK_SILENT">Voltage threshold event for {point} at {value} volts</eventConfig>
    </eventConfigs>
</events>

Event Type Configuration

The <eventConfig> element contains system-level configuration for Events that are posted with a certain event type. The configuration attributes are:

Attribute	Description
`severity`	The severity of the Event, an integer. Lower is more severe.
`designation`	What sort of occurrence the event type constitutes. See event designation description below.
`initialAlarmState`	The initial state of an Alarm raised by the Event. Does nothing unless the designation is `ALARM`.

Event Designation

The following are valid options for the event designation:

Value	Description
`EVENT`	The event type represents a standard Event but does not issue an Alarm.
`ALARM`	The event type is a standard Event and also raises an Alarm.
`LOG`	The event type does not create an Event and instead is logged by the services.

Initial Alarm State

The following are the valid options for initial alarm state:

Value	Description
`UNACK_AUDIBLE`	The Alarm begins in the unacknowledged and audible state.
`UNACK_SILENT`	The Alarm begins in the unacknowledged and silent state.
`ACKNOWLEDGED`	The Alarm begins in the acknowledged state.