Overview
As each alarm item must belong to a group, the settings pertaining to the set of alarm items are made here and applied to all items belonging to the same group.
There are three available groups by default, but the user can create as many as necessary.
A Group defines several general Alarm Groups allow to group alarms that share common characteristics and also define several characteristics of the alarm, such as:
Whether user acknowledgment is required.
Whether it will have sound.
Minimum time for the condition to trigger the alarm.
Type of notification.
The Alarms Groups properties allow users to define and manage collective behaviors of alarm items bundled into specific groups. Each group can have unique characteristics, such as whether acknowledgments are required, how they're visually or audibly represented, and the notification methods employed. The properties also facilitate categorization and provide metadata to track group modificationssettings pertaining the group are applied to all Alarm Items belonging to it.
On this page :
Table of Contents
Configuring Alarm Groups
AlarmGroup Configuration
AlarmGroup are a way to group together alarms that share common characteristics, such as the same priority, area, or notification method. In FrameworX, AlarmGroup are created and managed using the "Group" tab.
To create a new Alarm Group, follow these the steps below:
- Open the Alarm in the DesignerAccess Alarms → Items.
- Click on the "AlarmGroup" tab.
Click the "New item..." button.
Give the group a name, description, and choose the desired settings for that group, such as the priority level, notification method, etc.
Click "Ok" to create the new group.
Once an Alarm Group has been created, it can be edited, disabled, or deleted. To edit an existing Alarm Group, follow these steps:
Open the Alarm in the Designer.
Click on the "AlarmGroup" tab.
Select the group you want to edit from the list of groups.
In the selected row, edit the desired properties.
Make the desired changes to the group settings.
Click "Save" to save the changes.
To disable an Alarm Group, follow these steps:
Open the Alarm in the Designer.
Click on the "AlarmGroup" tab.
Select the group you want to disable from the list of groups.
Click the "Disable" button.
Confirm that you want to disable the group.
To delete an Alarm Group, follow these steps:
Open the Alarm in the Designer.
Click on the "AlarmGroup" tab.
Select the group you want to delete from the list of groups.
Click the "Delete Selected Item" button.
Confirm that you want to delete the group.
- the plus icon to create a new group.
- Enter a Name and Description for the group.
- Click Ok to save the new group.
- Now, edit the properties, such as Sound or Log Events, by double-clicking the desired one. See the next section on this page for more details on the available properties.
Once finished press Enter on your keyboard to save the edit.
Info title Edit existing group You can also do this to edit an existing group. Double-click the desired property to edit it, and press Enter on your keyboard to save it.
To delete an Alarm Group, select it from the list of groups and click the red X icon to delete it.
| Info |
|---|
| Info | title | note
Deleting an Alarm Group will also delete all of the alarms associated with that group. |
Alarms Groups Properties
The Alarms Groups properties allow users to define and manage collective behaviors of alarm items bundled into specific groups. Each group can have unique characteristics, such as:
- Whether acknowledgments are required.
- How they present themselves visually and audibly.
- The notification methods employed.
The following is a table describing each available property field for Alarm Groups:
| Info |
|---|
If a property column is not visible on the grid, enable it by right-clicking the grid header and selecting it from the list. |
Property | Description | ||
|---|---|---|---|
Name | |||
The name of the alarm group. | |||
AckRequiredAck Required | Acknowledgment Defines acknowledgment necessity status. If an alarm goes off, it remains active until acknowledged by the user, even if operating conditions return to normal. | ||
Active Time Deadband | The duration | ActiveTimeDeadband | Duration within which active alarms are ignored. |
AckTimeoutAck Timeout | Timeout The timeout period for acknowledgment. | ||
Auto Ack Time | The automatic | AutoAckTime | Automatic acknowledgment time setting. If an alarm has enabled Ack required property, you can set a period to acknowledge the alarm automatically if the user hasn't already. |
Sound | Sound The sound alert linked to the group. When running a Rich Client, if the application has an alarm window and an alarm goes off, this client will play the configured sound until the alarm is acknowledged. For more information, please see the AlarmGroup Alarm Groups Sounds page. | ||
Show | Display The display status of alarms from this group. | ||
LogEventsLog Events | Logging The logging status for group events. | ||
Colors | Color Defines the color codes associated with alarms in the group. | ||
NotificationMethodNotification Method | Method The method used for sending notifications. For custom applications, there is a way to call a Class method from the Script module to perform any automatic process like sending emails, SMS or anything that can be programmable | ||
Category | Category The category designation for the group. | ||
LockStateLock State | Current The current lock status of the group. | ||
LockOwnerLock Owner | User The user or system that locked the group. | ||
DateModifiedDate Modified | Date The date the group was last modified. | ||
DateCreated | Date The date the group was created. | ||
XRefInfoX Ref Info | Cross-reference information for the group. | ||
Description | Detailed The detailed description of the alarm group. |
In this section:
| Page Tree | ||||
|---|---|---|---|---|
|