| HTML |
|---|
<style>
.text-span-6 {
background-image: linear-gradient(99deg, rgba(170, 163, 239, .5), rgba(125, 203, 207, .5));
border-radius: 50px;
padding-left: 15px;
padding-right: 15px;
}
#title-text {
display: none;
}
.panelgradient {
background-image: linear-gradient(180deg, #d5def0, whitesmoke);
border-radius: 8px;
flex-direction: column;
justify-content: center;
align-items: center;
padding: 4rem;
display: flex;
position: relative;
}
</style>
<div class ="panelgradient">
<h1 style="text-align: center;">Alarms<br>(Audit Trail and Alerts)</h1>
</div> |
Introduction to the Alarms Module
The Alarms module is a powerful tool designed to monitor and manage alarm events within your solutions, providing Module monitors and manages real-time alarm events, alerts, notifications, and Audit Trail information. It provides alerts for critical events , and storing stores data for future analysis. Key functions include:
Real-time alarm states processing
Storage on any database provider
Hierarchical organization of alarms
System AuditTrail events and operator actions tracking
On this page:
| Table of Contents | ||||||
|---|---|---|---|---|---|---|
|
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.
Alarms Functionality
Features Highlights
The Alarms module offers the following key features:
The AlarmHistorian allows the Alarms module to save alarms and their state changes in a separate database (it is different from AuditTrail that only saves when editing the settings).
The Alarm Window object used to displaying active alarms and their state changes on displays
Real-time alarm processing to quickly identify and respond to critical events
Hierarchy organization and management of alarms for greater flexibility and control
Universal time and daylight saving considered for accurate timestamps
Dynamic language localization of alarm messages for easy understanding
High-precision timestamps up to 0.1ms for accurate and reliable data
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
Describe and link to child page.
and Terms
AlarmItem
A tag monitored by the Alarm Module, containing information such as tag name, alarm condition, AlarmGroup, Limit, Deadband, and Message.
AlarmGroup
Collection of AlarmItems sharing properties such as AckRequired and AutoAckTime.
AlarmArea
Hierarchical grouping of AlarmGroups for better organization.
Audit Trail
Logs changes and events when executing the solution, tracking who made changes and when. Useful for troubleshooting, analysis, and compliance.
Understanding the Alarms Module
Module Features
- AlarmViewer Control and AlarmAreas Control for displays.
- Real-time alarm processing
- Hierarchical alarm management
- Dynamic language localization for messages
- High-precision timestamps
- Custom notifications (e.g., SMS, email)
- Store and Forward archiving
- Automated replication in hot-standby scenarios
Monitoring Tags and Evaluating Conditions
When the Module Alarm is execution, all tags defined on AlarmItems are subscribed, so the alarm conditions are evaluated every time the tag as new value.
If a condition is reached, the alarm is issued, according to the behavior defined by its AlarmGroup. Notifications are sent if enabled to that group.
Configuring the Alarms Module
Configuration Workflow
Alarms Module Configuration Workflow | ||
|---|---|---|
Action | Where | Comments |
Create AlarmItems | Alarms / Items | Create an AlarmItem. It will be associated with a tag by inserting the tag's name into the Tag Name column. Learn more at AlarmItems. |
Define conditions | Alarms / Items | Define the alarm behavior, configuring the Condition to trigger the alarm and the Limit for the threshold value. Learn more at AlarmItems. |
Create or edit AlarmGroups | Alarms / Groups | Define the AlarmItems that share common characteristics and use them to define several alarm attributes. Learn more at AlarmGroups. |
Create or edit AlarmAreas | Alarms / Areas | Create a hierarchically structured group of Alarms. Learn more at AlarmAreas. |
Define settings | Alarms / Global Settings | Configure database settings for logging alarm events, behavior upon system startup, and specific alarm handling parameters. Learn more at Global Settings. |
Pre-Defined AlarmGroups
The Alarms module provides a predefined AlarmGroup to quickly configure alarms for common applications. These groups have pre-configured properties that make it easier to create and configure alarms for standard purposes.
To use a predefined AlarmGroup, you simply need to select it from the list of available groups and configure additional properties as needed.
The pre-defined AlarmGroups are:
- Critical: High Priority Alarms that requires acknowledgement and History logging.
- Warning: Medium Priority Alarms and Low Priority Alarms, which don't require acknowledgment, but are logged.
- Audit Trail: Alarms and Events that don't show on Operator Displays, but are records on the History log.
AlarmHistorian Database on Datasets
The Alarm Historian 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.
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 changes in conditions.
Runtime Execution
You can control the Alarms Module execution while running your solution. You can Run, Pause, or Stop the Alarms Module directly from the platform.
Access Runtime / Runtime Diagnostics to find the tools you can use to control the module.
Monitoring the Alarms Module Execution
The Alarms Monitor lets you see real-time information about the module when the solution is running. It showcases total, unacknowledged, active alarms, their priority, and the most recent alarm notification.
→ Read more about Alarms Monitor.
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.
→ Read more about the AlarmViewer Control and AlarmAreas Control.
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.
→ Read more about Alarm Email Notifications.
Customizing Alarm Sounds
Sets the sound played when an alarm goes off.
→ Read more about at AlarmGroup Sounds.
Alarms Advanced Topics
Alarm Execution Process
Presents in the detail the processes when executing the Alarm Engine.
→ Read more about Alarm Execution Process
Alarm Runtime Attributes
The Alarms Namespace exposes properties and methods from the .NET objects used by the Alarm Module execution.
→ Read more about Alarms Runtime Attributes
| Anchor | ||||
|---|---|---|---|---|
|
Best Practices and Recommendations
To ensure the smooth operation of the Alarms module, follow these best practices:
- Use clear and descriptive names for Alarm Group, Alarm Area, and Alarm Item.
- 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.
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
More on the Alarms Module
Follow the structure of the other modules.
In this section:
| Page Tree | ||||
|---|---|---|---|---|
|
...