projektering:larmhantering [Orbiq wiki]

Denna sida är skrivskyddad. Du kan titta på källkoden, men inte ändra den. Kontakta administratören om du anser att du bör kunna ändra sidan.
====== Integration av larm och händelser ======


Orbiq kan ta emot larm via flera kanaler och tolka meddelanden från flera olika format.

Inkommande larm från oregistrerade system "resurser" förkastas. [[administration:resurser:registrera|Se här]] för instruktion angående registering av resurser i Orbiq. Säkerställ därför att inställda avsändaradresser är registrerade i Orbiq som larmkällor, innan avprovning sker av larmfunktion.

====== Larm via API-anrop ======
Orbiq har ett [[api:rest:alarm|API för registrering av larmhändelser]]. Vid behov får ni gärna [[mailto:hello@iquest.se|kontakta oss]] för att få åtkomst för enskilda installationer.

API-specifikationen nås även via URL:en /api-tools/swagger/IQApi-v1 inom en Orbiq-installation.

====== Larm via Nimbus ======
Orbiq kan även ta emot larm från [[https//automatisera.se|Nimbus]]. [[projektering:larmhantering:nimbus|Här visar vi]] hur inställning av Nimbus kan ske. OBS! Kontrollera med er systemadmin först ifall er installation har stöd för Nimbus-formatet.

====== Larm via e-post ======
Det är viktigt att notera att Orbiqs SMTP-server för larmmottagning inte kommer att kunna användas för att skicka utgående e-post från anslutna system, av säkerhetsskäl. Enda funktionen är att ta emot e-post från godkända adresser, utvinna informationen från e-posten och registrera i Orbiq via API-anrop. 

Säkerställ därför att inställda avsändaradresser är registrerade i Orbiq som larmkällor, innan avprovning sker av larmfunktion.

Det generella formatet som Orbiq kan tolka bygger på "Nimbus generic" och innehållet presenteras nedan.
===== Generic =====
Servern för larmhantering tolkar innehållet i body-fältet och headern för e-postmeddelandet. För att det mail som kommer in ska vara giltigt måste ärendefältet (subject) börja med LARM eller ALARM. Ärendefältet kan också innehålla "-LARM" eller "-ALARM", men måste ha en larmklass som prefix, som t.ex. "A-LARM" eller "C-ALARM".

E-postmeddelande ska innehålla uppgift om larmklass enligt följande: “A” för A-larm, “B” för B-larm, “C” för C-larm etc.

Meddelandefältet i larm e-post ska i tur och ordning innehålla följande information:


TAG: ”Tagnamn” enligt Beställarens ”Beteckningssystem \\
AREA:  “Relativ URL” till sida i DUC/PLC eller motsvarande för den sida i webbserver som visar larmande objekt \\
CATEGORY: “Larmklass” exempelvis “A”, “B”, “C” etc. \\
NAME: ”Avsändare” (beteckning för larmsändare). Som standard används principen ”apparatskåp-objektsbeteckning@av-beställaren-angiven-epostadress.se”. \\
DESC: ”Beskrivande text” \\
STATE: ”Status” ska anges som sista raden i meddelandet. Se nedan för beskrivning av olika statuskoder. \\

**Inaktiv**: 
Larmservern tolkar händelsen som en återgång till normal (inaktiv) när STATE = INACTIVE, FRÅN eller NORMAL.

**Kvitterad**: 
Servern tolkar händelsen som en kvittens när STATE = ACK, ACKNOWLEDGE eller ACKED. 

**Aktiv**: 
Servern tolkar alla andra STATE-texter som aktiva.

Som avskiljare mellan informationerna i meddelandefält ska tecken för ny rad användas, motsvarande <13> <10> i råtextformat, vilket medför att informationen hamnar på separata rader i e-posten.
==== Larm aktivt ====
<code>
TAG: FASTIGHETA_AS01_LB01_GT1_AL
AREA: /lb01.htm
CATEGORY: B
NAME: as01-FASTIGHETA@fastighetsbolaget.se
DESC: Avvikande temperatur tilluft i Bostadsfabriken, AS01_LB01
STATE: ACTIVE
</code>
==== Larm kvitterat ====
<code>
TAG: FASTIGHETA_AS01_LB01_GT1_AL
AREA: /lb01.htm
CATEGORY: B
NAME: as01-FASTIGHETA@fastighetsbolaget.se
DESC: Avvikande temperatur tilluft i Bostadsfabriken, AS01_LB01
STATE: ACKED
</code>
==== Larm återgått ====
<code>
TAG: FASTIGHETA_AS01_LB01_GT1_AL
AREA: /lb01.htm
CATEGORY: B
NAME: as01-FASTIGHETA@fastighetsbolaget.se
DESC: Avvikande temperatur tilluft i Bostadsfabriken, AS01_LB01
STATE: NORMAL
</code>

===== Larm via andra e-postformat =====

Orbiq klarar även av att tolka larm från andra format. Nedan kommer vi att lista ett antal exempel.
===== Struxureware =====
Charset=utf-8 \\
Subject: Obj:/Objektsforteckning3_AS001/UC01/VV01 Larm/GT11_TempLarm

==== Exempel på återgånget larm ====

<code>
Object: /Objektsforteckning3_AS001/UC01/VV01 Larm/GT11_TempLarm
Text: Låg/hög-tappvarmvattentemperatur, betjänar Byggnadsdel 3 
Priority: 2
State: Återställning
Previous: Larm
AckTime: 
Date: 2017-03-09 13:00:40 +1H
</code>