AX Alarm Console

This view of the console recipient displays all the alarms that have been routed to it. To open this view, right-click an alarmRecipient under the AlarmService and click Views > AX Alarm Console.

The AX Alarm Console manages alarms on a per–point basis. Each row in the table is the most recent alarm from a point.

Image

This view displays BFormat text under the Message Text column of the window. This message text comes from the text entered using the console’s Property Sheet.

The AX Alarm Console supports alarm sounds when running in desktop browsers. For mobile support, browse to the page on the mobile. Web browsers like Chrome can play mp3 and ogg sound files. This is not recommended due to lack of support in Workbench.

 NOTE: The only format that works in both Workbench and in a browser is wav. 
Image

As with other tables, you can show or hide columns using the Table Options menu in the top right corner of the table.

Alarm commands

Command Icon Description
Acknowledge
Image
Allows you to recognize the currently selected alarm(s).
Hyperlink
Image
Allows you to open the alarm URL.
Add Notes
Image
Allows you to add explanatory text to a specific alarm.
Silence
Image
Allows you to quiet the sound issued by the currently selected alarm(s).
Filter
Image
Allows you to limit the alarms displayed.
Live Update
Image
Provides continuous alarm updating.
Alarm Details
Image
Allows you to view alarm details.
Refresh
Image
Allows you to refresh the window.

Columns

Column Value Description
Ack Required true or false
Indicates if the alarm must be acknowledged (true) or not (false).
Ack Time hours:minutes:seconds
Displays the time that the alarm was acknowledged (if applicable).
Ack State Acked or Unacked
Indicates if the alarm has been acknowledged.
Alarm Class read-only used in Lists, console columns, or %alarmClass% on a report.
Defines alarm routing options and priorities. Typical alarm classes include High, Medium and Low. An alarm class of Low might send an email message, while an alarm class of High might trigger a text message to the department manager.
Alarm Data read-only

Presents a detailed list of alarm data, including this information: Status, toState, msgText, Count, fromState and Timezone.

Transistion text
Shows the initial source state that generated the alarm. This value may not reflect the current state of the alarm source. Once the framework creates an Alarm Transition, it does not change for a single alarm record. For example, if the source state returned to normal after an offnormal status, this value remains at offnormal.
Message Text text Displays the text message.
Export read-only Generates the output of the present view.
Reset Column Width n/a Resets the column width.
Add Alarm Data text Appends alarm data column.
Remove Alarm Data text Deletes alarm data column.
Normal Time or NormalTime date and time
Displays the date and time (if applicable) that the alarm state returned to normal.
Priority [on-call contact] 1–255 for each transition, default: 255; %priority% on a report
Specifies the order in which the OnCallService sends alarm notifications to the OnCallContact. Colors graphically identify alarm priority levels. You set up Priority levels using the alarm options window. The contact with the lowest number (highest priority) receives notification first. An alarm that is not acknowledged within the designated time is forwarded to the next contact in the list.
 NOTE: Contacts may share the same Priority number. The OnCallService sends an identical notification to all contacts that have the same priority number 
Source %alarmData.sourceName% Displays the path to the point that is generating the alarm.
 NOTE: For how to format this information on a report, click on the help icon to the right of the field. 
Source State NormalHigh Limit The status of the entity at the time the event, such as an alarm, occurred.
TimeStamp hours:minutes:seconds%timestamp% (on a report)
Reports the date and time the event occurred.
User [alarms] Drop-down list Identifies the person that acknowledged the alarm. An unacknowledged alarm displays “unknown.”
Uuid read-only
Displays the Unique Universal Identifier (UUID) the system uses to identify the alarm record.
Last Update read-only Displays the time the system most recently updated the alarm.

Buttons

Button Value Description
Acknowledge button Recognizes each selected alarm.
Hyperlink button Changes the current view to the hyperlinked target associated with the selected alarm. If no hyperlink is associated with the alarm, the Hyperlink button is not available.
Notes button Displays the Notes dialog box for the purpose of adding a note to the selected alarm or alarms.
Close Button button Saves and exits the current dialog.

Alarm Report window

From the AX Alarm Console, you can view the Alarm Record to see all alarms on the point. Select an alarm and double-click it to see the Alarm Record.

You can sort the Alarms in order of any column by pressing the column bar (once for ascending, twice for descending). Available commands include:

  • Image Acknowledge
  • Image Hyperlink
  • Image Notes
  • Image Filter

Viewing Alarm Record

From the Alarm Report window, you can view the alarm record to see all information on the alarm. Select an Alarm and double-click it to see the alarm record. Available commands include:

  • Image Acknowledge
  • Image Hyperlink
  • Image Notes
  • Image Close

Clearing alarms

An alarm is cleared from the AX Alarm Console when both of the following conditions exist:
  • The alarm is acknowledged.
  • The point is in a normal state.