Alarms Global Settings (Reference) define system-wide
The Alarms Global Settings encompasses broad configurations for alarm management, including database settings for logging alarm events, determining behaviors upon system startup, and specific alarm handling parameters. Additionally, these properties offer robust audit trail capabilities, ensuring comprehensive tracking of various system events, user activities, and operational adjustments.
On this page:
Table of Contents | ||
---|---|---|
|
Tip | ||
---|---|---|
| ||
audit trail functionality. It configure:
Access via Alarms → Global Settings
Table of Contents maxLevel 2 minLevel 2 indent 10px exclude Steps style none
Setting | Description | Default |
---|---|---|
Database | Database type (SQLite, SQL Server, etc.) | SQLite |
Connection | Connection string | Local file |
Life Time | Days to retain alarm data (0 = forever) | 0 |
<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>
Setting | Description | Default |
---|---|---|
Initial Disable Time on Startup | Seconds to suppress alarms after startup | 00:00:00 |
Ignore Alarms During TimeDeadband | Ignore alarms during deadband period | False |
Enable LimitsByShift | Enable shift-based alarm limits | False |
LogUserFullName | Log full user name vs username | False |
Setting | Description | Default |
---|---|---|
Enable Audit Trail | Activate audit logging | False |
User Logon/Logoff | Log user sessions | False |
Open/Close Displays | Log display navigation | False |
Remote Connections | Log client connections | False |
Custom Messages | Log custom audit messages | False |
Tag Changes | Log all tag value changes | False |
Datasets | Log database operations | False |
Operator Actions | Log operator commands | False |
Save Reports | Log report generation | False |
System Warnings | Log system events | False |
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;
Prevents nuisance alarms during startup:
Example: Set to 00:01:00 (1 minute) for complex systems
When enabled:
When Enable LimitsByShift is active:
See [Alarm Limits by Shift] for configuration
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"
);
csharp
// Enable/disable options at runtime
@Alarm.GlobalSettings.AuditTrail.UserLogonLogoff = true;
@Alarm.GlobalSettings.AuditTrail.TagChanges = false;
For regulatory compliance:
Configure retention:
Life Time = 2555 days (7 years)
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;
Database connection failed:
Audit trail not logging:
Alarms triggering at startup:
Database growing too large:
Page Tree | ||
---|---|---|
|
The Global Settings interface is composed of three parts, they are:
See more details on each of them in the sections below.
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:
Setting | Description |
---|---|
Database | The type of database used. The default option is SQL Lite. You can adjust this setting by clicking the gear icon. |
Connection | The connection string for database connection. |
Life Time | Defines the amount of time the data remains in the database (in days).* |
The Alarm Handling setting manages the alarms considering the operational status of the devices. See below a table with all available settings this section:
Setting | Description |
Initial Disable Time on Startup | This setting determines the period during startup when alarms are disabled. It ensures that alarms are not triggered immediately upon startup, allowing the system to stabilize first. |
Ignore Alarms During TimeDeadband | This option enables the system to ignore alarms during a specified TimeDeadband. |
Enable LimitsByShift | Allows the user to set different alarm limits based on different work shifts. See our Alarm Limits by Shift. |
LogUserFullName | Option to log the complete name of the user. |
→ Learn more on the Audit Trail page.
In this section: