Mit diesem Artikel kann zwar keine Musterlösung dafür gegeben werden, wie Systemschnittstellen keine Probleme verursachen aber es soll ein Weg aufgezeigt werden, wie Schnittstellen verständlich beschrieben werden können, um einen Beitrag dazu zu leisten, Schnittstellenprobleme zu vermeiden.
Grundsätzliches Vorgehen
Im Grunde genommen ist die Beschreibung einer Schnittstellen kein Hexenwerk. Im Gegenteil, eine Schnittstelle lässt sich mit den gleichen Prinzipien beschreiben wie ein informationsverarbeitendes System. Stellt sich die Frage, wie wiederum ein informationsverarbeitendes System beschrieben werden kann. Der besondere Fokus liegt hierbei auf eine verständliche Beschreibung, es empfiehlt sich daher ein grafischer Ansatz. In vielen Projekten haben sich hier die Fundamental Modelling Concepts (FMC) bewährt. Der Schlüssel liegt bei diesem Ansatz darin, dass zwischen den Bereichen Aufbau, Ablauf und Wertebereich unterschieden wird.
Im Zentrum stehen Aufbaudarstellungen, mit denen als sog. „Big Picture“ der Überblick und das grundlegende Verständnis vermittelt werden. Mit ergänzenden Ablauf- und Wertebereichdarstellungen können die Funktion, Datenstrukturen etc. detailliert werden.
Wie kann eine Schnittstellenbeschreibung im Detail aussehen?
Betrachten wir an dieser Stelle beispielhaft eine Schnittstelle zwischen zwei IT-Systemen, wobei der Datenaustausch über eine Datei erfolgen soll.
Beginnen wir zur Beschreibung mit dem oben erwähnten Aufbaubild. In einer ggf. existierenden Anwendungslandkarte können die beteiligten Anwendungen und auch die Schnittstelle bereits erwähnt und dargestellt werden. Dies zeigt der u.s. Ausschnitt einer solchen Anwendungslandkarte. Die betrachtete Schnittstelle ist mit einem gestrichelten Rahmen markiert.
In der dargestellten Landkarte existiert eine unidirektionale Schnittstelle zwischen den Systemen SAP SCM und Business Warehouse. Die allgemeine Anwendungslandkarte gibt damit einen ersten allgemeinen Überblick. Zur Beschreibung der Schnittstelle kann ein weiteres Aufbaubild gute Dienste leisten.
Mit Hilfe einer kleinen Ausschnitts-Anwendungslandkarte ist die betreffende Schnittstelle nochmals aufgegriffen und etwas detaillierter dargestellt. Erkennbar ist, dass das SAP SCM-System ein Export-Modul beinhaltet, welches die CSV-Austauschdatei erstellt. Auf der Gegenseite beinhaltet das Business Warehouse ein Importer-Modul, welches diese Datei einliest.
Der grundsätzliche Aufbau der Schnittstelle ist somit beschrieben (zugegebenermaßen ist dies eine sehr einfache Schnittstelle).
Funktion der Schnittstelle
Kommen wir nun zur Funktion der Schnittstelle.
Die Beschreibung der Funktion ist, modellierungstechnisch gesehen, eine Detaillierung der aktiven Elemente. Die Funktion wird üblicherweise mit einem Ablaufbild beschrieben, folgend wird hierfür beispielhaft die Notation der „Ereignisgesteuerten Prozesskette“ (EPK) verwendet.
Mit dem oben dargestellten Ablaufplan wird aufgezeigt, wie die Schnittstelle arbeitet. Täglich um 22:00 wird der Importer aktiv, erstellt die Austauschdatei und speichert diese im Austauschverzeichnis. Der Importer wird aktiv, wenn im Austauschverzeichnis eine entsprechende Austauschdatei vorhanden ist.
Die Funktionsweise ist einfach, verständlich und klar beschrieben. Was allerdings noch nicht klar ist, sind Details zu den Daten. Welche Daten sollen übertragen werden? Wie ist die Austauschdatei aufgebaut? Wo liegt der Austauschordner? All diese Informationen sind Details zu den passiven Objekten. Diese Informationen ergeben sich somit über Wertebereichsdarstellungen.
Struktur der Schnittstelle
Zur Beschreibung der Struktur der Schnittstelle sind ein oder mehrere Wertebereichdarstellungen erforderlich/sinnvoll. Für das kleine Beispiel soll eine einfache Darstellung ausereichen.
Obige Abbildung zeigt, dass im Austauschverzeichnis die Austauschdatei abgelegt wird. Die Austauschdatei beinhaltet Datensätze (für die eigentlich zu übertragenden Daten) und die entspr. Codierungsinformationen. Berücksichtigt man, dass die dargestellten Elemente nicht einfach in Powerpoint o.ä. gezeichnet, sondern mit einem Modellierungswerkzeug erstellt werden, wird klar, warum eine solch einfache Darstellung ausreicht: Jedes gezeichnete Element kann im Modellierungswerkzeug mit weiteren Inhalten beschrieben und erläutert werden. Mit Hilfe dieser Beschreibungen werden alle Informationen hinterlegt, die zur verständlichen Beschreibung noch erforderlich sind.
Fazit
Mit dem einfachen Ansatz der Fundametal Modelling Concepts, bei dem informationsverarbeitende Systeme mit Hilfe von Aufbau-, Ablauf- und Wertebereichsdarstellungen beschrieben werden können, lassen sich sehr verständliche Schnittstellen-Dokumentationen erstellen.
Verwendet man diesen Modellierungsansatz bereits vor der Realisierung der Schnittstelle, kann diese Dokumentation auch eine Schnittstellen-Spezifikation darstellen. Hierbei werden zusätzlich Anforderungen definiert und auf die grafischen Elemente bezogen.
Unser Modellierungswerkzeug ARCWAY Cockpit ist besonders geeignet, solche Modelle zu erstellen und auch Spezifikations- und Dokumentationsdokumente daraus zu generieren.
