Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Alarm Areas (Reference)  provide hierarchical organization for alarm management in your FrameworX solution, Alarm Areas enable:

  • Hierarchical grouping of alarms
  • Plant or process area organization
  • Filtering and navigation in displays
  • Area-based acknowledgment
  • Responsibility assignment via auxiliary values

Areas create a tree structure for organizing alarms by location, system, or functional grouping.

In this page:

Table of Contents
maxLevel2
minLevel2
indent10px
excludeSteps
stylenone

Configuration Properties

PropertyDescriptionRequired
NameArea identifierYes
ParentParent area for hierarchyNo (root level)
DescriptionArea purpose and detailsNo
AuxValueAdditional information (e.g., responsible team)No
EnabledEnable/disable entire areaYes

Creating Alarm Areas

  1. Navigate to Alarms → Areas
  2. Click Plus icon
  3. Enter Name
  4. Select Parent for hierarchy (leave blank for root)
  5. Add Description
  6. Press Enter to save

Hierarchical Structure

Example plant hierarchy:

  • Plant
    • Production 
      • Line 1
      • Lline 2
      • Line 3
    • Utilities
      • Power
      • Water
      • HAVC
    • Storage
      • RawMaterials
      • FinishedGoods

Configure AlarmItems:

AlarmItem.Area = "Plant.Production.Line1"

Using Auxiliary Values

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"

Area-Based Operations

Acknowledge by Area

csharp

// Acknowledge all alarms in Production area
@Alarm.Area.Production.AckAll();

// Acknowledge specific sub-area
@Alarm.Area.Production.Line1.AckAll();

Filter Alarms

csharp

// Get active alarms for area
var productionAlarms = @Alarm.Area.Production.ActiveAlarms;

// Count alarms in area
int utilityCount = @Alarm.Area.Utilities.AlarmCount;

Enable/Disable Areas

csharp

// Disable all alarms in maintenance area
@Alarm.Area.Storage.Enabled = false;

Display Integration

AlarmAreas work with display controls for visualization:

AlarmViewer Filtering

Filter display to show only specific areas:

  • Set AlarmViewer.AreaFilter = "Production.Line1"
  • Users see only relevant alarms

Area Navigation Tree

Use AlarmArea control for hierarchical navigation:

  • Tree view of all areas
  • Click to filter associated alarms
  • Visual indicators for active alarms per area

Best Practices

  1. Match plant structure - Mirror physical or logical layout
  2. Consistent naming - Use standard naming conventions
  3. Limit depth - 3-4 levels maximum for usability
  4. Group functionally - Related equipment in same area
  5. Document responsibility - Use AuxValue for team assignments
  6. Plan hierarchy early - Harder to restructure later
  7. Test filtering - Verify displays show correct areas

Common Hierarchies

By Location

  • Site
    • Building_1
      • Floor_1
      • Floor_2
    • Building_B
      • Floor_1
      • Floor_2

By Function

  • Operations
    • Process
    • Quality
    • Safety

By System

  •  PlantSystems
    • FeedSystem
    • ReactorSystem
    • ProductSystem



Runtime Namespace

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

Troubleshooting

Alarms not appearing in area:

  • Verify Area property in AlarmItem
  • Check area name spelling/path
  • Confirm area is Enabled

Cannot acknowledge by area:

  • Check user permissions
  • Verify AlarmGroup.AckRequired
  • Confirm alarms are active

Area tree not showing:

  • Verify Parent relationships
  • Check for circular references
  • Confirm root areas have no Parent

In this section...

Page Tree
root@parent
spaces93DRAF

Overview

AlarmArea refer to the alarm feature that allows the grouping of alarms by logical areas for alarm-enhanced management. They enable collective acknowledgment, enable/disable functions across areas, and offer real-time monitoring via a graphical tree view. Configuration involves defining logical areas and it offers functionalities like filtering by sub-areas.

On this page:

Table of Contents
stylenone

Tip
titleSolution Example

Alarms Logical Areas Example

Configuring AlarmAreas

Alarm Areas focus on the organizational aspects of alarms, providing tools to manage the hierarchical arrangement and visual representation of alarms. They allow users to refresh the structure view, add new folders to the hierarchy, rename existing elements, or remove them altogether, ensuring a streamlined approach to alarm organization.

To define and organize an AlarmArea hierarchy, follow the steps below:

  1. Access Alarms → Areas.
  2. With AlarmAreas selected, click the folder with a plus icon.
  3. Enter the new AlarmArea name and press Enter on your keyboard.
Info

Repeat this process and nest the folders to create your desired hierarchy.

Image Removed

Having an AlarmAreas hierarchy will simplify alarm management, allowing you to quickly identify the source of an alarm and take appropriate action. It also allows you to customize alarm priorities and notifications based on your needs.

Using AlarmAreas at Runtime

Using configured AlarmAreas in the Alarms Modules at runtime is straightforward. Add an AlarmAreas graphical component to a display. The AlarmAreas has a graphical component designed to display the AlarmAreas configured in the Alarms module. To use it, navigate to Displays/Draw, select the Modules category, choose AlarmAreas, and place it on the Drawing area by clicking or dragging and dropping.
Refer to AlarmAreas Control for detailed information.

AlarmAreas Example

For a brewery, organizing logical Areas and child Areas for alarm management involves segmenting the facility into key operational sections. Each section can have specific alarms related to the brewing process, equipment health, safety conditions, and environmental controls.

Brewery Facility Example

Main Area: Brewery Facility

Child Area 1: Raw Material Storage

Sub-area 1.1: Grain Silos

Sub-area 1.2: Hops Cold Storage

Child Area 2: Brewing and Fermentation

Sub-area 2.1: Mash Tuns

Sub-area 2.2: Fermentation Tanks

Child Area 3: Packaging Line

Sub-area 3.1: Bottle Filling Station

Sub-area 3.2: Labeling and Packaging

Image Removed

In this section:

Page Tree
rootV10:@parent
spacesV10