Enterprise Architect von Sparx Systems (kurz EA) ist ein Werkzeug für Analyse und Design mit der Unified Modelling Language (kurz UML). UML ist eine Sprache zur Beschreibung technischer Systeme und hilft konsistente und nachvollziehbare Modelle des Systems zu erstellen. EA stellt dabei eine benutzerfreundliche und flexible Modellierungsumgebung zur Verfügung. EA wird immer dann eingesetzt, wenn UML-Diagramme nicht mehr trivial sind. Nur mit einem Werkzeug wie dem EA ist es möglich, Elemente des Modells konsistent in vielen verschiedenen Diagrammen zu verwenden. Nur so kann mit vertretbaren Aufwand eine Konsistenz in einem komplexen Modell sichergestellt werden.

Das Add-On “EA Connector for Confluence” ist ein Werkzeug, mit dem ein EA-Modell in wenigen Schritten für Confluence schnell und sicher verfügbar gemacht wird.

Weiterlesen auf atlassian.com

Einen anderen Ansatz beschreibt Per Spilling in seinem Blog. Mit einem API des EA ist es möglich, ein ganzes Modell zu exportieren und so für das Wiki verfügbar zu machen. Die PNG-Dateien tragen den Namen des Diagramms, die Ordnerstruktur folgt der Struktur des Modells im EA.

Weiterlesen auf perspilling.net

Medienbibliothek

Confluence erlaubt Anhänge in jeder Seite. Die Medienbibliothek in Confluence ist daher eine besondere Seite in der Produktdokumentation. Sie enthält Abbildungen und Diagramme, die in anderen Seiten verwendet werden. Sie hilft den Autoren, den Überblick zu behalten. Jedes Bild gibt es nur in einer Version. Eine Änderung im Diagramm wirkt sich sofort auf alle Seiten aus, in denen das Diagramm verwendet wird. Dadurch erkennen Autoren selbst oder durch Feedback der Leser recht schnell, ob Inhalte einer Seite, in der das Diagramm verlinkt wurde, noch richtig sind.

ktip Ohne Medienbibliothek gibt es Anhänge verteilt in vielen Seiten im Wiki. Es passiert dann manchmal, dass das gleiche Diagramm von zwei Autoren unabhängig voneinander in zwei verschiedenen Seiten eingefügt wird. Ändert sich eine Version des Diagramms, entsteht sofort eine Inkonsistenz in der Dokumentation, die aber nur sehr schwer entdeckt wird, weil jede Seite für sich immer noch konsistent ist.

Ein weiteres Ziel ist es, unabhängig vom Werkzeug zur Bearbeitung (hier EA) für die Einbettung in den Seiten konsequent PNG-Dateien bereitzustellen. Das hat Vorteile in der Benutzererfahrung der Leser (die Anzeige des Bildes ist immer gleich, unabhängig vom Werkzeug) und beim Export von Teilen der Produktdokumentation beispielsweise als PDF.

Diagramm erstellen

Die schrittweise Anleitung richtet sich an Autoren, die in Confluence mit dem Werkzeug EA ein Diagramm erstellen und zentral verfügbar machen wollen, entsprechend der Idee der Medienbibliothek. Die beschriebene Lösung benötigt kein spezielles Add-On.

EA hat eine Export-Funktion, die Diagramme als PNG-Dateien exportieren kann. Das Schöne an dieser Export-Funktion ist, dass der EA für jedes Bild eine eindeutige Bezeichnung vergibt, die sich nicht mehr ändert. Dieser Bezeichner wird als Name der PNG-Datei verwendet.

Du klickst mit der rechten Maus auf das oberste Element im “Project Browser”. Im aufgeklappten Menü führst du die Funktion “Export model to XMI” aus.

24-confluence-tip-uml-mit-enterprise-architect-im-griff-haben-export-package-to-xmi

Durch Klick auf “Publish” öffnest du das Fenster für die Export-Funktion.

24-confluence-tip-uml-mit-enterprise-architect-im-griff-haben-publish-model-package

Im Feld “Filename” wählst du einen beliebigen temporären Speicherort aus. Der Dateiname kann immer “model.xml” sein. Prüfe, ob der Haken “Generate Diagram Images” gesetzt ist und als Format “PNG” gewählt wurde. Durch Klick auf “Export” startest du den Export aller Diagramme in den Unterordner “images” im temporären Speicherort.

Gehe zur Seite Medien, um ein Diagramm hochzuladen. Öffne parallel dazu ein Explorer-Fenster im Unterordner “images” im temporären Speicherort. Dort liegen die exportierten PNG-Dateien aller Diagramme. Ziehe jede PNG-Datei in das Feld zum Hochladen von Dateien, die du in Confluence nutzen möchtest.

24-confluence-tip-uml-mit-enterprise-architect-im-griff-haben-upload

Gab es eine PNG-Datei bereits, dann wird nur eine neue Version im Anhang angelegt. Alte Versionen der Datei kannst du löschen, wenn du an der Historie nicht interessiert bist.

24-confluence-tip-uml-mit-enterprise-architect-im-griff-haben-image-details

Danach trägst du Stichworte bei den Eigenschaften jeder PNG-Datei ein. Das Stichwort “image” ist zwingend erforderlich, um die Art der Seite zu kennzeichnen.

Den Titel des Diagramms im EA trägst du als Kommentar bei der PNG-Datei ein. Der Kommentar ist wichtig, um den Bezug zum EA zu behalten. Die vom EA generierten Namen für die PNG-Dateien geben leider keinen Hinweis.

24-confluence-tip-uml-mit-enterprise-architect-im-griff-haben-image-list

Diagramm verwenden

Autoren verwenden die PNG-Datei eines Diagramms in ihren eigenen Seiten. Jede Aktualisierung der PNG-Datei aus dem EA wirkt sich auf alle Seiten aus, die dieses Diagramm nutzen.

Fazit

Mit dem beschriebenen Verfahren haben wir einen sehr einfachen Weg, wie wir Diagramme aus dem EA sicher und schnell für Confluence-Seiten nutzbar machen können. Selbst bei einer großen Zahl von Diagrammen entstehen keine unerwünschten Duplikate. Nur so können wir dauerhaft konsistente detailreiche Diagramme für die Produktdokumentation pflegen. Confluence ist sozusagen die Veröffentlichung der Diagramme aus dem EA für Leser, die mit der Komplexität des EA nicht nutzen können (keine Lizenz) oder wollen (zu kompliziert). Software-Experten nutzen weiterhin direkt den EA.