Schnittstellen¶

Schnittstellen dokumentieren die logischen Datenflüsse zwischen Ihren Anwendungen. Jede Schnittstelle repräsentiert eine Geschäftsintegration -- das „Warum" und „Was" des Datenaustauschs -- unabhängig davon, wie sie technisch implementiert ist. Der Arbeitsbereich ermöglicht es Ihnen, die Schnittstelle zu beschreiben, die Legs zu definieren, die Daten durch Ihre Landschaft bewegen, umgebungsspezifische Bindungen zu konfigurieren, die feldgenauen Mapping-Regeln zu erfassen und verwandte Schnittstellen, Dokumente und Anhänge zu verknüpfen.

Erste Schritte¶

Navigieren Sie zu IT-Landschaft > Schnittstellen, um Ihr Integrationsverzeichnis zu sehen. Klicken Sie auf Schnittstelle hinzufügen, um einen neuen Eintrag zu erstellen, oder öffnen Sie einen vorhandenen, um ihn zu bearbeiten.

Um eine Schnittstelle zu erstellen, benötigen Sie:

Schnittstellen-ID: Ein eindeutiger Kurzcode (z. B. INT-CRM-ERP-001)
Name: Ein beschreibender Name für die Integration
Geschäftlicher Zweck: Eine kurze Zusammenfassung, warum diese Integration existiert
Quellanwendung und Zielanwendung
Datenkategorie: Der Datentyp, der übertragen wird

Sobald diese festgelegt sind, können Sie die Schnittstelle speichern; der Rest des Arbeitsbereichs (Technisch, Umgebungen, Mapping, Verknüpfungen) wird danach verfügbar.

Tipp: Legen Sie den Integrationsroutentyp (Direkt oder Via Middleware) frühzeitig fest. Er steuert, welche Legs automatisch generiert werden und was im Reiter Technisch und in der Umgebungsmatrix angezeigt wird.

Arbeiten mit der Liste¶

Das Schnittstellenraster zeigt Ihr Integrationsverzeichnis auf einen Blick.

Standardspalten:

Schnittstellen-ID: Die eindeutige Kennung (klicken, um den Arbeitsbereich zu öffnen)
Name: Schnittstellenname
Umgebungen: Farbige Punkte, die zeigen, welche Umgebungen bereits Bindungen konfiguriert haben (z. B. PROD, QA, DEV)
Quell-App und Ziel-App: Die verbundenen Anwendungen
Lebenszyklus: Aktueller Status
Kritikalität: Geschäftliche Bedeutung
Erstellt: Wann der Datensatz erstellt wurde

Zusätzliche Spalten (über die Spaltenauswahl):

Geschäftsprozess: Verknüpfter Geschäftsprozess
Datenkategorie: Datentyp, der übertragen wird
Enthält PII: Ob die Schnittstelle personenbezogene Daten verarbeitet
Umgebungsabdeckung: Anzahl der Umgebungen mit mindestens einer Bindung
Bindungen: Gesamtzahl der Umgebungs-Bindungen

Filterung:

Schnellsuche über alle Textspalten
Spaltenfilter für Lebenszyklus, Kritikalität, Datenkategorie, Geschäftsprozess, Enthält PII, Integrationsroute und Datenklassifizierung

Aktionen:

Schnittstelle hinzufügen: Eine neue Schnittstelle erstellen (erfordert applications:manager)
Schnittstelle duplizieren: Eine Kopie einer ausgewählten Schnittstelle erstellen (erfordert applications:manager). Wählen Sie genau eine Zeile aus, um diese Aktion zu aktivieren. Ein Dialog ermöglicht es Ihnen zu wählen, ob Umgebungs-Bindungen kopiert werden sollen -- siehe Schnittstellen kopieren unten.
Ausgewählte löschen: Ausgewählte Schnittstellen entfernen (erfordert applications:admin). Eine Kontrollkästchen-Option ermöglicht es Ihnen auch, verwandte Bindungen zu löschen; wenn nicht aktiviert, werden Schnittstellen mit Bindungen nicht gelöscht.

Der Schnittstellen-Arbeitsbereich¶

Klicken Sie auf eine Zeile, um den Arbeitsbereich zu öffnen. Der Arbeitsbereich hat ein Seitenpanel mit den Schnittstelleneigenschaften auf der linken Seite und fünf Reiter auf der rechten Seite.

Schnittstelleneigenschaften (Seitenpanel)¶

Das Seitenpanel bleibt in jedem Reiter sichtbar und gruppiert die am häufigsten bearbeiteten Felder in drei einklappbare Bereiche:

Kerneigenschaften:

Schnittstellen-ID, Name, Geschäftlicher Zweck (erforderlich)
Geschäftsprozess: Verknüpfung mit einem Geschäftsprozess aus den Stammdaten
Lebenszyklus und Kritikalität
Quellanwendung und Zielanwendung (erforderlich)
Integrationsroutentyp: Direkt oder Via Middleware
Middleware-Anwendungen: Nur angezeigt, wenn der Routentyp Via Middleware ist. Die Liste ist auf Anwendungen beschränkt, die als ETL/Middleware gekennzeichnet sind.

Team:

Business-Verantwortliche: Geschäftliche Stakeholder, die für die Integration rechenschaftspflichtig sind
IT-Verantwortliche: Technische Teammitglieder, die für die Wartung verantwortlich sind

Daten & Compliance:

Datenkategorie: Die Art der übertragenen Daten
Datenklassifizierung: Sensibilitätsstufe (Öffentlich, Intern, Vertraulich, Eingeschränkt)
Enthält PII: Wenn aktiviert, erscheint ein Feld PII-Beschreibung, sodass Sie detaillieren können, welche PII enthalten sind
Datenhaltung: Länder, durch die die Daten fließen (ISO-2-Buchstaben-Codes)

Feldänderungen im Seitenpanel werden automatisch gespeichert, wenn Sie das Feld verlassen, sodass Sie Eigenschaften aus jedem Reiter aktualisieren können, ohne den Kontext zu wechseln.

Spezifikation¶

Der Reiter Spezifikation ist ein verwaltetes Rich-Text-Dokument, in dem Sie die Schnittstelle End-to-End beschreiben -- geschäftlicher Kontext, Umfang, Vertrag, Beispiele. Es ist das primäre narrative Dokument für die Schnittstelle.

Tipp: Verwenden Sie diesen Reiter als Ihre einzige Quelle der Wahrheit für Prosa. Mapping-Regeln und technische Legs leben in den dedizierten Reitern unten; halten Sie dieses Dokument auf Absicht, Umfang und die für Menschen lesbare Zusammenfassung fokussiert.

Technisch¶

Der Reiter Technisch definiert die gemeinsamen Legs, aus denen die Schnittstelle besteht. Legs sind Vorlagen: Sie beschreiben, was jeder Schritt allgemein tut (die gleiche Definition gilt für jede Umgebung).

Für jeden Leg können Sie bearbeiten:

Leg-Typ: EXTRACT, TRANSFORM, LOAD oder DIRECT (automatisch basierend auf der Integrationsroute festgelegt)
Von -> Zu: Welche Rolle jeden Schritt verarbeitet (Quell-App, Ziel-App oder Middleware)
Auslöser-Typ: Was diesen Leg initiiert (z. B. geplant, ereignisgesteuert, manuell)
Muster: Das Integrationsmuster (z. B. Batch, Echtzeit, Pub/Sub)
Format: Das Datenformat (z. B. JSON, XML, CSV, Flat-File)
Job-Name: Ein optionaler Standard-Job- oder Prozessname

Wenn noch keine Legs angezeigt werden, speichern Sie zuerst die Schnittstelle. Legs werden aus der Quellanwendung, Zielanwendung und dem Integrationsroutentyp im Seitenpanel generiert.

Umgebungen¶

Der Reiter Umgebungen verwaltet die umgebungsspezifischen Bindungen, die die Leg-Vorlagen in tatsächliche Konfigurationen umwandeln. Er präsentiert eine Matrix von Umgebungen und Legs, sodass Sie jede Kombination unabhängig konfigurieren können.

Wie es funktioniert:

Jede Umgebung (Prod, Pre-prod, QA, Test, Dev, Sandbox oder benutzerdefiniert) kann Bindungen für jeden Leg haben
Umgebungen werden automatisch aus Ihren Anwendungs-Instanzen erkannt; Sie können auch benutzerdefinierte Umgebungen hinzufügen
Klicken Sie auf eine leere Zelle, um eine Bindung zu erstellen, oder klicken Sie auf eine vorhandene, um sie zu bearbeiten

Bindungsfelder:

Quell-Instanz und Ziel-Instanz: Welche Anwendungs-Instanzen in dieser Umgebung verwendet werden sollen
Status: Aktiviert, Deaktiviert oder Test
Quellendpunkt und Zielendpunkt: Technische Endpunkte (URLs, Pfade, Queue-Namen usw.)
Auslöser-Details: Umgebungsspezifische Auslöser-Konfiguration
Umgebungs-Job-Name: Den Job-Namen der Leg-Vorlage für diese Umgebung überschreiben
Authentifizierungsmodus: Wie sich die Bindung authentifiziert
Monitoring-URL: Link zu Monitoring oder Observability für diese Bindung
Integrationswerkzeug-Anwendung: Falls zutreffend, das verwendete Integrationswerkzeug
Umgebungs-Notizen: Umgebungsspezifische Notizen

Verbindungs-Verknüpfung: Jede Bindung kann mit Infrastrukturverbindungen aus Ihrem Verbindungsverzeichnis verknüpft werden. So können Sie den vollständigen Pfad von der logischen Schnittstelle bis zur physischen Netzwerkverbindung nachverfolgen.

Mapping¶

Der Reiter Mapping ist der Ort, an dem Sie beschreiben, wie Quellfelder zu Zielfeldern werden. Er ist um zwei Konzepte herum organisiert:

Mapping-Regeln beschreiben eine einzelne Mapping-Entscheidung -- ein oder mehrere Quellfelder, ein oder mehrere Zielfelder, eine Operation (direktes Kopieren, Transformieren, Lookup, Aufteilen, Zusammenführen, Filtern, Standardwert oder eine benutzerdefinierte Operation) und optionale Bedingungs- / Geschäfts- / Middleware-Notizen.
Mapping-Gruppen sind Ordner, die die Regeln in thematische Bereiche organisieren (zum Beispiel „Header", „Kundenblock", „Positionen", „Footer"). Regeln können einer Gruppe zugewiesen oder ungruppiert gelassen werden. Zwei Basisgruppen, Head und Item, sind immer vorhanden; Sie können weitere hinzufügen.

Der Reiter arbeitet mit dem Standard-Mapping-Set der Schnittstelle. Die Kopfzeilenleiste zeigt den Namen des Sets, die aktuelle Revisionsnummer sowie die Regel- und Gruppenanzahl.

Regeln filtern:

Verwenden Sie das Dropdown Gruppenansicht über der Regeltabelle, um sich auf Folgendes zu konzentrieren:

Alle Regeln (Standard)
Ungruppierte Regeln (mit Anzahl)
Eine bestimmte Gruppe (zeigt die Reihenfolge, den Titel und die Regelanzahl)

Gruppen verwalten:

Klicken Sie auf Gruppen verwalten, um den Gruppen-Manager zu öffnen. Von dort aus können Sie:

Eine neue Gruppe hinzufügen (Titel, optionale Beschreibung, Reihenfolge)
Eine vorhandene Gruppe bearbeiten
Eine Nicht-Basisgruppe löschen (zugewiesene Regeln werden zu Ungruppiert verschoben)

Die Basisgruppen Head und Item können ausgewählt, aber nicht bearbeitet oder gelöscht werden.

Eine Regel hinzufügen oder bearbeiten:

Klicken Sie auf Regel hinzufügen oder klicken Sie auf eine beliebige Regelzeile, um die Regelleiste auf der rechten Seite zu öffnen. Regelfelder:

Regeltitel (erforderlich) und optionaler Regelschlüssel (eine stabile technische Kennung für Exporte oder nachgelagerte Systeme)
Gruppe: Einer Gruppe zuweisen oder Ungruppiert lassen
Quellfeld(er): Eine Zeile pro Quellbindung. Jede Zeile hat einen Pfad (z. B. origin.customerId) und einen optionalen Typ (string, number, date usw. oder einen beliebigen Freitext-Deskriptor). Verwenden Sie mehrere Zeilen, um 1:N- oder N:1-Mappings zu modellieren.
Zielfeld(er): Gleiche Struktur, eine Zeile pro Zielbindung
Operation: Direktes Kopieren, Transformieren, Lookup, Aufteilen, Zusammenführen, Filtern, Standardwert oder Andere (mit einer Freitext-Bezeichnung)
Gilt für Leg: Beschränken Sie die Regel auf einen bestimmten Leg (z. B. nur den EXTRACT-Leg) oder lassen Sie sie als Alle Legs
Reihenfolge: Anzeigereihenfolge innerhalb der Gruppe
Bedingung: Wann die Regel gilt
Geschäftsregel: Klare Erklärung der Geschäftslogik
Middleware- / Transformations-Notiz: Implementierungsnotizen für das Middleware- oder ETL-Team
Anmerkungen: Alles andere, was es wert ist, festgehalten zu werden

Die Mapping-Tabelle fasst jede Regel zusammen, indem sie die Quellbindungen, einen Pfeil und die Zielbindungen sowie die Operation, die Gruppe, zu der sie gehört, und den Leg-Bereich auflistet. Klicken Sie auf eine Zeile, um sie zu bearbeiten, oder verwenden Sie die Symbole der Zeile, um sie zu bearbeiten oder zu löschen.

Tipp: Behalten Sie eine Regel pro logischer Entscheidung anstatt einer Regel pro Feld. Eine Regel, die drei Quellfelder nimmt und ein verkettetes Zielfeld erzeugt, ist klarer als drei nahezu identische Zeilen -- und das Operationsfeld macht die Absicht explizit.

Verknüpfungen¶

Der Reiter Verknüpfungen sammelt die Verknüpfungen von dieser Schnittstelle zu anderen Dingen.

Schnittstellen-Abhängigkeiten: Vorgelagerte und nachgelagerte Schnittstellen. Verwenden Sie diese, um Reihenfolgen zu dokumentieren, wie „Order Sync muss vor Invoice Sync laufen".
Externe URLs: Links zur Dokumentation in Confluence, SharePoint usw. Fügen Sie eine Beschreibung und eine URL hinzu; das Symbol „In neuem Tab öffnen" führt Sie direkt zum Link.
Anhänge: Ziehen Sie Dateien per Drag-and-Drop in den Upload-Bereich oder verwenden Sie Dateien auswählen, um Spezifikationsdokumente direkt an die Schnittstelle anzuhängen. Klicken Sie auf einen Anhang-Chip, um ihn herunterzuladen; klicken Sie auf das Papierkorbsymbol, um ihn zu löschen (erfordert Manager-Rechte).

Ein Wissensdatenbank-Bereich ist für zukünftige entitätenübergreifende Wissensverknüpfungen reserviert; er zeigt derzeit einen informativen Platzhalter.

Schnittstellen kopieren¶

Es gibt zwei Möglichkeiten, Schnittstellen in KANAP zu kopieren.

Schnittstelle duplizieren (aus dem Schnittstellenraster)¶

Verwenden Sie dies, wenn Sie eine unabhängige Kopie einer Schnittstelle wünschen -- typischerweise um eine ähnliche Integration zwischen denselben oder anderen Anwendungen zu erstellen.

Wählen Sie eine Schnittstelle im Raster aus
Klicken Sie auf Schnittstelle duplizieren
Wählen Sie, ob Umgebungs-Bindungen kopiert werden sollen:
Ohne Bindungen: Eine saubere Kopie -- nur die Schnittstellendefinition, Legs, Verantwortliche und Metadaten
Mit Bindungen: Kopiert auch Umgebungs-Bindungen, löscht aber umgebungsspezifische Details (Endpunkte, Authentifizierung, Job-Namen), sodass Sie sie neu konfigurieren können

Was kopiert wird:

Daten	Kopiert
Schnittstellendefinition (Name, Apps, Routentyp)	Ja
Legs (Extract / Transform / Load / Direct)	Ja
Middleware-Anwendungen	Ja
Verantwortliche (Business und IT)	Ja
Betroffene Unternehmen	Ja
Abhängigkeiten	Ja
Schlüsselkennungen	Ja
Externe URL-Links	Ja
Datenhaltung	Ja
Bindungen	Optional
Mapping-Gruppen und -Regeln	Nein
Anhänge	Nein

Benennung: Die Kopie erhält „ - copy" sowohl an den Namen als auch an die Schnittstellen-ID angehängt.

Versionsmigration (aus der Anwendungsversionierung)¶

Verwenden Sie dies beim Upgrade einer Anwendung auf eine neue Version, wenn Sie Schnittstellen zur neuen Version migrieren müssen. Siehe Anwendungen > Versionsverwaltung für Details.

Wichtige Unterschiede zu Duplizieren:

Aspekt	Duplizieren	Versionsmigration
Zweck	Unabhängige Kopie erstellen	Zu neuer App-Version migrieren
App-Referenzen	Unverändert	Auf neue Version aktualisiert
Middleware-Referenzen	Unverändert	Aktualisiert, wenn App Middleware ist
Abhängigkeiten	Kopiert	Nicht kopiert
Bindungen	Optional (Instanzen unverändert)	Optional (Instanzen der neuen App zugeordnet)
Lebenszyklus	Erhalten	Auf Vorgeschlagen zurückgesetzt
Namenssuffix	„ - copy"	„ (new version)"

Tipps¶

Dokumentieren Sie das „Warum" zuerst: Verwenden Sie den Reiter Spezifikation und das Feld Geschäftlicher Zweck im Seitenpanel, um die Absicht zu erfassen, bevor Sie sich in Legs und Bindungen vertiefen.
Verwenden Sie das Seitenpanel von jedem Reiter aus: Verantwortliche, Kritikalität, Routentyp, PII-Flag und der Rest werden sofort gespeichert, sodass Sie sie aktualisieren können, während Sie Regeln oder Bindungen überprüfen.
Eine Schnittstelle, viele Umgebungen: Erstellen Sie keine separaten Schnittstellen für jede Umgebung -- verwenden Sie eine Schnittstelle und konfigurieren Sie jede Umgebung im Reiter Umgebungen.
Gruppieren Sie Ihre Mapping-Regeln: Bei Schnittstellen mit mehr als einer Handvoll Felder organisieren Sie die Regeln in Mapping-Gruppen (Header, Positionen, Footer usw.). Es macht Überprüfung und Auswirkungsanalyse weitaus einfacher.
Halten Sie Middleware explizit: Wenn Daten durch Middleware fließen, setzen Sie den Routentyp auf Via Middleware und wählen Sie die Middleware-Anwendungen aus. Die Schnittstellenkarte rendert dann den echten Datenpfad.
Duplizieren Sie für ähnliche Schnittstellen: Wenn Sie eine neue Schnittstelle erstellen, die einer vorhandenen ähnlich ist, verwenden Sie Schnittstelle duplizieren, um alle Einstellungen zu kopieren, und ändern Sie dann das, was anders ist. Schließen Sie optional Bindungen ein, um einen Vorsprung bei der Umgebungskonfiguration zu erhalten.
Verknüpfen Sie Bindungen mit Infra-Verbindungen: Verknüpfen Sie im Reiter Umgebungen jede Bindung mit ihrer zugrunde liegenden Infrastrukturverbindung, sodass Sie den vollständigen Pfad von der Geschäftsschnittstelle bis zur Netzwerkverbindung nachverfolgen können.