Beschreibung der Schnittstelle <Schnittstellenname>
Aus ZEuS-Wiki
<Überschrift Verweis auf Schnittstellenbezeichnung>
(1 Vorgeschaltete Seite, falls zwei Schnittstellen zwischen Systemen existieren.)
Beinhaltet Aufzählung der Schnittstellen mit Link auf die Beschreibungen
<Überschrift Schnittstellenbezeichnung>
Überblick
Was macht die Schnittstelle wofür?
Systembeschreibung
Wo laufen die Systeme Netz, Server ….
Usergruppen | Aufgabe / Systemnutzung für |
Ansprechpartner
Wer betreut das System technisch und fachlich?
Voraussetzungen
Version, Kompatibilität zu
Stand / offene Punkte in der Schnittstellenbereitstellung
Was sind die noch zu bewältigenden Hauptpunkte?
Art der Schnittstelle
z.B. Webservice , Datenfluss wohin/von wo
Im Fall eines CSV-Exports, Reihenfolge der Datenfelder
Zeitpunkt des Austauschs
Zeitpunkt der Lieferung bzw. Abholung der Daten im Fall von CSV-Dateien
Selektionskriterien für die Daten
aktive Beschäftigungsverhältnisse, veränderte Raumdaten etc.
Datenmapping
Tabellenname System 1 | Feldname System 1 | Attributtyp, also Date, Timestamp, Varchar | Datenfluss | Tabellenname System 2 | Feldname System 2 | Attributtyp, also Date, Timestamp, Varchar |
Zu beachten
Achtung: Die nachfolgenden Dinge sind zu beachten! |
z.B. Update Infos (wo mit Link), Kompatibilitätshinweise etc.
Ausführliche Dokumentation an anderem Ort
Link zur Doku bzw. Ortbezeichnung