Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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>
      <cmn:GeoData Latitude="33.860012" Longitude="-1.7891123"/>
    </al: Payload >
  </al:Alarm>
</al: AlarmReport>

...

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


Highways Source Payload

The highways alarm payload contains detailed information about the location of the alarm, both relative to the carriageway and real world coordinates.

Highways Source Payload Attributes

...

The security payload contains additional data related to a security alarm, including related entities such as areas and real world coordinates.

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

GeoData Attributes

Attribute

Description

Type

Unit

Latitude

WGS 84 Coordinate

String

Decimal Degrees

Longitude

WGS 84 Coordinate

String

Decimal Degrees

...

Related information

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

...