Templates – Udělejte své alarmové zprávy čitelnými i pro Vaše podřízené

22. 10. 2020

Alarmové zprávy v zařízeních HW group mají svoji dlouhou historii a jejich podoba odpovídá požadavkům uživatelů z doby vzniku HW group, kdy většina zákazníků patřila do skupiny IT odborníků s jejich specifickým pohledem na věc. A stejnou filozofii měl historicky i portál SensDesk. Doba však již pokročila a je třeba umožnit uživatelům vytvoření uživatelsky přívětivých zpráv, ze kterých bude jednoznačně poznat co a kde je špatně. Pro zachování zákaznické kompatibility se proto na portál SensDesk přidala funkce šablon (Templates), které Vám umožní přizpůsobit si zprávy dle svých potřeb.

Horizontal menu

Podpora

Už není nutné, aby alarmová zpráva o ztrátě komunikace zařízení vypadala stejně jako o překročení rozsahu povolených hodnot a rovněž není třeba luštit tabulky pro zjištění který konkrétní senzor je mimo povolený rozsah. Pro zachování kompatibility v systému pochopitelně původní zprávy zůstávají a Templates pouze rozšiřují možnosti systému.

Šablony se vytváří v Settings pod položkou Templates.

Zde je možnost editovat již existující nebo naopak vytvářet nové. V současné chvíli lze vytvářet šablony pro e-mailové nebo SMS zprávy – Liší se existencí pole Subject a podporou HTML formátování pro e-mailové zprávy.

Uživatel má možnost sestavit si zprávy podle svých potřeb jednoduché nebo naopak komplexní. K tomu má k dispozici sadu nástrojů a proměnných, kterou sice jsou schopni používat pouze technicky zdatnější uživatelé, ale ze kterých jsme připravili sadu příkladů, které můžete vzít a upravit si je dle svých potřeb.

Příklad: Ztráta komunikace se zařízením

Předmět E-mailu:

[PORTAL:NAME] hlásí: Chyba komunikace se zařízením [SRC:DEVICE:ALIAS] - [SRC:DEVICE:STATE]

Tělo e-mailu:

Zařízení <a href="[SRC:DEVICE:URL]">[SRC:DEVICE:ALIAS]</a> na portále <a href="[PORTAL:URL]">[PORTAL:NAME]</a> má problém s komunikací a hlásí stav <b>[SRC:DEVICE:STATE]</b>.

Výsledná zpráva vypadá asi takto:

Standardně se všechny zprávy odesílají jako plaintext. Chcete-li však odesílat zprávy v HTML formátu, stačí do pole Body použít HTML tagy, případně zprávu sestavit pomoci grafického editoru (dostupný kliknutím na odkaz Switch to rich text editor)

Použití WYSIWYG editoru není možné, pokud chcete aplikovat cykly (LOOP)!

Přehled všech dostupných proměnných a jejich význam

Source URL: [SRC:URL] - Úplná URL adresa k senzoru, digitálnímu vstupu nebo zařízení, který vyvolal alarmovou zprávu. V případě, že zdrojem je zařízení, je uvedena URL adresa zařízení a pak jsou položky [SRC:URL] i [SRC:DEVICE:URL] shodné.
URL device: [SRC:DEVICE:URL] - Úplná URL adresa k zařízení, které vyvolalo alarmovou zprávu, nebo k zařízení jehož senzor nebo digitální vstup vyvolal alarmovou zprávu
PortalName: [PORTAL:NAME] – Název portálu ze kterého přišla alarmová zpráva. Tuto položku nemůže běžný uživatel měnit
PortalUrl: [PORTAL:URL] – URL adresa portálu ze kterého přišla alarmová zpráva. Tuto položku nemůže běžný uživatel měnit
Pid: [SRC:PROCESS:PID] – ID procesu který vytvořil zprávu – jen pro potřeby ladění.
Type: [SRC:TYPE] – Co způsobilo alarm. Zda-li senzor (digitální vstup) nebo zařízení
Team: [SRC:TEAM] – Název týmu kterému zařízení náleží.
AlarmSeq: [SRC:ALARM:SEQ] – ID alarmu – virtuální ID sloužící pro strojové párování začátků a konců alarmů
AlarmTime: [SRC:ALARM:TIME] – Čas vzniku začátku nebo konce alarmu (de facto vzniku zprávy) v UTC
AlarmState: [SRC:ALARM:STATE] - Informace o začátku nebo konci stavu alarm: Activated / Deactivated
AlarmSubState: [SRC:ALARM:SUBSTATE] – Informace o začátku nebo konci alarmu: Begin / End / Interstage – Umožňuje řešit přechody mezi různými stavy Alarmu mezi s sebou. Begin znamená začátek Alarmu, End jeho konec a Interstage přechod mezi dvěma Alarmovými stavy (např. z Alarm Hi do Alarm Lo bez mezistavu Normal či například mezi mezi Alarm Hi a Dev.Inv.).
AlarmDesc: [SRC:ALARM:DESC] – Úplný popis typu a stavu Alarm Hi / Alarm Lo / Sensor Invalid / Device Invalid / Unknown + ACTIVATED/ DEACTIVATED
SensID: [SRC:SENSOR:SENSID] – ID senzoru v portále, který vyvolal Alarm
ID: [SRC:SENSOR:ID] – ID senzoru v zařízení, který vyvolal Alarm
Name: [SRC:NAME] – Jméno senzoru v zařízení, který vyvolal Alarm
Alias: [SRC:ALIAS] – Alias jména senzoru v portále, který vyvolal Alarm
LogTime: [SRC:LOGTIME] – Čas posledního zalogování změny stavu senzoru v UTC, která způsobila alarm.
ValueNum: [SRC:SENSOR:VALUE:NUM] – naměřená hodnota v číselné podobě (float s desetinnou tečkou). V případě stavů Dev.Inv. nebo Sens.Inv je stav vyčíslen jako -2 147 483 648.
ValueTxt: [SRC:SENSOR:VALUE:TXT] – naměřená hodnota v textové podobě (string). Stavy odpojeného zařízení nebo senzoru jsou vypsány textovým parametrem Dev.Inv. resp. Sens.Inv.
UnitKey: [SRC:SENSOR:UNIT:KEY] – strojový identifikátor jednotky měřené veličiny. Neobsahuje speciální znaky typu ° (stupeň), ale naopak i u bezrozměrných jednotek je uveden nějaký symbol.
UnitName: [SRC:SENSOR:UNIT:NAME] – Jednotka v textové podobě – např. °C apod .
State: [SRC:STATE] – Stav senzoru/zařízení: Normal, Alarm Hi, Alarm Lo, Sensor Invalid, Device Invalid, Unknown
NoticeID: [SRC:NOTICE:ID] – ID Notice Range který vyvolal Alarmovou zprávu. Pokud pochází od Saferange, tedy hodnoty přenášené ze zařízení, je uvedeno 0
NoticeName: [SRC:NOTICE:NAME] – název Notice Range který vyvolal Alarmovou zprávu. Pokud pochází od Saferange, tedy hodnoty přenášené ze zařízení hodnota prázdná
Min: [SRC:SENSOR:MIN] – Range Min – minimální povolená hodnota bezpečného rozsahu, který alarmovou zprávu vyvolal.
Max: [SRC:SENSOR:MAX] – Range Max – maximální povolená hodnota bezpečného rozsahu, který alarmovou zprávu vyvolal.
Hyst: [SRC:SENSOR:HYST] – Hystereze – hodnota hystereze v bezpečném rozsahu, který alarmovou zprávu vyvolal.
DevID: [SRC:DEVICE:DEVID] – ID zařízení od kterého pochází zpráva
DeviceName: [SRC:DEVICE:NAME] – Název zařízení (v zařízení) od kterého pochází zpráva
DeviceAlias: [SRC:DEVICE:ALIAS] – Alias názvu zařízení (v portále) od kterého pochází zpráva
DeviceState: [SRC:DEVICE:STATE] – Stav zařízení od kterého pochází zpráva
TemlateID:: [SRC:TEMPLATE:ID] – ID použité (aktuální) šablony alarmové zprávy
TemlateName: [SRC:TEMPLATE:NAME] – Jméno použité (aktuální) šablony alarmové zprávy
ActionID: [SRC:ACTION:ID] – ID akce, která vyvolala alarmovou zprávu
ActionName: [SRC:ACTION:NAME] – Název akce, která vyvolala alarmovou zprávu
QueueID: [SRC:ACTION:QUEUE:ID] - Primární klíč do tabulky, ve které se dočasně udržují požadavky na zpracováni alarmu. Slouží pro potřeby ladění.
MAC: [SRC:DEVICE:MAC] – MAC adresa zařízení od kterého pochází zpráva
IMEI: [SRC:DEVICE:IMEI] – IMEI zařízení od kterého pochází zpráva
HWID: [SRC:DEVICE:HWID] – HWID zařízení od kterého pochází zpráva, jedinečný identifikátor HW v Portále. MAC adresa nebo IMEI, podle toho, jakým identifikátorem zařízení disponuje.
Address: [SRC:DEVICE:ADDR] – IP adresa zařízení od kterého pochází zpráva.
SrcID: [SRC:ID] – ID zdroje zprávy – zpravidla odpovídá SensID a představuje ID senzoru, digitálních vstupu apod. V případě, že zdrojem je zařízení je [SRC:ID] = [SRC:DEVICE:DEVID]
TargetID: [SRC:TARGET:ID] – ID použitého (aktuálního) cíle alarmové zprávy. Je-li více cílů, tak jde o seznamy oddělené středníkem.
TargetName: [SRC:TARGET:NAME] – Jméno použitého (aktuálního) cíle alarmové zprávy. Je-li více cílů, tak jde o seznamy oddělené středníkem.

Cykly pro vypsání ucelených přehledů

V rámci portálu jsou k dispozici též 2 smyčky pro vytvoření přehledových zpráv

Přehled senzorů: [LOOP:SENSOR:ALL] – umožňuje vypsat přehled všech senzorů v Teamu
Přehled senzorů v Alarmu: [LOOP:SENSOR:ALL:ALARM] – umožňuje vypsat přehled všech senzorů ve stavu Alarm v Teamu
Přehled zařízení: [LOOP:DEVICE] – Umožňuje vypsat přehled všech zařízení v Teamu
Přehled nekomunikujících zařízení: [LOOP:DEVICE:DEVINV] – Umožňuje vypsat přehled všech nekomunikujících zařízení v Teamu.

Smyčka se zahajuje proměnnou [LOOP:SENSOR:ALL] nebo [LOOP:DEVICE] a ukončuje [LOOP:END]. Uvnitř smyčky se používají modifikované proměnné s výše uvedeného seznamu:

[$I] – ID proměnné
[SENSID:$I] – ID senzoru
[DEVID:$I] – ID zařízení
[ID:$I] – ID proměnné
[NAME:$I] – Název senzoru/zařízení (podle toho zda se jedná o smyčku [LOOP:SENSOR:ALL] nebo [LOOP:DEVICE])
[ALIAS:$I] – Alias názvu senzoru / zařízení (podle toho zda se jedná o smyčku [LOOP:SENSOR:ALL] nebo [LOOP:DEVICE])
[VALUE:NUM:$I] – Hodnota senzoru v číselné podobě (float s desetinnou tečkou)
[VALUE:TXT:$I] – Hodnota senzoru v textové podobě (string)
[UNIT:KEY:$I] – strojový identifikátor jednotky měřené veličiny. Neobsahuje speciální znaky typu ° (stupeň), ale naopak i u bezrozměrných jednotek je uveden nějaký symbol.
[UNIT:NAME:$I] – Jednotka v textové podobě – např. °C apod.
[STATE:$I] – Stav senzoru/zařízení (podle toho zda se jedná o smyčku [LOOP:SENSOR:ALL] nebo [LOOP:DEVICE]): Normal, Alarm Hi, Alarm Lo, Sensor Invalid, Device Invalid, Unknown
[MIN:$I] – Saferange MIN senzoru
[MAX:$I] – Saferange MIN senzoru
[HYST:$I] – Hystereze senzoru
[DEVICE:NAME:$I] – Název zařízení
[DEVICE:ALIAS:$I] – Alias názvu zařízení
[URL:$I] – URL senzoru/zařízení (podle toho zda se jedná o smyčku [LOOP:SENSOR:ALL] nebo [LOOP:DEVICE])
[DEVICE:URL:$I] – URL zařízení

Všechny tokeny jsou rovněž uvedeny v okně nápovědy přímo na portále a lze je aplikovat kliknutím na token. Ten se pak vloží do textového pole na pozici kurzoru.

Dále naleznete příklady použití těchto tokenů v různých typech alarmových zpráv. Pokud Vám nějaký typ proměnné chybí, nebo neumíte sestavit požadovanou zprávu, neváhejte nás kontaktovat a rádi Vám pomůžeme.

Příklady šablon alarmových zpráv

Ztráta komunikace se zařízením – Krátký e-mail

Šablona - předmět

[PORTAL:NAME] hlásí: Chyba komunikace se zařízením [SRC:DEVICE:ALIAS] - [SRC:DEVICE:STATE]

Šablona - tělo

<p>Zařízení <a href="[SRC:DEVICE:URL]">[SRC:DEVICE:ALIAS]</a> na portále <a href="[PORTAL:URL]">[PORTAL:NAME]</a> má problém s komunikací a hlásí stav <strong>[SRC:DEVICE:STATE]</strong>.</p>

Výsledek

Ztráta komunikace se zařízením – e-mail s uvedením stavu všech zařízení

Šablona - předmět

[PORTAL:NAME] hlásí: Chyba komunikace se zařízením [SRC:DEVICE:ALIAS] - [SRC:DEVICE:STATE]

Šablona - tělo

<p>Zařízení <a href="[SRC:DEVICE:URL]">[SRC:DEVICE:ALIAS]</a> na portále <a href="[PORTAL:URL]">[PORTAL:NAME]</a> má problém s komunikací a hlásí stav <strong>[SRC:DEVICE:STATE]</strong>.</p>
<h3>Přehled všech zařízení týmu [SRC:TEAM]</h3>
<table>
	<tbody>
		<tr>
			<th>ID zařízení</th>
			<th>Jméno</th>
			<th>Alias</th>
			<th>Stav zařízení</th>
			<th>Alias zařízení</th>
		</tr>[LOOP:DEVICE]
		<tr>
			<td>[DEVID:$I]</td>
			<td><a href="[$I:URL]">[NAME:$I]</a></td>
			<td>[ALIAS:$I]</td>
			<td>[STATE:$I]</td>
			<td><a href="[$I:DEVICE:URL]">[DEVICE:ALIAS:$I]</a></td>
		</tr>[LOOP:END]
	</tbody>
</table>

Výsledek

Překročení rozsahu povolených hodnot – Krátký e-mail

Šablona - předmět

Senzor [SRC:ALIAS] na portále [PORTAL:NAME] hlásí stav: [SRC:STATE]

Šablona - tělo

<p>Senzor <a href=" [SRC:URL]"><strong>[SRC:ALIAS]</strong></a> na zařízení <strong>[SRC:DEVICE:ALIAS]</strong> připojeném do portálu <a href="[PORTAL:URL]"><strong>[PORTAL:NAME]</strong></a> hlásí od času [SRC:ALARM:TIME] stav <strong>[SRC:STATE]</strong> proti rozsahu <strong>[SRC:NOTICE:NAME]</strong>.</p>
 
<p>Aktuální hodnota senzoru <strong>[SRC:STATE]</strong> je <strong>[SRC:SENSOR:VALUE:TXT] [SRC:SENSOR:UNIT:NAME]</strong>.</p>
 
<p>Průběh hodnot si můžete prohlédnout na adrese [SRC:URL] </p>

Výsledek

Překročení rozsahu povolených hodnot – e-mail s uvedením stavu všech senzorů a zařízení

Šablona - předmět

Senzor [SRC:ALIAS] na portále [PORTAL:NAME] hlásí stav: [SRC:STATE]

Šablona - tělo

<p>Senzor <a href="[SRC:URL]"><strong>[SRC:ALIAS]</strong></a> na zařízení <strong>[SRC:DEVICE:ALIAS]</strong> připojeném do portálu <a href="[PORTAL:URL]"><strong>[PORTAL:NAME]</strong></a> hlásí od času [SRC:ALARM:TIME] stav <strong>[SRC:STATE]</strong> proti rozsahu <strong>[SRC:NOTICE:NAME]</strong>.</p>
 
<p>Aktuální hodnota senzoru <strong>[SRC:STATE]</strong> je <strong>[SRC:SENSOR:VALUE:TXT] [SRC:SENSOR:UNIT:NAME]</strong>.</p>
 
<p>Průběh hodnot si můžete prohlédnout na adrese [SRC:URL] </p>
 
<h3>Přehled všech senzorů týmu [SRC:TEAM]</h3>
<table>
	<tbody>
		<tr>
			<th>ID senzoru</th>
			<th>Alias</th>
			<th>Hodnota</th>
			<th>Jednotka</th>
			<th>Stav senzoru</th>
			<th>SafeRange MIN</th>
			<th>SafeRange MAX</th>
			<th>Hystereze</th>
			<th>ID zařízení</th>
			<th>Device alias</th>
		</tr>[LOOP:SENSOR:ALL]
		<tr>
			<td>[SENSID:$I]</td>
			<td><a href="[$I:URL]">[ALIAS:$I]</a></td>
			<td>[VALUE:TXT:$I]</td>
			<td>[UNIT:NAME:$I]</td>
			<td>[STATE:$I]</td>
			<td>[MIN:$I]</td>
			<td>[MAX:$I]</td>
			<td>[HYST:$I]</td>
			<td>[DEVID:$I]</td>
			<td><a href="[$I:DEVICE:URL]">[DEVICE:ALIAS:$I]</a></td>
		</tr>[LOOP:END]
	</tbody>
</table>
 
<h3>Přehled všech zařízení týmu [SRC:TEAM]</h3>
<table>
	<tbody>
		<tr>
			<th>ID zařízení</th>
			<th>Alias</th>
			<th>Stav zařízení</th>
		</tr>[LOOP:DEVICE]
		<tr>
			<td>[DEVID:$I]</td>
			<td><a href="[$I:DEVICE:URL]">[DEVICE:ALIAS:$I]</a></td>
			<td>[STATE:$I]</td>
		</tr>[LOOP:END]
	</tbody>
</table>

Výsledek

Ztráta komunikace se zařízením – SMS

Šablona

Senzor [SRC:ALIAS] hlásí stav [SRC:STATE]. Aktuální hodnota je [SRC:SENSOR:VALUE:TXT][SRC:SENSOR:UNIT:NAME]

Výsledek

Software

Mobilní aplikace

SensDesk Mobile