Page History

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

Configuration Sections

Alarm Logging Database

<ac:structured-macro ac:name="warning"> ac:rich-text-body Note: Life Time function not compatible with PostgreSQL TimeScaleDB extension </ac:rich-text-body> </ac:structured-macro>

Alarm Handling

Audit Trail

Database Configuration

Supported Databases

• SQLite (default, embedded)
• SQL Server
• PostgreSQL
• MySQL
• Oracle

Connection String Examples

SQLite (default):

Provider=System.Data.SQLite;Data Source=_ExecutionPathAndName_.dbAlarm

SQL Server:

Server=localhost;Database=AlarmHistory;Trusted_Connection=true;

PostgreSQL:

Host=localhost;Database=alarms;Username=user;Password=pass;

Startup Behavior

Initial Disable Time

Prevents nuisance alarms during startup:

• System initializes without triggering alarms
• Tags stabilize to normal values
• After timeout, normal alarm processing begins

Example: Set to 00:01:00 (1 minute) for complex systems

TimeDeadband Handling

When enabled:

• Alarms ignored during group deadband period
• Prevents alarm flooding
• Useful for known transient conditions

Shift-Based Limits

When Enable LimitsByShift is active:

• AlarmItems use Limit, Limit1, Limit2
• Different thresholds for different shifts
• Automatic switching based on schedule

See [Alarm Limits by Shift] for configuration

Audit Trail Configuration

Enabling Audit Trail

1. Check Enable Audit Trail
2. Select events to log
3. Configure database (uses alarm database)
4. View in AlarmViewer with List = "AuditTrail"

Custom Messages

Add via script:

csharp

@Alarm.GlobalSettings.AuditTrail.AddCustomMessage(
    message: "Batch completed",
    areaName: "Production",
    objectName: "Reactor1",
    value: "500",
    itemName: "BatchID",
    auxValue: "Grade A",
    comment: "Normal completion"
);

Runtime Control

csharp

// Enable/disable options at runtime
@Alarm.GlobalSettings.AuditTrail.UserLogonLogoff = true;
@Alarm.GlobalSettings.AuditTrail.TagChanges = false;

FDA 21 CFR Part 11 Compliance

For regulatory compliance:

1. Enable Audit Trail - Required
2. User Logon/Logoff - Track user access
3. Operator Actions - Record all changes
4. System Warnings - Log system events
5. Tag Changes - Track process modifications

Configure retention:

Life Time = 2555 days (7 years)

Runtime Access

Access settings programmatically:

csharp

// Check audit trail status
bool auditEnabled = @Alarm.GlobalSettings.AuditTrail.IsEnabled;

// Add custom message
@Alarm.GlobalSettings.AuditTrail.AddCustomMessage("Process started");

// Check database connection
string dbConnection = @Alarm.GlobalSettings.Database.Connection;

// Modify settings
@Alarm.GlobalSettings.LogUserFullName = true;

Best Practices Checklist

•  Size database appropriately - Audit trail generates significant data
•  Set reasonable retention - Balance compliance vs storage
•  Test startup delays - Find optimal disable time
•  Selective audit logging - Only log necessary events
•  Regular database maintenance - Archive old data
•  Document settings - For compliance audits
•  Monitor database growth - Prevent storage issues

Troubleshooting

Database connection failed:

• Verify connection string
• Check database service running
• Confirm network access
• Review user permissions

Audit trail not logging:

• Confirm Enable Audit Trail checked
• Verify specific options enabled
• Check database write permissions
• Review disk space

Alarms triggering at startup:

• Increase Initial Disable Time
• Enable Ignore During TimeDeadband
• Review startup sequence

Database growing too large:

• Set Life Time appropriately
• Archive old data regularly
• Consider separate audit database
• Optimize logged events

In this section...

Configurating Global Settings

The Global Settings interface is composed of three parts, they are:

• Alarm Logging Database
• Alarm Handling
• Audit Trail

See more details on each of them in the sections below.

Alarm Logging Database

The Alarm Logging Database setting manages where and how alarms are logged. Users can choose the database type, define connection parameters, and configure the life span of stored alarm logs. See below a table with all available settings for alarm loggings:

Alarm Handling

The Alarm Handling setting manages the alarms considering the operational status of the devices. See below a table with all available settings this section:

Audit Trail

→ Learn more on the Audit Trail page.

In this section: