Promotic
WikipediaLinkedInYoutubeTwitterFacebook

Acknowledge - method of object PmAlarmEventItem

Description:
Alarm item acknowledgement.
Syntax:
Acknowledge([sUserNote As String], [tTimeAck As Date], [sExtra As String])
Calling:
oAlEvItem.Acknowledge sUserNote, tTimeAck
Parameters:
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 set, then the acknowledge time equals to the time of calling this method.
sExtra[optional] (String) Additional parameters parameters.

Entries are in format PmNamedValues, 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 not set, then 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 local 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 user from the viewer of an alarm group.

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, it 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.

Example:
Dim oAlItem
Set oAlItem = oAlEv.Item("Temperature")
oAlItem.Acknowledge "UserNote"
PROMOTIC 8.3.21 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