Alarm Areas (Reference) provide hierarchical organization for alarm management in your FrameworX solution, Alarm Areas enable:
Areas create a tree structure for organizing alarms by location, system, or functional grouping.
Property | Description | Required |
---|---|---|
Name | Area identifier | Yes |
Parent | Parent area for hierarchy | No (root level) |
Description | Area purpose and details | No |
AuxValue | Additional information (e.g., responsible team) | No |
Enabled | Enable/disable entire area | Yes |
Example plant hierarchy:
Configure AlarmItems:
AlarmItem.Area = "Plant.Production.Line1"
Assign responsibility or metadata:
Area: Utilities.Power
AuxValue: "Electrical Team"
Area: Production.Line1
AuxValue: "Shift A Supervisor"
Access in scripts:
csharp
string responsible = @Alarm.Area.Utilities.Power.AuxValue;
// Returns: "Electrical Team"
csharp
// Acknowledge all alarms in Production area
@Alarm.Area.Production.AckAll();
// Acknowledge specific sub-area
@Alarm.Area.Production.Line1.AckAll();
csharp
// Get active alarms for area
var productionAlarms = @Alarm.Area.Production.ActiveAlarms;
// Count alarms in area
int utilityCount = @Alarm.Area.Utilities.AlarmCount;
csharp
// Disable all alarms in maintenance area
@Alarm.Area.Storage.Enabled = false;
AlarmAreas work with display controls for visualization:
Filter display to show only specific areas:
Use AlarmArea control for hierarchical navigation:
By Function
PlantSystems
FeedSystem
ReactorSystem
ProductSystem
Access areas programmatically:
csharp
// Navigate hierarchy
var area = @Alarm.Area["Plant.Production.Line1"];
// Get area properties
string areaName = area.Name;
string responsible = area.AuxValue;
bool isEnabled = area.Enabled;
// Area statistics
int activeCount = area.ActiveAlarmCount;
int unackedCount = area.UnacknowledgedCount;
// Area operations
area.AckAll(); // Acknowledge all
area.Enabled = false; // Disable area
Alarms not appearing in area:
Cannot acknowledge by area:
Area tree not showing: