Innovator 11 excellence. Universally Unique Identifier (UUID) Wie UUIDs in Innovator verwendet werden. HowTo. Günther Ruck.

Transkript

1 Innovator 11 excellence Universally Unique Identifier (UUID) Wie UUIDs in Innovator verwendet werden Günther Ruck HowTo

2 Inhaltsverzeichnis Universally Unique Identifier (UUID)... 2 Was ist eine UUID?... 2 UUID-fähige Innovator-Elemente... 2 Vergabe einer UUID... 2 UUIDs beim Importieren einer Versionsdatei... 3 Suchstrategien beim Importieren einer Versionsdatei... 3 Suche nach Elementen über strukturelle Eigenschaften (Namensraum)... 3 Suche nach Elementen über UUID... 3 Generelles zusätzliches Suchprinzip für beide Suchstrategien... 3 Konflikte bei der Suche nach identischen Elementen... 4 Konflikt durch strukturell gleiche Elemente mit anderer UUID... 4 Konflikt durch verschiedene Fundstellen für UUID und Namensraum... 4 Importieren einer Versionsdatei im Konfigurationseditor... 5 Suche nach Elementen über Namen, UUID neu vergeben... 5 Suche nach Elementen über Namen, UUID übernehmen... 5 Suche nach Elementen über UUID, UUID übernehmen... 6 Suche nach Elementen über UUID, UUID neu vergeben... 7 Importieren einer Versionsdatei im Modellbrowser... 8 Weitere Aspekte der Verwendung von UUIDs in Innovator... 8 Importieren einer Add-on-Modellvorlage... 8 Modell kopieren... 8 Modelle zusammenführen (inomerge.exe)... 9 Innovator-Modellreferenzen (Uniform Resource Identifier (URI))... 9 Proxy... 9 oaw-schablonen... 9 Transformation von excellence-modellen aus Vorgängerversionen

3 Universally Unique Identifier (UUID) Was ist eine UUID? Ein Universally Unique Identifier (UUID) ist ein Identifikator innerhalb der Softwareentwicklung, der von der Open Software Foundation (OSF) als Teil des Distributed Computing Environment (DCE) standardisiert wird. UUIDs dienen dazu, Informationen in verteilten Systemen automatisch und mit sehr hoher Sicherheit eindeutig kennzeichnen zu können. Eine UUID besteht aus einer 16-Byte-Zahl, die in fünf Gruppen unterteilt wird. In ihrer Normalform sieht eine UUID beispielsweise so aus: 5fcb94e2-c083-cd74-839b-eba953124e6f. UUID-fähige Innovator-Elemente Seit der Version 10.1 wird für die meisten Konfigurations- und Modellelemente eines InnovatoreXcellence-Modells beim Erzeugen eine UUID vergeben. Bei grafischen Vorkommen in Diagrammen wird darauf verzichtet, da die Knoten bzw. Kanten eines Diagramms über die dargestellten Modellelemente identifiziert werden. Die UUID erlaubt es, ein Modellelement in verschiedenen Versionsständen eines Innovator-Modells zu identifizieren. Somit können Modellelemente, die in einer Folgeversion umbenannt bzw. in einen anderen Namensraum verschoben wurden, trotz geänderter struktureller Eigenschaften identifiziert werden. Vergabe einer UUID Die UUID wird beim Erzeugen einer UUID-fähigen Instanz vergeben. Diese UUID ist dann über alle Innovator-Repositorys eindeutig. Die UUID eines Elements wird während seiner Lebensdauer nicht geändert, außer dies wird im Rahmen einer Konfliktauflösung beim Importieren einer Versionsdatei bzw. interaktiv im Programm Zusammenführung explizit gewünscht. Beim Importieren einer Versionsdatei werden die darin enthaltenen Elemente im Modell gesucht. Ein Modellelement kann dabei über seine strukturellen Eigenschaften (qualifizierter Name) und ab Version 10.1 auch über seine UUID ermittelt werden. Im Dialog Konfiguration/Importieren/Von Versionsdatei bzw. Modell/Versionsdatei/Importieren kann bestimmt werden, nach welchem Verfahren importierte Modellelemente ihren Platz im Modell finden sollen. Sie können festlegen, ob Elemente über ihren Namensraum zu identifizieren und ob UUIDs zu übernehmen sind. Ebenso bestimmen Sie wie im Konfliktfall verfahren wird. Beim Einfügen als neues Element wird eine neue UUID vergeben. Platzhalterelemente werden beim Einfügen vorrangig über ihre UUID gesucht. Führt dies nicht zum Erfolg, wird eine strukturelle Suche (typischerweise der qualifizierte Name) durchgeführt. 2

4 UUIDs beim Importieren einer Versionsdatei Suchstrategien beim Importieren einer Versionsdatei Das bisherige Verhalten (ohne UUIDs) beim Import einer Versionsdatei bestand darin, dass das importierte Element dem strukturell gefundenen Element zugeordnet und dieses somit überschrieben wurde. Neue Elemente wurden gemäß ihrer Position im Namensraum neu angelegt. Suche nach Elementen über strukturelle Eigenschaften (Namensraum) Das bisherige Verfahren beim Importieren einer Versionsdatei in ein Modell suchte nach bereits im Modell vorhandenen Elementen ausschließlich über strukturelle Eigenschaften. Umbenannte bzw. in der Modellhierarchie verschobene Elemente können mit diesem Verfahren nicht mehr gefunden werden. Bereits im Namensraum existierende Elemente werden beim Importieren aus dem Modell gelöscht und durch ihre geänderte Version aus der Versionsdatei ersetzt. Beim Löschen gehen sämtliche Referenzen auf diese Instanzen verloren. Umbenannte oder in der Modellhierarchie verschobene Elemente, die nicht mehr gefunden werden, werden im importierenden Modell nur dann gelöscht, wenn sie zu einem versionierbaren Element gehören, das über die Suche gefunden wird. Tabellen sind z. B. versionierbare Elemente, deren Spalten jedoch nicht, da sie nicht unabhängig von einer Tabelle existieren können. Wird also einerseits z. B. eine im Modell nach der Versionierung umbenannte Spalte in einer Tabelle in der Versionsdatei nicht identifiziert, wird im Modell diese umbenannte Spalte aus der Tabelle gelöscht und die ursprüngliche Spalte aus der Versiondatei eingefügt. Wird andererseits z. B. eine umbenannte Tabelle in der Versionsdatei nicht identifiziert, wird diese nicht im Modell gelöscht, sondern die ursprüngliche Tabelle zusätzlich dort eingefügt. Suche nach Elementen über UUID Durch eine Suche über UUID können auch umbenannte und verschobene Elemente gefunden werden. Sie werden nicht mehr gelöscht. Referenzen, die auf sie verweisen, bleiben erhalten. Die Suche über UUID kann aber beim Einfügen des zu importierenden Elements zur Verletzung der Eindeutigkeit von Namensräumen führen. Wird in einem Paket beispielsweise eine umbenannte Klasse über ihre UUID gefunden, dann kann sie in der Versionsdatei einen Namen besitzen, der im Modell bereits wieder für eine andere Klasse aus demselben Paket vergeben ist. Nach dem Importieren würde das Paket zwei gleichnamige Klassen enthalten, was verhindert werden muss. Generelles zusätzliches Suchprinzip für beide Suchstrategien Beide Suchstrategien werden durch die jeweils andere ergänzt, um bestehende Widersprüche zwischen Versionsdatei und Modell sicher erkennen zu können. Wenn diese Widersprüche nicht durch die Vorgaben für den Import (zur (vorrangigen) Suchstrategie und zur UUID-Berücksichtigung) gelöst werden können, wird von einem Konflikt gesprochen. In diesem Fall können Sie als Anwender entscheiden wie der Konflikt gelöst werden soll. 3

5 Konflikte bei der Suche nach identischen Elementen Konflikte können bei der Suche nach identischen Elementen im Modell durch widersprüchliche Suchergebnisse über Namensraum bzw. UUID entstehen. Kein Konflikt liegt vor, wenn UUID und strukturelle Eigenschaften identisch sind, da dann von einem identischen Element ausgegangen werden kann. Ebenso liegt kein Konflikt vor, wenn ein Element mit gleicher UUID und anderen strukturellen Eigenschaften gefunden wird, da der Import einer Versionsdatei dem (widerspruchsfreien) Importieren des Versionsstands dienen soll. Es sind also zwei Konfliktfälle zu behandeln. Konflikt durch strukturell gleiche Elemente mit anderer UUID Konflikt 1 Problem UUID-Suche findet nichts, strukturelle Suche findet ein Element. Wenn das importierte Element neu erzeugt wird, dann entstehen zwei strukturell gleiche Elemente. Konfliktlösung 1.1 Die Modelle werden (interaktiv) so geändert, dass die strukturelle Suche keinen Treffer liefert. Konfliktlösung 1.2 Das importierte Element wird dem strukturell gefundenen Element zugeordnet. Die UUID des strukturell gefundenen Elements wird auf die UUID des importierten (Versions-)Elements geändert. Somit wird die UUID eines bestehenden Modellelements geändert. Konfliktlösung 1.3 Das importierte Element wird dem strukturell gefundenen Element zugeordnet. Das strukturell gefundene Element behält seine UUID, die UUID des importierten Elements wird verworfen. Konflikt durch verschiedene Fundstellen für UUID und Namensraum Konflikt 2 Problem UUID-Suche und strukturelle Suche finden verschiedene Elemente. Wird das über UUID gefundene Element angepasst, dann entstehen zwei strukturgleiche Elemente. Konfliktlösung 2.1 Die Modelle werden (interaktiv) so geändert, dass die strukturelle Suche keinen Treffer liefert. Konfliktlösung 2.2 Das importierte Element wird dem strukturell gefundenen Element zugeordnet. Dabei wird die UUID des strukturell gefundenen Elements auf die UUID des importierten Elements geändert. Um die Eindeutigkeit der UUID nicht zu verletzen, muss für das über die UUID-Suche gefundene Element eine neue UUID erzeugt werden. Somit werden die UUIDs von zwei Elementen geändert. 4

6 Konfliktlösung 2.3 Das importierte Element wird dem strukturell gefundenen Element zugeordnet. Dabei wird die UUID des importierten Elements verworfen. Das strukturell gefundene Element behält seine alte UUID. Im Modell ist also weiterhin ein anderes Element mit der verworfenen UUID des importierten Elements enthalten. Importieren einer Versionsdatei im Konfigurationseditor Suche nach Elementen über Namen, UUID neu vergeben Elemente über Namensraum identifizieren/identify Elements by Namespace: UUIDs beim Import übernehmen/adopt UUID on Import: aktiviert deaktiviert Wirkung Konflikt Zu den Elementen aus der Versionsdatei werden strukturell entsprechende Elemente im Modell gesucht. Elemente der Versionsdatei ohne Entsprechung im Modell werden neu erstellt. Die neu erstellten Elemente erhalten eine neue UUID. UUIDs aus der Versionsdatei werden, auch für im Modell strukturell gefundene Elemente, verworfen. Kein Konflikt, da Elemente über den Namensraum gesucht werden und neu erstellte Elemente immer eine neue UUID erhalten. Diese UUID kann im Modell nicht vergeben sein. Suche nach Elementen über Namen, UUID übernehmen Elemente über Namensraum identifizieren/identify Elements by Namespace: UUIDs beim Import übernehmen/adopt UUID on Import: aktiviert aktiviert Wirkung Konflikt 2 Zu den Elementen aus der Versionsdatei werden strukturell entsprechende Elemente im Modell gesucht. Elemente der Versionsdatei ohne Entsprechung im Modell werden neu erstellt. Die neu erstellten Elemente übernehmen ihre UUID aus der Versionsdatei. Im Modell strukturell gefundene Elemente übernehmen ihre UUIDs ebenfalls aus der Versionsdatei. Strukturelle Suche und (parallel durchgeführte) UUID-Suche finden verschiedene Elemente. Alternatives Verhalten bei Konflikten/ Behavior on conflicts Import abbrechen/ Abort Import Es wird die Liste der konfliktbehafteten Elemente ausgegeben. Der Import wird nicht durchgeführt. Am Modell werden keine Änderungen vorgenommen. Das Modell kann interaktiv so geändert werden, dass die Konflikte nicht mehr auftreten. 5

7 Importierte UUID übernehmen/ Adopt imported UUID (Konfliktlösung 2.2) Vorhandene UUID beibehalten/ Keep existing UUID (Konfliktlösung 2.3) Das strukturell gefundene Element übernimmt die Eigenschaften, insbesondere die UUID, des Elements aus der Versionsdatei. Um die Eindeutigkeit der UUID nicht zu verletzen, wird für das über UUID-Suche gefundene Element eine neue UUID erzeugt. (Dieses Verhalten unterstützt ein Migrationsszenario, bei dem nach der Migration auf die Version 10.1 strukturgleiche Profile bzw. Modelle auf dieselbe UUID-Basis gebracht werden sollen.) Das strukturell gefundene Element übernimmt außer der UUID alle Eigenschaften des Elements aus der Versionsdatei. Somit wird die UUID des im Modell gefundenen Elements nicht geändert. Das Element aus der Versionsdatei besitzt nach dem Import eine andere UUID. Weiterhin ist im Modell ein anderes Element mit der UUID des Elements aus der Versionsdatei enthalten. Suche nach Elementen über UUID, UUID übernehmen Elemente über Namensraum identifizieren/identify Elements by Namespace: UUIDs beim Import übernehmen/adopt UUID on Import: Hinweis Diese Optionsvariante ist der aktuelle Standard. deaktiviert aktiviert Wirkung Konflikt 1 Zu den Elementen aus der Versionsdatei werden Elemente im Modell über UUID gesucht. Elemente der Versionsdatei ohne Entsprechung im Modell werden neu erstellt. Die neu erstellten Elemente übernehmen dabei ihre UUID aus der Versionsdatei. UUID-Suche findet nichts, strukturelle Suche findet ein Element. Alternatives Verhalten bei Konflikten/ Behavior on conflicts Import abbrechen/ Abort Import Importierte UUID übernehmen/ Adopt imported UUID (Konfliktlösung 1.2) Es wird die Liste der konfliktbehafteten Elemente ausgegeben. Der Import wird nicht durchgeführt, am Modell werden keine Änderungen vorgenommen. Das Modell kann interaktiv so geändert werden, dass die Konflikte nicht mehr auftreten. Das strukturell gefundene Element übernimmt die Eigenschaften, insbesondere die UUID, vom Element aus der Versionsdatei. Somit wird die UUID des im Modell gefundenen Elements geändert. 6

8 Vorhandene UUID beibehalten/ Keep existing UUID (Konfliktlösung 1.3) Das strukturell gefundene Element übernimmt alle Eigenschaften des Elements aus der Versionsdatei außer der UUID. Somit wird die UUID des im Modell gefundenen Elements nicht geändert, das Element aus der Versionsdatei besitzt nach dem Import eine andere UUID. Konflikt 2 UUID-Suche und strukturelle Suche finden verschiedene Elemente. Alternatives Verhalten bei Konflikten/ Behavior on conflicts Import abbrechen/ Abort Import Importierte UUID übernehmen/ Adopt imported UUID (Konfliktlösung 2.2) Vorhandene UUID beibehalten/ Keep existing UUID (Konfliktlösung 2.3) Es wird die Liste der konfliktbehafteten Elemente ausgegeben. Der Import wird nicht durchgeführt, am Modell werden keine Änderungen vorgenommen. Das Modell kann interaktiv so geändert werden, dass die Konflikte nicht mehr auftreten. Um die Eindeutigkeit der UUID nicht zu verletzen, wird für das über die UUID-Suche gefundene Element eine neue UUID erzeugt. Das strukturell gefundene Element übernimmt die Eigenschaften, insbesondere die UUID, des Elements aus der Versionsdatei. Somit wird die UUID des im Modell strukturell gefundenen Elements geändert. Das strukturell gefundene Element übernimmt alle Eigenschaften, außer der UUID, des Elements aus der Versionsdatei. Somit wird die UUID des im Modell gefundenen Elements nicht geändert, das Element aus der Versionsdatei besitzt nach dem Import eine andere UUID. Weiterhin ist im Modell ein Element mit der UUID des Elements aus der Versionsdatei enthalten. Suche nach Elementen über UUID, UUID neu vergeben Elemente über Namensraum identifizieren/identify Elements by Namespace: UUIDs beim Import übernehmen/adopt UUID on Import: deaktiviert deaktiviert Wirkung Zu den Elementen aus der Versionsdatei werden Elemente im Modell über UUID gesucht. Elemente der Versionsdatei ohne Entsprechung im Modell werden neu erstellt. Die neu erstellten Elemente erhalten eine neue UUID. Über UUID gefundene Modellelemente behalten ihre UUID, nicht über UUID gefundene Elemente, die eine strukturelle Entsprechung haben, ersetzen das vorhandene Element und UUID des gefundenen Elements bleibt erhalten. 7

9 Konflikt Kein Konflikt, da Elemente über UUID gesucht werden und neu erstellte Elemente immer eine neue UUID erhalten. Diese UUID kann im Modell nicht vergeben sein. Importieren einer Versionsdatei im Modellbrowser Eine Versionsdatei, die im Modellbrowser importiert werden soll, enthält neben modellspezifischen Daten typischerweise auch Profildaten (Verweise auf Stereotype, StereotypeProperties usw.). Für das Importieren einer Versionsdatei kann das Suchverfahren (über UUID bzw. strukturell (Namensraum)) und das Verhalten im Konfliktfall für die eigentlichen Modellbestandteile anders eingestellt werden als für die Konfigurationsbestandteile, die mit einer feststehenden Optionsvariante für die Suche und einer feststehenden Verhaltensoption importiert werden. Die möglichen Optionen für das Importieren einer Versionsdatei im Modellbrowser entsprechen denen im Konfigurationseditor. Sie legen das Verhalten für den Import der Modellbestandteile fest. Die Konfigurationsbestandteile werden stets mit der Optionsvariante "Identifizieren über UUID" und "UUIDs beim Import übernehmen" für die Suche sowie dem Verhalten "Importierte UUID übernehmen/adopt imported UUID" im Konfliktfall betrieben. Weitere Aspekte der Verwendung von UUIDs in Innovator Importieren einer Add-on-Modellvorlage Das Importieren einer Profil-Vorlage bzw. das Laden einer Add-on-Vorlage im Konfigurationseditor bzw. Modellbrowser entspricht weitgehend dem Importieren einer Versionsdatei im Modellbrowser (siehe oben). Konflikte können hierbei zwar auftreten, sie werden jedoch stets einheitlich gelöst. Konfigurationsbestandteile werden stets mit der Optionsvariante "Identifizieren über UUID" und "UUIDs beim Import übernehmen" für die Suche sowie dem Verhalten "Importierte UUID übernehmen/adopt imported UUID" im Konfliktfall betrieben. Modellbestandteile werden stets mit der Optionsvariante "Elemente über Namensraum identifizieren" und "UUIDs neu vergeben" importiert. Modelle, die anhand derselben Modellvorlage erstellt wurden, sind somit voneinander unabhängige Modelle. Sie stehen in keiner Vorgänger-/Nachfolgerbeziehung untereinander bzw. zur Modellvorlage. Modell kopieren Im Administrationsprogramm können Sie Modelle kopieren und in das gleiche oder ein anderes Repository einfügen. Die UUIDs des Quellmodells werden im Zielmodell beibehalten. Beide Modelle sind somit identisch und unterscheiden sich zunächst höchstens im Namen. 8

10 Modelle zusammenführen (inomerge.exe) Zum Ermitteln von Modellunterschieden wird im Programm Zusammenführung (inomerge.exe) zu einem gegebenen Element aus dem linken Modell ein entsprechendes Element im rechten Modell ermittelt. Die Suche im rechten Modell erfolgt wie bei der Suche eines Platzhalterelements beim Kopieren/Einfügen vorrangig über ihre UUID bzw. eine strukturelle Suche, falls über die UUID kein Treffer ermittelt wird. Daher ist es im Programm Zusammenführung möglich, die UUID eines Elements von seinem entsprechenden Element zu übernehmen, wenn es über eine strukturelle Suche identifiziert wurde. Innovator-Modellreferenzen (Uniform Resource Identifier (URI)) Die Innovator-URI (URL-Protokoll inno) wird unter Verwendung der UUID konstruiert, z. B. inno:/demo_de/uml/uml-demomodell?uuid=5279cc3e d2e-9864-dda0aec606fe. Proxy Innovator-Proxy-Instanzen werden benutzt, um modellübergreifende Beziehungen abzubilden. Eine Proxy-Instanz ist ein Platzhalter für eine Instanz aus einem anderen Modell. Das Originalelement aus dem anderen Modell wird durch seine UUID identifiziert. oaw-schablonen Geschützte Bereiche in oaw-schablonen können durch Verwendung der UUID eines Elements identifiziert werden. Transformation von excellence-modellen aus Vorgängerversionen Bei der Transformation eines excellence-modells aus einer Version vor 10.1 erhält jedes UUID-fähige Element eine UUID. Das Verfahren zur Vergabe der UUID stellt sicher, dass eine UUID auch repository-übergreifend nicht doppelt vergeben wird. Eine Sonderbehandlung erhalten Profile und in Profilen enthaltene UUID-fähige Elemente, die im Modell referenziert werden können. Während der Transformation wird eine UUID über strukturelle Eigenschaften vergeben. Damit wird erreicht, dass nach der Transformation beispielsweise gleichbenannte Stereotype in allen Repositorys dieselbe UUID besitzen. Copyright 2010 MID GmbH Bei Fragen wenden Sie sich bitte an unsere Hotline. Telefon: +49 (0) , Innovator 11.2 HowTo UUID doc Dieses Dokument finden Sie neben anderen auch im exklusiven Login-Download-Bereich für Innovator-Wartungskunden unter Ihre MID MID GmbH, Eibacher Hauptstraße 141, Nürnberg Telefon: +49 (0) , Fax: +49 (0) , Internet: 9