Your Training Partner
Techniken-Toolbox
Schnittstellenkarte: die Lohnsoftware eines Schweizer KMU im Zentrum, acht Gegenparteien darum herum (AHV-Ausgleichskasse, kantonale Steuerverwaltung, UVG-Unfallversicherer, Bundesamt für Statistik, Bank, HR-System, Mitarbeitende, Buchhaltung), ein Pfeil pro Schnittstelle mit Richtung, Format und Frequenz, mit einem einzigen eingehenden Pfeil.

Schnittstellenanalyse

Die Schnittstellenanalyse (interface analysis, BABOK 10.24) erfasst die Punkte, an denen eine Lösung Informationen mit ihrem Umfeld austauscht, und legt die Bedingungen jedes Austauschs fest. Das BABOK gibt dem Wort Schnittstelle eine weite Reichweite: eine Maske, die eine Mitarbeiterin bedient, eine Behörde, die eine obligatorische Meldung entgegennimmt, ein Geschäftsprozess, der an einen anderen übergibt, ein Datenfluss zwischen zwei Systemen, eine API und ein Gerät sind allesamt Schnittstellen im Sinne der Technik. Ihr Produkt ist ein Grenzvertrag: was hinübergeht, in welche Richtung, in welchem Format, in welcher Frequenz, in welchem Volumen, auf welchen Auslöser hin, nach welchen Validierungsregeln, mit welchem Verhalten im Fehlerfall und unter wessen Verantwortung auf jeder Seite. Eine Schnittstelle, die niemand identifiziert hat, ist eine Funktion, die niemand gebaut hat, und sie taucht bei der Integration auf, im teuersten Moment.

Zweck

Die Technik dient drei Entscheidungen, und sie kommen in dieser Reihenfolge. Sie sichert zuerst die funktionale Abdeckung: das BABOK macht daraus ihre erste Stärke, eine früh geführte Schnittstellenanalyse erhöht die Anforderungsabdeckung, denn jeder vergessene Austausch ist eine Funktion, die im Umfang und in der Schätzung fehlt. Sie ermöglicht dann die Zuordnung: sobald die Grenze spezifiziert ist, weiss man, welche Seite welche Regel trägt. Eine AHV-Nummer zu validieren ist die Arbeit von jemandem, und die Spezifikation ist der Ort, an dem dieser Jemand benannt wird. Sie lenkt schliesslich die Elizitation: die Liste der Schnittstellen benennt die Gegenparteien, also die Anspruchsgruppen, also die Personen, die für die weitere Anforderungsarbeit an einen Tisch gehören. In dieser Hinsicht gehört die Technik ebenso zur Elizitation wie zur Anforderungsanalyse.

Das Ergebnis ist zweiteilig. Der Schnittstellenkatalog ist das Inventar: eine Zeile pro Schnittstelle, mit Gegenpartei, Richtung, Typ, Format, Frequenz, Volumen und Verantwortlichem. Die Schnittstellenspezifikation ist der Vertrag: für jede Schnittstelle, die es verdient, die feldweise Definition der Nachricht, die Validierungsregeln, die Transformation, die Auslöser einschliesslich der Fehlerauslöser, das Fehlerverhalten, das Servicelevel, die Sicherheit und die geltende Version. Das Systems Engineering nennt dieses zweite Dokument ein Interface Control Document, und das Systems Engineering Handbook der NASA legt dessen Familie fest (Interface Requirements Document, Interface Control Document, Interface Description Document). Die Norm ISO/IEC/IEEE 29148:2018 führt die externen Schnittstellenanforderungen innerhalb der Systemanforderungsspezifikation. Auf einem Projekt nach HERMES, der Projektmanagementmethode des Bundes, ist dieses Inventar vorgeschrieben: Die Integrationsobjekte und Schnittstellen bilden eine der neun Rubriken des Integrationskonzepts, neben der Systemübersicht, den Integrationsumgebungen und Integrationsschritten, den Risiken und der Qualitätssicherung.

Anwendung

Wann einsetzen

  • Frisch gezogene Lösungsgrenze: jede Überschreitung der Umfangslinie ist eine Schnittstelle, die zu spezifizieren und zu bepreisen ist.
  • Standardsoftware oder SaaS in der Auswahl: die Schnittstellen zur bestehenden Applikationslandschaft tragen den Grossteil der Integrationskosten.
  • Ablösung eines Altsystems: seine Schnittstellen sind das Inventar dessen, was der Nachfolger weiterhin erfüllen muss.
  • Vom Standard vorgegebener Austausch: ELM, ISO 20022, eCH, der Vertrag kommt von aussen und die Arbeit besteht darin, ihn zu lesen.
  • Bepreisung einer Integration: Volumen und Frequenz je Schnittstelle machen aus einer Liste einen Betrag.
  • Planung der Elizitation: die Liste der Schnittstellen benennt die Gegenparteien, die an die Sitzung gehören.
  • Übergabe zwischen zwei Einheiten oder zwei Unternehmen: dort geht die Verantwortung verloren.
  • Zu belegender Änderungsantrag: die reale Nutzung und die Störungen der heutigen Schnittstellen sind bezifferte Belege.

Wann nicht einsetzen

  • Internes Verhalten einer Komponente: die Grenze des BABOK, auf die Geschäftsregelanalyse oder ein Datenmodell zurückgreifen.
  • Noch offener Umfang: die Überschreitungen einer nicht vereinbarten Linie zu spezifizieren ergibt einen Wegwerfkatalog, zuerst mit der Umfangsmodellierung rahmen (BABOK 10.41).
  • Reihenfolge der Nachrichten in Frage: das Sequenzdiagramm (BABOK 10.42) sagt, in welcher Reihenfolge, was die Spezifikation offen lässt.

Die sechs Schnittstellentypen

Das BABOK zählt sechs Typen auf, und diese Liste ist der Punkt, den Praktiker am häufigsten verfehlen, weil sie Schnittstelle hören und API denken. Benutzerschnittstellen sind die Masken, über die Personen der Organisation direkt mit der Lösung arbeiten. Lösungsexterne Personen sind die Anspruchsgruppen, die Regulatoren und die Behörden, die Informationen empfangen oder liefern: in der Schweiz sind eine AHV-Ausgleichskasse, eine kantonale Steuerverwaltung und ein Statistikamt, das eine obligatorische Erhebung einzieht, vollwertige Schnittstellen, mit Format, Termin und Ausfallmodus. Geschäftsprozesse bilden eine Schnittstelle, wenn ein Prozess Informationen an einen anderen übergibt, auch innerhalb desselben Unternehmens. Datenschnittstellen zwischen Systemen sind die klassischen Austausche, nächtlicher Stapellauf, Replikation, Nachrichtenwarteschlange. Programmierschnittstellen, die APIs, sind die veröffentlichte Schnittstelle einer aufrufbaren Komponente. Geräte sind die Hardwareschnittstellen, Badgeleser, Zahlungsterminal, Werkstattsensor.

Diese Reichweite verankert die Technik in der Business Analyse, und das BABOK leitet daraus eine Stärke ab: ihre breite Anwendung erspart ihr die Überanalyse des Feindetails. Die beiden Typen, die niemand katalogisiert, sind die öffentliche Behörde und die Übergabe zwischen Prozessen. Der Integrationsarchitekt wird sie nicht finden, weil sie in keiner technischen Konfiguration erscheinen.

HERMES behandelt die Schnittstellen zwischen einer temporären Projektorganisation und der Stammorganisation, die sie aufnimmt: Die Methode garantiert die Kompatibilität dieser standardisierten Schnittstellen, zum Beispiel des Reportings. Sie nennt die drei Rollen, die für das Funktionieren der Schnittstellen unentbehrlich sind: den Auftraggeber, den Projektleiter und den Anwendervertreter. Was diese Grenze überquert, ist benannt: Projektstatusbericht, Phasenbericht, Releasebericht. Diese Übergabe gehört zum Typ Geschäftsprozess und wird wie die anderen katalogisiert, mit Sender, Empfänger, Frequenz, Inhalt und Termin.

Die materielle Schnittstelle

Ein Gerät tauscht Materie und Energie ebenso aus wie Nachrichten, und seine Spezifikation trägt Rubriken, die kein Dateiaustausch kennt. Die Form steht am Anfang: die Geometrie, der Platzbedarf, der Steckverbinder, die Befestigung, die Einbaurichtung, alles, was darüber entscheidet, ob die beiden Teile zusammenpassen. Die Betriebsfestigkeit ist die nichtfunktionale Anforderung der physischen Welt: der Temperaturbereich, die mechanische Beständigkeit gegen Stoss und Vibration, die chemische Beständigkeit gegen Reinigungsmittel, die Dichtheit gegen Staub und Wasser. Das Medium qualifiziert, was die Grenze physisch überschreitet: ein Gas, eine Flüssigkeit, ein Werkstück, bei welchem Druck und welchem Durchfluss. Die Energie ist eine Eingabe für sich: die Spannung, der Strom, die Leistung, die Erdung und die Frage, welche der beiden Seiten die andere speist.

Die Kommunikation entfaltet sich danach in drei Stockwerke, die regelmässig verwechselt werden. Die Übertragungsstrecke und die Codierung: die verdrillte Zweidrahtleitung, die 4-20-mA-Stromschleife, der Feldbus und die Art, wie die Bits auf dem Signal getragen werden, eine NRZ-Codierung, eine Manchester-Codierung. Das Protokoll: der Rahmen, die Adressierung, die Fehlerprüfung, der Takt der Austausche, Modbus RTU, CAN, OPC UA. Die Semantik: was der Wert bedeutet. Ein Temperatursensor in einem Pasteurisierungsbehälter liefert die ganze Zahl 3820 in einem Modbus-Register, das Protokoll ist eingehalten und spezifiziert ist noch nichts, denn 3820 sind 38,2 °C bei einem Skalierungsfaktor von 0,01 und einer Ablesung in Grad Celsius, und unter einer anderen Konvention sind es ganz andere Werte. Ein eingehaltenes Protokoll und eine unterstellte Semantik ergeben einen richtigen Wert, der falsch gelesen wird. Die Spezifikation ist der Ort, an dem die Einheit, der Skalierungsfaktor, der gültige Bereich und der vereinbarte Wert für einen gestörten Sensor aufgeschrieben werden.

Die Schnittstellen identifizieren

Die Vorbereitung besteht darin, das bereits Vorhandene zusammenzutragen. Das BABOK nennt die Dokumentenanalyse, die Beobachtung, die Interviews, die Umfangsmodellierung und vor allem das Kontextdiagramm, das die Schnittstellen auf hoher Flughöhe zwischen menschlichen Akteuren, Organisationseinheiten, Geschäftsprozessen und Lösungskomponenten sichtbar macht. In einer bestehenden Applikationslandschaft findet sich das verlässlichste Material im laufenden System: der Integrationscode, die Stapelverarbeitungspläne, die Themen des Nachrichtenbusses, die Firewallregeln und die Ablageverzeichnisse sind die Schnittstellen, die die Dokumentation vergessen hat. Das BABOK vermerkt einen zweiten, oft übersehenen Nutzen dieser Arbeit: sie legt die reale Nutzungsfrequenz der bestehenden Schnittstellen und deren Mängel offen, Material, das den Änderungsantrag stärkt.

Die Identifikation selbst geht jede Anspruchsgruppe und jedes System durch, das mit der Lösung interagiert, und listet die Schnittstellen auf, die der künftige Zustand braucht. Die Beziehung zwischen einer Anspruchsgruppe und ihren Schnittstellen kann viele zu viele sein, in manchen Fällen eins zu eins. Das BABOK besteht auf den nicht offensichtlichen Schnittstellen, jenen, die einer regulatorischen Funktion, einer Revision oder der Schulung der Mitarbeitenden dienen. Für jede vier Fragen: ihre Funktion beschreiben, ihre Nutzungsfrequenz beurteilen, den passenden Schnittstellentyp bestimmen und die ersten Details erheben.

Sechs Fragen strukturieren das Ganze, und das BABOK stellt sie genau so: wer die Schnittstelle nutzen wird, was hinübergeht und in welchem Volumen, wann und in welcher Frequenz, wo der Austausch stattfindet, warum die Schnittstelle besteht, wie sie umgesetzt ist oder umgesetzt werden soll. Das Produkt dieses Schritts ist eine Schnittstellenkarte, die Lösung im Zentrum, ihre Gegenparteien darum herum, ein beschrifteter Pfeil pro Schnittstelle.

Eine Schnittstelle spezifizieren

Das BABOK gibt fünf Definitionselemente: den Namen der Schnittstelle, ihren Geltungsbereich, die Austauschmethode zwischen den beiden Einheiten, das Nachrichtenformat und die Austauschfrequenz. Es fügt die Eingaben und Ausgaben hinzu, die Validierungsregeln, die sie beherrschen, und die auslösenden Ereignisse, mit dem Hinweis, dass diese Ereignisse den Normalfluss, die Alternativflüsse und die Ausfälle abdecken. Genau diese letzte Erwähnung wird vergessen. Sie ist das Scharnier zwischen einer Liste und einem Vertrag.

Die Vorlage wird Rubrik für Rubrik gefüllt, und jede Rubrik beantwortet eine Frage, die leer gelassen zu einer Störung wird.

RubrikDie Frage, die sie entscheidet
Jede Schnittstelle
Parteien und RichtungWer sendet, wer empfängt und verläuft der Austausch einseitig, als Anfrage und Antwort oder bidirektional?
AuslöserWas löst den Austausch aus: eine Uhr, ein Geschäftsereignis, eine Anforderung? Die Alternativflüsse und die Ausfälle haben ebenfalls einen.
Ausgetauschte DatenWelche Felder, welchen Typs, obligatorisch oder fakultativ, mit welchen Codelisten? An dieser Stelle übergibt die Spezifikation an das Datenwörterbuch (BABOK 10.12): die Schnittstelle benennt die Nachricht, das Wörterbuch definiert jedes ihrer Felder.
Methode und FormatÜber welchen Kanal und in welcher Form: XML über einen Webservice, JSON über REST, signierte Datei per SFTP abgelegt, ISO-20022-Nachricht pain.001, auf Papier gedruckter Strichcode.
Frequenz und VolumenWie viele Nachrichten, an der Spitze? Die Mengengerüste machen aus einer Schnittstelle einen Kostenblock und eine nichtfunktionale Anforderung.
ValidierungsregelnWas weist der Empfänger zurück und nach welchem Kriterium? In der Schweiz ist es oft ein vorgegebenes Format, dessen Prüfziffer sich ohne einen Anruf verifizieren lässt, etwa die dreizehnstellige AHV-Nummer, 756.XXXX.XXXX.XX.
TransformationWelche Seite ordnet die beiden Darstellungen einander zu, und was geschieht mit einem Wert, den die Codeliste des Ziels nicht ausdrücken kann: Zurückweisung, Vorgabewert oder stiller Verlust? Der dritte Fall ist der häufigste und der einzige, der keinen Fehler auslöst.
FehlerverhaltenFehlerhafte Nachricht, nicht verfügbarer Empfänger, zur Hälfte verarbeiteter Stapel: gibt es eine negative Empfangsbestätigung, ist ein erneuter Versand idempotent, wer wird benachrichtigt und innerhalb welcher Frist? Über HTTP gibt RFC 9457 das kanonische Format vor.
VerantwortungWer kann, namentlich und auf jeder Seite, eine Änderung verbindlich zusagen?
ServicevereinbarungWelche Verfügbarkeit, welche Latenz, welcher Durchsatz, welche Aufbewahrung und ab welcher Verspätung wird eine Datei zu einem Compliance-Problem?
Sicherheit und DatenschutzWas geht hinüber? AHV-Nummern und Löhne sind Personendaten im Sinne des revDSG, eine Eigenschaft der Schnittstelle.
VersionWelche Vertragsversion gilt, über welchen Kanal wird eine Änderung angekündigt und wie lange bleibt die alte Version parallel akzeptiert?
Zusätzlich, für eine menschliche Schnittstelle
Rollen und BerechtigungenWer sieht welche Daten, wer darf sie ändern, wer darf sie nur einsehen und über welchen Mechanismus wird dieses Recht erteilt und wieder entzogen?
Benutzerarbeitsfluss zwischen den SystemenWas trägt die Person von Hand, die ein System mitten in einer Aufgabe verlässt, um sie in einem anderen zu beenden? Dieser manuelle Weg ist der Teil der Schnittstelle, den niemand spezifiziert.
ManagementzieleWelche Messgrösse sagt, dass die Schnittstelle funktioniert: eine Bearbeitungsfrist, eine Erfassungsfehlerquote, eine Supportlast?
Usability und AccessibilityWelche Richtlinien der Organisation binden das Design, als Eingangsanforderungen?
Zusätzlich, für eine materielle Schnittstelle
Form und MontageWelche Geometrie, welcher Platzbedarf, welcher Steckverbinder, welche Befestigung, in welcher Einbaurichtung?
BetriebsfestigkeitWelcher Temperaturbereich, welche mechanische und chemische Beständigkeit, welche Dichtheit?
Medium und EnergieWelches Gas, welche Flüssigkeit, bei welchem Druck und welchem Durchfluss? Welche Spannung, welcher Strom und welche Seite speist die andere?
Übertragungsstrecke, Codierung und ProtokollWelche physische Verbindung, welche Signalcodierung (NRZ, Manchester), welcher Rahmen und welches Protokoll (Modbus RTU, CAN, OPC UA)?
Semantik des SignalsWas bedeutet der Wert: welche Einheit, welcher Skalierungsfaktor, welcher gültige Bereich und welcher vereinbarte Wert für einen gestörten Sensor?

Das BABOK ist beim Zeitpunkt menschlicher Schnittstellen ausdrücklich: sie verlangen eine detaillierte Analyse im Vorfeld, weil dort die grossen Designmängel entschieden werden und weil sie danach sehr teuer zurückzunehmen sind. Ein Katalog, dessen Vorlage nur die gemeinsamen Rubriken füllen kann, typisiert seine Masken als Benutzerschnittstellen und lässt sie dann leer.

Der letzte Schritt ist, den Katalog mit den Verantwortlichen an beiden Enden zu validieren. Eine nur auf einer Seite unterzeichnete Schnittstellenspezifikation bleibt ein Wunsch.

Die Grenze zu den benachbarten Techniken

Das Datenflussdiagramm (BABOK 10.13) zeigt die Daten, die durch Prozesse fliessen: woher sie kommen, was sie transformiert, wo sie ruhen, wo sie ankommen. Die Schnittstellenanalyse spezifiziert den Vertrag an einer Grenze zwischen zwei Systemen oder zwei Organisationen. Das Kontextdiagramm zählt die Überschreitungen auf, die Schnittstellenanalyse spezifiziert jede einzelne und die Übergabe steht ausdrücklich im BABOK, das das Kontextdiagramm unter die Eingaben der Vorbereitung stellt. Zwei Asymmetrien trennen die beiden Techniken endgültig: die Schnittstellenanalyse deckt auch Benutzerschnittstellen, Behörden und Geräte ab, die ein Datenflussdiagramm als blosse externe Entitäten behandelt; und ein Datenflussdiagramm sagt nichts über Frequenz, Volumen, Fehlerverhalten, Verantwortung oder Servicelevel, die die ganze Substanz einer Schnittstellenspezifikation ausmachen.

Die Umfangsmodellierung (BABOK 10.41) zieht die Linie und stellt die Elemente hinein oder hinaus. Die Schnittstellenanalyse spezifiziert jede Überschreitung, sobald die Linie gezogen ist. Die Abhängigkeit läuft in eine Richtung, und die Analyse zu starten, bevor der Umfang vereinbart ist, ergibt einen Katalog, der weggeworfen wird.

Das Sequenzdiagramm (BABOK 10.42) modelliert die Logik eines Nutzungsszenarios, indem es die zwischen Objekten ausgetauschten Informationen mit Lebenslinien und geordneten Nachrichten zeigt. Der Unterschied ist zeitlicher Natur: das Sequenzdiagramm zeigt die Reihenfolge der Nachrichten in einem Szenario, die Schnittstellenspezifikation zeigt die dauerhaften Bedingungen einer Schnittstelle, unabhängig von jedem Szenario. Beide fügen sich zusammen: sobald die Schnittstelle als Anfrage und Antwort mit negativer Bestätigung spezifiziert ist, ist das Sequenzdiagramm das Mittel, um die Choreografie eines fehlgeschlagenen Aufrufs und seiner Wiederholung zu zeigen.

Die Schnittstelle als Datenquelle

Der Guide to Business Data Analytics der IIBA (§3.13) dreht die Technik um: eine Schnittstelle erzeugt selbst auswertbare Daten. Neben dem, was die Benutzerin eingibt, zeichnet das System auf, was sie tut, und diese Transaktionsdaten beantworten Fragen, die die Eingabe nicht abdeckt. Welche Funktionen tatsächlich genutzt werden. Warum ein Antrag unvollendet bleibt. Wie lange ein Vorgang von Anfang bis Ende dauert. Wo sich Anmeldefehler oder Ladezeiten häufen.

Der Leitfaden zieht eine zweite Folgerung für die Spezifikation: jedes Schnittstellenelement entspricht einem Datenbankattribut, und diese Zuordnung aufzuschreiben legt die impliziten Aufbewahrungsregeln offen. Überschreibt eine Profiländerung den Datensatz, oder legt sie einen neuen an, den die jüngste Kennung bezeichnet? Beides sieht am Bildschirm gleich aus und verhält sich in einem Bericht unterschiedlich. Die dokumentierte Zuordnung ist das, was die Extraktions- und Ladeläufe anschliessend aufgreifen.

Die Fallstricke

Die Schnittstelle, die niemandem gehört

Jede Seite nimmt an, die andere validiere, wiederhole oder überwache. Der Mangel zeigt sich erst im Betrieb, und seine Behebung ist organisatorisch. Die Katalogspalte, die ihn verhindert, ist ein benannter Verantwortlicher auf jeder Seite: der Name einer Person und ihre Rolle. Wenn die Gegenpartei ein Lieferant ohne benannte Ansprechperson ist, ist der Ausweg die vertragliche Eskalation.

Das undokumentierte Feld, das Bedeutung trägt

Ein freies Referenzfeld, in das vor Jahren jemand begonnen hat, einen Code zu schreiben, von dem heute eine nachgelagerte Verarbeitung abhängt. Er steht in keinem Schema und in keinem Wörterbuch, und er bricht an dem Tag, an dem das Feld bereinigt wird. Schnittstellen sammeln diese blinden Passagiere an. Das ist der Grund, Feld für Feld zu spezifizieren.

Der Stapel, der stillschweigend Datensätze verliert

Der Empfänger lädt die Datei Datensatz für Datensatz und verwirft jene, die er nicht lesen kann. Bei einem Stapel von 4'812 Datensätzen werden 4'796 geladen und 16 verworfen, kein Fehler erreicht den Sender, niemand zählt nach. Die Antwort der Spezifikation ist ein Abstimmungsvertrag: der Sender meldet die gesendete Anzahl, der Empfänger bestätigt die geladene Anzahl, eine Abweichung ist eine Störung. Eine Schnittstelle ohne Empfangsbestätigung überlässt ihr Fehlerverhalten der Hoffnung.

Das angenommene Fehlerverhalten der anderen Seite

Mit dem Abstimmungsvertrag meldet der Empfänger nun seine 16 Zurückweisungen, und der Mangel verschiebt sich um eine Stufe. Die Wiederholung des Senders wurde in der Annahme gebaut, der Empfänger weise die ganze Datei zurück, sobald ein Datensatz fehlerhaft ist: sie sendet daher nach der Korrektur die ganze Datei erneut und dupliziert die 4'796 bereits geladenen Datensätze. Der Empfänger nimmt Datensatz für Datensatz an, der Sender nahm das Gegenteil an und keines der beiden Verhalten wurde je aufgeschrieben. Die Zurückweisung der ganzen Datei oder die teilweise Annahme ist eine Entscheidung, und die Wirkung eines erneuten Versands, Ersetzen oder Doppel, ist eine weitere: beide gehören in die Spezifikation.

Das leer gelassene Mengengerüst

Die Schnittstelle ist identifiziert, benannt, typisiert, und niemand hat nach dem Wie viel gefragt. Die Dimensionierung, die Servicevereinbarung und die Schätzung ruhen dann auf einer Ahnung.

Das Abdriften des Vertrags

Die andere Seite ändert den Vertrag, und man merkt es an einer Zurückweisung. Das Schweizer Beispiel ist datiert und öffentlich: die Umsetzungsrichtlinien der QR-Rechnung sind am 21. November 2025 auf Version 2.3 übergegangen, die strukturierte Adressen im Swiss QR Code verlangt und die kombinierte Form nicht mehr zulässt, wobei Version 2.4 am 14. November 2026 in Kraft tritt. Jedes Fakturierungssystem, das die Adresse als freien Text behandelte, hatte eine von aussen auferlegte Schnittstellenänderung zu einem bekannten Termin zu verkraften. Eine Spezifikation ohne Version und ohne Ankündigungskanal ist eine Momentaufnahme.

Das spezifizierte Format, die angenommene Bedeutung

Zwei Systeme einigen sich darauf, dass ein Feld eine dreizehnstellige Ziffernfolge ist, und gehen darüber auseinander, was es identifiziert. Die Einigung über das Format lässt die semantische Einigung offen, und diese lebt in den Codelisten, in der Zuordnungstabelle der Transformation und in den Definitionen des Datenwörterbuchs.

Der auf technische Schnittstellen verkürzte Katalog

Die sechs Typen des BABOK umfassen die Benutzerschnittstellen, die lösungsexternen Personen einschliesslich der öffentlichen Behörden und die Geschäftsprozesse. Die regulatorische Meldung und die Übergabe zwischen zwei Abteilungen haben ein Format, einen Termin und einen Ausfallmodus, genau wie ein Webservice.

KI-Betrachtungen

Der beste Einsatz ist die Ableitung eines Kandidatenkatalogs aus dem, was tatsächlich läuft. Ein Modell auf OpenAPI-, WSDL- oder XSD-Schemata richten, auf den Integrationscode, auf die Definitionen der ETL-Verarbeitungen, auf die Konfiguration des Nachrichtenbusses und auf die Firewallregeln; danach lässt man es einen ersten Wurf in die festgelegten Spalten extrahieren. In einer Altlandschaft, die seit zehn Jahren niemand dokumentiert hat, ersetzt das die leere Seite durch einen Entwurf, den es zu widerlegen gilt, und die Widerlegung führt man gegen das laufende System.

Zwei weitere Einsätze sind solide. Der Schemavergleich und die Wirkungsanalyse: zwei Versionen eines XSD oder eines OpenAPI-Dokuments und die Frage, welche der tatsächlich genutzten Felder sich geändert haben. Die Aufgabe ist mechanisch, vollständig und jene Wachsamkeit, die die menschliche Durchsicht beim vierhundertsten Element verliert; sie verwandelt eine Release Note des Lieferanten in eine Arbeitsliste. Die Erzeugung von Beispielnachrichten und negativen Testfällen aus einem Schema: fehlerhafte Nachricht, Randwert, fehlendes Pflichtfeld, Code ausserhalb der Liste. Die Fehlerpfade sind der am wenigsten getestete und am meisten spezifizierte Teil einer Schnittstelle, und sie aus dem Vertrag zu erzeugen kostet wenig. Die Matrix des Fehlerverhaltens lässt sich ebenso aus den Statuscodes und dem Fehlermodell vorredigieren, die eine API deklariert.

Drei Grenzen liegen im Urteil und im Recht. Mengengerüst, Frequenz, Verantwortung und Servicelevel stehen in keinem Schema: sie sind Eigenschaften der Organisation, sodass ein befragtes Modell eine plausible Zahl produziert. Ein erfundenes Volumen ist schlimmer als eine leere Zelle, weil man darauf dimensioniert. Die Semantik einer Codeliste kommt von den beiden Verantwortlichen: ein Modell wird sagen, dass ein Feld elf Werte aufzählt, nur das Fachgebiet wird sagen, welche noch gebraucht werden, welcher systematisch falsch verwendet wird und worauf sich jeder in der Liste des Ziels abbildet. Der Datenschutz schliesslich: eine ELM-Nachricht trägt AHV-Nummern, Löhne und die UID des Arbeitgebers, also Personendaten im Sinne des revDSG. Die Arbeit erfolgt am Schema und an synthetischen Nutzdaten. Ein Produktionsauszug, der in ein Allzweckmodell kopiert wird, ist ausgeschlossen.

Beispiele

Die gewählte Landschaft ist die der Lohnschnittstellen eines Schweizer KMU mit 120 Mitarbeitenden, rund um die Lohnsoftware. Von diesen 120 Mitarbeitenden sind 34 quellenbesteuert (B-Bewilligung und Grenzgänger), und die Buchhaltung verteilt die Lohnsumme auf vier Kostenstellen: diese beiden Zahlen sind zusammen mit dem Personalbestand die einzigen Eingaben, von denen sämtliche Volumen des Katalogs abhängen. Die Landschaft trägt acht Schnittstellen, fünf der sechs Typen des BABOK, fünf Formate und vier Rhythmen (ereignisgesteuert, monatlich, jährlich, alle zwei Jahre), und sie lässt die öffentliche Behörde und die Übergabe zwischen Prozessen als gewöhnliche Gegenparteien erscheinen.

Schnittstellenkarte eines Schweizer KMU: die Lohnsoftware im ZentrumAcht Schnittstellen rund um die Lohnsoftware eines Schweizer KMU. Oben, gruppiert unter einer orangen Klammer mit der Bezeichnung lösungsexterne Personen: AHV-Ausgleichskasse (IF-01, ausgehend, XML Lohnstandard-CH, einmal pro Jahr), kantonale Steuerverwaltung (IF-02, ausgehend, XML Lohnstandard-CH, zwölfmal pro Jahr), UVG-Unfallversicherer (IF-03, ausgehend, XML Lohnstandard-CH, einmal pro Jahr), Bundesamt für Statistik (IF-04, ausgehend, XML Lohnstandard-CH, einmal alle zwei Jahre). Unten, vier strukturelle Gegenparteien in Blau: Bank (IF-05, ausgehend, ISO 20022 pain.001, dreizehnmal pro Jahr), HR-System (IF-06, eingehend, der einzige eingehende Pfeil, JSON/REST, ereignisgesteuert), Mitarbeitende (IF-07, ausgehend, PDF, einmal pro Jahr), Buchhaltung (IF-08, ausgehend, CSV, zwölfmal pro Jahr).Lösungsexterne PersonenAHV-AusgleichskasseKantonaleSteuerverwaltungUVG-UnfallversichererBundesamt fürStatistikBankHR-SystemMitarbeitendeBuchhaltungLohnsoftwareIF-01XML Lohnstandard-CH· 1×/JahrIF-02XML Lohnstandard-CH· 12×/JahrIF-03XML Lohnstandard-CH· 1×/JahrIF-04XML Lohnstandard-CH· 1× / 2 JahreIF-05ISO 20022 pain.001· 13×/JahrIF-06JSON/REST· ereignisgesteuertIF-07PDF· 1×/JahrIF-08CSV· 12×/Jahr
Schnittstellenkarte der Lohnsoftware eines Schweizer KMU. Acht Schnittstellen, vier externe Gegenparteien, davon drei öffentliche Behörden, ein einziger eingehender Fluss.

Die Karte trägt den Vertrag jedes Flusses in drei Zeichen: die Richtung, das Format, den Rhythmus. Der Katalog faltet dieselben acht Schnittstellen in Spalten auf und ergänzt, was die Karte nicht tragen kann, das Volumen und den Verantwortlichen an jedem Ende.

IdSchnittstelleRichtungGegenparteiTyp (BABOK)Methode und FormatAuslöser und FrequenzVolumen (Spitze)Verantwortliche (Sender / Empfänger)
IF-01ELM-LohnmeldungausgehendAHV-AusgleichskasseLösungsexterne Person (Behörde)XML Lohnstandard-CH, Webservice (PIV-Verfahren)Jahresabschluss der Löhne, 1 Übermittlung pro Jahr120 Datensätze, einer pro MitarbeitendenLohnverantwortliche / technische Ansprechperson der Kasse
IF-02QuellensteuerabrechnungausgehendKantonale SteuerverwaltungLösungsexterne Person (Behörde)XML Lohnstandard-CHFreigabe der Monatsabrechnung, 12 Übermittlungen pro Jahr34 Datensätze, die 34 quellenbesteuerten Mitarbeitenden von 120Lohnverantwortliche / kantonale Quellensteuerstelle
IF-03UVG-LohnsummenmeldungausgehendUnfallversichererLösungsexterne Person (Versicherer)XML Lohnstandard-CHJahresabschluss, 1 Übermittlung pro Jahr120 DatensätzeLohnverantwortliche / Policenbetreuung
IF-04Schweizerische Lohnstrukturerhebung (LSE)ausgehendBundesamt für StatistikLösungsexterne Person (Behörde)XML Lohnstandard-CHBundeserhebung, 1 Übermittlung alle zwei Jahre120 DatensätzeLohnverantwortliche / Erhebungsstelle
IF-05LohnzahlungsauftragausgehendBankDaten zwischen SystemenISO 20022 pain.001, E-Banking-ÜbermittlungLohnfreigabe, 13 Läufe pro Jahr: der 13. Monatslohn geht im Dezember als separater Lauf hinaus120 Transaktionen pro Lauf; Spitze von 240 Transaktionen im Dezember, der zwei Läufe trägtLohnverantwortliche / E-Banking-Support der Bank
IF-06PersonaldateneingehendHR-SystemAPIJSON über REST, synchroner AufrufEreignisgesteuert (Eintritt, Mutation, Austritt), rund 8 pro Monat1 Datensatz pro EreignisHR-Verantwortliche / Lohnverantwortliche
IF-07LohnausweisausgehendMitarbeitendeBenutzerschnittstellePDF, MitarbeitendenportalNach Jahresabschluss, 1 pro Mitarbeitenden120 DokumenteLohnverantwortliche / Mitarbeitende
IF-08LohnbuchungausgehendBuchhaltung (der Buchhaltungsprozess)GeschäftsprozessCSV-Datei mit Sammelbuchungen, Ablage in einem gemeinsamen VerzeichnisLohnfreigabe, 12 Übermittlungen pro Jahr: der 13. Monatslohn wird in der Dezemberperiode verbucht4 Sammelbuchungen pro Übermittlung, eine pro KostenstelleLohnverantwortliche / Buchhalterin
Schnittstellenkatalog der Lohnsoftware eines Schweizer KMU. Vier der acht Gegenparteien sind im Sinne des BABOK lösungsexterne Personen, drei davon öffentliche Behörden, und die Rhythmen reichen von ereignisgesteuert bis zu einer Erhebung alle zwei Jahre. Dieselbe Lohnfreigabe löst IF-05 dreizehnmal pro Jahr und IF-08 zwölfmal aus: der Rhythmus ist eine Eigenschaft der Schnittstelle, die Schnittstelle für Schnittstelle zu ermitteln ist.

Der Katalog hört dort auf, wo der Vertrag beginnt. Die Spezifikation entfaltet eine einzige Zeile, IF-01, und die Rubriken, die sie vom Katalog unterscheiden, sind am mühsamsten zu füllen: das Fehlerverhalten, der Verantwortliche, der seine Seite verbindlich zusagen kann, die Servicevereinbarung und die Version.

RubrikIF-01, ELM-Lohnmeldung
GeltungsbereichJährliche Lohnsumme aller AHV-pflichtigen Mitarbeitenden, für ein Geschäftsjahr.
Parteien und RichtungLohnsoftware (Sender) an die AHV-Ausgleichskasse (Empfänger). Ausgehend, mit Antwort: Empfangsbestätigung und Verarbeitungsbericht.
AustauschmethodeWebservice, PIV-Verfahren des Swissdec-Standards. Vorgesehener Rückfall: EIV-Verfahren (Datei exportieren, manuell im Portal des Empfängers einreichen), wenn der Webservice am Termin nicht verfügbar ist.
NachrichtenformatXML gemäss der Meldung Lohnstandard-CH. Die Software ist Swissdec-zertifiziert für die zum Zeitpunkt der Übermittlung geltende Version des Standards.
SchlüsselfelderAHV-Nummer der Mitarbeitenden, 13 Ziffern, 756.XXXX.XXXX.XX. UID der Arbeitgeberin, CHE-NNN.NNN.NNN. Abrechnungsperiode, beitragspflichtige Beträge nach Beitragskategorie.
ValidierungsregelnPrüfziffer der AHV-Nummer und der UID vor der Übermittlung verifiziert. Die AHV-Nummer wird nicht erzeugt: sie wird von der Zentralen Ausgleichsstelle vergeben, und Mitarbeitende ohne Nummer blockieren die Zeile.
Transformation und ZuordnungDie Lohnarten der Software werden den Rubriken des Standards zugeordnet, auf der Senderseite, vor der Übermittlung. Vom Projekt entschieden: eine interne Lohnart ohne Entsprechung im Standard blockiert die Übermittlung und geht an die Lohnverantwortliche.
AuslöserJahresabschluss der Löhne. Sekundärer Auslöser: erneute Übermittlung eines korrigierten Datensatzes nach einer Zurückweisung.
Frequenz und Volumen1 Übermittlung pro Jahr, 120 Datensätze, einer pro Mitarbeitenden. Keine Spitze.
FehlerverhaltenVom Standard vorgegeben und in den Unterlagen von Swissdec nachzulesen: die Granularität der Zurückweisung, der Inhalt des von der Kasse zurückgegebenen Verarbeitungsberichts und die Wirkung einer erneuten Übermittlung nach Korrektur (Ersetzen des Datensatzes oder Doppel). Die Spezifikation schreibt sie ab. Vom Projekt entschieden: der Abstimmungsvertrag, der Sender gleicht die Anzahl gesendeter Datensätze mit der bestätigten Anzahl ab und behandelt jede Abweichung als Störung; und die Eskalation, eine nach 5 Arbeitstagen unbehandelte Zurückweisung geht an die Lohnverantwortliche.
VerantwortlicheSender: die Lohnverantwortliche, namentlich. Empfänger: die im Anschlussvertrag mit der Kasse benannte technische Ansprechperson. Beide können auf ihrer Seite eine Änderung verbindlich zusagen.
ServicevereinbarungVom Gesetz vorgegeben: die Meldung ist auf ein festes Datum geschuldet, und eine Überschreitung ist ein Compliance-Problem mit regulatorischen Folgen. Vom Projekt entschieden: die Übermittlung wird spätestens fünf Arbeitstage vor dem Termin vorbereitet und kontrolliert.
Sicherheit und DatenschutzDie Nachricht trägt AHV-Nummern und Löhne, also Personendaten im Sinne des revDSG. Verschlüsselter Transport, Zugriff beschränkt auf die beiden benannten Rollen, kein Produktionsauszug ausserhalb des Perimeters.
Version und ÄnderungDie Version des Standards, für die die Software zertifiziert ist. Ankündigungskanal: die Publikationen von Swissdec. Bei jedem Versionswechsel festzustellen: wie lange die alte Version parallel akzeptiert bleibt.
Spezifikation der Schnittstelle IF-01, eine Katalogzeile entfaltet. Die vier fett gesetzten Rubriken machen aus dem Inventar einen Vertrag: das Fehlerverhalten, der Verantwortliche, der seine Seite verbindlich zusagen kann, die Servicevereinbarung und die Version. Der Katalog trägt nur eine davon, den Verantwortlichen, und zwar als Rolle. Jede der vier trennt, was der Standard vorgibt und gelesen wird, von dem, was das Projekt entscheidet und schreibt.

Aufwand

PhaseNiveauBegründung
VorbereitungMittelDas vorhandene Material zusammenzutragen (Kontextdiagramm, Integrationsinventar, Belege aus dem laufenden System) ist begrenzt. Auf der anderen Seite eine Person zu finden, die ihren Teil verbindlich zusagen kann, kostet die eigentliche Zeit.
DurchführungMittelDie Identifikation geht schnell und passt in eine Sitzung, sofern ein Kontextdiagramm besteht. Die Charakterisierung jeder Schnittstelle (Volumen, Transformation, Fehlerverhalten, Servicelevel, Verantwortliche) hängt von der Gegenpartei ab, und die Dauer der Technik folgt deren Verfügbarkeit.
DokumentationHochDie Spezifikation ist der Vertrag: sie wird versioniert und bei jeder Änderung auf der einen oder anderen Seite nachgeführt. Dieser Posten entscheidet, ob die Technik auf Dauer trägt, und er wird als Erster aufgegeben. Eine Spezifikation, die von der realen Schnittstelle abgedriftet ist, richtet Schaden an, weil man ihr vertraut.

Werkzeuge

Die Tabellenkalkulation oder die Wiki-Tabelle ist das ehrliche Zuhause des Katalogs, solange die Landschaft klein ist, wo die meisten realen Kataloge leben. Die Werkzeuge des Anforderungsmanagements (Jama, Polarion, DOORS) übernehmen, sobald die Spezifikation vertraglichen Wert hat und die Schnittstellen bis zu den Anforderungen und den Tests verfolgt werden müssen.

Die Vertragsformate sind die Spezifikation in maschinenlesbarer Form, und sie zu übernehmen ist das einzig bekannte Mittel, damit die Spezifikation nicht von der Umsetzung abdriftet: OpenAPI für REST-APIs über HTTP, AsyncAPI für ereignis- und nachrichtenbasierte Austausche, WSDL und XSD für SOAP, das im PIV-Verfahren von Swissdec zum Einsatz kommt, und JSON Schema für die Validierung der Nutzdaten. Vertragstests (Pact) und API-Clients (Postman, SoapUI) machen die Spezifikation ausführbar: die Integrationsstrecke erkennt das Abdriften dann vor der Inbetriebnahme. API-Gateways und Entwicklerportale sind der Ort, an dem der Katalog und der Vertrag auf der Konsumentenseite veröffentlicht werden.

Für die Karte genügt ein Modellierungswerkzeug: eine Sicht der Anwendungskooperation in ArchiMate oder ein C4-Containerdiagramm liegen auf der Flughöhe der Schnittstellenkarte. Bleibt die Dokumentation der Standards selbst, die für eine Schweizer Schnittstelle oft die Spezifikation ist, die man nicht schreiben darf: Swissdec für ELM, SIX für die Swiss Payment Standards, die IBAN und die QR-Rechnung, eCH für die Austausche des E-Government, das Forum Datenaustausch für die Fakturierung zwischen Leistungserbringern und Versicherern. Den vorgegebenen Vertrag zu lesen ist die Arbeit.

Quellen

Schätzung
Alle Techniken
Sequenzdiagramme