Konfiguration der Zustellpunkte im Selfservice Portal über den Upload und die automatische Verarbeitung einer XML/Excel-Datei zu ermöglichen
User Story
Als Fachadministrator:in möchte ich Zustellpunkte im Self-Service-Portal (SSP) effizient konfigurieren können, indem ich eine XML-, JSON- oder Excel-Datei hochlade, die automatisch verarbeitet und in das System übernommen wird. Dadurch kann ich mehrere Zustellpunkte gleichzeitig anlegen oder aktualisieren, ohne diese manuell einzeln im Portal pflegen zu müssen.
Warum
Bisher müssen Zustellpunkte im SSP manuell angelegt oder geändert werden. Für große Organisationen oder IT-Dienstleister mit vielen Zustellpunkten (z. B. bei Rechenzentrums- oder Landeslösungen) ist das sehr zeitaufwändig.
Mit dem Upload einer standardisierten XML/JSON/Excel-Datei kann eine automatisierte Verarbeitung erfolgen, wodurch die Administration vereinfacht, Fehler reduziert und der Rollout neuer Systeme beschleunigt wird.
In der Variante mit der Nachnutzung der API benötigen wir eine von unserem externen Hersteller entwickelte zusätzliche Softwarelösung.
In der Variante, dass wir im Self-Service Portal eine JSON/XML/.. uploaden könnten, würden wir diese Tätigkeiten aus dem Betriebsteam ohne zusätzliche Software umsetzen können.
Links, Hinweise, Bemerkungen
- Anlehnung an bestehende API-Endpunkte der Destination API
- Dateiformate (XML/JSON/Excel etc.) sollen einer standardisierten Struktur entsprechen
- Beispielstruktur und Schemadefinition sind zentral in der Dokumentation zu hinterlegen
- Prozess soll revisionssicher protokolliert werden (z. B. Upload-Log, Prüfergebnis, Importstatus)
- Fehlerhafte Datensätze sollen einzeln ausgewiesen werden
- Integration in das bestehende Rollen- und Rechtemanagement (nur berechtigte Personen dürfen Uploads durchführen)
- Es ist zu klären, ob die Struktur einer Destination gut in Excel abbildbar ist (z.B. wegen mehreren Leistungen, mehreren Regionen)
- Es ist zu klären, welche Aktionen möglich sein sollen: Anlegen, Bearbeiten, Statuswechsel, Löschen/Deaktivieren?
- Was ist mit dem Upload der Schlüssel?
- Information vom Kunden (Rechenzentrum): "in der Variante mit der Nachnutzung der API benötigen wir eine von unserem externen Hersteller entwickelte zusätzliche Softwarelösung. In der Variante, dass wir im Self-Service Portal eine JSON/XML/.. uploaden könnten, würden wir diese Tätigkeiten aus dem Betriebsteam ohne zusätzliche Software umsetzen können."
Akzeptanzkriterien
-
Im SSP kann eine XML-, JSON- oder Excel-Datei mit Zustellpunktdaten hochgeladen werden. -
Die Datei wird automatisch geprüft (Syntax, Validität, Berechtigungen). -
Erfolgreiche Einträge werden automatisch in den ZSD übernommen und aktiviert. -
Fehlerhafte Einträge werden mit aussagekräftiger Fehlermeldung angezeigt. -
Der Importprozess ist im EventAudit-Log nachvollziehbar. (Destinations haben kein Event-Log) -
Über die Destination API kann der Importstatus (Erfolg, Fehler, Warnung) abgefragt werden. -> Ist das sinnvoll? Wenn sie die Destination API nutzen, können sie die Destinations darüber anlegen bzw. bearbeiten und brauchen den Import nicht. -
SDKs (Java, .NET, JavaScript) werden um Beispielmethoden zur Generierung der XML/Excel-Datei erweitert.
-> Auch JavaScript? -
Im SSP wird die erfolgreiche oder fehlerhafte Verarbeitung visuell angezeigt (Status: „In Prüfung“, „Erfolgreich importiert“, „Fehlerhaft“). -
Dokumentation in der Betriebsdokumentation wurde aktualisiert. -
Definition of Done wurde überprüft.
Verantwortlichkeiten nach Komponente
SSP (Self-Service-Portal)
- Bereitstellung der Upload-Oberfläche (Drag & Drop oder Dateiauswahl)
- Anzeige von Importstatus, Fehlermeldungen und Logs
- Umsetzung der Benutzerführung und Rechteprüfung
- Integration der Upload-Funktion mit dem ZSD über interne API
ZSD (Zustelldienst)
- Verarbeitung und Validierung der importierten Daten
- Automatisiertes Anlegen, Ändern oder Löschen von Zustellpunkten
- Bereitstellung von Statusinformationen und Fehlerberichten
- Versionierung und Protokollierung der Änderungen
SDKs
- Bereitstellung von Code-Beispielen zur Erstellung der XML/JSON/Excel-Dateien
- Automatisierte Validierung gegen das Schema
- Unterstützung bei Integration in Build- oder Verwaltungstools
- Anpassung der Dokumentation und Beispielprojekte
Mögliche Folgeaktivitäten
-
Erweiterung der Funktion für Export (z. B. Export aller Zustellpunkte in XML/JSON/Excel) -
Erstellung von Templates (z. B. „Leere Vorlage herunterladen“) -
Erweiterung um CSV-Import (optional) -
Ergänzung in den FIT-Connect Leitfaden für IT-Dienstleister -
Schulungs- oder Demo-Video im SSP veröffentlichen