server:ansteuerungen:groupalarmcom [Einsatzleitsoftware EDP]

Diese Seite ist nicht editierbar. Sie können den Quelltext sehen, jedoch nicht verändern. Kontaktieren Sie den Administrator, wenn Sie glauben, dass hier ein Fehler vorliegt.
====== Schnittstelle "Groupalarm.com" ======

===== 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:
  * Alarmierung über Label (z.B. Gruppe "Helfer" oder Gruppe "Führungskräfte")
  * Alarmierung über angelegter Szenarien
  * Alarmierung einzelner Benutzer oder Einheiten
  * Komplettalarmierung aller Teilnehmer in der Organisation
  * Den Alarmierungen können entsprechend konfigurierte Alarmnachrichten mitgegeben werden
**
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. \\ 
\\ 
Weiterführende Informationen zur Funktionalität von groupalarm.com finden sie auf der Seite des Anbieters: [[https://www.groupalarm.com/]].

===== 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 |}}
\\ 
\\ 
** 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.
{{ :anleitungen:api-schluessel.png |}}
\\ 
\\ 
** PA-Token (Personal Access Token) **\\ 
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 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.
\\ 
\\ 
** Organisations-ID **\\ 
Für die Organisations-ID klicken Sie bitte auf den Namen ihrer Organisation (Grüner Kasten). In der URL (Adressleiste) finden Sie nach dem Trennstrich ihre Organisations-ID (Roter Kasten, nur Nummern).
{{ :anleitungen:orgid.png |}}
\\ 
\\ 
** Alarmmodus **\\ 
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.
\\ 
\\ 
** Einsatzlaufzeit **\\ 
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 =====
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.
\\ 
\\ 
<code>
Beispiel:				Format
=========================================================================
Kräfteauswahl
&allUsers				"&allUsers"

&Labels=1001#3,1002#3,...#...		"&Labels="[LabelID]"#"[Menge]","
&Users=0,1,2,3,4,5,...			"&Users="[UserID]","
&Scenarios=35,89,145,...		"&Scenarios="[ScenarioID]","
&Units=U23,U24,U...			"&Units="[UnitID]","

--------------------------------------------------------------------------
Sonstige Parameter
&OrgID=1234                             "&OrgID="[OrganisationID]

&Message=Alarm: <%ORT%> <%MELDUNG%> 	"&Message="[Nachricht] (Darf nicht '&' oder '=' enthalten!)
</code>
\\ 
\\ 
** &allUsers **\\ 
Wird dieser Parameter verwendet, werden alle Kräfte der Organisation alarmiert. Es dürfen keine weiteren Parameter der Gruppe "Kräfteauswahl" verwendet werden, sonstige Parameter sind selbstverständlich weiterhin erlaubt.
\\ 
\\ 
** &Labels ** \\ 
Der Parameter wird aufgeteilt in die Nummer des Labels und die Menge der benötigten Kräfte dieser Gruppe - getrennt durch das "#"-Symbol. Mehrere dieser Anweisungen werden durch Kommata getrennt. Um die Nummer eines Labels herauszufinden, bearbeiten Sie bitte das Label auf GroupAlarm.com ("Konfiguration" -> "Labels" -> "..." -> "Bearbeiten"), in dieser Ansicht findet sich die ID in der Adressleiste zwischen "labels" und "edit" (Roter Kasten)
{{ :anleitungen:labels_bearbeiten.png |}}
\\ 
\\ 
** &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>
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 =====
<code>
&labels=1111#4,2222#6,3333#4&users=7788,8899&message=Fahrzeugbrand in Musterstadt.
</code>
Alarmiert:
  * Vier Kräfte der Gruppe 1111     (1111#4)
  * Sechs Kräfte der Gruppe 2222    (2222#6)
  * Vier Kräfte der Gruppe 3333     (3333#4)
  * Die Benutzer 7788 und 8899
Mit der Alarmnachricht "Fahrzeugbrand in Musterstadt."
----
<code>
&allUsers&message=Melderüberprüfung Januar
</code>
Alarmiert:
  * **Alle** Benutzer dieser Organisation
Mit der Alarmnachricht "Melderüberprüfung Januar"
----
<code>
&scenario=3,4&users=7653&units=232,7887
</code>
Alarmiert:
  * Die Kräfte der Szenarien 3 und 4
  * Den Benutzer 7653
  * Die Kräfte der Einheiten 232 und 7887
Mit der Standard-Alarmnachricht (Standardmäßig "EDP-Alarm", kann in der Ansteuerungskonfiguration geändert werden)
\\ 
{{ :anleitungen:bspaufgabe1.png |}}
{{ :anleitungen:bspaufgabe2.png |}}

===== Fehlerbehandlung =====
//Ab EDP 4.9//
\\
\\
** 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.