Guide · SysML v2
Faire passer un modèle SysML v1 en SysML v2 : une migration pas à pas
Un modèle SysML v1 peut être converti automatiquement en SysML v2, mais une migration est plus qu'une conversion de fichier : quelqu'un doit décider à quoi le modèle converti doit ressembler et vérifier qu'il dit toujours ce que disait le modèle v1. Ce guide parcourt une migration en huit étapes, de l'inventaire du modèle v1 jusqu'à la bascule, avec un petit modèle converti et lu ligne par ligne.
Sur cette page
- Avant de commencer : une traduction, pas une mise à niveau
- 1. Faire l'inventaire du modèle v1
- 2. Exporter le modèle depuis l'outil SysML v1
- 3. Convertir un package pilote
- 4. Lire le rapport de conversion
- Un exemple détaillé : un petit modèle de rover
- 5. Retravailler ce qui a été approché ou laissé de côté
- 6. Reconstruire les vues qui comptent
- 7. Contrôler et revoir le modèle v2
- 8. Convertir le reste et basculer
- Liste de contrôle de la migration
- Pour aller plus loin
Avant de commencer : une traduction, pas une mise à niveau
SysML v2 est un nouveau langage, pas une nouvelle version du format de fichier SysML v1. Les blocs deviennent des définitions de part, les ports sont typés par des définitions de port, les exigences portent des conditions, et les diagrammes deviennent des vues que le modèle définit. SysML v1 et v2 explique les différences une à une.
Un convertisseur fait la partie mécanique : chaque élément qui a un équivalent SysML v2 est écrit en SysML v2, et le reste est signalé dans le rapport. Ce qu'un convertisseur ne peut pas faire, c'est décider comment votre équipe veut utiliser le nouveau langage. Planifiez la migration comme une tâche de modélisation avec un responsable, une revue et un moment où le modèle v2 devient la référence.
Ce guide utilise le convertisseur de Holarch, qui importe un modèle SysML 1.x dans un projet SysML v2 et classe chaque élément comme converti, approché ou laissé de côté. Les étapes de planification s'appliquent quel que soit le convertisseur utilisé.
1. Faire l'inventaire du modèle v1
Avant d'exporter quoi que ce soit, déterminez ce que contient le modèle et qui en dépend. Un court inventaire évite de reprendre du travail plus tard.
- Packages et responsables. Listez les packages de premier niveau, qui maintient chacun d'eux, et ceux auxquels d'autres modèles ou documents font référence. Les packages sont l'unité que vous allez convertir et revoir.
- Diagrammes qui comptent. Notez les diagrammes réellement utilisés dans les revues et les documents. Les dispositions de diagrammes ne sont pas reprises en SysML v2 ; ces diagrammes deviennent donc des vues à reconstruire.
- Profils et stéréotypes. Listez vos propres stéréotypes et leurs valeurs étiquetées. Ils deviennent des définitions de métadonnées, et leur signification dans le nouveau modèle doit être convenue de nouveau.
- Comportement écrit sous forme de code. Les comportements opaques, les gardes et les contraintes en OCL, dans un langage d'action ou dans le langage de script d'un outil sont conservés sous forme de texte dans leur langage d'origine ; ils ne sont pas traduits.
- Éléments sans nom. Les relations qui pointent vers des éléments sans nom ne peuvent pas être écrites en texte SysML v2, qui désigne les éléments par leur nom. Nommez dès maintenant, dans l'outil v1, les éléments vers lesquels vous tracez.
- Taille. Holarch convertit un fichier à la fois, jusqu'à 64 Mo et 250 000 éléments. Les modèles plus grands s'exportent un package à la fois.
2. Exporter le modèle depuis l'outil SysML v1
Le convertisseur lit le modèle à partir de XMI, le format d'échange qu'écrivent les outils SysML v1. Chaque outil l'exporte un peu différemment :
| Outil | Quoi importer |
|---|---|
| Cameo Systems Modeler, MagicDraw | Le fichier de projet .mdzip, ou File → Export To → Eclipse UML2 (v5.x) XMI File et le fichier .xmi |
| Enterprise Architect | Sélectionnez le package, Publish → Export XML, choisissez XMI 2.1 et importez le fichier .xml. Les fichiers de projet (.eap, .qea) ne sont pas lus directement. |
| IBM Rhapsody | Un export XMI 2.x depuis la boîte à outils XMI |
| Eclipse Papyrus | Le fichier .uml du modèle |
Conservez le fichier exporté avec les enregistrements de la migration : c'est l'entrée v1 exacte à laquelle votre revue se réfère.
3. Convertir un package pilote
Commencez par un package représentatif mais pas le plus grand : un sous-système avec de la structure, des interfaces, un peu de comportement et ses exigences. Le pilote montre à quoi ressemble la conversion de votre modèle avant que vous n'y engagiez toute l'équipe.
- Créez un projet SysML v2, ou ouvrez celui dans lequel le modèle converti doit aller, et cliquez sur Modèle → Importer et exporter.
- Sous Importer, choisissez Dans un nouveau projet SysML v2 pour un pilote, afin que rien d'autre ne soit touché.
- Déposez le fichier exporté dans la zone. Une carte de progression affiche les étapes : lecture du fichier XMI, conversion en SysML v2, contrôle du résultat.
Rien n'est encore importé. L'écran suivant est l'aperçu avec le rapport de conversion.
4. Lire le rapport de conversion
Conversion depuis SysML v1, en haut de l'aperçu, donne le nombre d'éléments convertis, approchés et laissés de côté, et indique si le texte SysML v2 se contrôle sans problème. Chaque élément du modèle v1 a un seul résultat :
- Converti : l'élément a un équivalent SysML v2 direct, comme un bloc qui devient une
part def. - Approché : l'élément est conservé sous une forme modifiée, par exemple une transition passant par un choix qui devient une transition par chemin. Ce sont les endroits où le sens peut différer du modèle v1.
- Laissé de côté : SysML v2 n'a pas d'équivalent, ou l'élément pointe vers quelque chose qui n'est pas dans le fichier.
Utilisez Afficher pour lister les éléments approchés et laissés de côté. Chaque ligne donne l'élément, son type SysML v1, ce qu'il est devenu avec son nom SysML v2, et pourquoi. Ouvrez Afficher le texte SysML v2 pour lire le résultat, et cliquez sur Télécharger le rapport pour conserver le rapport sous forme de fichier CSV. Le CSV est la liste de travail de l'étape 5 : triez-le par motif et attribuez un responsable à chaque groupe.
Un exemple détaillé : un petit modèle de rover
Un petit modèle SysML v1 de la chaîne de puissance d'un rover planétaire, en trois packages :
| Package | Éléments SysML v1 |
|---|---|
| Types | Un type de valeur Power avec l'unité W ; un bloc Charge ; un bloc d'interface Power Interface avec deux propriétés de flux sortantes, charge (un Charge) et voltage (un Real) |
| Structure | Un bloc encapsulé Rover avec les propriétés de part battery et computer, une propriété de valeur power budget de 120 W, un connecteur power bus entre leurs ports et un flux d'item power flow de Charge sur ce connecteur. Un bloc Battery avec un port proxy out ; un bloc Computer avec un port proxy conjugué in et un port complet raw. Les deux portent un stéréotype utilisateur «Hardware» avec des valeurs étiquetées. Une association dont l'extrémité appartient à l'association. |
| Exigences | Les exigences R-1 Mission et R-2 Power Margin ; R-2 dérivée de R-1 ; R-2 satisfaite par la part battery ; une trace de Computer vers Battery |
Une fois converti, il se lit ainsi. Le listing est la sortie du convertisseur, sans modification :
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;
}
}
}
Ce qu'est devenue chaque partie du modèle v1 :
- Type de valeur avec unité. Power en watts spécialise
ISQ::PowerValuede la bibliothèque standard, et la valeur par défaut est écrite avec son unité :120 [SI::W]. Un type de valeur dont l'unité n'est pas une unité SI prise en charge reste un nombre réel, avec l'unité dans sa documentation, et est signalé comme approché. - Blocs et propriétés. Les blocs deviennent des
part defet les propriétés de part despart. L'attribut isEncapsulated du bloc n'a pas de mot-clé SysML v2 ; il est donc conservé sous forme de métadonnéesSysMLv1Library::BlockData. - Bloc d'interface et ports. Le bloc d'interface devient une
port defdont les propriétés de flux sont des features orientées :out itempour celle typée par un bloc,out attributepour la valeur. Le port proxy conjugué est typé~Types::'Power Interface'. Le port complet devient une part avec des métadonnéesSysMLv1Library::PortData, car un port SysML v2 est typé par une définition de port. - Connecteur et flux d'item. Le connecteur devient une
connectionentre les deux ports, et le flux d'item qui le parcourt unflowde Charge entre les mêmes ports. - Exigences. Chaque exigence conserve son identifiant comme nom court,
<'R-1'>, et son texte commedoc. La relation satisfy se trouve dans le bloc qui possède la part qui satisfait l'exigence ; la relation derive devient une connexion de dérivation ; la trace devient une dépendance avecSysMLv1Library::TraceData. - Le stéréotype utilisateur. «Hardware» devient une
metadata defdans un package'SysML v1 Profiles', appliquée à chaque bloc avec ses valeurs étiquetées. Ses deux applications sont signalées comme approchées : les valeurs étiquetées sont devenues des attributs texte, quel que soit leur type dans le profil. - L'association. Une association sans classe n'a pas d'équivalent SysML v2 ici, et son extrémité possédée par l'association n'est pas convertie non plus. Les deux sont signalées comme laissées de côté ; les propriétés des blocs portent la structure.
Le rapport pour ce modèle : 31 éléments, 27 convertis, 2 approchés, 2 laissés de côté, et le texte se contrôle sans erreur ni avertissement. Les noms qui ne sont pas de simples identifiants, comme 'power budget' ou 'out' (un mot-clé SysML v2), sont mis entre apostrophes pour conserver leur graphie v1.
5. Retravailler ce qui a été approché ou laissé de côté
Parcourez les lignes approchées et laissées de côté du rapport par motif. La plupart des motifs appellent l'une de quelques décisions :
| Ce que dit le rapport | Ce qu'il faut décider |
|---|---|
| Un port est typé par un bloc qui n'est pas un bloc d'interface ; il est devenu un port sans type | Définissez une définition de port avec les features qui traversent la frontière, et typez le port avec elle. |
| Transitions passant par un choix, une jonction, une bifurcation ou une réunion ; chaque chemin est devenu une transition | Vérifiez que les gardes combinées disent toujours ce que voulait dire le diagramme v1 ; simplifiez là où les chemins sont désormais plus lisibles. |
| Un déclencheur est conservé comme documentation | Réécrivez les déclencheurs de changement et de temps sous forme de déclencheurs SysML v2 lorsque le sens est clair, comme accept after une durée. |
| Une unité n'est pas une unité SI que Holarch fait correspondre ; le type de valeur est un nombre réel | Décidez si une grandeur standard convient, ou conservez le nombre réel et l'unité documentée. |
| Une action d'un type autre que call, opaque ou accept est devenue une action simple | Réécrivez les envois et autres actions spécifiques avec l'action SysML v2 qui fait la même chose. |
| Les partitions d'activité ne sont pas converties | Indiquez quelle part fait quoi avec perform dans la part, au lieu d'un couloir. |
| Il pointe vers un élément sans nom | Nommez la cible dans l'outil v1 et convertissez de nouveau, ou ajoutez la relation dans le modèle v2. |
| Son nom est utilisé deux fois au même endroit ; renommé avec un suffixe | Donnez à chaque élément un nom qui dit ce qu'il est. |
| Les valeurs étiquetées sont devenues des attributs texte des métadonnées | Donnez aux attributs de métadonnées les types dont ils ont besoin, et convenez de ce que signifie désormais chaque stéréotype. |
Deux sortes de texte méritent un examen même lorsqu'elles ont été converties sans problème. Les corps opaques sont conservés sous forme de représentations textuelles dans leur langage d'origine, comme language "OCL" /* … */ ; Holarch ne contrôle que les corps écrits en SysML ou en KerML, donc réécrivez une garde ou une contrainte sous forme d'expression SysML là où le modèle doit l'évaluer. Par ailleurs, les traductions littérales conservent les contournements de v1, comme les types propres à une propriété créés uniquement pour fixer une valeur : en SysML v2, ce sont de simples redéfinitions sur des usages. Ce qui doit être repensé liste les cas fréquents.
6. Reconstruire les vues qui comptent
Les diagrammes et leur disposition ne sont pas convertis. Reprenez la liste des diagrammes de l'étape 1 et créez une vue pour chacun de ceux qui sont encore nécessaires : une vue générale pour la structure et les exigences, une vue d'interconnexion pour les parts et les connexions, une vue de flux d'action pour les activités, une vue des transitions d'état pour les machines à états. Ne reconstruisez que ce que les gens utilisent ; le modèle contient tout le reste de toute façon. Voir la référence des vues.
7. Contrôler et revoir le modèle v2
- Le texte se contrôle sans problème. L'import affiche le contrôle du texte converti avant toute modification ; après votre reprise, l'Éditeur signale tout nouveau problème pendant la saisie.
- Les décomptes correspondent. Comparez quelques chiffres entre le modèle v1 et le modèle v2 : exigences, parts, ports, connexions, relations de vérification. Une différence que le rapport n'explique pas mérite un examen.
- Les utilisateurs du modèle le revoient. Parcourez le package pilote avec ses responsables, en commençant par les éléments approchés et les vues reconstruites.
- Consignez les décisions. Notez les conventions de modélisation retenues pour les ports, les déclencheurs, les unités et les stéréotypes, afin que le reste de la migration les suive.
8. Convertir le reste et basculer
Convertissez les packages restants un par un, dans le même projet SysML v2. Chaque import affiche le même aperçu : un package déjà présent dans le projet apparaît comme Modifié ou Inchangé, un nouveau comme Nouveau, et vous choisissez quels packages importer. Chaque import est une seule étape d'annulation.
Conservez le modèle v1 comme référence jusqu'à ce que le modèle v2 ait été revu, puis gelez-le et faites du projet SysML v2 le modèle de référence officiel. À partir de là, les modifications vont uniquement dans le modèle v2.
Liste de contrôle de la migration
- Les packages, leurs responsables et les diagrammes qui comptent sont listés.
- Les éléments vers lesquels pointent des relations ont un nom.
- Le fichier XMI exporté est conservé avec les enregistrements de la migration.
- Un package pilote est converti, son rapport téléchargé, et chaque ligne approchée ou laissée de côté a une décision.
- Les conventions de modélisation pour les ports, les déclencheurs, les unités et les stéréotypes sont consignés.
- Les vues nécessaires sont reconstruites ; le texte se contrôle sans problème.
- Les utilisateurs du modèle ont revu le pilote.
- Les packages restants sont convertis de la même façon, et le modèle v1 est gelé.
Pour aller plus loin
- De SysML v1 à SysML v2 dans Holarch : ce que le convertisseur lit et écrit, et l'exemple du CubeSat EO-1.
- Importer des modèles SysML v1 : chaque étape, correspondance, limite et message dans la documentation.
- SysML v1 et v2 : en quoi les deux langages diffèrent.
- Tutoriel SysML v2 : construire un modèle dans la notation textuelle.
- Couverture du langage SysML v2 : ce que prennent en charge les projets SysML v2 et les lacunes connues.
Cameo Systems Modeler, MagicDraw, Enterprise Architect, Rhapsody et Eclipse Papyrus sont des marques de leurs propriétaires respectifs. Holarch n'est ni affilié à eux ni approuvé par eux.