Promotic
WikipediaLinkedInYoutubeTwitterFacebook

Acknowledge - metoda objektu PmAlarmEvent

Popis:
Kvitace alarm položky (kvitace objektu PmAlarmEventItem).
Syntaxe:
Acknowledge(sId As String, [sUserNote As String], [tTimeAck As Date], [sExtra As String])
Volání:
oAlEv.Acknowledge sId, sUserNote, tTimeAck
Parametry:
sId(String) Jednoznačný textový identifikátor alarm/event položky. Viz konfigurátor "Identifikátor".

Pro hromadnou kvitaci všech alarm/event položek lze zadat text "$all".

Poznámka!Pro hromadnou kvitaci všech alarm/event 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/event položkou (povoluje se v záložce 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 PmNamedValues, 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čení národního jazyka 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 je možno ovlivnit jazyk pro vyhodnocení lokalizovaných polí. Například"lang:en;".
Poznámka:
Kvitace se povede pouze tehdy, má-li lokální uživatel 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 určuje konfigurátor Typ kvitace. Kvitaci alarmu zpravidla provádí interaktivně uživatel aplikace z prohlížeče alarmní skupiny.

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

Při pokusu kvitovat neexistující alarm/event položku (špatný parametr sId) vznikne chyba v INFO systému pouze v případě, že v příslušném objektu PmAlarmEvent není žádná alarm/event položka s nastaveným konfigurátorem Vzor pro dynamicky vytvářené položky (tzn. že všechny alarm/event položky objektu PmAlarmEvent jsou staticky nakonfigurovány).

Kvitovat hromadně všechny alarm/event položky lze uvedením textu $all v parametru sId, případně následovaný filtračním řetězcem.

Pro eventy nemá smysl (pouze pro alarmy).

Metoda je synchronní, tzn. že alarmní subsystém ji ihned vykoná. Nicméně vlastní zápis na disk do historie alarmů/eventů je asynchronní, to znamená, že že tato metoda předá alarmnímu subsystému požadavek na zápis do historie, ten je zařazen do fronty požadavků a alarmní subsystém jej později vykoná.

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