Alarms Module (How-to Guide)

Alarms → Tutorial | Concept | How-to Guide | Reference

In this section...

Configuration Workflow

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. Enter in the table first row:
   • TagName: Tag to monitor
   • Condition: Trigger type
   • Limit: Threshold value
   • Group: Select AlarmGroup
   • Message: Alarm description
3. Press Enter to save

Example Configurations

Condition Types

Advanced Properties

• Deadband: Hysteresis to prevent chattering
• Setpoint: Reference for deviation alarms
• Priority: Display sorting (0-999)
• Area: Hierarchical grouping

Configure Global Settings

Navigate to Alarms → Global Settings

Database Configuration

• Database: SQLite (default) or external
• Connection: Database connection string
• LifeTime: Days to retain (0 = forever)

Alarm Handling

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

Enable Audit Trail

Check events to track:

• User Logon/Logoff
• Tag Changes
• Operator Actions
• Custom Messages

Add Alarm Displays

Using AlarmViewer Control

1. Go to Displays → Draw
2. From toolbox, navigate to Modules
3. Drag AlarmViewer to display
4. Double-click to open configuration dialog:
   • List: OnlineAlarms or AlarmHistory
   • Group Filter: Select specific groups
   • Area Filter: Select specific areas
   • Show Acknowledged: Display options
5. Click OK to apply

Pre-built Alarm Page

1. In Displays → Pages
2. Select New Page → AlarmPage template
3. Page includes configured AlarmViewer with controls

Test Alarms

Testing Procedure

1. Start Runtime: Press F5
2. Trigger Alarm: Modify tag value to exceed limit
3. Verify Display: Check alarm appears in viewer
4. Test Acknowledgment: Select alarm and acknowledge
5. Monitor Status: Check Alarms → Monitor

Runtime Access

Access alarm properties in scripts:

csharp

@Alarm.Group.Critical.UnAckCount     // Unacknowledged count
@Alarm.TotalCount                    // Total active alarms
@Alarm.Item.TagName.Active          // Specific alarm state

Create Alarm Areas

Organize alarms hierarchically:

1. Navigate to Alarms → Areas
2. Create structure:
   • Plant
     • Production
     • Utilities
     • Storage
3. Assign areas to AlarmItems

Common Issues

Alarm Not Triggering

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

Alarm Flooding

• Increase deadband
• Add time delays
• Group related alarms

No Sound

• Check file exists
• Verify audio enabled
• Test file format

Acknowledgment Issues

• Verify AckRequired enabled
• Check user permissions
• Confirm runtime connected

Best Practices

• Use appropriate groups - Match severity to response
• Set deadbands - Prevent analog chattering
• Configure priorities - Focus operator attention
• Write clear messages - Include equipment and condition
• Test conditions - Verify activation and clearing
• Document philosophy - Define response procedures
• Regular maintenance - Review and tune limits

Next Steps

• [Alarm Notifications] - Email and SMS setup
• [Alarm Areas] - Hierarchical organization
• [Audit Trail] - Compliance configuration

In this section...