Integrationen

Einführung in das Segment “Integrationen”

Das Segment Integrationen in Docusnap365 dient der zentralen Erfassung und strukturierten Dokumentation aller externen Schnittstellen, die im Kontext der IT-Infrastruktur verwendet werden. Es handelt sich dabei nicht um aktive Datenimporte, sondern um eine definitorische Übersicht über vorhandene Integrationspunkte – mit dem Ziel, Transparenz, Wartbarkeit und Nachvollziehbarkeit zu schaffen.

Typische Anwendungsfälle sind die Beschreibung von (S)FTP-Zugängen, Datenbank-Endpunkten, REST-APIs oder Dateiablagen, die von anderen Systemen genutzt oder bereitgestellt werden.

Dokumentierte Integrationstypen

Folgende Typen von Integrationen lassen sich dokumentieren:

• (S)FTP
  Definition von Dateiservern mit Pfadangaben, Authentifizierung und Zweckbeschreibung.

• E-Mail
  Beschreibung von E-Mail-Postfächern oder Adressen, über die Daten oder Benachrichtigungen verarbeitet werden.

• NFS
  Netzwerkfreigaben auf NFS-Basis, inkl. Pfadstruktur, Berechtigungen und Mount-Konfigurationen.

• Rest API
  REST-Endpunkte mit Methoden, Authentifizierungsmechanismen (z. B. Token, OAuth), verwendeten Parametern und Beispielaufrufen.

• SMB
  Windows-Netzwerkfreigaben (UNC), inkl. Pfade, Zugriffskonventionen und Nutzungszweck.

• SQL
  Datenbankserver mit Name, Typ, Zugriffsdaten, betroffenen Tabellen/Sichten und Zugriffsmöglichkeiten.

• Upload
  Manuelle Bereitstellungsschnittstellen mit Informationen zu Dateiformaten, Zielstruktur und Ansprechpartnern.

Strukturierte Schnittstellenbeschreibung

Jede Integration wird in Docusnap365 anhand einheitlicher Felder dokumentiert:

• Name und Typ der Integration
  Klar identifizierbare Bezeichnung inkl. Zuordnung zu einem der oben genannten Typen.

• Organisation und Standort
  Zugehörigkeit zu einer organisatorischen Einheit sowie optionaler physischer Standort der Integration.

• Beschreibung
  Freitext zur Erläuterung des Zwecks und der Funktionsweise der Schnittstelle.

• Verantwortliche Person
  Zuständige Person für Betrieb, Betreuung oder Wartung der Schnittstelle.

• Datenformat
  Erwartetes oder verwendetes Datenformat (z. B. JSON, CSV, XML), um die technische Ausgestaltung nachvollziehbar zu machen.

• Ausführungsart
  Information zur Art der Verwendung oder Aktivierung (z. B. zeitgesteuert, manuell, eventbasiert).

• Verknüpfungen mit Systemen
  Möglichkeit, diese Schnittstelle logisch mit Systemen, Diensten oder Anwendungen innerhalb der Docusnap365-Dokumentation zu verbinden.

• Kommentare & Änderungsverlauf
  Ergänzende Informationen, interne Notizen oder Kommunikationsverläufe.

Ziele der Segmentdokumentation

• Transparenz über bestehende Schnittstellen
  Einheitliche Erfassung aller Kommunikationspunkte mit Drittsystemen – intern wie extern.

• Dokumentationspflicht und Compliance
  Nachvollziehbarkeit, wer auf welche Systeme zugreifen kann, welche Daten wohin fließen und auf welcher Basis.

• Wartbarkeit und Fehlersuche
  Im Fehlerfall steht eine zentrale, aktuelle Übersicht über alle definierten Integrationen zur Verfügung.

• Zukunftssicherheit
  Klare Ablösung veralteter Schnittstellen durch Lifecycle-Status; Hilfe bei Modernisierungsprojekten.