Alarm Parameters

[Alarm]Ack - Obsolete in version 7.30.

[Alarm]AckHold - Determines whether alarms that have become inactive (and have been acknowledged) remain in the OFF ACKNOWLEDGED alarm list.

[Alarm]Active - The period (in milliseconds) at which the clients are advised of a change in alarms.

[Alarm]AlarmDisable - Enables/disables the processing of alarms.

[Alarm]AlarmListRequestTimeout - Specifies the length of time (in seconds) that an alarm display will wait to receive data from all clusters.

[Alarm]ArchiveAfter - Sets the amount of time between each archive of Event Journal data.

[Alarm]ArgyleTagValueTimeout - Obsolete in version 2015.

[Alarm]BackgroundColorMode - Sets the background color mode of the alarm list and alarm banner on the Tab_Style templates.

[Alarm]BrowseRowLimit - Defines the maximum number of rows per cluster that will be returned in an alarm browse.

[Alarm]CacheLength - Obsolete in version 7.30.

[Alarm]CacheSize - Defines the amount of memory (in megabytes) dedicated to the storage of event data.

[Alarm]DBLogDBServer - Defines logging for the alarm server database.

[Alarm]DBLogHistoric - Defines logging for Historian operations on the alarm server database.

[Alarm]DBLogServerCore - Defines logging for the analysis of redundancy and synchronization issues.

[Alarm]DefaultSOETimeRange - Obsolete in version 2015.

[Alarm]DefDspFmt - Specifies an Alarm display format to use if the Alarms Display Format field is blank (in Alarm Categories).

[Alarm]DefSOEFmt - Specifies an SOE display format to use if the SOE Display Format field is blank (in Alarm Categories).

[Alarm]DefSumFmt - Specifies an Alarm Summary display format to use if the Summary Display Format field is blank (in Alarm Categories).

[Alarm]DeltaTimeUpdate - Determines if DeltaTime (duration) field is set on non-OFF alarms by calculating volatile duration between current time and the time when the alarm was activated.

[Alarm]DisableFilterOptimization - Allows you to turn off filter optimization.

[Alarm]DisableSOE - Used to turn off the storage of events.

[Alarm]DisableSummary -Used to turn off the storage of summary events.

[Alarm]DisplayDisable - Changes the meaning of the AlarmDisable() function.

[Alarm]EnableErrorLogging - Enables or disables the logging of operational errors.

[Alarm]EnableSmartCustomFilters - Enables/disables the caching of custom alarm queries to facilitate the use of the same filter later.

[Alarm]EnableStateLogging - Enables or disables the logging of major alarm system state changes.

[Alarm]EventFmt - Specifies the format of the event queue string.

[Alarm]EventQue - Enables/disables the Alarm event queue on the Alarms Server.

[Alarm]ExtendedDate - Specifies if extended date format is used in alarm formatting.

[Alarm]FilterViewByPrivilege - Obsolete in v7.30.

[Alarm]FlushTimeLimit - The alarm server flushes Event Journal entries to disk periodically (every 60 seconds). Set this parameter to determine the maximum duration of each alarm server flush.

[Alarm]FutureMessages - Defines the maximum amount of time in the future that is permitted for future Event Journal messages

[Alarm]HardHoldTime - The time (in seconds) to hold a hardware alarm in its alarm state before it is reset.

[Alarm]HardReAlarm - Obsolete in v7.0.

[Alarm]HardwareDisable - Enables/disables the processing of hardware alarms.

[Alarm]HeadingFont - Determines the text font used for column headings displayed on the alarm templates.

[Alarm]HeartbeatTimeout - Defines how long a server will wait before terminating a link that has been used for receiving heartbeat poll requests from its pair server, but is currently idle.

[Alarm]HighResOff - Sets the precision of time stamped alarms.

[Alarm]Hres24HrDeadBand - Determines the "previous day" deadband on time stamped alarms.

[Alarm]HresTimerExprDelay - Allows you to configure and fine tune time delay.

[Alarm]HresType - Determines the time format used to record time stamped alarms.

[Alarm]HwAlarmFmt - Defines the format of the data written into the hardware alarm queue and placed in the string field.

[Alarm]HwAlarmQueMax - Specifies the maximum length of the hardware alarm queue.

[Alarm]HwExclude - Specifies a list of hardware alarms that the hardware alarm system will not process.

[Alarm]IsolationDetectInterval - Sets the interval between ICMP packets to detect network isolation on alarm servers.

[Alarm]IsolationDetectIP1 - Determines the status of the disconnected alarm server and keeps the disconnected alarm server in 'non-main' state. Use this parameter to apply setting to all servers on machine.

[Alarm]IsolationDetectIP2 - Determines the status of the disconnected alarm server and keeps the disconnected alarm server in 'non-main' state. Use this parameter to apply setting to all servers on machine.

[Alarm]IsolationDetectRetryCount - Sets the ICMP retry count to detect network isolation on alarm servers.

[Alarm]KeepOnlineFor - Sets the amount of time for which the Alarm Server stores event messages on-line.

[Alarm]LastAlarmCategories - Determines which alarms are displayed on the alarms toolbar, based on category.

[Alarm]LastAlarmDisplayMode - Determines whether the last alarm is displayed by category or priority.

[Alarm]LastAlarmFmt - Specifies the format of the last alarm as displayed on the included templates.

[Alarm]LastAlarmPriorities - Determines which alarms are displayed on the alarms toolbar, based on priority.

[Alarm]LastAlarmType - Determines which alarms are displayed in the alarms toolbar, based on type.

[Alarm]MaxOptimisedQueries - Sets the number of queries that can be cached.

[Alarm]MaxQueryExecuteTime - Creates a log entry if an internal SQL query takes longer than a specified amount of time.

[Alarm]MemoryWarningLimit - Value in Mb, of the threshold of the alarm server memory.

[Alarm]MonitorConnectTimeout - Defines the amount of time, in seconds, that the server will wait for a monitor connection to occur.

[Alarm]MonitorRequestTimeout - Defines the amount of time, in seconds, that the server will wait for a response from the other server in the pair.

[Alarm]Period - The period for rate of change alarms.

[Alarm]Primary - Obsolete in version 7.0.

[Alarm]Process - Obsolete in version 7.0.

[Alarm]QueryCPUUsage - Defines the percentage of processor use you want allocate to query searches.

[Alarm]QueryRowLimit - Defines the maximum number of rows that can be returned in the result set for a single query.

[Alarm]QueryTimeout - Defines the amount of time (in seconds) that is permitted for query searches.

[Alarm]ReloadBackOffTime -Back-off time configured to control the pace of the reload on an alarm server.

[Alarm]SavePeriod - Obsolete in version 7.30.

[Alarm]SavePrimary - The path to the primary save file.

[Alarm]SaveSecondary - The path to the secondary save file.

[Alarm]SaveStyle - Obsolete in version 7.30.

[Alarm]ScanTime - Determines the rate at which an alarm server can receive updates from an I/O server.

[Alarm]Server - Obsolete in version 7.0.

[Alarm]SetTimeOnAck - Determines whether the {Time} field in the Alarm Display and Alarm Log Device contains the time when an alarm is triggered, or the time when the alarm is acknowledged.

[Alarm]SetTimeOnOff - Determines whether the {Time} field in your Alarm Display and Alarm Log Device contains the time when an alarm is triggered, or the time when the alarm becomes inactive.

[Alarm]SOERowLimit - Obsolete in version 2015.

[Alarm]ShowAllConfigured - When set to true, it will show configured alarms on an alarm list using mode 4 (show configured alarms).

[Alarm]Sort - Determines the order in which alarms are displayed in the alarm list.

[Alarm]SortMode - Determines the sort order for displaying alarms.

[Alarm]Sound<n> - Determines the wav file that is played when an alarm of priority <n> occurs.

[Alarm]Sound<n>Interval - Determines the interval of time before the alarm sound for priority <n> alarms will be repeated.

[Alarm]SoundSilenceTimeoutOnAck - Determines the timeout period in seconds for silencing alarm after the user acknowledges any alarms using the Tab_Style templates.

[Alarm]StandbyCommandDelay - Sets a delay that a standby alarm server will apply when executing alarm commands received from the main alarm server.

[Alarm]StartTimeout - Sets the timeout period for loading each packet from the primary Alarms Server. This parameter has been reinstated for v2015 only.

[Alarm]StreamSize - Defines the amount of data that is included in an event data file.

[Alarm]SummaryAutoRefreshMode - Represents the default value for AlarmSetInfo type 15.

[Alarm]SummaryBufferSize - Specifies the value to limit the size of the alarm summary buffer.

[Alarm]SummaryLength - Obsolete in version 2015.

[Alarm]SummaryMode - Specifies whether alarm summary events are logged to the Alarm Summary log device in the order they went ON, or in the order they went OFF.

[Alarm]SummarySort - Specifies whether OnTime, OffTime or AckTime will be used to determine the order in which alarms will be listed on the alarm summary page.

[Alarm]SummarySortMode - Specifies whether alarms listed on the alarm summary page will be displayed in ascending or descending order.

[Alarm]SummaryTimeout - The length of time after which an alarm summary entry is considered timeout.

[Alarm]SummaryTimeoutTolerance - The length of time from timeout after which an alarm summary entry is committed to Summary Device regardless the fact that Off Time is not set.

[Alarm]SummaryTolerance - Obsolete is version 2015.

[Alarm]SummaryShutdownMode - Specifies whether alarm summary entries that have not been logged are logged at shutdown.

[Alarm]SumStartupCopy - Determines whether the alarm summary data is copied to the other Alarms Server on startup.

[Alarm]SumStateFix - Obsolete is version 2015.

[Alarm]SyncAllHistoricData - On multi-server systems, the Primary server and Standby server synchronize their data so that the Standby server contains an accurate, up to date backup of the Primary server’s data.

[Alarm]TimeDate - Specifies the time/date string format used by Cicode functions that support ONTIMEDATE or OFFTIMEDATE.

[Alarm]TransferConnectTimeout - Defines the amount of time, in seconds, that the Primary server will wait for a connection to occur.

[Alarm]TransferInterleave - Controls how often the data synchronization is triggered by the Primary to the Standby Server.

[Alarm]TransferInterval - Defines the number of seconds between each attempt to update the data on the Standby server.

[Alarm]TransferRequestTimeout - Defines the amount of time, in seconds, that the Primary server will wait for the Standby server to respond to a data transfer request.

[Alarm]UseConfigLimits - Forces the Plant SCADA alarm server to use alarm property values from the runtime database.

[Alarm]UseInOperatorForGroupCommands - Determines if the IN operator is used by Cicode alarm functions that can be passed a handle for a group that contains more than one item.

[Alarm]WebClientUpdatePollPeriod - Obsolete in version 2015.

AVEVA™ Plant SCADA

Alarm Parameters

Table of Contents

Alarm Parameters

See Also

Related Links