Introduction to Alarms module
The Alarms module is a powerful tool designed to monitor and manage alarm events within your solutions, providing alerts for critical events, and storing data for future analysis.
On this page:
Purpose and Key Concepts
The Alarms module is designed to provide real-time monitoring and notification of events or conditions that require immediate attention. This is done by evaluating tags values in real-time to generate alarms when the monitored value reaches a defined limit or condition. The module evaluates the conditions of AlarmItems and compares their current value with the set limit to determine whether an alarm should be triggered or not. The module can evaluate conditions such as exceeding a limit, falling below a limit, or entering/exiting a range.
The configuration of the Alarms module is performed on the sections: AlarmGroup, AlarmArea, AlarmItem, and AuditTrail.
AlarmGroup
An AlarmGroup is a collection of AlarmItems that share common properties and characteristics. Each AlarmGroup can have its own configuration properties, such as AckRequired, AutoAckTime, and Sound, that apply to all of its AlarmItems. The configuration of AlarmGroup is on the Solution Explorer, at Alarms → AlarmGroup.
AlarmArea
An AlarmArea is a hierarchical grouping of AlarmGroup that allows for a more organized and structured approach to managing alarms. An AlarmArea can have child AlarmArea, allowing for a hierarchical structure of AlarmGroup and AlarmItems. The configuration of AlarmArea is on the Solution Explorer, at Alarms → Area.
AlarmItem
An AlarmItem is a tag or expression that is monitored by the Alarms module. It contains information such as the tag name, the alarm condition (what triggers the alarm), and the associated AlarmGroup. Each AlarmItem can have its own configuration properties, such as Limit, Deadband, and Message, that define the alarm behavior and characteristics. The configuration of AlarmItems is on the Solution Explorer, at Alarms → Items.
AuditTrail
The AuditTrail is a feature of the Alarms module that logs all changes made to the AlarmGroup and AlarmItems, including creation, modification, and deletion events. It is a way to track and record the history of changes made to the alarm configuration, providing a clear audit trail of who made what changes and when. The configuration of the AuditTrail is on the Solution Explorer, at Alarms → Global Settings → AuditTrail.
Understanding the Alarms module
Such as other modules, the alarm module run in a separate process from TServer.exe, it means that the alarm operations occur at the same time that other events in the solution bringing reliability to process monitoring.
When an alarm is triggered, it can be acknowledged by any client logged in with a user with matching access level through the Alarm Viewer, this also can be done through other ways like: Tag properties, Alarm Group or Alarm Item's runtime properties.
Monitoring Tags and Evaluating Conditions
The Alarms functionality allows users evaluate if tag values satisfy certain conditions in real-time. With that the FrameworX can send notifications to users or take actions based on specific conditions.
When monitoring tags, users can set up one or more conditions to evaluate. For example, a user might set up a condition to trigger an alarm if the value of a tag exceeds a certain threshold. Also, it's possible to bind any alarm trigger with a Script Task through the property "Alarm.Item.<AlarmID>.State", chaining an automatic process.
Conditions can be based on a variety of factors, such as tag values, tag quality, or any object property.
Configuring the Alarms Module
Configuring an alarm involves creating an AlarmsItem object. Creating an AlarmsItem involves selecting a system Tag and associating a condition to generate an alarm event. Once done, it is necessary to specify which alarm group this item belongs to. The alarm item will inherit properties and attributes defined in the alarm groups. Finally, based on your process hierarchy defined on AlarmsAreas, you can specify which place the alarm item belongs to. So, to create and manage alarm items, go to Alarms/Items; to customize and fine-tune the groups of alarms, go to Alarms/Groups; and to define the process hierarchy and organize your alarm systems, go to Alarms/Areas.
Note for Marc: this is just the general text, would it be cool to have something like table we have on Devices? Or text is better?
Device Module Configuration Workflow | ||
|---|---|---|
Action | Where | Comments |
Create Channels | Devices → Channels | Identify the required field devices and protocols the project requires, create channels accordingly. Learn more at Device Channels. |
Create Nodes | Devices → Nodes | Identify the Network addresses and relevant information to all stations and devices that need connectivity. Learn more at Devices Nodes. |
Map Tags to Point addresses | Devices → Points | Optionally, you can Copy Tags from Excel/CSV from Excel or execute Import Wizards. Learn more at Device Points. |
Create or Customize AccessTypes | Devices → AccessTypes | Optionally, you can optimize the communication, grouping Points with similar requirements to the same AccessType. Learn more at AccessType. |
Working with the Alarms module
Once you have set up your AlarmGroup, AlarmArea, and AlarmItem, you can use the Alarms module to monitor your process and respond to any abnormal conditions.
Integration with Other Modules
The Alarms module can be integrated with other modules to enhance its functionality. For example, the Display module can be used to display alarms on a graphical screen, and the Reporting module can be used to generate reports that include alarms and their details. Additionally, the Scripting module can be used to handle alarm notifications, as well as to create custom alarms and modify the runtime behavior of the Alarms module.
Visualizing Alarms on Displays
The Displays module can be used to create displays that visualize alarms in real-time. The alarms can be displayed in tables, custom graphics, objects and others with the ability to sort and filter based on various alarm properties. The displays can also include interactive components, such as acknowledging alarms and displaying alarm details, to allow operators to quickly respond to alarms.
Handling Notifications with Scripts
The Scripting module can be used to create custom scripts that handle alarm notifications. These scripts can define the behavior of the Notification Method property of the AlarmGroup, allowing for more customized notifications based on the type and severity of the alarm. The scripts can also define notification methods beyond the built-in options, such as sending emails or SMS messages. For Email information, go to the Alarm Email Notifications page
AlarmHistorian Database definition on Datasets
The AlarmHistorian database is where the Alarms module stores all alarm events and audit trail information. The AlarmHistorian database can be defined using datasets, which allows for easy configuration and modification of the database properties. The datasets can define the database connection settings, the schema of the database tables, and the properties of the alarm events and audit trail entries.
Advanced Features and Options
The Alarms module also includes several advanced features and options to further customize its functionality. These include the ability to create custom alarm states, the ability to filter alarms based on specific conditions, the ability to configure alarms to only be active during certain time periods, and the ability to define custom properties for alarm events and audit trail entries. These advanced features provide additional flexibility and control over the Alarms module's behavior.
Advanced Configuration
The Alarms module can be customized to meet specific requirements. This section will cover the various configuration options available in the Alarms module.
The following are some of the settings that can be customized:
Alarm Notification: This setting allows the user to specify how alarms are notified to users.
Sound: This setting allows the user to specify the sound that should be played when an alarm is raised.
For information on sound configuration, go to the AlarmGroup Sounds page.
Display: This setting allows the user to specify the display options for the alarms.
Audit-Trail: This setting allows the user to specify whether or not to log alarms and events.
Database: This setting allows the user to specify the database where alarm information is stored.
Security: This setting allows the user to specify the security settings for the Alarms module.
In addition to the global settings, the Alarms module can be customized further by creating AlarmGroup, AlarmArea, and AlarmItem. These can be used to group and organize alarms based on specific criteria.
The next sections will cover how to create and manage AlarmGroup, AlarmArea, and AlarmItem.
Using Pre-Defined Groups
The Alarms module provides pre-defined AlarmGroup that you can use to quickly configure alarms for common applications. These pre-defined groups have pre-configured properties that make it easier to create and configure alarms for specific purposes.
To use a pre-defined Alarm Group, you simply need to select it from the list of available groups and configure any additional properties as needed. The available pre-defined groups may vary depending on the version of the Alarms module that you are using and the features that have been installed.
Some common AlarmGroup that may be available, include:
High Priority Alarms
This group is used to track critical alarms that require immediate attention. The alarms in this group will typically have a high priority and may be configured to generate notifications or take other actions automatically.Medium Priority Alarms
This group is used to track alarms that are important, but not as critical as high priority alarms. The alarms in this group may have a lower priority than those in the high priority group, and may not require immediate attention.Low Priority Alarms
This group is used to track alarms that are less critical than medium priority alarms. The alarms in this group may have a lower priority than those in the medium priority group and may not require immediate attention.Equipment Alarms
This group is used to track alarms related to specific pieces of equipment or systems. The alarms in this group may be configured to generate notifications or take other actions specific to the equipment being monitored.Production Alarms
This group is used to track alarms related to production processes or activities. The alarms in this group may be configured to generate notifications or take other actions related to the production process being monitored.
Using pre-defined AlarmGroup can save time and effort in configuring the Alarms module, as the properties of the alarms in the group are already pre-configured. However, you can still customize these pre-defined groups or create new ones as needed to fit your specific requirements.
Troubleshooting and Best Practices
Common Issues and Solutions
The Alarms module may encounter some issues in its operation. Here are some common issues and their solutions:
#Alarm not firing
Check the tag name, condition, and alarm item configuration. Ensure the tag is valid and the condition is met.
#Alarm not acknowledged
Check the alarm acknowledgement configuration. Ensure that the alarm acknowledges property is set and the acknowledgement timeout is not expired.
#Database connection error
Check the database connection string and ensure that the database is reachable.
#Alarm flooding
Check the alarm configuration and ensure that the deadband settings are properly configured.
#Notification not received
Check the notification configuration and ensure that the notification method is properly set.
Best Practices and Recommendations
To ensure the smooth operation of the Alarms module, follow these best practices:
Use clear and descriptive names for AlarmGroup, areas, and items.
Configure alarms with proper priority and severity levels.
Use deadbands and delays to prevent alarm flooding.
Regularly check and maintain the alarm configuration.
Configure notifications and acknowledge alarms in a timely manner.
Alarms Runtime Attributes
The T.Modules.Alarm has the properties of the alarm server. The Alarm.Group object has the list of all defined groups and their properties.The Alarm.Item object has all AlarmItem and their properties.The tag properties are connected with the Alarms module.
Example | |
|---|---|
| Configuration and runtime status of the HI Limit condition for the tag. The naming of all tag properties follow this same method. |
See the T.Modules.Alarm Namespace for the complete programming reference!
In this section: