Detta är en gammal version av dokumentet!
Larm via API-anrop
Orbiq har ett API för registrering av larmhändelser. Vid behov får ni gärna kontakta oss för att ta del av specifikationen.
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 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
Orbiq kan ta emot larm via e-post och tolka larm från flera olika format. E-post från oregistrerade adresser förkastas. Se här för instruktion angående registering av resurser. Orbiqs SMTP-server kommer heller inte att kunna användas för att skicka utgående e-post från anslutna system. 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) innehålla LARM eller 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
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
Larm kvitterat
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
Larm återgått
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
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
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