| Identifier | The unigue text identifier of the item in the group that allows to refer to the alarm item in the application code.
This configurator sets the initial value of the PmAlarmItem.Id property. It is used, for example, in the PmaAlarmGroup.Item method for obtaining the reference to the corresponding item. It is not stored into the data by default (it is enabled on the "Storage" tab). This is a system name, so it must contain only alphanumeric and must not contain any diacritics (i.e. national dependent characters), empty string, spaces and first character must not be a number. |
|---|---|
| Source | The text specifies the logical placement of the alarm item the technology.
This configurator sets the initial value of the PmAlarmItem.Source property. It is used in the alarm viewer by the end user for filtering the items according to the source. It means that it allows 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 the alarm item itself.
This configurator sets the initial value of the PmAlarmItem.Description property. The main text of the item that is seen by the end user in the alarm viewer. 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. |
| Priority | Priority of the alarm item.
This configurator sets the initial value of the Priority property. 0 = low
1
2
3
4
5 = medium
6
7
8
9
10 = high |
| Inactivate type | The configurator specifies the behavior of the alarm item during the inactivation by the PmAlarmItem.Inactivate method. |
| Acknowledgment type | The configurator specifies the behavior of the alarm item after acknowledgment in the alarm state viewer or by the PmAlarmItem.Acknowledge method.
0 = automatic acknowledgment during activation - The acknowledgment doesn't do anything. Alarm item is always acknowledged.
1 = acknowledgment only - The acknowledgment makes only alarm item acknowledged.
|
| Activate delay [sec] | The configurator specifies the delay of the alarm activation in seconds. The 0 value means that the activation is started immediately.
If the value is greater than 0, then the alarm activation moves the alarm to 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 in 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 alarm viewer of the state or the history. So there is no record in 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 deactivated. 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 0 value means that the inactivation is started immediately.
If the value is greater than 0, then the alarm inactivation moves the alarm to 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 inactivation time (or the time set in 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 alarm viewer of the state or the history. So there is no record in history about the unacknowledged suspicion. |
| Enabled | Enable/disable the state change of the alarm item in the running application.
This configurator sets the initial value of the PmAlarmItem.Enabled property. |
| Template for dynamically created items | The 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 dynamically creating 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 (green) alarms 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 (green) alarms are deleted and they will not exist from now on. It is suitable first of all for dynamically created alarms that are repeatedly generated by the PmaAlarmGroup.ActivateNew method. |
| Sound notification | The 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 acknowledgment or inactivate
2 = sound stops after acknowledgment and inactivate
3 = sound stops after acknowledgment |
| Sound parameters | Sound 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;".
The "Sound parameters" configuration window can be used for sound selection and playback parameter setting (allows also sound sample playback). file:xx; - Sound file. It is recommended to use the PROMOTIC path syntax - see PROMOTIC path to files or folders.
Files of the *.wav type are in the \Promotic\PmVXXYY\Resource\Sound folder. 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 the "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 of sound 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 the queue.
The default value is delay:0;. |