Schnittstellen & Datenübergabe
Projektdaten sollen weiter nutzbar bleiben.
Sie möchten Informationen ins Archiv übernehmen oder ein bestehendes System anbinden? Beschreiben Sie zuerst den Datenfluss. Gemeinsam prüfen wir, welche Daten, Funktionen und Formate für Ihre Anforderung verfügbar sind.
Schnittstelle und Übergabeanforderungen besprechenwinplan bietet eine REST API. Für Ihr Fremdsystem legen wir Umfang und Datenfluss gemeinsam fest und nehmen die Anbindung zusammen ab.
Vier Aufgaben mit unterschiedlichem Leistungsumfang
Mit Dateien arbeiten
Pläne, Dokumente und IFC-Modelle werden im jeweiligen Produktablauf verwendet. Prüfen Sie Ihre konkreten Dateien und erforderlichen Attribute an einem Beispiel.
Projektakte übergeben
Legen Sie fest, welche Dokumente, Planstände, Metadaten und Nachweise Sie nach dem Projekt benötigen. Stimmen Sie ein lesbares Musterpaket mit dem Empfänger ab.
Systeme verbinden
Eine API-Anbindung kann Datenflüsse zwischen Systemen unterstützen. Verfügbare Operationen, Authentifizierung und Einschränkungen werden für Ihren Einsatzfall technisch geprüft.
Individuell anpassen
Anpassung, Entwicklung, Betrieb und Wartung einer Integration sind gesonderte Aufgaben. Benennen Sie für beide Systeme einen technischen Verantwortlichen.
So wird aus „Wir brauchen eine Schnittstelle“ ein prüfbarer Auftrag
| Frage | Beispiel für die Abstimmung | Abnahmekriterium |
|---|---|---|
| Welche Richtung? | Abgeschlossene Projektunterlagen aus winplan ins Zielarchiv | Vereinbarte Daten vollständig angekommen |
| Welche Objekte? | Aktuelle Pläne, definierte Dokumentarten und ausgewählte Metadaten | Feldzuordnung mit Beispieldateien geprüft |
| Welcher Auslöser? | Einmalige Übergabe oder vereinbarter regelmäßiger Austausch | Zeitpunkt und Fehlerfall reproduzierbar getestet |
| Welche Rechte? | Technischer Zugriff mit benötigtem Umfang | Kein Zugriff auf unbeteiligte Projekträume |
| Wer betreibt die Verbindung? | Verantwortliche für Quell- und Zielsystem | Fehlermeldung, Wiederholung und Supportweg dokumentiert |
Illustrative Anforderungsmatrix. Die Beispiele sind keine Zusage vorhandener API-Endpunkte oder Standardintegrationen.
Was Ihre IT vor einer Zusage erhält
Für die technische Klärung fragen wir die aktuelle Schnittstellendokumentation und die konkret benötigten Funktionen ab. Dazu gehören Authentifizierungsverfahren, Rechte, Datenformate, Mengenbegrenzungen, Fehlerverhalten und Versionsänderungen.
Ein Test mit repräsentativen, möglichst anonymisierten Daten zeigt, ob das Zielsystem die Übergabe tatsächlich lesen und zuordnen kann. Erst der geprüfte Umfang wird Bestandteil des Angebots. Für SAP, DMS- oder Archivsysteme wird deshalb keine pauschale Plug-and-play-Verbindung vorausgesetzt.
Die spätere Übergabe schon beim Start definieren
Ein Download einzelner Dateien ist noch keine vereinbarte Projektakte. Klären Sie, ob der Empfänger zusätzlich Versionsstände, Statusinformationen, Dokumentlisten, Prüfvermerke oder Protokolle benötigt und in welcher Form diese verfügbar sind.
Prüfen Sie den Musterexport früh. Verantwortlichkeiten, Fristen, Aufbewahrung, Zugriff nach Vertragsende und ein mögliches Löschverfahren gehören in die Vereinbarung. Konkrete technische und vertragliche Bedingungen werden projektbezogen bestätigt.
Diese fünf Angaben helfen im ersten Gespräch
- Quell- und Zielsystem einschließlich verantwortlicher Ansprechpartner
- Ein oder zwei benötigte Datenobjekte mit anonymisiertem Beispiel
- Gewünschte Richtung und Häufigkeit des Austauschs
- Vorgaben Ihrer IT zu Zugriff und Betrieb
- Erwartetes Ergebnis und Termin der technischen Abnahme
Fragen vor der Entscheidung
Gibt es eine REST API?
Eine REST API ist in der öffentlichen Produktdarstellung beschrieben. Für Ihr Vorhaben bestätigen wir die aktuelle Dokumentation, benötigte Funktionen, Zugriffsbedingungen und den vereinbarten Leistungsumfang.
Kann ich alle Daten einschließlich Historie exportieren?
Legen Sie den benötigten Umfang mit uns fest und prüfen Sie eine Musterübergabe. Verfügbare Formate und die Abbildung von Metadaten, Historien oder verknüpften Vorgängen müssen konkret bestätigt werden.
Quellen und Einordnung
- NetzWerkPlan: Gespräch mit einem öffentlichen Bauherrn
Beschreibt Musterprojekte, delegierte Administration und Rahmenvereinbarungen. Den aktuellen Leistungsumfang legen wir im Angebot fest.
Ihr nächster Schritt
Schnittstelle und Übergabeanforderungen besprechenDatenmigration planen
Daten, Struktur und Team kontrolliert in den Projektraum überführen.
Datenmigration planenAnforderungskatalog vorbereiten
Arbeitshilfe herunterladen und im eigenen Projekt einsetzen.
Anforderungskatalog vorbereitenSicherheitsnachweise
Datenhaltung, Rollen und Nachweise für Ihre Freigabe prüfen.
Sicherheitsnachweise