Promotic
WikipediaLinkedInYoutubeTwitterFacebook

Acknowledge - method of object PmAlarmEvent

Description:
Alarm/Event item acknowledgement (acknowledgement of PmAlarmEventItem object).
Syntax:
Acknowledge(sId As String, [sUserNote As String], [tTimeAck As Date], [sExtra As String])
Calling:
oAlEv.Acknowledge sId, sUserNote, tTimeAck
Parameters:
sId(String) The unique text identifier of the alarm/event item. See the configurator "Identifier".

For the multiple acknowledgement of all alarm/event items, the text "$all" can be set.

Note!For the multiple acknowledgement of all alarm/event items that are in compliance with filtering criteria, it is possible to enter the "$all" text followed by filtration string.. For example$all;area:boiler1;

sUserNote[optional] (String) The text note that is stored to the data together with the acknowledged alarm/event item (it is enabled on the Storage page).
tTimeAck[optional] (Date) The acknowledge time of the alarm. If not used, the acknowledge time equals to the time of calling this method.
sExtra[optional] (String) Additional method parameters.

Entries with assigned value are separated by a semicolon, for example "ackerid:operator1;lang:en;".

"ackerid:xx;" - Identifier of user that acknowledged the alarm. This identifier is defined in the AckerId property of the corresponding alarm and will also be written to disk into the AckerId column (if this column is enabled for writing to disc). If the parameter is not entered then the identifier of user that acknowledged the alarm is used (local user or network user). For example"ackerid:operator1;".
"lang:xx;" - Definition of national language for Macro expression $.text. Language is determined with a text identifier, e.g. "en", "de", "ru" etc. - see Fully supported languages in the PROMOTIC system. If the language is not defined, the present language of running application is used instead. This is relevant for multiple acknowledgement with filtration string switched on (e.g. $all;area:boiler1;), where it is possible to set the language for evaluation of localized fields. For example"lang:en;".
Note:
The acknowledgement succeeds only when the locally logged-in user has the access right Acknowledge.

Calling the Acknowledge method over the acknowledged alarm has no effect. An unacknowledged alarm is acknowledged. The behaviour of the alarm during the acknowledgement is specified by the Acknowledge type configurator. The acknowledgement of the alarm is usually done interactively by the operator from the viewer of an alarm group.

If there are several instances of the alarm/event item with the same identifier (caused by alarm/event states inactive unacknowledged (blue)), the last, the latest old, item is acknowledged. Older alarm/event items can be acknowledged by the PmAlarmEventItem.Acknowledge method over the reference to the corresponding alarm/event item obtained by the Item property with using the auxiliary parameter tTimeOn.

After the attempt to acknowledge non-existing alarm/event item (wrong parameter sId), an error arises in the Info system only if in the corresponding PmAlarmEvent object there is no alarm/event item with the set configurator Template for dynamically created items (i.e. all alarm/event items of the PmAlarmEvent object are statically configured).

For the multiple acknowledgement of all alarm/event items, the text "$all" can be set in the sId parameter, or followed by filtration string.

It is irrelevant for events (relevant only for alarms).

The method is synchronous, i.e. it is processed immediately by the alarm subsystem. Nevertheless writing the history to disk is asynchronous, which means that this method passes the request for writing to the history to the alarm subsystem, it is placed into the queue of requests and it is processed later by the alarm subsystem.

Example1:
oAlEv.Acknowledge "T1_HI"
Example2:
oAlEv.Acknowledge "$all"
Example3:
oAlEv.Acknowledge "$all;area:boiler1;source:#begin:temperature;"
© MICROSYS, spol. s r. o.Tavičská 845/21 703 00 Ostrava-Vítkovice