Alarms / Alarm Action List
Introduction
An alarm action describes a response that the NovaStar system can execute in association with an active alarm.
Alarm Action List
Clicking on the Alarms / Alarm Action List menu displays the Alarm Action List page. A new NovaStar system will display an empty Alarm Action List.
Alarm Actions (see full-size image)
Navigation, Adding, Deleting, Modifying, and Copying Actions
See Application Functionality for more information about basic component functionality.
The Alarm Action List page conforms to a layout similar to many data types which includes a list of data items. See List Features for more information detailing page navigation; adding, copying and deleting actions; and modifying existing actions.
Identification
The following properties are used to identify the action. Note that creating a new alarm requires entering, at a minimum, the name.
Alarm Action Identification (see full-size image)
| Data Label | Description |
|---|---|
| Name | Alarm action name. Max: 100 characters. |
| Description | Alarm action description name. Max: 100 characters. |
User Groups
The User groups table shows the user groups currently assigned to the action. For more information, see the User Groups documentation.
User Groups Assigned (see full-size image)
Action
The following actions are available:
Action - Custom
A custom action is user defined and is executed when an alarm is triggered or reset. Custom scripts are run using the input options. This is the only action where the Command field is editable. For all others, the Command is set, based on the action type.
Alarm Action - Custom (see full-size image)
| Data Label | Description |
|---|---|
| Command | Custom alarm command name. Command scripts must be stored in /usr/ns/cus. |
| Options | Command arguments passed to command. |
Action - Console Alarm
Audible alarm on console computer. Acknowledging the alarm or disabling alarms for system will stop the audible sound.
Alarm Action - Console (see full-size image)
| Data Label | Description |
|---|---|
| Command | nsconsolebeep |
| Beep interval | Number seconds to beep, default 2 seconds. |
| Frequency | Beep frequency, default 100 Hz. |
| Hz Length | Beep length in milliseconds, default 200 milliseconds. |
| On acknowledge | Select true to cancel console alarm sound when acknowledged. |
Action - Send Email
Email alarm action. Emails are sent to the email addresses in the contact list. The emails will be from the address and with the email subject defined for this alarm action. For point alarms, the point ID, name, alarm value and interval are encoded in email message followed by the alarm trigger message. For system alarms only the alarm message is sent.
Alarm Action - Email (see full-size image)
| Data Label | Description |
|---|---|
| Command | nsalarmemail |
| Email from | Email from address. In the above example, HOSTNAME is replaced by the server hostname. |
| Email subject | Email subject. |
| Alarm details | Information to include in the email. Any number of items can be checked: point index, numid, name, tagname, line, type station numid, name, tagname trigger index, name, time, type, limit, interval, threshold, when alarm index, condition, value, units, interval, state, time. |
| Message | Position of alarm trigger message with alarm details. after puts alarm trigger message after alarm details. before puts alarm trigger message before alarm details. none does not print the alarm trigger message. only prints alarm trigger message, does not print alarm details. |
Action - SMS
Text alarm action. Texts are sent to the contact information in the contact list.
Alarm Action - SMS (see full-size image)
| Data Label | Description |
|---|---|
| Command | nsalarmsms |
| Alarm details | Information to include in the text. When more than 4 items are selected, the dropdown (when not activated) indicates the number of selected items, as in the image above. Otherwise, the items are listed. Any number of items can be checked: point index, numid, name, tagname, line, type station numid, name, tagname trigger index, name, time, type, limit, interval, threshold, when alarm index, condition, value, units, interval, state, time. |
| Message | Position of alarm trigger message with alarm details. after puts alarm trigger message after alarm details. before puts alarm trigger message before alarm details. none does not print the alarm trigger message. only prints alarm trigger message, does not print alarm details. |
Action - Silent Alarm
Visual alarm action, no sound. Active alarm bar will be shown at top of menu bar. Disabling alarms privately will prevent the display of the active alarm bar.
Alarm Action - Silent (see full-size image)
| Data Label | Description |
|---|---|
| Command | warning silent |
Contact List
The Contact list shows all the alarm contacts currently assigned to the alarm action and can show details about each alarm contact.
Clicking the Add button navigates to the Alarms / Alarm Contacts List page to allow creation of a new contact. However, to assign or remove an existing contact, click the Assign/Remove Contacts tab above the contact list to display the list of existing contacts. Check or uncheck desired contacts.
Alarm Action Contacts (see full-size image)
Alarm Action Log
Click the View log file button to display the log file for this alarm action. The log file will show the time stamped activity logged by this alarm action. It can be used to verify the alarm action is working properly. The View Log File page is displayed.
Alarm Action View Log File (see full-size image)
