Promotic
WikipediaLinkedInYoutubeTwitterFacebook

Alarm/Event item

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

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

It is used, for example, in the PmAlarmEvent.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 and must not contain empty string, diacritics, spaces and the first character must not be a number.
SourceThe text that specifies the logical placement of an alarm/event item in the technology.

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

It is used in the viewer of the alarm/event group by the end user for filtering the items according to the source. This enables to show only those alarm/event 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 can not be used for input.

DescriptionThe description of an alarm/event item itself.

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

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

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

PriorityPriority of the alarm/event item.

This configurator sets the initial value of the property Priority.

0 = low
5 = medium
10 = high
Inactivate typeThe configurator specifies the behaviour of an alarm/event item during the inactivation by the PmAlarmEventItem.Inactivate method. Meant only for the item of the Alarm type (not Event).
0 = automatic inactivation during activation - The inactivation doesn't do anything, the item is always inactive.
1 = pure inactivation - The inactivation makes only the item inactive.
2 = inactivation and automatic acknowledgement - The inactivation makes the item inactive together with the automatic acknowledgement. The item becomes inactive, acknowledged.
Acknowledge typeThe configurator specifies the behaviour of an alarm/event item during the acknowledgement in the viewer of an alarm/event group or by the PmAlarmEventItem.Acknowledge method. Meant only for the item of the Alarm type (not Event).
0 = automatic acknowledgement during activation - The acknowledgement doesn't do anything, the item is always acknowledged.
1 = acknowledgement only - The acknowledgement makes only the item acknowledged.
2 = acknowledgement and automatic inactivation - The acknowledgement makes the item acknowledged together with the automatic inactivation. The item becomes inactive, acknowledged.
Activate delay [sec]Meant only for the item of the Alarm type (not Event). 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). When 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 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, the alarm in the suspicion is activated automatically in the set time.

Inactivate delay [sec]Meant only for the item of the Alarm type (not Event). 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). When 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.
EnabledEnables/disables the state change of an alarm/event item in the running application.

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

Template for dynamically created itemsThe alarm/event item meant only for the development environment that serves as a template for creating dynamic alarm/event items in the running application. See: PmAlarmEvent.RegisterNew and PmAlarmEvent.ActivateNew.
Delete inactive acknowledged (green)If Yes, then the 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/event items.
By parent - The value is not set locally. It is taken from the setting the PmAlarmEvent 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. Warning! Then at the dynamic alarm/event 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 PmAlarmEvent.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 notificationMeant only for the item of the Alarm type (not Event). The way of sound indication of an alarm items state.

This configurator sets the initial value of the property PmAlarmEventItem.SoundMode.

By parent - The value is not set locally, it is taken from the setting the Sound notification configurator in the PmAlarmEvent group.
0 = no sound
1 = sound stops after Acknowledge or Inactivate
2 = sound stops after Acknowledge and Inactivate
3 = sound stops after Acknowledge
Sound playerThe configurator sets the sound playback method.
0 = beeper (obsolete, only for OS Windows XP) - The sound is generated on an internal beeper in a form of simple tone. The higher number of sound active alarms the higher pitch.

Caution!The internal beeper works correctly only in OS Windows XP (if present). In OS Windows Vista it does not work at all and in OS Windows 7 its functionality is transferred to soundcard, but not exactly (the tone pitch is constant).

1 = sound server - The sound is played by a sound server on a sound card of a computer. The sound itself is in a form of WAV sound file. The additional parameters can define the number of sound repeating (provided the alarm is still sound active) and eventually the delay between sound repeating. The sounds are queued both by rise time of a request and by priority of an alarm. The sound which starts playing is always played to its end. There is always maximally one played sound at the moment. Sounds are played one by one.
Sound parametersSound playback method parameters (valid only for sound server). It is a text in format PmNamedValues. For example "file:#pmres:Sound/alarm01.wav;repeat:5;delay:2.5;".

The system dialog can be used for sound selection and playback parameter setting (allowing also the sound 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 ("/Pm/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 the configurator "Paths to system folders"). For example of the filelink: #appres:MySound1.wav.

repeat:xx; - Sound repeat number (-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;.
© MICROSYS, spol. s r. o.Tavičská 845/21 703 00 Ostrava-Vítkovice