Promotic

Acknowledge - metoda objektu PmaAlarmGroup

Popis:
Kvitace alarm položky (kvitace objektu PmAlarmItem).
Syntaxe:
Empty Acknowledge(String sId, [String sUserNote], [Date tTimeAck], [String sExtra])
Parametry:
sId(String) Jednoznačný textový identifikátor alarm položky. Viz konfigurátor "Identifikátor".
Pro hromadnou kvitaci všech alarm položek lze nastavit text "$all".
Poznámka! Pro hromadnou kvitaci všech alarm položek, splňujících zadané filtrační kritérium, lze zadat text "$all;" následovaný filtračním řetězcem. Například"$all;area:boiler1;"
sUserNote[nepovinné] (String) Textová poznámka, která se uloží do dat společně s kvitovanou alarm položkou (povoluje se v kartě "Uložení").
tTimeAck[nepovinné] (Date) Čas kvitace alarmu. Pokud není nastaveno, pak se použije aktuální čas počítače.
sExtra[nepovinné] (String) Dodatečné parametry metody.
Údaje jsou zde ve formátu KeyVal, například "ackerid:operator1;lang:en;".
"ackerid:xx;" - Identifikátor uživatele, který provedl kvitaci alarmu.
Tento identifikátor se nastaví do vlastnosti AckerId příslušného alarmu a bude také zapsán na disk do sloupce AckerId (pokud je tento sloupec pro zápis na disk povolen).
Pokud se parametr neuvede, pak se použije identifikátor uživatele, který kvitaci provedl (lokálně lokální uživatel, na Webu síťový uživatel).
Například"ackerid:operator1;".
"lang:xx;" - Určuje národní jazyk pro Makro výraz $.text.
Jazyk je určen textovým identifikátorem, např. "cs", "sk", "en" atd. - viz Jazyky s plnou podporou v systému PROMOTIC.
Pokud není nastaveno, pak se použije právě aktuální jazyk spuštěné aplikace. Má význam při hromadné kvitaci se zapnutým filtračním řetězcem (např. "$all;area:boiler1;"), kde lze ovlivnit jazyk pro vyhodnocení lokalizovaných textů.
Například"lang:en;".
Poznámka:
Kvitace se povede pouze pokud je splněno oprávnění "Acknowledge".
Volání metody Acknowledge nad kvitovaným alarmem nemá žádný účinek. Nekvitovaný alarm se kvituje. Chování alarmu při kvitaci se určuje v konfigurátoru "Typ kvitace". Kvitaci alarmu obvykle provádí interaktivně uživatel aplikace z prohlížeče skupiny alarmů.

Pokud existuje několik instancí alarm položky se stejným identifikátorem (způsobeno stavy alarm položek neaktivní nekvitovaný (modrý)), pak se kvituje poslední nejméně stará alarm položka. Kvitovat starší instanci alarm položky lze metodou PmAlarmItem.Acknowledge nad referencí na příslušnou alarm položku získanou metodou Item s využitím pomocného parametru tTimeOn.

Při pokusu kvitovat neexistující alarm položku (špatný parametr sId) vznikne chyba v INFO systému pouze pokud v příslušném objektu PmaAlarmGroup není žádná alarm položka se zatrženým konfigurátorem "Vzor pro dynamicky vytvářené položky" (to znamená, že všechny alarm položky objektu PmaAlarmGroup jsou staticky nakonfigurovány).
Kvitovat hromadně všechny alarm položky lze uvedením textu "$all" v parametru sId, případně následovaný filtračním řetězcem.

Metoda je synchronní, to znamená, že subsystém alarmů ji ihned vykoná. Nicméně vlastní zápis na disk do historie alarmů je asynchronní, to znamená, že tato metoda předá subsystému alarmů požadavek na zápis do historie, ten je zařazen do fronty požadavků a subsystém alarmů jej později vykoná.
Viz také:
Příklad1:
JavaScriptVBScriptVyber a zkopíruj do schránky

var oAl = pMe.Pm("/Alarm");
oAl.Acknowledge("T1_HI");
Příklad2:
JavaScriptVBScriptVyber a zkopíruj do schránky

var oAl = pMe.Pm("/Alarm");
oAl.Acknowledge("$all");
Příklad3:
JavaScriptVBScriptVyber a zkopíruj do schránky

var oAl = pMe.Pm("/Alarm");
oAl.Acknowledge("$all;area:boiler1;source:#begin:temperature;");

Historie:
Pm8.03.02: Přidán nový parametr sExtra s ackerid a lang.
Pm8.01.09: Nyní bere v úvahu poznamku UserNote i při hromadné kvitaci za pomocí příznaku "$all".
© MICROSYS, spol. s r. o.