Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

--- server:ansteuerungen:groupalarmcom [2020/01/22 08:23] – Beispiel-SS der Aufgabenkonfiguration hinzugefügt benni
+++ server:ansteuerungen:groupalarmcom [2025/01/24 15:26] (aktuell) – [Fehlerbehandlung] pascal
@@ Zeile 1: / Zeile 1: @@
-====== Schnittstelle "Groupalarm.com" ======
+==== Schnittstelle "Groupalarm.com" ====
-===== Einführung =====
+=== Einführung ===
 Über die Ansteuerung "groupalarm.com" können Sie aus EDP heraus Teilnehmer Ihrer Organisation über die korrespondierende App, SMS oder E-Mail alarmieren.
 Die Ansteuerung unterstützt folgende Funktionen:
@@ Zeile 9: / Zeile 9: @@
   * Alarmierung über angelegter Szenarien
   * Alarmierung einzelner Benutzer oder Einheiten
-  * Komplettalarmierung aller Einheiten
+  * Komplettalarmierung aller Teilnehmer in der Organisation
   * Den Alarmierungen können entsprechend konfigurierte Alarmnachrichten mitgegeben werden
+  * Versenden von Statusmeldungen von Einsatzmitteln
 **
 Für die Verwendung der Ansteuerung ist ein Konto bei GroupAlarm.com und eine Internetverbindung notwendig.** Die Verwaltung der Teilnehmer / Gruppen / Szenarien / usw. erfolgt auf der Webseite von GroupAlarm.com.
-Alarmierungen müssen in der EDP-Datenversorgung als Aufgaben angelegt werden und können dann aus dem Einsatzleitplatz verwendet werden.
+Alarmierungen müssen in der EDP-Datenversorgung als Aufgaben angelegt werden und können dann aus dem Einsatzleitplatz verwendet werden. \\
+\\
+Weiterführende Informationen zur Funktionalität von groupalarm.com finden sie auf der Seite des Anbieters: [[https://www.groupalarm.com/]].
-===== Konfiguration =====
+=== Konfiguration ===
-Die Konfiguration der Ansteuerung geschieht mit dem Programm __EDPServerKonfig.exe__ unter dem Punkt Ansteuerungen. Nach dem Klicken auf den Bearbeiten-Knopf erscheint folgendes Fenster, in dem alle Einstellungen der Ansteuerung vorgenommen werden: {{ :anleitungen:konfiguration.png?400 |}}
+Die Konfiguration der Ansteuerung geschieht mit dem Programm __EDPServerKonfig.exe__ unter dem Punkt Ansteuerungen. Nach dem Klicken auf den Bearbeiten-Knopf erscheint folgendes Fenster, in dem alle Einstellungen der Ansteuerung vorgenommen werden: {{:server:ansteuerungen:anst_groupalarm.jpg?400|}}
 \\
 \\
 ** API-Schlüssel **\\
-Den API-Schlüssel erhalten sie aus ihrer Organisationsübersicht. Wählen sie dazu ihre Organisation aus und folgen sie den Menüpunkten "Admin" -> "Berechtigungen" -> "API-Schlüssel". Hier können sie einen beliebigen Namen festlegen und dann mit einem Klick auf "+ API-Schüssel erzeugen". Diesen können sie nun in der Konfiguration der Ansteuerung (API-Schlüssel) einfügen.
+Den API-Schlüssel erhalten Sie aus Ihrer Organisationsübersicht. Wählen Sie dazu Ihre Organisation aus und folgen sie den Menüpunkten "Admin" -> "Berechtigungen" -> "API-Schlüssel". Hier können sie einen beliebigen Namen festlegen und dann mit einem Klick auf "+ API-Schüssel erzeugen". Diesen können sie nun in der Konfiguration der Ansteuerung (API-Schlüssel) einfügen.
 {{ :anleitungen:api-schluessel.png |}}
 \\
 \\
 ** PA-Token (Personal Access Token) **\\
-Für Ihr PAT gehen sie bitte unter https://app.groupalarm.com/d/profile/settings und scrollen zum Menüpunkt "API-Schlüssel erstellen". Dort können Sie nun einen beliebigen Namen (z.B. "EDP-Server FW-Musterstadt") festlegen und bekommen den Schlüssel. Diesen fügen Sie einfach in die Konfiguration (PA-Token) ein.
+Für Ihr PAT gehen Sie bitte oben rechts auf Ihr persönliches Konto -> "Profil" -> "Einstellungen" (alternativ über https://app.groupalarm.com/d/profile/settings ) und scrollen zum Menüpunkt "API-Schlüssel erstellen". Dort können Sie nun einen beliebigen Namen (z.B. "EDP-Server FW-Musterstadt") festlegen und bekommen einen weiteren API-Schlüssel. Diesen fügen Sie einfach in die Konfiguration (PA-Token) ein.
 \\
 \\
 ** Standardnachricht **\\
-Diese Nachricht wird als Alarmnachricht verwendet, wenn Sie später in der Alarmierung keine spezifische Nachrichtfestlegen. Sie können hier einen beliebigen Text einfügen, spezielle Zeichen wie Emojis werden allerdings nicht unterstützt und können zu Darstellungsfehlern führen.
+Diese Nachricht wird als Alarmnachricht verwendet, wenn Sie später in der Alarmierung keine spezifische Nachricht festlegen. Sie können hier einen beliebigen Text einfügen, spezielle Zeichen wie Emojis werden allerdings nicht unterstützt und können zu Darstellungsfehlern führen.
 \\
 \\
@@ Zeile 39: / Zeile 42: @@
 \\
 ** Alarmmodus **\\
-Zur Verfügung stehen: "best-effort" (Standardmodus) und "strict" (Alarm kann erst geschlossen werden, wenn ALLE Alarmierten eine Rückmeldung gegeben haben)
+Zur Verfügung stehen: "best-effort" (Standardmodus) und "strict". Im "best-effort"-Modus versucht GroupAlarm den Einsatz bestmöglich zu besetzen und entsprechend zu alarmieren. \\
+ Wählen sie den Modus "strict" wird ein Alarm nur ausgeführt, wenn alle Positionen besetzt werden können. Ist dies z.B. aufgrund von bekannten Abwesenheiten nicht möglich, wird nicht alarmiert.
 \\
 \\
@@ Zeile 45: / Zeile 49: @@
 Dieser Wert gibt an, wie lange ein Einsatz-Event in Groupalarm.com offen gehalten wird. (z.B. für Nachalarmierungen, die dem gleichen Event zugeordnet werden sollen.) Im Normalfall sollte dieser Wert nicht angepasst werden müssen. Der Wert hat **keine Auswirkungen** auf Vorgänge in EDP.
-===== Alarmierung =====
+=== Alarmierung ===
 Nach Abgeschlossener Konfiguration können Sie neue Alarmierungen als Aufgaben anlegen. Öffnen Sie dazu die EDP-Editor (Datenversorgung), melden Sie sich an und Navigieren Sie zu "AAO/Alarm" -> "Aufgaben". Legen Sie eine neue Aufgabe an und wählen sie auf der Rechten Seite "Ansteuerung" -> "GroupAlarm.com" aus. Unter "Wert" können sie nun die Alarmierung in nachfolgendem Format anlegen.
 \\
@@ Zeile 79: / Zeile 83: @@
 ** &Users, &Scenarios, &Units ** \\
 Die ID dieser Parameter kann genauso ausgelesen werden wie die ID der Labels, hier ist aber keine Mengenangabe möglich, alarmiert werden alle Kräfte, die den Szenarien/Einheiten/Nutzern zugeordnet sind.
+\\
+\\
+** &OrgID ** \\
+Der Parameter "OrgID" kann verwendet werden um in der Aufgabe eine separate Organisations-ID für die Alarmierung zu verwenden. Ist der Parameter gesetzt, wird die "Organisations-ID" aus der Konfiguration für diese Aufgabe überschrieben.\\
+Die Verwendung dieses Paramters sollte nur in Ausnahmefällen notwendig sein. (z.B. mehrere hinterlegte Organisationen)
 \\
 \\
 ** &Message ** \\
-<note important>In der Nachricht dürfen weder das Gleichzeichen ("=") noch das kaufmännische UND ("&") verwendet werden!</note>
+**In der Nachricht dürfen weder das Gleichzeichen ("=") noch das kaufmännische UND ("&") verwendet werden!**
 Fügt der Alarmierung eine Alarmnachricht an. Innerhalb der Nachricht können auch Platzhalter aus den EDP Protokolltags verwendet werden. Wird dieser Parameter nicht übergeben, wird der Standard-Text, der in der Konfiguration der Ansteuerung hinterlegt ist, verwendet.
-===== Beispiele =====
+===== Versenden von Statusmeldungen =====
+Zur Weiterleitung von Statusmeldungen an Groupalarm muss die dazugehörige Checkbox im Konfigurationsfenster der Schnittstelle aktiviert werden. Danach muss für jedes Einsatzmittel, dessen Status übermittelt werden soll, der "Externe Bezeichner" in Groupalarm in den hinterlegten Namen aus EDP geändert werden. Nach dem Ändern runterscrollen und speichern.
+{{:server:ansteuerungen:groupalarm_einheit_extid.jpg|}}
+=== Beispiele ===
 <code>
 &labels=1111#4,2222#6,3333#4&users=7788,8899&message=Fahrzeugbrand in Musterstadt.
@@ Zeile 114: / Zeile 128: @@
 {{ :anleitungen:bspaufgabe1.png |}}
 {{ :anleitungen:bspaufgabe2.png |}}
+=== Fehlerbehandlung ===
+\\
+** Fehler: 500 Internal Server Error ** \\
+Tritt üblicherweise auf, wenn ein Label, Szenario, Gruppe, etc. verwendet wurde, welches GroupAlarm.com nicht bekannt ist. (Z.B. //&users=7788// -> Aber Benutzer 7788 ist in GroupAlarm nicht angelegt.) \\
+Bitte überprüfen Sie, dass sie die korrekte Nummer verwenden.