| 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 monitors and manages real-time alarm events, alerts, notifications, and Audit Trail information. It provides alerts for critical events and 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 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.
In this section:
About the Alarm Module
The Alarm Module is a crucial component for most projects, designed to monitor and manage alarm events within your projects. By leveraging the Alarm Module, you can create a comprehensive alarm management system tailored to your specific application requirements.
The documentation will guide you through the Alarm Module's functionalities, starting with an overview of the module's purpose and key concepts. It will then cover how the Alarm Module works, followed by sections on configuring and working with the module. Finally, the documentation will provide troubleshooting information and best practices to ensure optimal performance of your alarm management system.
By understanding and implementing the Alarm Module effectively, you can enhance your projects' responsiveness to critical events and ensure a high level of control and automation for your application.| Table of Contents | ||
|---|---|---|
|
Introduction to Alarm Module
The Alarm Module is a complete solution for managing real-time alarms, notification events, and Audit-Trail information. It is a powerful tool that enables users to monitor and control their processes in real-time, by providing alerts for critical events, and storing data for future analysis.The Alarm Module can be used in a wide range of industries, including manufacturing, energy, and transportation. It is an essential component of any modern control system, and is designed to help users achieve greater efficiency and productivity.The key features and functionalities of the Alarm Module include:Real-time Alarm States Processing: The Alarm Module is designed to process alarms in real-time, ensuring that critical events are identified and responded to as quickly as possible.Agnostic storage on any Database provider: The Alarm Module can store data on any database provider, making it flexible and easy to use.Store and Forward when archiving to remote databases: The Alarm Module is capable of storing and forwarding data to remote databases, ensuring that data is always available for analysis.Automated replication in hot-stand-by scenarios: The Alarm Module is designed to work in hot-stand-by scenarios, ensuring that data is always available and up-to-date.Organize and manage alarms hierarchically: The Alarm Module allows users to organize and manage alarms hierarchically, providing greater flexibility and control over their processes.Define System AuditTrail event and Track Operator actions: The Alarm Module allows users to define system audit-trail events and track operator actions, providing greater visibility and accountability.Send Notifications by SMS or e-mails: The Alarm Module is capable of sending notifications by SMS or e-mails, ensuring that users are always aware of critical events.Universal Time and Daylight Saving always considered for accurate time-stamp: The Alarm Module always considers universal time and daylight saving, ensuring that timestamps are accurate and reliable.Timestamps precision up to 0.1 ms: The Alarm Module provides high precision timestamps up to 0.1 ms, ensuring that data is always accurate and reliable.Dynamic Language localization of alarm messages: The Alarm Module allows users to localize alarm messages dynamically, ensuring that they are easy to understand and relevant to their audience.In summary, the Alarm Module is a powerful and versatile tool that enables users to monitor and control their processes in real-time, by providing alerts for critical events, and storing data for future analysis. It is an essential component of any modern control system, and can be used in a wide range of industries to improve efficiency and productivity.
Purpose and Key Concepts
The Alarm Module is designed to provide real-time monitoring and notification of events or conditions that require immediate attention. The key concepts in the Alarm Module include AlarmGroups, AlarmAreas, AlarmItems, and AuditTrail.
AlarmGroup
An AlarmGroup is a collection of AlarmItems that share common properties and characteristics. It is a way to group alarms together for easier management and organization. Each AlarmGroup can have its own configuration properties, such as AckRequired, AutoAckTime, and Sound, that apply to all of its AlarmItems.
AlarmArea
An AlarmArea is a hierarchical grouping of AlarmGroups that allows for a more organized and structured approach to managing alarms. An AlarmArea can have child AlarmAreas, allowing for a hierarchical structure of AlarmGroups and AlarmItems. This can be useful for large systems with many alarms, as it allows for a more intuitive and manageable way of organizing them.
AlarmItem
An AlarmItem is a tag or expression that is monitored by the Alarm 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.
AuditTrail
The AuditTrail is a feature of the Alarm Module that logs all changes made to the AlarmGroups 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. This is useful for troubleshooting, analysis, and compliance purposes.
| Info |
|---|
For information on its configuration, go to the AuditTrail page. |
How the Alarm Module Works
The Alarm Module monitors and evaluates tags 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 AlarmGroups can be used to group similar alarms together and define their behavior, such as whether they require acknowledgment, their sound and color settings, and their notification settings. The AlarmAreas allow organizing the alarms into a hierarchical structure to reflect the plant's physical layout. The AuditTrail feature logs all alarm and acknowledgment events and allows for tracking changes made to the alarm configuration.
The AlarmHistorian feature allows the Alarm Module to save alarms and their state changes in a separate database, allowing for efficient storage and retrieval of alarms data. The Alarm Module can be configured to store alarms data on a target database of your choice.
When an alarm is triggered, it can be acknowledged by operators and maintenance personnel through the Alarm Visualization object, Tag properties, or Alarm Group or Alarm Item's runtime properties. The alarm visualization object allows for displaying active alarms and their state changes on displays, while the Tag properties allow for viewing and acknowledging alarms on the HMI/SCADA system.
The Alarm Module can be integrated with other modules such as the Historian Module to allow for storing alarms data alongside process data. Overall, the Alarm Module provides an efficient and comprehensive solution for monitoring and managing alarms in real-time.
Features Highlights
The Alarm Module has several features and functionalities that can help users manage real-time alarms and notifications efficiently. Here are some of the highlights of the Alarm Module:
Configurable Alarm Groups: The Alarm Module allows the creation of custom Alarm Groups with specific properties and configurations, enabling users to group alarms in a logical and organized manner.
Alarm Areas: The Alarm Module supports the creation of Alarm Areas, which can further organize alarms and provide users with an intuitive and hierarchical way to navigate them.
Flexible AlarmItem Configuration: The Alarm Module offers multiple configuration properties for Alarm Items, such as Limit, Deadband, Setpoint, and PriorityOrder, allowing users to customize their alarms to fit specific requirements.
Audit-Trail Logging: The Alarm Module logs events in the Audit-Trail, providing users with a record of all alarm and notification-related activities, including acknowledgement and clearing of alarms.
Alarm Historian: The Alarm Module supports data logging of alarms and notifications into a separate database, providing users with a historical record of alarm events for analysis and troubleshooting.
Notification Events: The Alarm Module supports custom .NET scripts for notification events, enabling users to create custom actions for alarm notifications.
Alarm Acknowledgement: The Alarm Module offers various methods for acknowledging alarms, including acknowledging all alarms, acknowledging a single alarm, or acknowledging the highest priority alarm.
Alarm Visualization: The Alarm Module provides built-in objects for displaying alarms and notifications on displays or reports, enabling users to visualize alarms in real-time.
Overall, the Alarm Module is a powerful tool that can help users monitor their systems effectively, quickly identify and respond to issues, and keep their operations running smoothly.
Monitoring Tags and Evaluating Conditions
Configuring the Alarm Module
Global Settings and CustomizationCreating and Managing Alarm Groups
Using Pre-defined GroupsDefining and Organizing Alarms Areas HierarchyAdding and Editing Alarm Items
Working with the Alarm Module
Runtime Execution
Integration with Other Modules
AlarmHistorian Database definition on Datasets
Visualizing Alarms on Dislays
Handling Notifications with Scripts
Advanced Features and Options
Troubleshooting and Best Practices
Common Issues and Solutions
Best Practices and Recommendations
Alarm Module Runtime Attributes
The Alarm Namespace
The Alarm namespace 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 alarm items and their properties.
The tag properties are connected with the alarm module.
tag.tagname.Hi| Info |
|---|
| See Namespaces API for the complete programming reference on runtime objects. |
| Page Tree | ||||
|---|---|---|---|---|
|
...