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" UniqueId="A5E6F74B-6ABA-4EE6-B5C1-C9FFFAF73B45" Description="A Highways Alarm" Priority="2" Reported="2012-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" BreakingTrackDbId="{4431-445678AF-AFB212}" RadarUserId="1">
      <cmn:Distance DistanceFromOrigin=”99758”/>
      <cmn:GeoData Latitude="33.860012" Longitude="-1.7891123"/>
    </al: Payload >
  </al:Alarm>
</al: AlarmReport>

...

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" UniqueId="1D8B49FB-C21D-4C48-8751-BC6B808194C2" 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 numeric Id of the alarm. This Id is persisted in the systems storage to ensure the numbering continues incrementing even after restarts and resilient failovers. However in the event of a critical failure that requires a backup restore

Long


UniqueId*

GUID that represents each unique alarm instance. This is guaranteed to be unique even after system restores

String

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


AlarmKey

Unique key of alarm - this can be matched up with AlarmKey on the Camera Report

String

...