1. Allgemeine Informationen
|
Parameter |
Beschreibung |
|---|---|
|
Projektname |
[Name des Projekts] |
|
Datum |
[Erstellungsdatum] |
|
Version |
[Versionsnummer, z. B. 1.0] |
|
Ersteller |
[Name der verantwortlichen Person/Abteilung] |
|
Zielsetzung |
[Kurzbeschreibung des Ziels der Schnittstelle] |
2. Beteiligte Systeme und Datenflussbeschreibung
|
System 1 |
Rolle (System 1) |
System 2 |
Rolle (System 2) |
Datenrichtung |
Übertragungshäufigkeit |
Datenformat |
Übertragungsweg |
Besonderheiten |
|---|---|---|---|---|---|---|---|---|
|
SAP |
Führendes System |
getaiplan |
Empfangendes System |
Einseitig (SAP → getaiplan) |
Periodisch (3x täglich) |
JSON/CSV |
API/Middleware |
Primärquelle für Fertigungsaufträge |
|
MES |
Empfangendes System |
getaiplan |
Führendes System |
Zweiseitig (getaiplan ↔ MES) |
Schichtweise |
JSON/CSV |
API |
Rückmeldungen zu gefertigten Stückzahlen |
|
Legacy-System |
Hybrid-System |
getaiplan |
Hybrid-System |
Zweiseitig oder einseitig |
Echtzeit/Triggerbasiert |
XML |
API/Middleware |
Datenvalidierung notwendig |
|
Externe Datenbank |
Datenquelle |
getaiplan |
Datenkonsument |
Einseitig (Datenbank → getaiplan) |
Täglich (nachts) |
CSV |
Dateiablage |
Batch-Import für historische Daten |
|
Webservice |
Datenkonsument |
getaiplan |
Datenquelle |
Einseitig (getaiplan → Webservice) |
Echtzeit |
JSON |
API |
Schnittstelle für Echtzeit-Statusabfragen |
|
IoT-Sensoren |
Datenlieferant |
getaiplan |
Datenkonsument |
Einseitig (Sensoren → getaiplan) |
Sekundenweise |
JSON |
API/Websocket |
Hohe Übertragungsfrequenz, geringe Datenmenge |
|
Middleware |
Integrationsplattform |
getaiplan |
Zielsystem |
Zweiseitig |
Abhängig von Konfiguration |
JSON/XML |
API/Middleware |
Zentraler Punkt für mehrere Systeme |
Erklärung der Varianten
-
SAP → getaiplan: Klassisches Beispiel für ein führendes System, das periodisch Produktionsaufträge überträgt.
-
MES ↔ getaiplan: Zweiseitige Schnittstelle für die Rückmeldung von gefertigten Stückzahlen.
-
Legacy-System → getaiplan: Hybrid-Ansatz für ältere Systeme, die Daten sowohl senden als auch empfangen können.
-
Externe Datenbank → getaiplan: Einseitige Übertragung großer Datenmengen, beispielsweise historische Informationen.
-
getaiplan → Webservice: Beispiel für eine API-basierte Schnittstelle, bei der getaiplan Status-Updates oder Berichte sendet.
-
IoT-Sensoren → getaiplan: Hochfrequente Echtzeitübertragung für IoT-Geräte, z. B. Maschinendaten.
-
Middleware ↔ getaiplan: Middleware als zentrale Integrationsplattform, die als Vermittler für verschiedene Systeme fungiert.
2.1. Datendetails je Schnittstelle
Mitarbeiterbezogene Daten
|
Datenfeld |
Systemrelevant |
Beschreibung |
Bemerkung / projektrelevant |
|---|---|---|---|
|
[Feldname 1] |
Pflicht |
[Beschreibung] |
|
|
[Feldname 2] |
Optional |
[Beschreibung] |
|
|
... |
... |
... |
|
Zusätzliche Informationen:
-
Erwartetes Datenvolumen: [Details zum Volumen, z. B. 10 MB pro Übertragung]
-
Identifikationsmerkmale: [Primärschlüssel, z. B. Personalnummer]
Produktions- und Projektbezogene Daten
|
Datenfeld |
Systemrelevant |
Beschreibung |
Bemerkung / projektrelevant |
|---|---|---|---|
|
[Feldname 1] |
Pflicht |
[Beschreibung] |
|
|
[Feldname 2] |
Optional |
[Beschreibung] |
|
|
... |
... |
... |
|
Zusätzliche Informationen:
-
Erwartetes Datenvolumen: [Details zum Volumen, z. B. 10 MB pro Übertragung]
-
Identifikationsmerkmale: [Primärschlüssel, z. B. Fertigungsauftragsnummer]
2.2. Technische Spezifikationen
Datenstruktur
-
Datenquelle 1:
-
[Beschreibung: Bereitstellung im [FORMAT], wahlweise als Voll- oder Delta-Import (je nach Vereinbarung).]
-
Sicherheitsanforderungen
-
Datenquelle 1:
-
[Details zur Übertragungssicherheit, z. B. SFTP, API, Verschlüsselung]
-
Fehlerbehandlung
-
Fehlerhafte Datensätze, z. B. aufgrund fehlender Pflichtfelder oder ungültiger Formate, werden protokolliert.
-
Die restlichen Datensätze werden weiterverarbeitet.
2.3. Validierungsregeln
Datenvollständigkeit
-
Datenquelle 1:
-
Validierung von Voll- oder Deltaimporten (Details je nach Vereinbarung).
-
Pflichtfelder
-
Datenquelle 1: [Pflichtfeld 1], [Pflichtfeld 2].
-
Datenquelle 2: [Pflichtfeld 1], [Pflichtfeld 2].
Änderungserkennung
-
Beschreibung: Änderungen werden geprüft, um Unterschiede zu bereits gespeicherten Datensätzen zu identifizieren.
Hinweise zur Nutzung
-
Dieses Template dient als Basis und kann an spezifische Anforderungen angepasst werden.
-
Platzhalter wie Datenquelle 1, FORMAT und Pflichtfeld sollten durch konkrete Informationen ersetzt werden.
-
Für jeden Abschnitt können zusätzliche Informationen oder Beispiele ergänzt werden.