Leitfaden · SysML v2
Ein SysML-v1-Modell nach SysML v2 bringen: eine Migration Schritt für Schritt
Ein SysML-v1-Modell lässt sich automatisch nach SysML v2 konvertieren, aber eine Migration ist mehr als eine Dateikonvertierung: Jemand muss entscheiden, wie das konvertierte Modell aussehen soll, und prüfen, dass es noch sagt, was das v1-Modell gesagt hat. Dieser Leitfaden führt in acht Schritten durch eine Migration, von der Bestandsaufnahme des v1-Modells bis zur Umstellung, mit einem kleinen Modell, das konvertiert und Zeile für Zeile gelesen wird.
Auf dieser Seite
- Bevor Sie beginnen: eine Übersetzung, kein Upgrade
- 1. Bestand des v1-Modells aufnehmen
- 2. Das Modell aus dem SysML-v1-Werkzeug exportieren
- 3. Ein Pilotpaket konvertieren
- 4. Den Konvertierungsbericht lesen
- Ein durchgearbeitetes Beispiel: ein kleines Rover-Modell
- 5. Nacharbeiten, was angenähert oder ausgelassen wurde
- 6. Die wichtigen Ansichten neu aufbauen
- 7. Das v2-Modell prüfen und reviewen
- 8. Den Rest konvertieren und umstellen
- Migrations-Checkliste
- Wie es weitergeht
Bevor Sie beginnen: eine Übersetzung, kein Upgrade
SysML v2 ist eine neue Sprache, keine neue Version des SysML-v1-Dateiformats. Blöcke werden zu Part-Definitionen, Ports werden durch Port-Definitionen typisiert, Anforderungen tragen Bedingungen, und Diagramme werden zu Ansichten, die das Modell definiert. SysML v1 und v2 im Vergleich erklärt die Unterschiede einzeln.
Ein Konverter erledigt den mechanischen Teil: Jedes Element mit einer Entsprechung in SysML v2 wird in SysML v2 geschrieben, und der Rest wird gemeldet. Was ein Konverter nicht kann, ist zu entscheiden, wie Ihr Team die neue Sprache verwenden will. Planen Sie die Migration als Modellierungsaufgabe mit einem Verantwortlichen, einem Review und einem Zeitpunkt, an dem das v2-Modell zur Referenz wird.
Dieser Leitfaden verwendet den Konverter von Holarch, der ein SysML-1.x-Modell in ein SysML-v2-Projekt importiert und jedes Element als konvertiert, angenähert oder ausgelassen meldet. Die Planungsschritte gelten für jeden Konverter.
1. Bestand des v1-Modells aufnehmen
Bevor Sie etwas exportieren, finden Sie heraus, was das Modell enthält und wer davon abhängt. Eine kurze Bestandsaufnahme spart später Nacharbeit.
- Pakete und Verantwortliche. Listen Sie die Pakete der obersten Ebene auf, wer jedes pflegt und auf welche andere Modelle oder Dokumente verweisen. Pakete sind die Einheit, die Sie konvertieren und prüfen.
- Wichtige Diagramme. Notieren Sie die Diagramme, die tatsächlich in Reviews und Dokumenten verwendet werden. Diagrammlayouts werden nicht nach SysML v2 übernommen, daher werden diese zu Ansichten, die Sie neu aufbauen.
- Profile und Stereotypen. Listen Sie Ihre eigenen Stereotypen und ihre Tagged Values auf. Sie werden zu Metadatendefinitionen, und ihre Bedeutung im neuen Modell muss neu vereinbart werden.
- Als Code geschriebenes Verhalten. Opaque Behaviors, Guards und Constraints in OCL, einer Aktionssprache oder der Skriptsprache eines Werkzeugs bleiben als Text in ihrer Originalsprache erhalten; sie werden nicht übersetzt.
- Unbenannte Elemente. Beziehungen, die auf Elemente ohne Namen zeigen, lassen sich nicht in SysML-v2-Text schreiben, der Elemente über ihren Namen referenziert. Benennen Sie die Elemente, zu denen Sie nachverfolgen, jetzt im v1-Werkzeug.
- Größe. Holarch konvertiert jeweils eine Datei mit bis zu 64 MB und 250.000 Elementen. Größere Modelle werden Paket für Paket exportiert.
2. Das Modell aus dem SysML-v1-Werkzeug exportieren
Der Konverter liest das Modell aus XMI, dem Austauschformat, das SysML-v1-Werkzeuge schreiben. Jedes Werkzeug exportiert es etwas anders:
| Werkzeug | Was importiert wird |
|---|---|
| Cameo Systems Modeler, MagicDraw | Die Projektdatei .mdzip oder File → Export To → Eclipse UML2 (v5.x) XMI File und die Datei .xmi |
| Enterprise Architect | Paket auswählen, Publish → Export XML, XMI 2.1 wählen und die Datei .xml importieren. Projektdateien (.eap, .qea) werden nicht direkt gelesen. |
| IBM Rhapsody | Ein XMI-2.x-Export aus dem XMI-Toolkit |
| Eclipse Papyrus | Die .uml-Datei des Modells |
Bewahren Sie die exportierte Datei bei den Migrationsunterlagen auf: Sie ist genau die v1-Eingabe, auf die sich Ihr Review bezieht.
3. Ein Pilotpaket konvertieren
Beginnen Sie mit einem Paket, das repräsentativ, aber nicht das größte ist: ein Subsystem mit Struktur, Schnittstellen, etwas Verhalten und seinen Anforderungen. Der Pilot zeigt, wie die Konvertierung Ihres Modells aussieht, bevor Sie das ganze Team darauf festlegen.
- Legen Sie ein SysML-v2-Projekt an oder öffnen Sie dasjenige, in das das konvertierte Modell kommen soll, und klicken Sie auf Modell → Import und Export.
- Wählen Sie unter Import für einen Pilot In ein neues SysML-v2-Projekt, damit nichts anderes berührt wird.
- Ziehen Sie die exportierte Datei auf das Feld. Eine Fortschrittskarte zeigt die Stufen: XMI-Datei lesen, nach SysML v2 konvertieren, Ergebnis prüfen.
Noch ist nichts importiert. Der nächste Bildschirm ist die Vorschau mit dem Konvertierungsbericht.
4. Den Konvertierungsbericht lesen
Konvertierung aus SysML v1 oben in der Vorschau nennt die Anzahl der konvertierten, angenäherten und ausgelassenen Elemente und ob der SysML-v2-Text ohne Probleme geprüft wird. Jedes Element des v1-Modells hat ein Ergebnis:
- Konvertiert: Das Element hat eine direkte Entsprechung in SysML v2, etwa ein Block, der zu einer
part defwird. - Angenähert: Das Element bleibt in veränderter Form erhalten, zum Beispiel eine Transition über eine Choice, die zu einer Transition pro Pfad wird. Das sind die Stellen, an denen die Bedeutung vom v1-Modell abweichen kann.
- Ausgelassen: SysML v2 hat keine Entsprechung, oder das Element verweist auf etwas, das nicht in der Datei ist.
Mit Anzeigen listen Sie die angenäherten und ausgelassenen Elemente auf. Jede Zeile nennt das Element, seine SysML-v1-Art, was mit welchem SysML-v2-Namen daraus wurde, und warum. Öffnen Sie SysML-v2-Text anzeigen, um das Ergebnis zu lesen, und klicken Sie auf Bericht herunterladen, um den Bericht als CSV-Datei aufzubewahren. Die CSV ist die Arbeitsliste für Schritt 5: Sortieren Sie sie nach Grund und geben Sie jeder Gruppe einen Verantwortlichen.
Ein durchgearbeitetes Beispiel: ein kleines Rover-Modell
Ein kleines SysML-v1-Modell des Leistungspfads eines Planetenrovers, in drei Paketen:
| Package | SysML-v1-Elemente |
|---|---|
| Typen | Ein Value Type Power mit der Einheit W; ein Block Charge; ein Interface Block Power Interface mit zwei ausgehenden Flow Properties, charge (ein Charge) und voltage (ein Real) |
| Struktur | Ein gekapselter Block Rover mit den Part Properties battery und computer, einer Value Property power budget von 120 W, einem Connector power bus zwischen ihren Ports und einem Item Flow power flow von Charge darauf. Ein Block Battery mit einem Proxy Port out; ein Block Computer mit einem konjugierten Proxy Port in und einem Full Port raw. Beide tragen einen Benutzerstereotyp «Hardware» mit Tagged Values. Eine Assoziation, deren Ende der Assoziation gehört. |
| Anforderungen | Anforderungen R-1 Mission und R-2 Power Margin; R-2 abgeleitet von R-1; R-2 erfüllt durch das Part battery; ein Trace von Computer zu Battery |
Konvertiert liest es sich so. Die Auflistung ist die unveränderte Ausgabe des Konverters:
package 'Rover Model' {
package Types {
attribute def Power :> ISQ::PowerValue;
part def Charge;
port def 'Power Interface' {
out item charge : Charge;
out attribute voltage : ScalarValues::Real;
}
}
package Structure {
part def Rover {
doc /* Six-wheeled science rover. */
@SysMLv1Library::BlockData { isEncapsulated = true; }
part battery : Battery;
part computer : Computer;
attribute 'power budget' : Types::Power = 120 [SI::W];
connection 'power bus' connect battery.'out' to computer.'in';
satisfy Requirements::'Power Margin' by battery;
flow 'power flow' of Types::Charge from battery.'out' to computer.'in';
}
part def Battery {
@'SysML v1 Profiles'::rov::Hardware { qualified = "true"; vendor = "Acme Cells"; }
port 'out' : Types::'Power Interface';
attribute capacity : Types::Power;
}
part def Computer {
@'SysML v1 Profiles'::rov::Hardware { vendor = "Orbital Logic"; }
port 'in' : ~Types::'Power Interface';
part raw : Types::Charge {
@SysMLv1Library::PortData { isFullPort = true; }
}
}
}
package Requirements {
requirement <'R-1'> Mission {
doc /* The rover shall explore the landing site. */
}
requirement <'R-2'> 'Power Margin' {
doc /* Keep a 50 % power margin. */
}
connection : DerivationConnections::Derivation connect 'Power Margin' to Mission;
dependency from Structure::Computer to Structure::Battery {
@SysMLv1Library::TraceData { isTrace = true; }
}
}
}
package 'SysML v1 Profiles' {
package rov {
metadata def Hardware {
attribute qualified : ScalarValues::String;
attribute vendor : ScalarValues::String;
}
}
}
Was mit jedem Teil des v1-Modells geschah:
- Value Type mit Einheit. Power in Watt spezialisiert
ISQ::PowerValueder Standardbibliothek, und der Standardwert wird mit seiner Einheit geschrieben:120 [SI::W]. Ein Value Type, dessen Einheit keine zugeordnete SI-Einheit ist, bleibt eine reelle Zahl mit der Einheit in seiner Dokumentation und wird als angenähert gemeldet. - Blöcke und Properties. Blöcke werden zu
part defs und Part Properties zuparts. isEncapsulated des Blocks hat kein SysML-v2-Schlüsselwort und bleibt daher als MetadatenSysMLv1Library::BlockDataerhalten. - Interface Block und Ports. Der Interface Block wird zu einer
port def, deren Flow Properties gerichtete Features sind:out itemfür die blocktypisierte,out attributefür den Wert. Der konjugierte Proxy Port wird mit~Types::'Power Interface'typisiert. Der Full Port wird zu einem Part mit den MetadatenSysMLv1Library::PortData, weil ein SysML-v2-Port durch eine Port-Definition typisiert wird. - Connector und Item Flow. Der Connector wird zu einer
connectionzwischen den beiden Ports und der Item Flow darauf zu einemflowvon Charge zwischen denselben Ports. - Anforderungen. Jede Anforderung behält ihre ID als Kurznamen,
<'R-1'>, und ihren Text alsdoc. Die satisfy-Beziehung steht in dem Block, dem das erfüllende Part gehört; die derive-Beziehung wird zu einer Derivation Connection; der Trace wird zu einer Abhängigkeit mitSysMLv1Library::TraceData. - Der Benutzerstereotyp. «Hardware» wird zu einer
metadata defin einem Paket'SysML v1 Profiles', angewendet auf jeden Block mit seinen Tagged Values. Seine beiden Anwendungen werden als angenähert gemeldet: Tagged Values wurden zu Textattributen, unabhängig von ihrem Typ im Profil. - Die Assoziation. Eine Assoziation ohne Klasse hat hier keine Entsprechung in SysML v2, und ihr der Assoziation gehörendes Ende wird ebenfalls nicht konvertiert. Beide werden als ausgelassen gemeldet; die Properties an den Blöcken tragen die Struktur.
Der Bericht für dieses Modell: 31 Elemente, 27 konvertiert, 2 angenähert, 2 ausgelassen, und der Text wird ohne Fehler und ohne Warnungen geprüft. Namen, die keine einfachen Bezeichner sind, etwa 'power budget' oder 'out' (ein SysML-v2-Schlüsselwort), werden in Anführungszeichen gesetzt, damit sie ihre v1-Schreibweise behalten.
5. Nacharbeiten, was angenähert oder ausgelassen wurde
Gehen Sie die angenäherten und ausgelassenen Zeilen des Berichts nach Grund durch. Die meisten Gründe verlangen eine von wenigen Entscheidungen:
| Was der Bericht sagt | Was zu entscheiden ist |
|---|---|
| Ein Port ist durch einen Block typisiert, der kein Interface Block ist; er wurde zu einem Port ohne Typ | Definieren Sie eine Port-Definition mit den Features, die die Grenze überqueren, und typisieren Sie den Port damit. |
| Transitionen über eine Choice, einen Junction, Fork oder Join; jeder Pfad wurde zu einer Transition | Prüfen Sie, ob die zusammengeführten Guards noch sagen, was das v1-Diagramm meinte; vereinfachen Sie, wo die Pfade jetzt leichter zu lesen sind. |
| Ein Trigger bleibt als Dokumentation erhalten | Schreiben Sie Change- und Time-Trigger als SysML-v2-Trigger neu, wo die Bedeutung klar ist, etwa accept after einer Dauer. |
| Eine Einheit ist keine SI-Einheit, die Holarch zuordnet; der Value Type ist eine reelle Zahl | Entscheiden Sie, ob eine Standardgröße passt, oder behalten Sie die reelle Zahl und die dokumentierte Einheit. |
| Eine Aktionsart außer Call, Opaque oder Accept Action wurde zu einer einfachen Aktion | Schreiben Sie Sends und andere spezifische Aktionen mit der SysML-v2-Aktion neu, die dasselbe tut. |
| Activity Partitions werden nicht konvertiert | Sagen Sie mit perform im Part, welches Part was tut, statt mit einer Swimlane. |
| Es zeigt auf ein Element ohne Namen | Benennen Sie das Ziel im v1-Werkzeug und konvertieren Sie erneut, oder fügen Sie die Beziehung im v2-Modell hinzu. |
| Sein Name wird an derselben Stelle zweimal verwendet; mit einem Suffix umbenannt | Geben Sie jedem Element einen Namen, der sagt, was es ist. |
| Tagged Values wurden zu Textattributen der Metadaten | Geben Sie den Metadatenattributen die Typen, die sie brauchen, und vereinbaren Sie, was jeder Stereotyp jetzt bedeutet. |
Zwei Arten von Text brauchen einen Blick, auch wenn sie sauber konvertiert wurden. Opaque Bodies bleiben als textuelle Repräsentationen in ihrer Originalsprache erhalten, etwa language "OCL" /* … */; Holarch prüft nur Bodies in SysML oder KerML, schreiben Sie also einen Guard oder Constraint als SysML-Ausdruck neu, wo das Modell ihn auswerten soll. Und wörtliche Übersetzungen behalten v1-Behelfslösungen, etwa Property-spezifische Typen, die nur zum Setzen eines Werts angelegt wurden: In SysML v2 sind das einfache Redefinitionen an Usages. Was ein Umdenken erfordert listet die häufigen Fälle.
6. Die wichtigen Ansichten neu aufbauen
Diagramme und ihr Layout werden nicht konvertiert. Nehmen Sie die Liste der Diagramme aus Schritt 1 und legen Sie für jedes noch benötigte eine Ansicht an: eine General View für Struktur und Anforderungen, eine Interconnection View für Parts und Verbindungen, eine Action Flow View für Aktivitäten, eine State Transition View für Zustandsautomaten. Bauen Sie nur neu auf, was verwendet wird; das Modell enthält alles andere ohnehin. Siehe die Referenz zu Ansichten.
7. Das v2-Modell prüfen und reviewen
- Der Text wird sauber geprüft. Der Import zeigt die Prüfung des konvertierten Texts, bevor sich etwas ändert; nach Ihrer Nacharbeit markiert der Editor neue Probleme beim Tippen.
- Die Anzahlen stimmen. Vergleichen Sie einige Zahlen zwischen dem v1- und dem v2-Modell: Anforderungen, Parts, Ports, Verbindungen, Verifikationsbeziehungen. Ein Unterschied, den Sie nicht aus dem Bericht erklären können, verdient einen Blick.
- Wer das Modell verwendet, prüft es. Gehen Sie das Pilotpaket mit seinen Verantwortlichen durch, beginnend mit den angenäherten Elementen und den neu aufgebauten Ansichten.
- Entscheidungen festhalten. Schreiben Sie die Modellierungsmuster auf, auf die Sie sich für Ports, Trigger, Einheiten und Stereotypen geeinigt haben, damit der Rest der Migration ihnen folgt.
8. Den Rest konvertieren und umstellen
Konvertieren Sie die übrigen Pakete einzeln in dasselbe SysML-v2-Projekt. Jeder Import zeigt dieselbe Vorschau: Ein bereits im Projekt vorhandenes Paket erscheint als Geändert oder Unverändert, ein neues als Neu, und Sie wählen, welche Pakete importiert werden. Jeder Import ist ein Rückgängig-Schritt.
Behalten Sie das v1-Modell als Referenz, bis das v2-Modell geprüft ist, frieren Sie es dann ein und machen Sie das SysML-v2-Projekt zum maßgeblichen Modell. Ab diesem Zeitpunkt gehen Änderungen nur noch in das v2-Modell.
Migrations-Checkliste
- Pakete, Verantwortliche und die wichtigen Diagramme sind aufgelistet.
- Elemente, auf die Beziehungen zeigen, haben Namen.
- Die exportierte XMI-Datei liegt bei den Migrationsunterlagen.
- Ein Pilotpaket ist konvertiert, sein Bericht heruntergeladen, und jede angenäherte und ausgelassene Zeile hat eine Entscheidung.
- Modellierungsmuster für Ports, Trigger, Einheiten und Stereotypen sind aufgeschrieben.
- Benötigte Ansichten sind neu aufgebaut; der Text wird sauber geprüft.
- Die Anwender des Modells haben den Pilot geprüft.
- Die übrigen Pakete sind auf dieselbe Weise konvertiert, und das v1-Modell ist eingefroren.
Wie es weitergeht
- SysML v1 zu SysML v2 in Holarch: was der Konverter liest und schreibt, und das Beispiel CubeSat EO-1.
- SysML-v1-Modelle importieren: jeder Schritt, jede Zuordnung, Grenze und Meldung in der Dokumentation.
- SysML v1 und v2 im Vergleich: wie sich die beiden Sprachen unterscheiden.
- SysML-v2-Tutorial: ein Modell in der textuellen Notation aufbauen.
- Sprachabdeckung von SysML v2: was SysML-v2-Projekte unterstützen und die bekannten Lücken.
Cameo Systems Modeler, MagicDraw, Enterprise Architect, Rhapsody und Eclipse Papyrus sind Marken ihrer jeweiligen Inhaber. Holarch ist nicht mit ihnen verbunden und wird nicht von ihnen unterstützt.