Alarms Module (How-to Guide)

This guide walks you through configuring the Alarms module to monitor process conditions and notify operators of abnormal situations. You'll create alarm items, configure groups, set up notifications, and display alarms in runtime.

Prerequisites:

• Tags created in UNS
• Understanding of process limits
• Display screens for alarm visualization

Configuration Workflow

1. Create or Edit AlarmGroups - Define shared alarm behaviors
2. Create AlarmItems - Configure tag conditions to monitor
3. Configure Global Settings - Set up database and handling
4. Add Alarm Displays - Visualize alarms in runtime
5. Test Alarms - Verify triggering and acknowledgment

Step 1: Configure AlarmGroups

AlarmGroups define shared behaviors for related alarms (acknowledgment, sounds, colors, logging).

Using Pre-defined Groups

The platform provides three default groups:

Creating Custom Groups

1. Navigate to Alarms → Groups
2. Click Plus icon
3. Configure properties:
   • Name: Group identifier
   • AckRequired: Force acknowledgment
   • Sound: Alert sound file
   • LogEvents: Enable historian logging
   • Colors: Visual identification
4. Click OK

Group Properties

Step 2: Create AlarmItems

AlarmItems monitor specific tag conditions.

Basic Configuration

1. Go to Alarms → Items
2. In first row, enter:
   • TagName: Tag to monitor (or select from list)
   • Condition: Trigger type
   • Limit: Threshold value
   • Group: Select AlarmGroup
3. Press Enter to save

Example Configurations

Condition Types

Advanced Properties

• Deadband: Hysteresis to prevent chattering
• Setpoint: Reference for deviation alarms
• Priority: Sorting in alarm displays (0-999)
• Message: Custom alarm text
• Area: Hierarchical grouping

Step 3: Configure Global Settings

Database Configuration

1. Navigate to Alarms → Global Settings
2. Configure Alarm Logging Database:
   • Database: SQLite (default) or external
   • Connection: Database connection string
   • LifeTime: Days to retain (e.g., 90)

Alarm Handling

Configure system-wide behaviors:

• Initial Disable Time: Startup suppression (seconds)
• Ignore During Deadband: Prevent alarm flooding
• LogUserFullName: Record operator names

Enable Audit Trail

Check events to track:

• User Login/Logout
• Tag Value Changes
• Alarm Acknowledgments
• System Configuration Changes

Step 4: Add Alarm Displays

Using AlarmViewer Control

1. Go to Displays → Draw
2. From component panel, navigate to Modules
3. Drag AlarmViewer to display
4. Configure properties:
   • Group: Filter by AlarmGroup
   • Area: Filter by AlarmArea
   • ShowAckButton: Enable acknowledgment

Pre-built Alarm Page

1. In Displays → Pages
2. Select New Page → AlarmPage template
3. Page includes:
   • AlarmViewer with filters
   • Acknowledgment controls
   • Historical query

Step 5: Test Alarms

Testing Procedure

1. Start Runtime:
   • Press F5 or click Run Test
   • Open display with AlarmViewer
2. Trigger Alarm:
   • Modify tag value to exceed limit
   • Verify alarm appears in viewer
   • Check sound plays (if configured)
3. Test Acknowledgment:
   • Click alarm row
   • Press Acknowledge button
   • Verify alarm state changes
4. Monitor Status:
   • Go to Alarms → Monitor
   • Check group counters
   • Verify logging to database

Runtime Properties

Access alarm status in scripts/displays:

@Alarm.Group.Critical.UnAckCount     // Unacknowledged count
@Alarm.Group.Warning.PriorityItem    // Highest priority alarm
@Alarm.TotalCount                    // Total active alarms

Common Issues

Alarm Not Triggering

• Verify tag name is correct
• Check condition logic
• Ensure alarm is not disabled
• Confirm tag value updates

Alarm Flooding

• Increase deadband value
• Add time delay (ActiveTimeDeadband)
• Group related alarms
• Use rate-of-change limits

No Sound

• Check sound file exists
• Verify audio settings
• Test with different file format
• Check group Show property

Acknowledgment Not Working

• Verify AckRequired is enabled
• Check user permissions
• Confirm runtime is connected
• Test AckTimeout setting

Best Practices

? Use appropriate groups - Critical for safety, Warning for information ? Set deadbands - Prevent chattering on analog alarms ? Configure priorities - Help operators focus on important alarms ? Write clear messages - Include equipment ID and condition ? Test all conditions - Verify both activation and normalization ? Document alarm philosophy - Define response procedures ? Regular maintenance - Review and tune alarm limits

Advanced Features

• [Alarm Notifications →] Email and SMS alerts
• [Limits by Shift →] Different thresholds per shift
• [Custom Sounds →] Unique alerts per group
• [Alarm Areas →] Hierarchical organization
• [Audit Trail →] Compliance tracking

Next Steps

• [Historian Module →] Log alarm events long-term
• [Scripts Module →] Custom notification methods
• [Reports Module →] Alarm performance metrics