====== Alarm Auditor Scripts ======
Author: Eoin Joy\\ \\

The Alarm Auditor scripts are used during the alarm sync process to compare the discovered alarms to the set of alarms we currently have in the system.
===== Matches Method =====
This script is used to compare a single DiscoveredAlarm against a single ActiveAlarm to determine if they match. Should this return true for any such DiscoveredAlarm, it will not be called to create a new alarm.
==== Return Value ====
//Boolean//
==== Inserted Variables ====
**activeAlarm** – //ActiveAlarm// – The local alarm\\
**discoveredAlarm** – //DiscoveredAlarm// – The alarm discovered in the sync
===== Is Discovered Alarm Disabled =====
This script is used to determine if a given DiscoveredAlarm is contained in the list of Disabled Alarms discovered in the alarm severity sync process for this hub. If it finds a match for the Discovered Alarm, then the alarm is added to the list of found alarms that were disabled and is not going to create a new alarm.
==== Return Value ====
//Boolean//
==== Inserted Variables ====
**discoveredAlarm** – //DiscoveredAlarm// – The alarm discovered in the sync\\
**disabledAlarms** – //Collection<DiscoveredAlarmSeverity>// – The disabled alarms from the previously run alarm severity sync
===== Retrieve Local Alarm Text =====
This script determines what the alarm text of an alarm that exists on the local system, but was not found in a sync will show as in the results screen, either immediately in the case of an on-demand sync, or in the alarm sync history.
==== Return Value ====
//String//
==== Inserted Variables ====
**activeAlarm** – //ActiveAlarm// – The alarm in the local system that was not matched by any of the discovered alarms.