Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Example Highways Alarm Report
Code Block
languagexml
<?xml version="1.0" encoding="utf-8" ?>
<al:AlarmReport xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:al="ICDNAV001-AlarmReport" xmlns:cmn="ICDNAV001-CommonTypes">
  <al:Alarm AlarmId="5" Description="AnA Highways Alarm" Priority="2" Reported="20102012-04-03T22:05:02.112" Category="Rule" Severity="Warning" State="AlarmOn" Acknowledged="False" RuleId="1">
    <al:Payload SectionId="1" LaneId="3" CarriagewayId="2" SubType="Stopped" CarriagewayName="M25-J">
      <cmn:Distance DistanceFromOrigin=”99758”/>
      <cmn:GeoData Latitude="33.860012" Longitude="-1.7891123"/>
    </al: Payload >
  </al:Alarm>
</al: AlarmReport>
Example Security Alarm Report
Code Block
languagexml
<?xml version="1.0" encoding="utf-8" ?>
<al:AlarmReport xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:al="ICDNAV001-AlarmReport" xmlns:cmn="ICDNAV001-CommonTypes">
  <al:Alarm AlarmId="5" Description="A Security Alarm" Priority="2" Reported="2019-04-03T22:05:02.112" Category="Rule" Severity="Threat" State="AlarmOn" Acknowledged="False" RuleId="3">
    <al:Payload>
      <RelatedAreas>
        <Area Id="1" Name="Alarm Zone 1"/>
        <Area Id="3" Name="North Gate"/>
      </RelatedAreas>
    </al: Payload >
  </al:Alarm>
</al: AlarmReport>

Alarm Element

The alarm element represents a generic alarm, either incident or system health. In addition it can contain specialised alarm payloads which contain data specific to certain alarm types. Currently the only documented payload is for the Highways alarm which is covered below.

...

Attribute

Description

Type

Unit

Reported 

Time alarm was reported

DateTime


AlarmId

Unique Id of the alarm

Long


Category

Alarm category – options are: 

Rule        

System        

Health

AlarmCategoryList


Description

Description of the alarm – normally based on the alarm category or rule message

String


Severity

Severity of the alarm – options are: 

Threat

Warning

Friend

Unknown

AlarmSeverityTypeList


State

Alarm state - options are: 

AlarmOn

AlarmOff

Dismissed

AlarmStateTypeList


Priority

Indicates the level of priority based on the users requirements

Integer


Acknowledged

Indicates if the alarm has been acknowledged

Boolean


RuleId*

The id of the rule to which this alarm is associated

Integer


...

Attribute

Description

Type

Unit

SubType

Highways Rule SubType – options are: 

Person

Stopped

Slow

Debris

Reversing

Queue

ERA

Enforcement

RuleSubTypeList


SectionId

Section Id in which alarm happened (note : this is the user entered Id not the system Id)

Integer


LaneId

Lane Id in which alarm happened (note : this is the user entered Id not the system Id)

Integer


CarriagewayId

Carriageway Id in which alarm happened

Integer


CarriagewayName

Carriageway Name in which alarm happened

String


Distance Attributes

Attribute

Description

Type

Unit

DistanceFromOrigin

Linear distance to centre of section in alarm from the carriageway origin

Integer

Metres 

...

Attribute

Description

Type

Unit

Latitude

WGS 84 Coordinate

String

Decimal Degrees

Longitude

WGS 84 Coordinate

String

Decimal Degrees

Security Source Payload

The security payload contains additional data related to a security alarm.

Related Areas Element

This element contains a list of related areas. These areas are connected to the alarm, typically they will be alarm zones with real time activity that has triggered an alarm.

Area Attributes

Attribute

Description

Type

Unit

Id

User Id of the area related to the alarm

Integer


Name

The user configured name of the area

String


...

Related information

Filter by label (Content by label)
showLabelsfalse
cqllabel = "icd-001" and space = currentSpace ( )

...