Promotic
WikipediaLinkedInYoutubeTwitterFacebook

ActivateNew - method of object PmaAlarmGroup

Description:
The dynamic creation of a new alarm item (of the PmAlarmItem object) in the active and unacknowledged state (red) or the activation of already created item. The method returns the corresponding alarm item. The reference can be obtained also by calling the Item method.
Syntax:
Object ActivateNew(String sId, String sIdCopy, [String sSource], [String sDesc], [String sComment], [Date sTimeOn], [Long nAttr])
Calling:
oAl.ActivateNew sId, sIdCopy, sSource, sDesc, sComment, tTimeOn, nAttr
Parameters:
sId(String) The unique text identifier of the new alarm item. This identifier is used for calling methods, for example: Activate, Inactivate, Acknowledge, Item, etc.
sIdCopy(String) The unique text identifier of an alarm item of template type (see "Template for dynamically created items" configurator), whose configuration is used.
sSource[optional] (String) The specification of the source of an alarm item. It enables to the user to sort and filter alarm items in the viewer in the running application according to the specified source. If not set, then the template value is used.
sDesc[optional] (String) The description itself of the alarm item. The basic text of the alarm item that is displayed in the viewer in the running application. If not set, then the template value is used.
sComment[optional] (String) The text comment that is stored into the data together with the activated alarm item (it is enabled on the "Storage" page).
sTimeOn[optional] (Date) The activation time of the alarm item. If not set, then the computer current time is used.
nAttr[optional] (Long) Attributes that make more accurate the behaviour of the command when alarm item exist/doesn't exist.
0 (default) - When the alarm item with the specified idenfitier exists, the command makes the activation over the existing alarm item. When the alarm item with the specified idenfitier doesn't exist, the command creates a new alarm item with the activation that follows.
1 - When the alarm item with the specified idenfitier exists, the command fails. When the alarm item with the specified idenfitier doesn't exist, the command creates a new alarm item with the activation that follows.
Return Values:
Returns the newly created (or existing) and activated alarm item of the PmAlarmItem type. In case of an error, it returns the value null for JavaScript or Nothing pro VBScript (probably the alarm item with the set Id already exists). Nothing value can be tested by VBScript Is operator.
See also:
Example:
JavaScriptVBScriptSelect and copy to clipboard

oAl.ActivateNew("T1_HI", "HI", "Boiler", "T1 over high limit", "Temperature");
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