alarmOrion-OrionArchiveAlarmProvider

In Niagara 4.11 and later, this component provides the alarm archive feature in the AlarmService where it archives cleared and closed alarms.

NOTE: The Alarm Archive feature is available only on Supervisor stations.

This component stores open, unacknowledged alarms in the local alarm database where the system can update alarm transitions, acknowledgements, notes, etc. often, and display the alarms in the alarm console. A schedule triggers the system to update cleared alarms to a remote database where retries-on-failure resolve any remote connectivity issues.

Figure 12. Example Alarm Archive architecture

An alarm becomes eligible to be archived once the AlarmService clears it from the alarm recipient console or alarm console (it returned to normal or was acknowledged). A cleared or closed alarm exists only temporarily in the local alarm database before being exported to the archive.

The OrionArchiveAlarmProvider archives alarm records in the configured relational database and can be extended to run periodically to export cleared alarms to a remote database.

Figure 13. OrionAlarmArchiveProvider properties

To access these properties, expand Config > Services > OrionAlarmService and double-click OrionAlarmArchiveProvider.

In addition to the standard properties (Status, Enabled, Fault Cause and Alarm Source Info), these properties configure this component.

Property	Value	Description
State	read-only	Reports the current state of the data transfer as: `Idle`, `Pending` or `In Progress`.
Execution Time	additional time trigger properties	Configures a time trigger that controls when to perform the function. Trigger properties are documented in the Getting Started with Niagara guide.
Cleared Alarm Linger time	hours minutes seconds	The minimum time that an alarm should remain in the cleared state before it can be archived. On execution, the provider will only export the alarm records eligible for archival since the lastUpdate time minus the `clearedAlarmLingerTime`.
Last Attempt	read-only	Reports the date and time of the last attempted execution.
Last Success	read-only	Reports the last time the station successfully performed this function.
Last Failure	read-only	Reports the last time the system failed to perform this function. Refer to `Fault Cause` for details.
Retry Trigger	additional time trigger properties	Defines how frequently to attempt a failed operation again. This continues until successful execution occurs. Appears in the Nav tree but not in any manager view and is unique in that it requires no linking of its output for operation. Getting Started with Niagara documents `Retry Trigger` properties.
Alarm on Failure	`true` (default) or `false`	Controls the recording of ping failure alarms. `true` records an alarm in the station’s AlarmHistory for each ping-detected device event (down or subsequent up). `false` ignores device down and up events.
Alarm Source Info	additional properties	Contains a set of properties for configuring and routing alarms when this component is the alarm source. For property descriptions, refer to the Niagara Alarms Guide
Rdb Ord	text	Defines the archive’s database ORD.

Actions

You can configure these actions in the OrionArchiveAlarmProvider’s Property Sheet or trigger them manually.

Execute archives the alarm records in the configured RDBMS server.
Retry exports the alarms that failed in the previous execution.
Import Open Alarms imports the alarms that are still open for execution.