ixarmaxml Treiber Konfiguration

Transkript

1 MICROMEDIA INTERNATIONAL ALERT: Treiber - ixarmaxml ALERT Die flexible Alarmierungslösung Autor: Jens Eberle Seitenanzahl: 10 Firma: Micromedia International Datum: 12/4/ Version: Ref. : ALERT_Treiber ixarmaxml_de.docx [Kommentare ] ixarmaxml Treiber Konfiguration Verteiler An CC Firma Anhang 04/12/ ixarmaxml Treiber Konfiguration 1/10

2 Inhaltsverzeichnis Einleitung... 3 Anforderungen... 3 ixarma Verbindungsdaten... 3 ALERT - ixarma Verbindung... 3 Das ixarma Treiber Interface... 4 Servicenachricht (Nachricht senden )... 5 Alarmfall, zwei Konfigurationsarten... 5 Verwendete Parameter der Alarmdefinition... 6 Alarmgenerierung in ixarma (dynamisch/statisch)... 7 Zusätzliche Benutzer-Befehle... 8 Redundanz... 9 Alert.ini ixarmaxml.ini Konfiguration /12/ ixarmaxml Treiber Konfiguration 2/10

3 Einleitung ixarma ist ein System zur Überwachung von Sicherheits- und Gebäudetechnik-Anlagen. Dieses Dokument beschreibt die Verbindung zwischen ALERT (Client) und dem ixarma Webserver. Anforderungen ALERT ab Version 3.6 rev. 1 Build 27 IXARMAXML Lizenzoption muss freigeschaltet sein Systemanforderungen entsprechen den Anforderungen an ALERT. Link: Kompatibilität und Systemanforderungen oder unter unter der SUPPORT\FAQ\ALERT. ixarma Verbindungsdaten Um sich mit dem ixarma Webserver verbinden zu können, sind folgende Zugangsdaten / Einstellungen erforderlich: URL (Master) Empfohlen, TCP/IP Port 443 (HTTPS) muss eingehenden und ausgehenden Traffic erlauben Ab Version wird das HTTP Protokoll als auch das definieren der TCP/IP Ports unterstütz, z.b.: Differenzierung GET/POST Methode (Default, GET) Benutzername Passwort Bei Redundanz o URL (Slave) des 2. und ggf. 3. Webservers ALERT - ixarma Verbindung Es handelt sich hierbei um eine Client/Server Verbindung, ALERT übernimmt hierbei die Rolle eines Clients. Es existieren 2 Verbindungsarten: a. Direkter Modus Die ixarma Server URL wird direkt in die Adressbar des Benutzers-> Übertragungsmedium eingetragen. Die Redundanzumschaltung geschieht hier direkt nach Alarm Auslösung, durch entsprechende Konfiguration des Teams bzw. der Übertragungsmedien. 04/12/ ixarmaxml Treiber Konfiguration 3/10

4 b. Heartbeat/Redundant Modus (zu empfehlen bei qualitativ schlechtem Netzwerk) URL wird im Treiberdialog bestimmt, nach erfolgreicher Eingabe der Zugangsdaten wird eine query Anfrage (Heartbeat) von ALERT an den ixarma Webserver gestellt um die Erreichbarkeit zu prüfen. Das Zeitintervall Heartbeat (s) dieser Anfrage bzw. der Heartbeats, kann bestimmt und bei mehrmaligen Fehlschlägen Heartbeat retries auf eine andere URL umgeschaltet werden (Umschaltung nur, wenn Redundanzmodus aktiviert). Siehe folgende Abbildung (ALERT-ixArma Treiber Interface). VORSICHT: Bei Wechsel von einem Modus in den anderen, bitte die Adressfelder der Übertragungsmedien prüfen und ggf. anpassen! Das ixarma Treiber Interface Zu sehen ist die Oberfläche des ixarma Treibers mit Erläuterungen, welche zur Konfiguration des Treibers dient. ALERT Treibername System ID Automatische Rufquittierung, bitte Haken setzten! Momentan steht keine Option zur manuellen Rufquittierung von ixarma zu Verfügung. Treiberaktivität in der Ereignisliste anzeigen Pro Alarm in ALERT wird ein Alarm an ixarma übertragen, bitte setzen! Ansonsten wird nur der letzte Alarm übertragen. Heartbeats, sollte größer als 1 Minute sein, ansonsten kann ixarma die query Anfrage zurückweisen. Bei Hearbeat = 0 wird der Redundanzmodus ebenfalls abgeschaltet! Anzahl Hearbeat: Anzahl der Anfrageversuche bevor auf Slave URL umgeschaltet wird. Benutzername und Passwort, alle Server (Master/Slave) benutzen dieselben Logindaten. Direct URL mode, wenn aktiviert, wird der Heartbeat- /Redundanzmodus ausgeschaltet. Hier kann die URL direkt in der Adressbar verwendet werden. URL (Master) und wenn Redundant mode aktiviert ist, bitte die Slave URLs (URL2, URL3) eintragen. 04/12/ ixarmaxml Treiber Konfiguration 4/10

5 Servicenachricht (Nachricht senden ) Laut ixarma wird ein Alarm als kommendes Ereignis ausgelöst, bei Rücksetzung als gehendes und bei Quittierung als quittiertes, dies wird durch den Befehl K, G und Q gekennzeichnet. Im Falle einer Servicenachricht wird in ixarma eine Art Ereignis ausgelöst, welche durch voranstellen des $-Zeichens der <apid> ausgelöst wird. Dies bewirk ein kommend mit darauffolgendem gehend. Somit muss nachdem senden nicht zusätzlich ein G übermittelt werden. Bitte das Feld Kurznachricht verwenden um den Alarm zu definieren, welcher in ixarma ausgelöst werden soll = Alarm Punkt ID <apid>. Es gilt zu beachten, dass bei Versand einer Servicenachricht der Bezeichner <bez> auf ServiceCallofALERT und die Family <family> auf ALERT gesetzt werden. Alarmfall, zwei Konfigurationsarten Im Falle eines Alarms in ALERT wird eine Anfrage, gemäß der Alarmverarbeitung an den ixarma Webserver gesendet. Nachdem ALERT ein OK auf diese Anfrage erhalten hat, wird der Ruf in ALERT quittiert. Falls ALERT ein NOTOK erhält wird eine ggf. neue Anfrage/Ruf gemäß der Benachrichtigungsoptionen getätigt. Fall 1: In der ALERT Alarm Definition muss eine Rücksetzungs- bzw. Quittierungsaktion gewählt werden, andernfalls wird ein in ixarma zuvor gesetzter Alarm nicht rückgesetzt bzw. quittiert. D.h. eine erneute Alarmauslösung, seitens ixarma wird fehlschlagen, da der Alarm immer noch ansteht. 04/12/ ixarmaxml Treiber Konfiguration 5/10

6 Fall 2: Durch setzen des wird eine Alarmprozedur in ixarma angestoßen. Auf die Rücksetzungs- und Quittierungsaktion kann dann verzichtet werden, da hierdurch eine Alarmroutine in ixarma gestartet und gleich wieder beendet wird. Verwendete Parameter der Alarmdefinition Um eine Nachricht an ixarama zu senden, generiert der Treiber eine XML Zeichenfolge. Hierbei werden folgende Felder von ALERT verwendet. In folgender Abbildung sind die Relationen zu ixarma zu sehen. 1. Alarm Name in ALERT ist die Alarm Bezeichnung in ixarma 2. Priorität, in ixarma sind nur Werte von 0 3 erlaubt! 3. Alarmverarbeitung = K (Kommend) 4. Rücksetzung = G (Gehend) Quittierung = Q 5. Alarmnachricht = Alarmtext 6. Kurznachricht in ALERT ist die Alarmpunkt ID in ixarma (diese löst den ALARM aus!) 7. Alarmgruppe in ALERT = Alarmpläne in ixarma (family) XML Zeichenfolge (grün) zu obiger Abbildung: diese Zeichenfolge wird an ixarma übermittelt. /AlarmService/alarm?version=1&xml=<msg><apid>DPALERT</apid><sysid>JENSEBERLE- PC</sysid><event>K</event><bez>DPALERT1</bez><prio>0</prio><family> </family><callerid>alert</callerid><text><![cdata[dpalert1 Alarm kommend]]></text></msg> 04/12/ ixarmaxml Treiber Konfiguration 6/10

7 VORSICHT: Für die Aktionen Rücksetzung und Quittierung müssen alle Felder bis auf Alarmnachricht äquivalent zu der Alarmverarbeitung sein. D.h. das Feld Kurznachricht muss bei Alarmverarbeitung, Rücksetzung und Quittierung überall denselben Name aufweisen und die Rufgruppe muss auch dieselbe sein! Falls die Alarmaktionen Rücksetzung/Quittierung nicht verwendet werden sollen, bitte den im Nummer/Adressfeld des Übertragungsmediums setzen, hiermit wird der Alarm in ixarma ausgelöst und sofort wieder zurückgesetzt, eine Alarmierung der Benutzer in ixarma findet dennoch statt. EMPFEHLUNG: Bei Verwendung der Rücksetzungs-/Quittierungsaktion, dem ersten anzurufenden Benutzer bei der Alarmverarbeitung, den mitgeben. Hiermit wird der auszulösende Alarm zuerst rückgesetzt. Dies ist eine Art Schutzmechanismus, da ixarma einen Alarm, definiert als Kommend, nicht nochmals auslösen kann. Alarmgenerierung in ixarma (dynamisch/statisch) Der ixarma Server kann durch entsprechende Konfiguration das Anlegen von dynamischen Alarmen erlauben. Hierbei muss ein entsprechendes Skript des ixarma Servers zur Verfügung stehen um die Daten welche von ALERT kommen richtig auswerten zu können. Ansonsten (statisch) müssen die Alarme zuvor in ixarma angelegt werden, damit sie von ALERT ausgelöst werden können. 04/12/ ixarmaxml Treiber Konfiguration 7/10

8 Zusätzliche Benutzer-Befehle Im Nummer/Adressfeld des Übertragungsmediums ixarmaxml Driver der jeweiligen Benutzer kann durch Q! eine Kommendes, Gehendes, Quittiertes und Kommendes & Gehendes Ereignis in ixarma ausgelöst werden. kann ein Alarmpunkt direkt gesetzt werden, bitte Eingabe mit Semikolon (;) beenden. Dasselbe Im Direkt Modus muss zuerst die URL gefolgt von den Befehlen gesetzt werden, z.b. Dies dient der Erweiterten Konfiguration für bezeichnet ein Kommendes Ereignis auf dem ixarma Server bezeichnet ein Gehendes Ereignis auf dem ixarma Server bezeichnet ein Quittiertes Ereignis auf dem ixarma Server bezeichnet ein Kommendes mit darauffolgendem Gehenden Ereignis <apid>$alarmpunktid</apid> in diesem Fall wird <event> immer als Kommend = <apid$*alarmpunktid>, bitte bei Inax.ch um Bedeutung = send query request, IxArma Unterscheidung zwischen der GET und POST Methode. Standard GET, siehe ini wenn verwendet kann ein ALARM Punkt direkt in Nummer-/Adressfeld @SYSID: setzen der System ID = = <family> In folgender Abbildung ist ein Beispiel für den direkten Modus zu sehen. 04/12/ ixarmaxml Treiber Konfiguration 8/10

9 Vorsicht: Befehle werden vorrangig behandelt, d.h. es URL im Adressfeld hat höhere Priorität als in ixarmaxml Treiber GUI definiert, gilt auch für family, sysid, etc. Redundanz Direkter Modus Per TEAM Falls der erste Benutzer nicht erreicht wird der Alarm an den Ersatzbenutzer (Slave URL), in dem Fall der Redundantserver gesendet. Oder per Benutzer Heartbeat Modus Redundanz funktioniert nur, wenn Heartbeat Timeout größer 0 und Redundant mode aktiviert ist. Hearbeat retries, definiert die Anzahl der fehlgeschlagenen Heartbeats welche an ixarma gesendet werden, bevor auf eine der Slave-URLs umgeschaltet wird. Ist keine Slave-URL erreichbar, wird auf die Master-URL zurückgeschaltet. Sollte dies der Fall sein, bitte URL, Firewall-Einstellungen, Zugangsdaten und Erreichbarkeit der ixarma Server prüfen, die Heartbeat Methode befindet sich in dieser Zeit in einem Loop-Modus und prüft auf Änderungen der Einstellungen jede Minute. 04/12/ ixarmaxml Treiber Konfiguration 9/10

10 Alert.ini Falls die ixarmaxml.dll nicht in der Setuproutine enthalten ist, bitte folgend Eintrag der Sektion [drivers] hinzufügen: ixarmaxml=4700,ixarmaxml.dll,0,3 Info: Freischaltung der Lizenzoption nicht vergessen! Erst nach Aktivierung oder im Demomodus kann der ixarmaxml Treiber verwendet werden. ixarmaxml.ini Konfiguration Um die Log-Datei von ixarmaxml zu aktivieren muss TraceInFile auf TRUE gesetzt werden, beim nächsten Start von ALERT wird das ixarmaxml_log.txt in ALERT angelegt (Wenn Heartbeat Modus gewählt und ein Timeout von einer Minute definiert wurde, beträgt die Dateigröße pro Tag ca. 500KBs). 04/12/ ixarmaxml Treiber Konfiguration 10/10