AlarmUuidAckHandler (Alarm Uuid Ack Handler)

If the alarms exported from a station include a unique ID (UUID), this component passes back the UUID.

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

Figure 94. AlarmUuidAckHandler properties

You add this handler to a station by expanding the Inbound > Handlers folder in the palette and dragging this component to a message router in the Nav tree.

In addition to the standard property (Enabled), these properties support the AlarmUuidAckHandler:

Property	Value	Description
Last Result	read-only	Reports the results of the alarm acknowledgment to allow for logging or post-processing activity. Example output: `Unable to find messagge key:` `Problem parsing messageType`
Last Result Time	read-only	Reports when the handler ran last.
Last Input	read-only	Reports the last message routed to a component.
Status	read-only	Reflects the current status of the component. Ok indicates the JSON processed successfully. fault indicates the JSON did not process for any reason, such as invalid JSON or missing expected values in the JSON.
Ack Source	text	Configures a string to append to every alarm record acknowledgement. This string can provide additional information for future auditing. The alarm data record stores it as AckSource.
Ack Result		Reports the results of the alarm acknowledgment for logging or post processing activity.

Example

The expected format for this component is:

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

This array allows the system to acknowledge multiple alarms at once.

The alarm record stores the user value, which identifies the user who 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 JsonSchemaService’s Run As User property 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.

Actions

These actions are available when you right-click on the AlarmUuidAckHandler.

Figure 95. AlarmUuidAckHandler action buttons

Route causes this component to process the String parameter and update the Out slot.
Run Last Input executes the last input again.
Clear Output sets the Out slot of this component to an empty string.