Index | Prev | Next

Handlers and alarm acknowledgments

Message handlers are components designed to perform a specific task with the data routed and selected via the other inbound components. Handlers make acknowledging alarms possible.

If an alarm exported from a station includes the UUID, an Alarm Uuid Ack Handler can pass back that unique id. The expected format is shown below, where the array allows multiple alarms to be acknowledged at once. 

{
  "user": "Maya",
  "alarms": [ "5cf9c8b2-1542-42ba-a1fd-5f753c777bc0" ]
}

The user value stored on the alarm record identifies which user acknowledged the alarm in the remote application. If the user key is omitted the component still tries to acknowledge the alarms using the fallback name “AlarmUuidAckUser”.

 
NOTE: The Json Schema Service runAsUser is a prerequisite for this handler to work. The specified user must have admin write permissions for the alarm class of the records being acknowledged.
 

Two alarm handler properties configure this task:

  • AckSource is a string appended to every AlarmRecord acknowledged. Its purpose is to allow auditing in future and is stored as AckSource in the alarm data.
  • AckResult is a topic that reports the results of the alarm acknowledgment. Its purpose is to log or post process activity. Here is an example of the output it reports:

    "Ack-ed alarm " + record

    "Already ack-ed in alarmDb " + record

    "Could not create BUuid from " + uuid

Related Links

  • Importing JSON (Parent Topic)

    • Related References

  • AlarmUuidAckHandler (Alarm Uuid Ack Handler)

    • Index | Prev | Next