Unter Weblink verstehen wir URL-Requests, welche alle nötigen Informationen beinhalten, um Alarmvorlagen, Drehbücher und/oder Konferenzvorlagen fern auszulösen. Weblink ist besonders für automatische, technische Schnittstellen ohne menschliche Interaktion geeignet.
In GroupAlarm pro sind keine besonderen Konfigurationen notwendig, um per Weblink Alarme auslösen zu können. Gerade für Drittsysteme welche über Weblink alarmieren macht es aber Sinn, einen eigenen Mitbenutzer mit Login und Passwort zu definieren. Dadurch erhöht sich die Nachvollziehbarkeit der Alarme in den Protokollen und Statistiken, weil man dann explizit nach Alarmen von diesem Auslöser suchen kann.
Es gilt folgende URL-Syntax für den Verbindungstest (https ist zwingend) per Weblink:
https://pro.groupalarm.de/webin.php?log_user=user&log_epass=epass
Folgende Parameter werden dabei berücksichtigt:
| Parameter | Beschreibung |
|---|---|
| log_user | Benutzername |
| log_epass | Kodiertes Passwort (QuickLogin-Bookmark) |
Verbindung ok, Logindaten ok:
OK: Ping event processed
Verbindung ok, Logindaten not_ok:
Not_OK: Falsche oder nicht existierende Anmeldedaten.
Verbindung not_ok:
[Standard-Browser-Timeout-Meldung]
Es gilt folgende URL-Syntax für die Auslösung (https ist zwingend) per Weblink:
https://pro.groupalarm.de/webin.php?log_user=user&log_epass=epass&template=XXX&text=9
Folgende Parameter werden dabei berücksichtigt:
| Parameter | Beschreibung |
|---|---|
| log_user | Benutzername |
| log_epass | Kodiertes Passwort (QuickLogin-Bookmark) |
| template | Auslösecode der zu alarmierenden Alarmvorlage |
| scenario | Auslösecode des zu alarmierenden Drehbuchs |
| conference | Auslösecode der zu alarmierenden Konferenzvorlage |
| event | Auslösecode des zu alarmierenden Ereignisses |
| dtfree | deutscher Freitext |
| frfree | französischer Freitext |
| itfree | italienischer Freitext |
| enfree | englischer Freitext |
| text | Der Code des zu verwendenden Alarmtextes, welcher per Checkbox für die auszulösende Vorlage zugelassen sein muss. Fehlt der Parameter, wird ein Freitext gesendet. Steht der Code auf 0, wird der Standard-Text versendet (Radio-Button). |
| duration | Zeit nach welcher der Alarm automatisch beendet werden soll in Minuten. Wird dieser Parameter nicht gesetzt, so bleibt ein Alarm offen bis die global definierte Dauer erreicht ist bzw. wenn diese nicht konfiguriert wurde, bis der Alarm manuell terminiert wird. |
| dryrun | Gibt an ob es sich um einen DRY-RUN handelt, falls ja dann sollte der Wert „1“ gesetzt sein |
| koord | Koordinaten die für die Alarmierung notwendig sind. |
Folgende Feedbacks kommen als Antworten auf den Auslöse-Weblink-Request zurück:
erfolgreicher Alarm:
OK: Alarm '[Name der ausgelösten Einheit]' erfolgreich ausgelöst Text: [Alarmtext] Teilnehmer: [Anzahl Teilnehmer] alarmiert. (AKEY-[Alarm_ID])
erfolgreicher Drehbuch:
OK: Scenario activated successfully. (BKEY-[Alarm_ID])
erfolgreicher Konferenz:
OK: Conference activated successfully. (CKEY-[Raum_PIN]) (TRAVERSE)
nicht erfolgreiche Auslösung:
Not_OK: [Fehlermeldung] (z.B. “Template, Conference or Scenario not found“)
Bei Bedarf kann über Weblink auch der Alarm-Status anhand des zurückgegebenen AKey (bzw. für Drehbücher den BKey und für Konferenzen den CKey) verfolgt werden:
Es gilt folgende URL-Syntax für das Feedback (https ist zwingend) per Weblink:
Folgende Parameter werden dabei berücksichtigt:
| Parameter | Beschreibung |
|---|---|
| log_user | Benutzername |
| AKey | Alarm-ID |
| BKey | Drehbuch-ID |
| CKey | Konferenz-ID |
Alarm-Status: laufend
OK: Alert 9924e4681bbb9291d2a91bfeff8949c8 still running.
Alarm-Status: erfolgreich beendet (d.h. durch ein Abbruchkriterium frühzeitig beendet)
OK: Alert 9924e4681bbb9291d2a91bfeff8949c8 completed with success.
Alarm-Status: nicht erfolgreich beendet (d.h. bis ans Ende durchgelaufen, ohne dass ein Abbruchkriterium erreicht wurde)
OK: Alert 9924e4681bbb9291d2a91bfeff8949c8 completed abort.
Bemerkung: „erfolgreich beendet“ heisst, dass der Alarm ein definiertes Alarmabbruchkriterium (Alarmoptionen) erreicht hat, bevor der Alarm per Timeout beendet wurde. Läuft die Alarmdauer aus bevor ein Abbruchkriterium erreicht wird, dann gilt der Alarm als „nicht erfolgreich beendet“.
Alarm-Status: laufend
OK: Scenario e0b291d6fc27f1114d260d16cdd46290 still running.
Alarm-Status: erfolgreich beendet (d.h. durch ein Abbruchkriterium frühzeitig beendet)
OK: Scenario e0b291d6fc27f1114d260d16cdd46290 completed with success.
Alarm-Status: nicht erfolgreich beendet (d.h. bis ans Ende durchgelaufen, ohne dass ein Abbruchkriterium erreicht wurde)
OK: Scenario 91c65900d5e1467c62d6cff212a8dacb completed abort.
Bemerkung: Falls ein Drehbuch „nicht erfolgreich beendet“ sein sollte, dann sind die Eskalationsszenarien allesamt abgelaufen und trotzdem wurde das Abbruchkriterium nicht erreicht. Für GroupAlarm pro ist dieser Alarm dann beendet. (Je nach Definition der Eskalation kann als letztes im Szenario eine bestimmte Person darüber informiert werden, dass der Alarm nicht erfolgreich beendet wurde.)
Konferenz-Status: laufend (d.h. es sind noch Teilnehmer aktiv in der Konferenz)
OK: Conference 123_1234 still running.
Konferenz-Status: erfolgreich beendet (d.h. es waren zwischenzeitlich mehr als 1 Teilnehmer aktiv in der Konferenz)
OK: Conference 123_1234 completed with success.
Konferenz-Status: nicht erfolgreich beendet (d.h. die Konferenz hat Ihr Timeout erreicht bevor mindestens 2 Teilnehmer aktiv verbunden waren).
OK: Conference 123_1234 completed abort.