Guia · SysML v2
Levar um modelo SysML v1 para SysML v2: uma migração passo a passo
Um modelo SysML v1 pode ser convertido para SysML v2 automaticamente, mas uma migração é mais que a conversão de um arquivo: alguém precisa decidir como o modelo convertido deve ficar e checar se ele ainda diz o que o modelo v1 dizia. Este guia percorre uma migração em oito etapas, do inventário do modelo v1 até a troca, com um modelo pequeno convertido e lido linha por linha.
Nesta página
- Antes de começar: uma tradução, não uma atualização
- 1. Faça o inventário do modelo v1
- 2. Exporte o modelo da ferramenta SysML v1
- 3. Converta um pacote piloto
- 4. Leia o relatório de conversão
- Um exemplo prático: um pequeno modelo de rover
- 5. Retrabalhe o que foi aproximado ou deixado de fora
- 6. Reconstrua as visões que importam
- 7. Cheque e revise o modelo v2
- 8. Converta o resto e faça a troca
- Checklist de migração
- Para onde ir a seguir
Antes de começar: uma tradução, não uma atualização
A SysML v2 é uma linguagem nova, não uma nova versão do formato de arquivo da SysML v1. Blocos se tornam definições de partes, portas são tipadas por definições de portas, requisitos têm condições, e diagramas se tornam visões que o modelo define. SysML v1 vs v2 explica as diferenças uma a uma.
Um conversor faz a parte mecânica: todo elemento que tem uma contrapartida em SysML v2 é escrito em SysML v2, e o resto é relatado. O que um conversor não pode fazer é decidir como sua equipe quer usar a nova linguagem. Planeje a migração como uma tarefa de modelagem com um responsável, uma revisão e um ponto em que o modelo v2 passa a ser a referência.
Este guia usa o conversor do Holarch, que importa um modelo SysML 1.x para um projeto SysML v2 e relata cada elemento como convertido, aproximado ou deixado de fora. As etapas de planejamento valem para qualquer conversor que você use.
1. Faça o inventário do modelo v1
Antes de exportar qualquer coisa, descubra o que o modelo contém e quem depende dele. Um inventário curto evita retrabalho depois.
- Pacotes e responsáveis. Liste os pacotes de nível mais alto, quem mantém cada um e quais deles outros modelos ou documentos referenciam. Os pacotes são a unidade que você vai converter e revisar.
- Diagramas que importam. Anote os diagramas que as pessoas realmente usam em revisões e documentos. Os layouts dos diagramas não passam para a SysML v2, então eles se tornam visões que você reconstrói.
- Perfis e estereótipos. Liste seus próprios estereótipos e seus valores marcados. Eles se tornam definições de metadados, e seu significado no novo modelo precisa ser acordado de novo.
- Comportamento escrito como código. Comportamentos opacos, guardas e restrições em OCL, em uma linguagem de ações ou na linguagem de script de uma ferramenta são mantidos como texto na linguagem original; eles não são traduzidos.
- Elementos sem nome. Relacionamentos que apontam para elementos sem nome não podem ser escritos em texto SysML v2, que se refere aos elementos pelo nome. Dê nome agora, na ferramenta v1, aos elementos até os quais você rastreia.
- Tamanho. O Holarch converte um arquivo de até 64 MB e 250.000 elementos por vez. Modelos maiores são exportados um pacote por vez.
2. Exporte o modelo da ferramenta SysML v1
O conversor lê o modelo a partir de XMI, o formato de troca que as ferramentas SysML v1 gravam. Cada ferramenta o exporta de um jeito um pouco diferente:
| Ferramenta | O que importar |
|---|---|
| Cameo Systems Modeler, MagicDraw | O arquivo de projeto .mdzip, ou File → Export To → Eclipse UML2 (v5.x) XMI File e o arquivo .xmi |
| Enterprise Architect | Selecione o pacote, Publish → Export XML, escolha XMI 2.1 e importe o arquivo .xml. Os arquivos de projeto (.eap, .qea) não são lidos diretamente. |
| IBM Rhapsody | Uma exportação XMI 2.x a partir do XMI toolkit |
| Eclipse Papyrus | O arquivo .uml do modelo |
Guarde o arquivo exportado com os registros da migração: ele é a entrada v1 exata a que sua revisão se refere.
3. Converta um pacote piloto
Comece com um pacote que seja representativo, mas não o maior: um subsistema com estrutura, interfaces, algum comportamento e seus requisitos. O piloto mostra como fica a conversão do seu modelo antes de você comprometer a equipe inteira com ela.
- Crie um projeto SysML v2, ou abra aquele em que o modelo convertido deve entrar, e clique em Modelo → Importar e exportar.
- Em Importar, escolha Em um projeto SysML v2 novo para um piloto, para que nada mais seja afetado.
- Solte o arquivo exportado na caixa. Um cartão de progresso mostra as etapas: leitura do arquivo XMI, conversão para SysML v2, checagem do resultado.
Nada foi importado ainda. A próxima tela é a prévia com o relatório de conversão.
4. Leia o relatório de conversão
Conversão do SysML v1, no topo da prévia, dá o número de elementos convertidos, aproximados e deixados de fora, e se o texto SysML v2 é checado sem problemas. Cada elemento do modelo v1 tem um resultado:
- Convertido: o elemento tem uma contrapartida direta em SysML v2, como um bloco que se torna uma
part def. - Aproximado: o elemento é mantido de forma alterada, por exemplo uma transição por um choice que se torna uma transição por caminho. Esses são os pontos em que o significado pode diferir do modelo v1.
- Deixado de fora: a SysML v2 não tem contrapartida, ou o elemento aponta para algo que não está no arquivo.
Use Mostrar para listar os elementos aproximados e deixados de fora. Cada linha dá o elemento, seu tipo em SysML v1, aquilo em que ele se tornou com seu nome em SysML v2, e o motivo. Abra Mostrar o texto SysML v2 para ler o resultado, e clique em Baixar relatório para guardar o relatório como arquivo CSV. O CSV é a lista de trabalho da etapa 5: ordene-o por motivo e dê um responsável a cada grupo.
Um exemplo prático: um pequeno modelo de rover
Um pequeno modelo SysML v1 do caminho de energia de um rover planetário, em três pacotes:
| Pacote | Elementos SysML v1 |
|---|---|
| Types | Um value type Power com a unidade W; um bloco Charge; um interface block Power Interface com duas flow properties de saída, charge (um Charge) e voltage (um Real) |
| Estrutura | Um bloco encapsulado Rover com as part properties battery e computer, uma value property power budget de 120 W, um conector power bus entre suas portas e um item flow power flow de Charge sobre ele. Um bloco Battery com uma proxy port out; um bloco Computer com uma proxy port conjugada in e uma full port raw. Ambos levam um estereótipo de usuário «Hardware» com tagged values. Uma associação cuja extremidade pertence à própria associação. |
| Requisitos | Requisitos R-1 Mission e R-2 Power Margin; R-2 derivado de R-1; R-2 satisfeito pela parte battery; um trace de Computer para Battery |
Convertido, ele fica assim. A listagem é a saída do conversor, sem alterações:
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;
}
}
}
O que aconteceu com cada parte do modelo v1:
- Value type com unidade. Power em watts especializa o
ISQ::PowerValueda biblioteca padrão, e o valor padrão é escrito com sua unidade:120 [SI::W]. Um value type cuja unidade não é uma unidade SI mapeada continua sendo um número real, com a unidade na documentação, e é relatado como aproximado. - Blocos e propriedades. Blocos se tornam
part defs e part properties se tornamparts. O isEncapsulated do bloco não tem palavra-chave em SysML v2, então é mantido como metadadoSysMLv1Library::BlockData. - Interface block e portas. O interface block se torna uma
port defcujas flow properties são features direcionadas:out itempara a que é tipada por bloco,out attributepara o valor. A proxy port conjugada é tipada~Types::'Power Interface'. A full port se torna uma parte com o metadadoSysMLv1Library::PortData, porque uma porta SysML v2 é tipada por uma definição de porta. - Conector e item flow. O conector se torna uma
connectionentre as duas portas, e o item flow sobre ele umflowde Charge entre as mesmas portas. - Requisitos. Cada requisito mantém seu id como nome curto,
<'R-1'>, e seu texto comodoc. O relacionamento satisfy fica no bloco dono da parte que satisfaz; o relacionamento derive se torna uma conexão de derivação; o trace se torna uma dependência comSysMLv1Library::TraceData. - O estereótipo de usuário. «Hardware» se torna uma
metadata defem um pacote'SysML v1 Profiles', aplicada a cada bloco com seus tagged values. Suas duas aplicações são relatadas como aproximadas: os valores das tags viraram atributos de texto, qualquer que fosse seu tipo no perfil. - A associação. Uma associação sem classe não tem contrapartida em SysML v2 aqui, e sua extremidade pertencente à associação também não é convertida. Ambas são relatadas como deixadas de fora; as propriedades nos blocos carregam a estrutura.
O relatório deste modelo: 31 elementos, 27 convertidos, 2 aproximados, 2 deixados de fora, e o texto é checado sem erros nem avisos. Nomes que não são identificadores simples, como 'power budget' ou 'out' (uma palavra-chave da SysML v2), ficam entre aspas para manter a grafia da v1.
5. Retrabalhe o que foi aproximado ou deixado de fora
Percorra as linhas aproximadas e deixadas de fora do relatório por motivo. A maioria dos motivos pede uma de poucas decisões:
| O que o relatório diz | O que decidir |
|---|---|
| Uma porta é tipada por um bloco que não é um interface block; ela virou uma porta sem tipo | Defina uma definição de porta com as features que cruzam a fronteira e tipe a porta com ela. |
| Transições por choice, junction, fork ou join; cada caminho virou uma transição | Cheque se as guardas combinadas ainda dizem o que o diagrama v1 queria dizer; simplifique onde os caminhos agora estão mais fáceis de ler. |
| Um trigger é mantido como documentação | Reescreva change triggers e time triggers como triggers SysML v2 onde o significado for claro, como accept after uma duração. |
| Uma unidade não é uma unidade SI que o Holarch mapeia; o value type é um número real | Decida se uma grandeza padrão serve, ou mantenha o número real e a unidade documentada. |
| Um tipo de ação diferente de call, opaque ou accept action virou uma ação simples | Reescreva sends e outras ações específicas com a ação SysML v2 que faz o mesmo. |
| Activity partitions não são convertidas | Diga qual parte faz o quê com perform na parte, em vez de uma raia. |
| Ele aponta para um elemento sem nome | Dê nome ao alvo na ferramenta v1 e converta de novo, ou acrescente o relacionamento no modelo v2. |
| Seu nome é usado duas vezes no mesmo lugar; renomeado com um sufixo | Dê a cada elemento um nome que diga o que ele é. |
| Os tagged values viraram atributos de texto do metadado | Dê aos atributos do metadado os tipos de que precisam e combine o que cada estereótipo significa agora. |
Dois tipos de texto merecem atenção mesmo quando foram convertidos sem problemas. Corpos opacos são mantidos como representações textuais na linguagem original, como language "OCL" /* … */; o Holarch checa só corpos escritos em SysML ou KerML, então reescreva uma guarda ou restrição como expressão SysML onde o modelo deve avaliá-la. E traduções literais mantêm gambiarras da v1, como tipos específicos de propriedade criados só para definir um valor: em SysML v2 eles são simples redefinições em usages. O que precisa ser repensado lista os casos comuns.
6. Reconstrua as visões que importam
Diagramas e seus layouts não são convertidos. Pegue a lista de diagramas da etapa 1 e crie uma visão para cada um que ainda for necessário: uma visão geral para estrutura e requisitos, uma visão de interconexão para partes e conexões, uma visão de fluxo de ações para atividades, uma visão de transição de estados para máquinas de estados. Reconstrua só o que as pessoas usam; o modelo guarda todo o resto de qualquer forma. Veja a referência de visões.
7. Cheque e revise o modelo v2
- O texto é checado sem problemas. A importação mostra a checagem do texto convertido antes de qualquer mudança; depois do seu retrabalho, o Editor marca qualquer problema novo enquanto você digita.
- As contagens batem. Compare alguns números entre o modelo v1 e o modelo v2: requisitos, partes, portas, conexões, relacionamentos de verificação. Uma diferença que você não consegue explicar pelo relatório merece uma olhada.
- As pessoas que usam o modelo o revisam. Percorra o pacote piloto com seus responsáveis, começando pelos elementos aproximados e pelas visões reconstruídas.
- Registre as decisões. Anote os padrões de modelagem que vocês adotaram para portas, triggers, unidades e estereótipos, para que o resto da migração os siga.
8. Converta o resto e faça a troca
Converta os pacotes restantes um por vez, no mesmo projeto SysML v2. Cada importação mostra a mesma prévia: um pacote que já está no projeto aparece como Alterado ou Inalterado, um novo como Novo, e você escolhe quais pacotes importar. Cada importação é uma etapa de desfazer.
Mantenha o modelo v1 como referência até o modelo v2 ser revisado; depois congele-o e faça do projeto SysML v2 o modelo de referência oficial. A partir daí, as mudanças entram só no modelo v2.
Checklist de migração
- Os pacotes, os responsáveis e os diagramas que importam estão listados.
- Os elementos para os quais relacionamentos apontam têm nome.
- O arquivo XMI exportado está guardado com os registros da migração.
- Um pacote piloto foi convertido, seu relatório foi baixado, e cada linha aproximada ou deixada de fora tem uma decisão.
- Os padrões de modelagem para portas, triggers, unidades e estereótipos estão anotados.
- As visões necessárias foram reconstruídas; o texto é checado sem problemas.
- Os usuários do modelo revisaram o piloto.
- Os pacotes restantes foram convertidos do mesmo jeito, e o modelo v1 está congelado.
Para onde ir a seguir
- SysML v1 para SysML v2 no Holarch: o que o conversor lê e escreve, e o exemplo do CubeSat EO-1.
- Importar modelos SysML v1: cada etapa, mapeamento, limite e mensagem na Docs.
- SysML v1 vs v2: como as duas linguagens diferem.
- Tutorial de SysML v2: construa um modelo na notação textual.
- Cobertura da linguagem SysML v2: o que os projetos SysML v2 suportam e as lacunas conhecidas.
Cameo Systems Modeler, MagicDraw, Enterprise Architect, Rhapsody e Eclipse Papyrus são marcas registradas de seus respectivos proprietários. O Holarch não é afiliado a eles nem endossado por eles.