Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

Beide Seiten der vorigen RevisionVorhergehende Überarbeitung
Nächste Überarbeitung
Vorhergehende Überarbeitung
server:ansteuerungen:einsatzexport [2023/02/15 16:44] – [JSON-Vorlagen] patrickserver:ansteuerungen:einsatzexport [2025/01/24 15:44] (aktuell) – [JSON-Vorlagen] pascal
Zeile 1: Zeile 1:
-====== Ansteuerung Einsatzexport ======+==== Ansteuerung Einsatzexport ====
  
 Die Ansteuerung Einsatzexport ermöglicht das Verschicken verschiedener Einsatzdaten an bereitgestellte Schnittstellen anderer Systeme. Die Einsatzdaten werden dabei in vordefinierten JSON-Vorlagen verschickt. Die Ansteuerung Einsatzexport ermöglicht das Verschicken verschiedener Einsatzdaten an bereitgestellte Schnittstellen anderer Systeme. Die Einsatzdaten werden dabei in vordefinierten JSON-Vorlagen verschickt.
Zeile 14: Zeile 14:
 Zuerst muss eine Systemvorlage gewählt werden, dabei sind einige Systeme bereits hinterlegt. Falls das gewünschte System noch nicht hinterlegt ist, kann die Vorlage "Benutzerdefiniert" gewählt werden. Bei Auswahl eines bereits hinterlegten Systems werden die Server- und JSON-Einstellungen vorausgefüllt und es muss nur noch die Authentifizierung nach Vorgaben des angesteuerten Systems eingestellt werden. Zuerst muss eine Systemvorlage gewählt werden, dabei sind einige Systeme bereits hinterlegt. Falls das gewünschte System noch nicht hinterlegt ist, kann die Vorlage "Benutzerdefiniert" gewählt werden. Bei Auswahl eines bereits hinterlegten Systems werden die Server- und JSON-Einstellungen vorausgefüllt und es muss nur noch die Authentifizierung nach Vorgaben des angesteuerten Systems eingestellt werden.
  
-===== Export an FF-Agent =====+=== Export an FF-Agent ===
  
 Nach Auswahl der richtigen Systemvorlage muss nur noch die Authentifizierung ausgefüllt werden. Dafür muss sich auf der Website von FF-Agent angemeldet werden und über Einstellungen → Alarmierung → Schnittstellen zum Abschnitt EDP navigiert werden. Dort können der API-Token und das API-Secret ausgelesen werden.   Nach Auswahl der richtigen Systemvorlage muss nur noch die Authentifizierung ausgefüllt werden. Dafür muss sich auf der Website von FF-Agent angemeldet werden und über Einstellungen → Alarmierung → Schnittstellen zum Abschnitt EDP navigiert werden. Dort können der API-Token und das API-Secret ausgelesen werden.  
  
-===== Export an benutzerdefiniertes System =====+Beim Anlegen einer Aufgabe zum Einsatzexport an FF-Agent kann als Wert eine Liste an Organisationen übergeben werden, die in FF-Agent zugeordnet werden. 
 + 
 +{{:server:ansteuerungen:einsatzexport_aufgabe.png?600|}} 
 + 
 +=== Export an benutzerdefiniertes System ===
  
 Hierfür muss zuerst die Serveradresse und die Adresse des API-Endpoints ausgefüllt werden. Danach kann mit der Authentifizierung fortgefahren werden. Hierfür muss zuerst die Serveradresse und die Adresse des API-Endpoints ausgefüllt werden. Danach kann mit der Authentifizierung fortgefahren werden.
  
-==== Authentifizierung ====+=== Authentifizierung ===
  
 Die Authentifizierung geschieht primär über ein Access-Token, das von dem anzusteuernden Programm zur Verfügung gestellt werden muss. Dieses Token wird bei einer Anfrage im Header als Authorization übergeben. Als weitere Authentifizierungs- und Sicherheitsfunktion kann ein hmac der http-Request erstellt werden. Dafür muss ein API-Secret hinterlegt werden. Mithilfe dieses Secrets wird ein hash über [API-Token][Request-Body] erstellt und als hmac im Header übergeben. Die Authentifizierung geschieht primär über ein Access-Token, das von dem anzusteuernden Programm zur Verfügung gestellt werden muss. Dieses Token wird bei einer Anfrage im Header als Authorization übergeben. Als weitere Authentifizierungs- und Sicherheitsfunktion kann ein hmac der http-Request erstellt werden. Dafür muss ein API-Secret hinterlegt werden. Mithilfe dieses Secrets wird ein hash über [API-Token][Request-Body] erstellt und als hmac im Header übergeben.
  
-==== JSON-Vorlagen ====+=== JSON-Vorlagen ===
  
 Es können verschiedene Einsatzdaten als JSON verschickt werden, die über eine Vorlage ausgewählt werden. Diese JSON-Vorlagen haben folgende Strukturen: Es können verschiedene Einsatzdaten als JSON verschickt werden, die über eine Vorlage ausgewählt werden. Diese JSON-Vorlagen haben folgende Strukturen:
Zeile 86: Zeile 90:
     }     }
   ],   ],
-  "einsatzverlauf": [+  "dokumentation": [
     {     {
       "UHRZEIT": 1676369980,       "UHRZEIT": 1676369980,
Zeile 142: Zeile 146:
   "helfer": [   "helfer": [
     {     {
-      "ID": "4", 
       "NAME": "Mustermann",       "NAME": "Mustermann",
       "VORNAME": "Erika",       "VORNAME": "Erika",
Zeile 152: Zeile 155:
       "BEGINN": 1676369612,       "BEGINN": 1676369612,
       "ENDE": 1676372400,       "ENDE": 1676372400,
-      "EINSATZNUMMER": 2023000006, 
       "BEMERKUNG": "",       "BEMERKUNG": "",
       "HELFER_ID": "112",       "HELFER_ID": "112",
Zeile 160: Zeile 162:
     },     },
     {     {
-      "ID": "5", 
       "NAME": "Mustermann",       "NAME": "Mustermann",
       "VORNAME": "Max",       "VORNAME": "Max",
Zeile 170: Zeile 171:
       "BEGINN": 1676369613,       "BEGINN": 1676369613,
       "ENDE": 1676372400,       "ENDE": 1676372400,
-      "EINSATZNUMMER": 2023000006, 
       "BEMERKUNG": "",       "BEMERKUNG": "",
       "HELFER_ID": "113",       "HELFER_ID": "113",