ICD-001 Acknowledge Alarm Command

Owned by Guy Avery (Deactivated)
Last updated: Sept 21, 2021 by Charlotte Dakin-Norris
2 min read

Introduction

This page covers the ICD-001 Acknowledge Alarm Command.

Contents

Acknowledge Alarm Example

<!--MsgId is the unique id of the message being sent --> <!--AlarmId is the unique numeric id of the alarm that you want to acknowledge --> <?xml version="1.0" encoding="utf-8"?> <AcknowledgeAlarmCommand MsgTimeStamp="2021-04-02T15:01:01+00:00" MsgId="1" AlarmId="6" UserName="External" Notes="Single intruder near gate A1" xmlns="ICDNAV001-AcknowledgeAlarmCommand"> <Sender SenderId="SenderId1" NetworkAddress="127.0.0.1" NetworkPort="1" /> </AcknowledgeAlarmCommand>

Acknowledge Alarm Command Element

The acknowledge alarm command provides the ability for external systems to acknowledge a pending alarm. Pending alarms are alarms which have been cleared by WItness because the incident is no longer active but have not yet been acknowledged by the operator. When acknowledging an alarm the command can provide a username and notes which will be recorded with the alarm details in WItness to provide a full audit trail.

For alarm acknowledgement to work you must disable auto-acknowledgement in Witness. Auto-acknowledgement is enabled by default. Please refer to the relevant alarm documentation for each product for more information.

Acknowledge Alarm Command Attributes

Optional attributes are formatted in italics and highlighted with an asterisk.

Attributes

Description

Type

Notes

MsgId

Unique message Id

Long

This must be globally unique across all message types 

MsgTimeStamp

Date and time that the message was sent

DateTime



AlarmId

Id of the alarm instance which needs acknowledgement

Integer

This is the alarm Id that appears on all ICD-001 Alarm Reports.

UserName*

The user name of the operator or identifier of the external system that is initiating the acknowledgement (optional)

String

 

Notes*

Any notes or descriptions associated with the alarm acknowledgement that need to be stored with the alarm (optional)

String

This can be used to send any actions or notes associated with the alarm. These notes can be accessed when reviewing alarm details in Witness.

If the alarm is still active or the alarm Id you have provided does not match with any pending alarms then this command will return a failure status.

Network Sender Element

Each incoming message can include an optional Sender element. This must include the IP address and port that the client is using to send instructions.

If the Sender element is included the NetworkAddress value will be checked against the subscriber IP address and the command rejected if they do not match. 

In addition the Sender element is included in the Command Reply. This is a duplicate of the incoming details (i.e. the subscribers IP address and port). The subscriber can use this to verify that they authored the message.

Related Information

 

 

Safety is everything.