Promotic
WikipediaLinkedInYoutubeTwitterFacebook

Alarm item

Description:
The configurator of an alarm item. It allows to configure the alarm item already in the development environment. The advantage is that the alarm group knows about this item from starting the application and only the state of the alarm item can be changed.
Configuration items:
IdentifierThe unique text identifier of the item in the group that enables to refer to the alarm item in the application code.

This configurator sets the initial value of the property PmAlarmItem.Id.

It is used, for example, in the PmaAlarmGroup.Item method for getting the reference to the corresponding item. It is not stored into the data by default (it is enabled on the "Storage" page).

This is a system name, so it must contain only alphanumeric and must not contain any diacritics, empty string, spaces and the first character must not be a number.
SourceThe text that specifies the logical placement of an alarm item in the technology.

This configurator sets the initial value of the property PmAlarmItem.Source.

It is used in the viewer of an alarm group by the end user for filtering the items according to the source. It means that it enables to show only those alarm items of the group that refer to the specified source.

Macro expression can be used for input ($.text ..) (it is evaluated while the window is opening). Caution: Macro expression $vb cannot be used for input.

Description (desc)The description of an alarm item itself.

This configurator sets the initial value of the property PmAlarmItem.Description.

The main text of the item that is seen by the end user in the viewer of an alarm group.

Macro expression can be used for input ($.text ..) (it is evaluated while the window is opening). Caution: Macro expression $vb cannot be used for input.

PriorityPriority of the alarm item.

This configurator sets the initial value of the property Priority.

0 = low
1
2
3
4
5 = medium
6
7
8
9
10 = high
Inactivate typeThe configurator specifies the behaviour of an alarm item during the inactivation by the PmAlarmItem.Inactivate method.
0 = automatic inactivation during activation - The inactivation doesn't do anything, alarm item is always inactive.
1 = pure inactivation - The inactivation makes only alarm item inactive.
2 = inactivation and automatic acknowledgement - The inactivation makes the item inactive together with the automatic acknowledgement. Alarm item becomes inactive, acknowledged.
Acknowledge typeThe configurator specifies the behaviour of an alarm item during the acknowledgement in the viewer of an alarm group or by the PmAlarmItem.Acknowledge method.
0 = automatic acknowledgement during activation - The acknowledgement doesn't do anything. Alarm item is always acknowledged.
1 = acknowledgement only - The acknowledgement makes only alarm item acknowledged.
2 = acknowledgement and automatic inactivation - The acknowledgement makes the acknowledged together with the automatic inactivation. Alarm item becomes inactive, acknowledged.
Activate delay [sec]The configurator specifies the delay of the alarm activation in seconds. The value 0 means that the activation is started immediately. If the value is greater than 0, then the alarm activation moves the alarm into the state of the suspicion to the activation, when the time of the activation delay starts counting. The alarm activation starts automatically after the time delay elapses. The creation time when the alarm came into the suspicious state, is recorded as the time of the alarm activation (or the time set by the tTimeOn parameter). If the alarm finds itself in the state of the suspicion to the activation, then the next activation doesn't do anything but the inactivation recalls immediately the state of the suspicion to the activation. The suspicion itself doesn't mean the change of the alarm state and the suspicion is not displayed in the viewer of the state or the history. So there is no record in the history about the unacknowledged suspicion.

By this method it is possible to prevent unnecessary activation/inactivation of alarms caused by some swings of values of the watched variable, for example, by the interference or failure of the communication. By this method it is also possible to implement alarms for the actions with the 'timeout', when the alarm is activated with delayed activation before such action and after detection of the successful termination of the action, the alarm is inactivated. If the action is not successfully terminated in the set time, then the alarm in the suspicion is activated automatically in the set time.

Inactivate delay [sec]The configurator specifies the delay of the alarm inactivation in seconds. The value 0 means that the inactivation is started immediately. If the value is greater than 0, then the alarm inactivation moves the alarm into the state of the suspicion to the inactivation, when the time of the inactivation delay starts counting. The alarm inactivation starts automatically after the time delay elapses. The original time when the alarm came into the suspicious state, is recorded as the time of the alarm inactivation (or the time set by the tTimeOff parameter). If the alarm finds itself in the state of the suspicion to the inactivation, then the next inactivation doesn't do anything but the activation recalls immediately the state of the suspicion to the inactivation. The suspicion itself doesn't mean the change of the alarm state and the suspicion is not displayed in the viewer of the state or the history. So there is no record in the history about the unacknowledged suspicion.
EnabledEnable/disable the state change of an alarm item in the running application.

This configurator sets the initial value of the property PmAlarmItem.Enabled.

Template for dynamically created itemsThe alarm item meant only for the development environment that serves as a template for creating dynamic alarm items in the running application. See: PmaAlarmGroup.RegisterNew and PmaAlarmGroup.ActivateNew.
Delete inactive acknowledged (green)If Yes, then the alarm item is deleted from the list if it becomes inactive and acknowledged at the same time. For alarms, see the state inactive acknowledged (green). It has sense only as a template for creating dynamic alarm items.
By parent - The value is not set locally. It is taken from the setting the PmaAlarmGroup group Delete inactive acknowledged (green) (valid only for dynamically created items).
No - Inactive acknowledged items (green) are not deleted and they will exist from now on. Caution! Then at the dynamic alarm items it can come into the unlimited build-up of their count.
Yes - Inactive acknowledged items (green) are deleted and they won't exist from now on. It is suitable first of all for dynamic event items that are repeatedly generated by the PmaAlarmGroup.ActivateNew method. The event item doesn't appear in the viewer of the states (it has no sense for events mostly) and it appears only in the viewer of the history.
Sound notificationThe way of sound indication of an alarm items state.
By parent - The value is not set locally, it is taken from the setting the "Sound notification" configurator in the PmaAlarmGroup object.
0 = no sound
1 = sound stops after Acknowledge or Inactivate
2 = sound stops after Acknowledge and Inactivate
3 = sound stops after Acknowledge
Sound parametersSound playback method parameters (valid only for sound server). This is a text in the KeyVal format. For example "file:#pmres:Sound/alarm01.wav;repeat:5;delay:2.5;".

System dialog "Sound parameters" can be used for sound selection and playback parameter setting (allowing also sound sample playback).

file:xx; - Sound file. It is recommended to use the PROMOTIC path syntax - see PROMOTIC path to files and folders.

There are some *.wav files located in the Promotic folder ("\Promotic\PmVXXYY\Resource\Sound") that can be used. The link to these files is for example #pmres:Sound/alarm01.wav.

The designer can create personal files and place them into the application source folder (see "Paths to system folders" configurator). For example of the filelink: #appres:MySound1.wav.

repeat:xx; - The number of sound repeat (-1 = unlimited, default).
delay:xx; - Delay while repeating in seconds (e.g. delay:0.5;). The delay is a minimal time between an end of previous and a start of next replaying of the same sound. The delay can be greater if another sound is being replayed at the moment (need to wait for its end) or some others sound of higher priority are in a queue. Default option is delay:0;.

History:
Pm9.00.02: Modification of entry values in Priority configurator from three possible values 0,5,10 to a range of values 0-10.
PROMOTIC 9.0.7 SCADA system documentation - MICROSYS, spol. s r.o.

Send page remarkContact responsible person
© MICROSYS, spol. s r. o.Tavičská 845/21 703 00 Ostrava-Vítkovice