Modelo
Esquema e extensões
Adapte o esquema LML de um projeto com classes, atributos, opções, relações, rótulos e fluxos de status personalizados, e veja como cada mudança afeta os dados existentes.
Nesta página
- Visão geral
- Conceitos
- Como usá-lo
- Quando e por quê
- Adicionar um atributo a uma classe
- Adicionar opções a um atributo existente
- Criar uma subclasse
- Adicionar um rótulo
- Permitir um novo relacionamento
- Definir um fluxo de trabalho de status
- Adicionar ou alterar os estados de um fluxo de trabalho
- Escolher os aprovadores de uma transição
- Solicitar aprovação para uma mudança de estado
- Compartilhar um esquema entre projetos
- Exemplo prático: CubeSat EO-1
- Dicas e boas práticas
- Erros comuns
- Como se conecta a outros recursos
- O Editor de esquema
- Como as mudanças no esquema afetam os dados existentes
- Extensões nativas
- Atalhos de teclado
- Opções e ajustes
- Mensagens
- Limites
- Relacionado
Visão geral
O esquema define o que o modelo de um projeto pode conter:
- as classes de entidades,
- os atributos que cada classe tem,
- as relações que podem ligar classes,
- os rótulos que marcam entidades,
- fluxos de trabalho opcionais: os estados de um atributo de status por classe, como eles podem mudar e quais mudanças exigem aprovação.
Todo projeto parte do esquema padrão da Lifecycle Modeling Language (LML). O Editor de esquema o altera apenas para um projeto. A primeira edição cria a cópia própria do projeto, então os outros projetos não são afetados. Cada edição do esquema pode ser revertida com um único Desfazer.
O Holarch também acrescenta extensões nativas a todo projeto, como Prioridade e Responsável nos requisitos e Estratégia de tratamento nos riscos. Consulte Extensões nativas.
Para trabalhar com entidades, atributos e relacionamentos no dia a dia, consulte Modelo e banco de dados.
Conceitos
O esquema do projeto
- Esquema padrão: as classes, relações, atributos e rótulos LML com que o Holarch é fornecido. Os tópicos da Ajuda do aplicativo Classes da LML (esquema), Relacionamentos da LML (esquema) e Rótulos (esquema) os listam ao vivo para o projeto aberto.
- Esquema do projeto: uma cópia guardada dentro do projeto. Ela é criada na primeira edição. Ela acompanha o projeto nas exportações e chega a todo membro que o abre.
- Extensões nativas: acréscimos de que os recursos do Holarch precisam. Elas são aplicadas pelo nome cada vez que um projeto abre. Por isso a maioria dos projetos já tem sua própria cópia, e a página Uso diz "Este projeto usa seu próprio esquema editado."
Turmas
Uma classe é um tipo de entidade, como Requirement ou Asset. Ela tem um Nome, uma Descrição, um Pai e uma Cor, e dois indicadores (Abstrata e Oculta).
- Pai: uma subclasse herda os atributos e os destinos de relação da classe pai. Ela aparece em toda consulta, filtro e diagrama que abrange a classe pai. Por exemplo, uma subclasse personalizada de Action recebe diagramas de ações. Uma subclasse personalizada de Requirement recebe as checagens de qualidade e os controles de aprovação.
- Abstrata: a classe agrupa subclasses e não pode ser criada diretamente.
- Oculta: a classe não é oferecida quando você cria entidades ou muda a classe delas. Ela e suas subclasses ficam de fora do filtro de classes do Banco de dados. As entidades existentes permanecem.
- Cor: a cor do selo e da amostra da classe. Sem uma cor, uma classe personalizada assume a cor do seu ancestral nativo mais próximo. O selo mostra as duas primeiras letras do nome.
Atributos
Um atributo é um campo que toda entidade de uma classe tem, como Prioridade nos requisitos. Um atributo também pode pertencer a uma relação.
Um atributo tem um Nome, um Tipo e um lugar na ordem da classe. Ele pode ter Valores permitidos, um Valor padrão e uma Descrição. A descrição aparece quando você aponta para o rótulo do atributo.
Tipos, agrupados como a caixa de diálogo de atributo os lista (o id do tipo guardado está entre colchetes; exportações, importações e a API o usam):
| Grupo | Tipo | Contém |
|---|---|---|
| Texto | Texto curto (TEXT), Texto longo (BIG_TEXT), Texto formatado (HTML) | Uma linha; várias linhas; texto formatado |
| Números | Número (NUMBER), Porcentagem (PERCENT), Duração (DURATION) | Um número ou uma distribuição; de 0 a 100; um número ou uma distribuição com unidade de tempo |
| Data e hora | Data e hora (DATETIME) | Data e hora |
| Escolhas | Um de uma lista (ENUMERATION), Vários de uma lista (MULTISELECT), Sim ou não (BOOLEAN) | Um valor; vários valores; Sim ou Não |
| Links | Endereço web (URI), Arquivo (FILE) | Um link; um arquivo enviado |
| Especial | Localização (GEOPOINT), Equação (EQUATION), Calculado (COMPUTABLE), Pessoa ou equipe (USER_TEAM), Multiplicidade (MULTIPLICITY), Verificação de qualidade (QUALITY) | Latitude e longitude; texto LaTeX; um valor calculado a partir de atributos de outras entidades; o nome de uma pessoa ou equipe; n, n..m, n..* ou *; um critério Sim/Não definido pela checagem de qualidade |
Os editores de cada tipo estão descritos em Tipos de atributos e editores.
Os atributos herdados das classes pai são listados primeiro, depois os atributos próprios da classe, na ordem definida na página de cada classe (arraste uma linha, ou use ↑ / ↓). Um atributo novo vai para o fim.
Um atributo oculto mantém seus valores. Ele some dos editores, filtros, colunas, pesquisas e relatórios até ser mostrado de novo.
Relações e destinos
- Uma relação é sempre um par: um nome e um nome inverso, como satisfies / satisfied by. Criar uma cria as duas.
- Um destino permite uma relação de uma classe para outra, por exemplo Requirement verified by Test Case. Um destino para uma classe também permite suas subclasses. As subclasses herdam os destinos da classe pai.
- As relações podem ter atributos, por exemplo Multiplicidade em decomposed by. Um atributo acrescentado a uma relação também se aplica à sua inversa.
- Uma relação oculta aparece esmaecida no Editor de esquema e fica de fora da lista de referência da Ajuda. Ela continua utilizável.
Rótulos
Um rótulo é uma marcação que você coloca em entidades, como Necessidade do stakeholder. Ele não acrescenta campos nem muda nada estrutural.
Um rótulo tem um Nome, uma Descrição e a(s) Classe(s) a que se aplica. Ele pode ter um rótulo Pai, de modo que os rótulos podem se aninhar.
- Sem classe selecionada, o rótulo se aplica a todas as classes.
- Um rótulo para uma classe também se aplica às suas subclasses.
- Um rótulo oculto permanece nas entidades que o têm, mas não é mais oferecido.
Fluxos de trabalho
Um fluxo de trabalho controla como um atributo ENUMERATION de uma classe pode mudar, em geral o Status. Ele tem:
- Estados: os valores que a classe usa, em ordem. Você pode adicionar, renomear, reordenar e remover estados personalizados. Os estados nativos, como o Approved de um requisito, só podem ser desativados. Uma subclasse cujo atributo é herdado (por exemplo um Software Requirement sob Requirement) mantém seus próprios estados.
- Transições (De → Para): as mudanças permitidas. Sem transições, qualquer estado pode seguir qualquer outro.
- Aprovação em uma transição: a mudança exige uma solicitação de mudança aprovada. Por padrão, decidem os aprovadores definidos em Solicitações de mudança → Ajustes. Uma transição pode nomear seus próprios aprovadores: proprietários, editores ou pessoas nomeadas, e quantos deles precisam aprovar (até 5, ou todas as pessoas nomeadas).
- Bloquear o item após esta transição (no menu ⋯ da transição): o item é bloqueado após a mudança.
Os editores do atributo passam então a oferecer apenas o valor atual e os próximos estados permitidos. Um estado que exige aprovação aparece como (exige aprovação).
Como usá-lo
Quando e por quê
Adapte o esquema no início de um projeto: quando você define o método de modelagem e antes de importar dados. Motivos típicos:
- Adotar um método ou uma norma: adicione os atributos que seu processo exige, por exemplo um TRL nos assets ou um Safety Integrity Level nos requisitos. Adicione os rótulos que seus modelos de documento esperam.
- Especializar classes: adicione subclasses como Hazard sob Risk ou Payload Instrument sob Asset. Consultas, filtros e relatórios conseguem então distingui-las, e elas mantêm todos os relacionamentos LML.
- Permitir um relacionamento de que o método precisa: adicione um destino ou um novo par de relações.
- Impor um processo de revisão: adicione um fluxo de trabalho para que o Status de um requisito passe de Draft → In Review → Approved. O editor então nunca o deixa pular uma etapa. Marque In Review → Approved como Aprovação para que a passagem siga pelos aprovadores do projeto.
- Reutilizar entre projetos: exporte o esquema de um projeto e importe-o no seguinte.
O esquema responde à pergunta "O que este modelo pode dizer?". Altere-o com intenção. Consultas, colunas salvas, relatórios e importações se referem a classes, atributos e relações pelo nome.
Adicionar um atributo a uma classe
- Na barra de navegação, clique em Ajustes → Esquema (com as ferramentas na parte inferior).
- Na barra lateral, em Classes, clique na classe, por exemplo Asset.
- No cartão Atributos, clique em + Atributo.
- Digite o Nome.
- Escolha o Tipo, por exemplo Um de uma lista em Opções.
- Para Um de uma lista ou Vários de uma lista: digite as opções em Valores permitidos, uma por linha.
- Opcional: defina um Valor padrão. As entidades novas da classe começam com ele.
- Opcional: digite uma Descrição.
- Clique em Adicionar atributo.
Você vê a notificação "Atributo salvo". O atributo fica por último na lista da classe e aparece para essa classe e suas subclasses: no inspetor, na Visão do item, nas colunas e filtros do Banco de dados, nas pesquisas, nos relatórios e nos mapeamentos de importação.
- Para movê-lo, arraste sua linha na tabela Atributos ou use ↑ e ↓ na linha. Cada movimento pode ser revertido com um único Desfazer.
Adicionar opções a um atributo existente
- Abra a classe que define o atributo. A coluna Definido em a mostra. Um atributo herdado é editado na classe que o define.
- Clique em ✎ (Editar atributo) na linha.
- Adicione a nova opção em uma linha própria em Valores permitidos.
- Clique em Salvar.
Para Um de uma lista, o quadrado antes de cada opção (abaixo da lista) define a cor do valor. Os quadros Kanban cujas colunas são os valores desse atributo a usam como cor da coluna.
Para remover uma opção, exclua sua linha no mesmo diálogo. As entidades que já têm esse valor o mantêm, mas o editor deixa de oferecê-lo. Antes de remover uma opção, encontre essas entidades com uma consulta de atributo (por exemplo Requirement:"Priority=Urgent") e dê a elas uma opção atual.
Criar uma subclasse
- Abra a classe pai.
- Clique em + Subclasse.
(Ou clique em + Classe na barra lateral e escolha o Pai.)
- Insira o Nome e a Descrição.
- Defina Abstrata, Oculta e Cor, se necessário.
- Clique em Criar classe.
Você vê a nova classe. Ela já tem todos os atributos e destinos herdados.
Para mover entidades existentes para a nova classe, selecione-as no Banco de dados e use Alterar classe…. Veja Alterar classe.
Adicionar um rótulo
- Clique em + Rótulo na barra lateral, ou em + Novo rótulo na página Rótulos.
- Insira o Nome e a Descrição.
- Se o rótulo pertence a outro rótulo, escolha esse Pai.
- Selecione a(s) Classe(s) à(s) qual(is) ele se aplica. ⌘ / Ctrl/Ctrl+clique seleciona várias. Sem nenhuma selecionada, o rótulo se aplica a todas as classes.
- Clique em Criar rótulo.
Para aplicar o rótulo, use + Rótulo no inspetor ou na Visão do item, ou Rótulo ▾ na barra de ações em massa do Banco de dados.
Permitir um novo relacionamento
Um relacionamento entre duas classes só é permitido quando um destino o permite. Adicione um destino para permiti-lo.
- Abra a classe de origem.
- Em Relações, clique em + Relação.
- Escolha a Relação.
- Escolha a Outra classe.
- Mantenha Adicionar também a relação inversa à outra classe marcada. O vínculo pode então ser feito a partir de qualquer extremidade.
- Clique em Adicionar relação.
Se a outra classe não tiver a inversa, a coluna Voltar para esta classe mostra + em <class>: clique nele para adicionar a inversa lá.
Se a relação de que você precisa não existir, crie-a primeiro:
- Clique em Novo tipo de relação… no diálogo (ou em + Relação na barra lateral).
- Insira o Nome e o Nome inverso, e suas descrições.
- Clique em Criar relação.
- Escolha a nova relação no passo 3 acima.
Definir um fluxo de trabalho de status
- Clique em Fluxo de trabalho na barra lateral.
- Em Adicionar uma classe…, escolha a classe.
Você vê um cartão para a classe. O fluxo de trabalho monitora o primeiro atributo de enumeração da classe.
- Se necessário, escolha outro atributo na lista monitora. Alterá-lo limpa as transições.
- Clique em + Adicionar transição.
- Defina o Nome, De e Para da transição. De é (Inicial — sem valor) ou um estado.
- Marque Aprovação se a mudança exigir uma solicitação de mudança aprovada. Para bloquear o item após a mudança, abra o menu ⋯ da linha (ou clique com o botão direito na linha) e escolha Bloquear o item após esta transição; a linha passa a dizer Bloqueia o item.
- Repita os passos 4 a 6 para cada passo permitido.
Para escolher quem aprova uma transição, veja Escolher os aprovadores de uma transição.
Os editores do atributo agora oferecem apenas os próximos estados permitidos, marcados com ⇢ fluxo de trabalho.
Adicionar ou alterar os estados de um fluxo de trabalho
- Na página Fluxo de trabalho, encontre o cartão da classe. A coluna Itens conta os itens em cada estado; um item sem valor conta no padrão do atributo (um caso de teste sem status conta como Não executado, como a Central de testes o mostra).
- Para adicionar um estado, digite seu nome em Novo estado e clique em + Adicionar estado.
O estado é adicionado à classe e às opções do atributo.
- Para ordenar os estados, clique em ↑ ou ↓. Os seletores e as colunas do quadro seguem essa ordem.
- Para renomear um estado personalizado, clique em Renomear… e insira o novo nome.
Os itens nesse estado, as transições e a cor do valor recebem o novo nome. Um único Desfazer reverte tudo.
- Para remover um estado, clique em Remover… (personalizado) ou Desativar… (nativo).
- Um estado que nenhum item tem é removido.
- Quando há itens nele, escolha Mover e remover com o estado para o qual movê-los, ou Manter como Desativado. Um estado desativado permanece em seus itens, mostra (desativado) e deixa de ser oferecido. Suas transições de saída permanecem, para que os itens possam sair dele. Restaurar volta a oferecê-lo.
Nenhuma mudança nesta página limpa um valor.
Escolher os aprovadores de uma transição
- Na página Fluxo de trabalho, marque Aprovação na transição.
Aparece um botão ao lado: Ajustes de solicitação de mudança ▾.
- Clique no botão.
Aprovadores da transição é aberto.
- Em Quem aprova, escolha uma opção:
- Conforme definido em Solicitações de mudança → Ajustes: os aprovadores do projeto decidem (o padrão).
- Proprietários ou Proprietários e editores.
- Pessoas nomeadas: marque os membros do projeto que aprovam. No aplicativo desktop, digite os nomes deles, separados por vírgulas, como cada pessoa o insere em Preferências → Seu nome.
- Em Aprovações necessárias, escolha quantos precisam aprovar: de 1 a 5, ou Todas as pessoas nomeadas.
- Clique em Salvar.
O botão mostra a regra, por exemplo Todas as 3 nomeadas ▾. Um único Desfazer reverte a mudança.
Uma solicitação que contém várias mudanças de estado precisa de todas as regras que se aplicam. Uma rejeição por alguém que pode aprovar a rejeita. No serviço hospedado, os aprovadores nomeados só contam quando um proprietário do projeto definiu o fluxo de trabalho por último; caso contrário, a transição precisa do mesmo número de aprovações de proprietários.
Solicitar aprovação para uma mudança de estado
- No inspetor ou na Visão do item, escolha um estado marcado com (requer aprovação). Para um requisito, você também pode clicar na transição dele na faixa de revisão (ela termina em …).
Solicitar aprovação é aberto.
- Opcionalmente, insira um Motivo e clique em Enviar solicitação.
Uma solicitação de mudança com a mudança de estado é criada e enviada. O diálogo nomeia seus aprovadores: os da própria transição, ou os definidos em Solicitações de mudança → Ajustes. O item mantém seu estado.
Enquanto a solicitação está aberta, a faixa de revisão do requisito a mostra com sua contagem, por exemplo CR-4: 1 de 3 aprovações.
- Os aprovadores a aprovam.
Com a última aprovação, o item passa para o novo estado, quando esse aprovador pode editar o projeto. Caso contrário, um editor abre a solicitação e clica em Aplicar mudanças. O histórico do item mostra via CR-n, e o registro de aprovação de um requisito nomeia todos os aprovadores e a solicitação.
Mudanças diretas para tal estado são recusadas com "… needs approval. Choose "X" on the item to request it." (… requer aprovação. Escolha “X” no item para solicitá-la.): Atributos… em massa, células da grade, movimentos no quadro e mudanças da IA. Escolher o estado de novo enquanto uma solicitação está aberta abre essa solicitação.
Compartilhar um esquema entre projetos
- No projeto de origem, abra Ajustes → Esquema na barra de navegação.
- Clique em Exportar esquema.
Um arquivo JSON é baixado.
- No projeto de destino, abra Ajustes → Esquema na barra de navegação.
- Clique em Mais ▾ → Importar esquema… e escolha o arquivo.
- Escolha o Modo:
- Mesclar (adicionar as classes, atributos, relações e rótulos que faltam neste projeto, correspondidos pelo nome), ou
- Substituir o esquema deste projeto.
- Clique em Importar.
Exemplo prático: CubeSat EO-1
Este exemplo adiciona um nível de maturidade tecnológica (TRL) aos ativos, especializa uma classe e adiciona um fluxo de trabalho de revisão. Crie a demonstração com Gerenciar projetos → Arquivos do projeto ▾ → Novo projeto de demonstração e abra Ajustes → Esquema na barra de navegação.
Observe o modelo.
- Leia a página Uso.
A tabela Classes lista primeiro as classes mais usadas, com seus itens, atributos e relações. Ainda não usado lista as classes, rótulos e relações que a demonstração não usa.
Adicione um TRL aos ativos.
- Clique em Asset e depois em + Atributo.
- Insira o Nome
TRLe escolha o Tipo Um de uma lista. - Digite as opções de
1a9em Valores permitidos, uma por linha. - Insira a Descrição
Technology readiness level. - Clique em Adicionar atributo.
Preencha-o.
- Abra Arquitetura → Assets.
- Selecione 1.2.1 Reaction Wheel Assembly e defina TRL como
7no inspetor. - Defina 1.2.2 Star Tracker como
6e 1.1 Payload Camera como5da mesma forma.Consulte-o.
- Na caixa de pesquisa, digite
Asset:"TRL>=6"e pressione Enter.A consulta vira um chip de filtro na barra de consulta. A tabela lista as rodas de reação e o rastreador de estrelas. Os valores de opção que são números são comparados como números.
Especialize uma classe.
- De volta ao Editor de esquema, abra Asset e clique em + Subclasse.
- Nomeie-a como
Payload Instrumente clique em Criar classe. - No Banco de dados, marque 1.1 Payload Camera e clique em Alterar classe….
- Escolha Payload Instrument como a Nova classe.
O diálogo diz "1 item se tornará Payload Instrument." e não lista nada a remover: a subclasse herda todos os atributos e destinos de Asset.
- Clique em Mudar classe.
A câmera mantém seu TRL, seus vínculos performs e seu lugar na decomposição.
Adicione um fluxo de trabalho de revisão.
- Abra Fluxo de trabalho e escolha Requirement em Adicionar uma classe….
- Confira se ele monitora Status.
- Adicione estas transições: Inicial → Rascunho, Rascunho → Em revisão, Em revisão → Aprovado, Em revisão → Rejeitado, Rejeitado → Rascunho.
- Abra 2.4 Target Slew. Seu Status é Rascunho.
Sua lista Status agora oferece apenas Rascunho e Em revisão.
Desfaça ou mantenha.
- Pressione ⌘Z / Ctrl+Z uma vez por mudança para desfazer o experimento. Ou mantenha as mudanças e clique em Exportar esquema para reutilizá-las no próximo projeto CubeSat.
Dicas e boas práticas
- Prefira subclasses e rótulos a novas classes de nível superior. Uma subclasse mantém todas as relações LML, diagramas e checagens de seu pai. Um rótulo não muda nada estrutural.
- Oculte em vez de excluir. Ocultar uma classe, um atributo ou um rótulo mantém os dados existentes intactos e pode ser revertido.
- Configure o esquema antes de importar. O mapeamento da importação oferece os atributos que existem. As colunas mapeadas para Novo atributo são criadas automaticamente, com um tipo estimado. Veja Importação e exportação.
- Mantenha as adições nativas. Oculte uma extensão nativa de que você não precisa. Não a renomeie nem a exclua: uma que esteja faltando é adicionada de novo, com valor vazio, na próxima vez que o projeto abrir.
- Documente cada elemento personalizado em sua Descrição. Ela aparece como dica nos editores e nas tabelas de esquema da Ajuda.
- Testes de atributo com “menor que” também correspondem a entidades sem valor. Por exemplo,
Asset:"TRL<6"inclui ativos sem TRL. Combine esse teste com um teste positivo, ou use>=no complemento.
Erros comuns
- Alterar o tipo de um atributo limpa seus valores. O Holarch avisa "N entidades têm um valor "X". Alterar o tipo de A para B limpa esses valores." Se você precisar dos valores antigos, exporte um relatório CSV antes. Um único Desfazer reverte tanto a mudança de tipo quanto os valores limpos; em projetos com mais de 5.000 desses valores, o cartão de progresso aparece enquanto eles são limpos.
- Excluir uma relação exclui seus relacionamentos. A confirmação os conta. Desfazer os restaura.
- Remover um destino deixa relacionamentos que o esquema não permite mais. Os vínculos existentes permanecem; Checagens do modelo os lista na regra Global.9 (Relacionamentos que o esquema não permite). Remova-os ou mude sua relação antes ou depois de remover o destino; a confirmação os conta.
- Uma classe não pode ser excluída enquanto tiver entidades. Mude a classe delas ou exclua-as primeiro, ou oculte a classe.
- Transições simples apenas orientam os editores. Atributos… em massa, importações e mudanças da IA ainda podem definir qualquer estado que não exija aprovação. Marque uma transição com Aprovação quando uma mudança não puder contornar a revisão.
- Não é possível renomear um estado nativo. Aprovações, controle de configuração e verificação dependem deles. Adicione um novo estado em vez disso, ou desative o nativo.
Como se conecta a outros recursos
- Banco de dados, inspetor e Visão do item mostram e editam os atributos. Eles oferecem as relações que o esquema permite. As consultas se referem a classes, atributos, rótulos e relações pelo nome. Veja Modelo e banco de dados.
- Diagramas: os tipos de diagrama que uma entidade pode ter dependem de sua classe e das classes acima dela. As subclasses personalizadas os herdam.
- Os recursos de Requisitos (qualidade, aprovações, TBD/TBR, vínculos a revisar) dependem de atributos nativos como Status, TBD/TBR e os critérios de qualidade. Veja Requisitos.
- Matriz de rastreabilidade e Checagens do modelo usam os destinos das relações para decidir o que é permitido e o que está faltando. Veja Rastreabilidade.
- Importação e exportação mapeiam para atributos pelo nome e levam o esquema no JSON do projeto e em arquivos
.holarche ReqIF. Veja Importação e exportação.
O Editor de esquema
O Editor de esquema é onde você faz toda mudança de esquema. Abra-o em Ajustes → Esquema na barra de navegação (com as ferramentas na parte inferior). O endereço schema?class=<id> abre uma classe diretamente (um número antigo de classe nativa ainda funciona).
O editor tem um cabeçalho de página, uma barra lateral e uma área principal. A área principal mostra a página Uso, uma classe, ou a página Relações, Rótulos ou Fluxo de trabalho.
Cabeçalho da página
| Controle | O que ele faz |
|---|---|
| Exportar esquema | Baixa o esquema do projeto como JSON (<Project_name>_schema.json). |
| Mais ▾ → Importar esquema… | Importa um arquivo JSON de esquema (também um JSON de projeto que contenha um esquema) com Mesclar ou Substituir. |
| Adicionar novos itens nativos… | Mostrado quando o projeto tem seu próprio esquema. Lista as classes, relações, atributos e rótulos que o esquema padrão tem e esta cópia não tem (correspondidos pelo nome), como as adições do LML 2.0, e os valores e relacionamentos permitidos do LML 2.0 dos existentes (Decision Status Open e Closed; Logical decomposed by Logical; Connection transfers Input/Output), e os adiciona, e um único Desfazer reverte tudo. As classes, atributos, opções e dados existentes ficam inalterados; os novos valores vão depois dos existentes. |
| Mais ▾ → Redefinir para o padrão… | Oferecido quando o projeto tem seu próprio esquema. Substitui-o pelo esquema LML padrão após confirmação. |
Barra lateral
- Pesquisar classes, atributos, relações, rótulos… filtra a árvore de classes. A área principal mostra Classes, Atributos, Relações encontradas e Rótulos encontrados correspondentes, ou "Nenhuma classe, atributo, relação ou rótulo corresponde. Tente outro termo de pesquisa."
- Uso.
- + Classe, + Rótulo, + Relação.
- Classes: a árvore de classes com amostras de cor, marcas "(abstrata)" e "(oculta)", e o número de entidades (incluindo subclasses).
- Outros: Relações (com a contagem), Rótulos (com a contagem) e Fluxo de trabalho.
Uso
Uso abre primeiro. Sua linha de status diz "O esquema LML padrão. A primeira edição faz uma cópia para este projeto." ou "Este projeto usa seu próprio esquema editado."
- Classes: uma tabela das classes que não estão ocultas, as mais usadas primeiro: Classe (clique para abri-la), Itens (com suas subclasses), Atributos (os próprios), Relações (permitidas, incluindo as herdadas) e Última mudança (a última vez que um de seus itens mudou).
- Ainda não usado: três listas que você pode abrir, Classes, Rótulos e Relações que nada no projeto usa, cada uma com uma contagem. Ocultar em uma linha oculta essa classe, rótulo ou par de relações (um único Desfazer reverte tudo); os itens ocultos permanecem no esquema e são mostrados de novo em sua página ou diálogo.
Página da classe
Clique em uma classe na barra lateral para abrir sua página. De cima para baixo:
- Trilha de navegação das classes pai. Clique em uma para abri-la.
- Cabeçalho: ícone e nome da classe, chips Abstrata e Oculta, ✎ Editar classe, + Subclasse e Excluir. N entidades no projeto › abre o Banco de dados filtrado pela classe.
- Cartão Descrição: a descrição, os chips Id N, Atributos N (com "(k herdados)" quando alguns vêm dos pais), Relações N e Entidades N, e as Subclasses.
- Cartão Atributos: + Atributo e uma tabela com estas colunas:
- Os controles de ordem dos atributos próprios da classe: arraste a linha, ou ↑ / ↓ (um único Desfazer reverte cada movimento).
- Nome, Tipo (o nome do tipo; aponte para ele para ver o id armazenado).
- Detalhes: opções e padrão.
- Definido em: "esta classe" ou a classe ancestral.
- Descrição.
- Ações, para atributos definidos nesta classe: ✎ (Editar atributo), ⊘ / 👁 (Ocultar atributo / Mostrar atributo) e × (Remover atributo).
- Cartão Relações: + Relação e uma tabela com as duas direções: Relação, Outras classes, Voltar para esta classe (o nome inverso, e + em <class> para outra classe que não tenha a inversa) e Descrição. Em Outras classes, × remove uma relação definida nesta classe. As herdadas mostram "(herdada de X)".
- Cartão Rótulos: os rótulos disponíveis na classe.
*marca rótulos disponíveis em todas as classes.
Caixa de diálogo Editar classe
Intitulado Criar nova classe ou Editar classe — X. Campos: Nome, Descrição, Pai ((nenhuma — nível superior) ou uma classe), Oculta, Abstrata e Cor. Clique em Criar classe ou Salvar classe.
Uma classe nativa que tem entidades não pode mudar de pai: "Há entidades que usam esta classe nativa, então seu pai é fixo."
Caixa de diálogo de atributo
Intitulado Novo atributo ou Editar atributo — X. Para um atributo de relação, o título acrescenta "(relação "…")". Clique em Adicionar atributo ou Salvar.
- Nome e Tipo (agrupados: Texto, Números, Data e hora, Opções, Vínculos, Especiais). Não há campo de ordem: um novo atributo vai por último.
- Valores permitidos (um por linha): apenas para Um de uma lista e Vários de uma lista. Linhas vazias e valores repetidos são descartados. Uma lista precisa de pelo menos dois valores: "Uma enumeração precisa de pelo menos duas opções. Adicione outra opção." ("Uma seleção múltipla …" para Vários de uma lista). Um atributo que já tem um único valor ainda é salvo enquanto sua lista não for alterada. Para Um de uma lista, um quadrado de cor por valor segue a lista.
- Valor padrão: não para FILE, COMPUTABLE, QUALITY, HTML e USER_TEAM.
- Descrição.
Página Relações
Clique em Relações na barra lateral para ver todos os pares de relações. A página tem + Relação e uma tabela com estas colunas:
- Relação e Inversa.
- Origem → Destino: todos os pares de classes permitidos.
- Atributos: ✎ por atributo, e + Atributo.
- Usado: o número de relacionamentos.
- Descrição.
- ✎ (Editar relação) e × (Excluir relação).
O diálogo de relação é intitulado Nova relação ou Editar relação — X. Ele tem Nome, Nome inverso, Descrição, Descrição inversa, Oculta e Cor (ou Cor padrão). Os diagramas Spider desenham a relação nessa cor; um diagrama ainda pode escolher sua própria cor por relacionamento. A coluna Relação mostra a cor como uma amostra. Na edição, ele também lista os atributos da relação, com + Adicionar atributo. Clique em Criar relação ou Salvar.
Página Rótulos
Clique em Rótulos na barra lateral para ver todos os rótulos. A página tem Adicionar rótulos DoDAF e Adicionar rótulos UAF (os rótulos de framework que faltam neste projeto; eles também são adicionados no primeiro produto DoDAF ou visão UAF), + Novo rótulo e uma tabela em ordem de árvore com estas colunas:
- Rótulo.
- Aplica-se a: chips de classe ou "Todas as classes".
- Entidades: a contagem.
- Descrição.
- Ações: ✎ (Editar rótulo), ⊖ (Retirar este rótulo de todas as entidades, mostrado quando está em uso) e × (Excluir rótulo). Um único Desfazer devolve um rótulo a todas as entidades de que foi retirado; com mais de 5.000 entidades, o cartão de progresso aparece.
O diálogo de rótulo é intitulado Criar novo rótulo ou Editar rótulo — X. Ele tem Nome, Descrição, Pai ((nenhum) ou um rótulo), Classes (nenhuma selecionada: todas as classes) e Oculto. Clique em Criar rótulo ou Salvar rótulo.
Página Fluxo de trabalho
Clique em Fluxo de trabalho na barra lateral. A página diz "Defina quais mudanças de valor um atributo de enumeração (como Status) permite."
A página diz "Defina os estados de uma classe e quais mudanças entre eles são permitidas ou exigem aprovação."
Adicionar uma classe… lista as classes que têm um atributo de enumeração e ainda não têm fluxo de trabalho. Ele monitora Status quando a classe tem um. Cada classe de fluxo de trabalho tem um cartão com:
- O chip da classe, monitora e o atributo monitorado. Alterá-lo pede confirmação antes quando o fluxo de trabalho tem transições.
- Remover: remove o fluxo de trabalho da classe. Os valores dos itens permanecem.
- Estados: uma tabela de Estado (marcado nativo ou (desativado)), Itens (a contagem) e ↑, ↓, Renomear…, Remover… ou Desativar…, ou Restaurar. Novo estado e + Adicionar estado abaixo dela. Uma subclasse com um atributo herdado diz "Estados próprios de X; Y é herdado."
- Transições: + Adicionar transição adiciona "Nova transição" de (Inicial — sem valor) para o primeiro estado. Uma tabela: Nome, De, Para, Aprovação e um menu ⋯ com Bloquear o item após esta transição e Excluir transição (também clique com o botão direito na linha, ou ⇧F10 / Shift+F10 nela). Nome, De e Para aparecem como texto; clique em um (ou pressione Enter ou F2 nele) para alterá-lo. Sem transições, o cartão diz "Sem transições: qualquer estado pode seguir qualquer outro."
No serviço hospedado, apenas os proprietários do projeto alteram fluxos de trabalho; os outros veem a página somente leitura com "Apenas os proprietários do projeto alteram fluxos de trabalho."
Como as mudanças no esquema afetam os dados existentes
Confira esta tabela antes de alterar um elemento do esquema que já tem dados.
| Mudança | Efeito sobre entidades e relacionamentos |
|---|---|
| Renomear uma classe, um atributo, uma relação ou um rótulo | Os dados são mantidos, porque tudo é armazenado por id. Consultas salvas, texto de pesquisa e títulos de coluna que usam o nome antigo deixam de corresponder. Atualize-os. |
| Alterar o pai de uma classe | Nos editores, a classe ganha os atributos e destinos do novo pai e perde os do pai antigo. Os valores armazenados permanecem. Não permitido para uma classe nativa que tem entidades. |
| Marcar uma classe como abstrata ou oculta | As entidades existentes permanecem. A classe deixa de ser oferecida para novas entidades ou para Alterar classe. |
| Excluir uma classe | Permitido apenas quando a classe não tem subclasses nem entidades. Seus próprios atributos e destinos são removidos. Os rótulos a retiram de sua lista de classes. |
| Adicionar um atributo | As entidades existentes não têm valor. As novas entidades recebem o Valor padrão. |
| Alterar o tipo de um atributo | Todos os valores desse atributo são limpos, após confirmação. |
| Remover uma opção | As entidades mantêm o valor antigo. O editor deixa de oferecê-lo. |
| Ocultar um atributo | Os valores são mantidos, mas não são mostrados, pesquisados nem exportados até serem mostrados de novo. |
| Remover um atributo | Seu valor é limpo em todas as entidades e relacionamentos, após confirmação. |
| Adicionar um destino | A relação fica disponível entre essas classes (e suas subclasses). |
| Remover um destino | Os relacionamentos existentes permanecem, embora o esquema não os permita mais. A regra Global.9 das Checagens do modelo os lista. |
| Excluir uma relação | O par de relações, seus destinos e todos os relacionamentos que o usam são removidos. |
| Excluir um rótulo | Ele é removido de todas as entidades. Seus rótulos filhos sobem para o pai dele. |
| Importar esquema (Mesclar) | Adiciona as classes, relações, destinos, atributos e rótulos que faltam pelo nome. Nada existente é alterado ou removido. |
| Adicionar novos itens nativos | Adiciona as classes, relações, atributos e rótulos do esquema padrão que faltam pelo nome, com seus ids padrão. Destinos são adicionados para as classes e relações adicionadas, além dos destinos do LML 2.0 entre classes existentes; os valores de Decision Status do LML 2.0 são acrescentados. Nada existente é alterado ou removido. |
| Importar esquema (Substituir) ou Redefinir para o padrão | O esquema é substituído. Os dados das entidades permanecem, mas os valores de atributos que não existem mais não são mostrados. As extensões nativas são adicionadas de novo na próxima vez que o projeto abrir. |
Cada mudança pode ser revertida com um único Desfazer, e ⌘Z / Ctrl+Z restaura o esquema junto com os dados que ele removeu.
Extensões nativas
O Holarch adiciona estes elementos a todo projeto quando ele abre, porque seus recursos precisam deles.
- Eles são correspondidos pelo nome, sem diferenciar maiúsculas e minúsculas.
- Eles só são adicionados quando faltam, e nunca são renomeados nem removidos.
- Suas edições neles são mantidas.
| Classe | Atributos adicionados |
|---|---|
| Requisito | Prioridade e Criticidade (High, Medium, Low), Responsável, Origem, TBD/TBR (None, TBD, TBR), Responsável pelo TBD, Prazo do TBD, Método de verificação (seleção múltipla: Analysis, Demonstration, Inspection, Test), Nível de verificação (Component, Subsystem, System), Critérios de sucesso |
| Risk | Responsável, Estratégia de tratamento (Accept, Avoid, Transfer, Mitigate, Watch), Probabilidade residual, Consequência residual, Data de necessidade, Gatilho, Justificativa do fechamento; Status ganha as opções Mitigating e Watch |
| Test Case | Testado por, Data do teste, Configuração, Artigo de teste, Evidência de teste (arquivo) |
| Tarefa | Coluna do quadro (enumeração), adicionado quando um quadro Kanban com nomes de colunas próprios é criado ou convertido. Seus valores são os nomes das colunas. |
| Input/Output | Taxa de dados, Unidades da taxa de dados, Protocolo/Formato, Definição de mensagem/dados |
| Conduit | Conector/Pinos, Meio, Responsável, Status da interface (Draft, Proposed, Agreed, Baselined), TBD/TBR (None, TBD, TBR) |
| Port | Conjugado |
| Medida | Peso, Direção de melhoria (N/A, Positive, Negative), Método de pontuação (Direct 1-10, Direct 1-5, Linear, Thresholds), Limiares de pontuação, Estimativa atual |
| Decisão | Status (Open, In Analysis, Decided, Deferred, Superseded), Data da decisão, Decidido por |
| Característica | Unidades |
| Asset | Quantidade |
Rótulos adicionados: Necessidade das partes interessadas e Requisito de interface (Requirement), Bloco de interface (Asset, sob Block), Estudo de trade-off e Quadro branco (Artifact), Critérios e TPM (Measure).
Destinos de relação adicionados: Decision alternative Asset, Action, Artifact, Resource, Statement e Requirement, com a inversa alternative of.
As páginas de framework (DoDAF e UAF) criam os rótulos que seus produtos usam na primeira vez que você adiciona um desses produtos.
Atalhos de teclado
| Tecla | Onde | Ação |
|---|---|---|
| Enter | Campo Valores permitidos no diálogo de atributo | Iniciar a próxima opção (uma por linha) |
| ⌘ / Ctrl/Ctrl+clique | Lista Classe(s) no diálogo de rótulo | Selecionar várias classes |
| ⌘ / Ctrl+Z / ⌘ / Ctrl+Shift+Z | Em qualquer lugar | Desfazer / refazer uma mudança de esquema |
Opções e ajustes
- O esquema do projeto é armazenado no projeto e compartilhado com todos os membros que podem abri-lo.
- Membros com o papel de leitor não podem alterá-lo ("Somente visualização: peça acesso de edição a um proprietário.").
- Os arquivos de Exportar esquema usam o formato
holarch-schemae contêm as classes, relações, atributos, rótulos e o fluxo de trabalho.
Mensagens
| Mensagem | Significado e correção |
|---|---|
| "Insira um nome de classe." | O nome da classe está vazio. |
| "Esse nome de classe é longo demais; encurte-o." | Os nomes de classes e de rótulos são limitados a 100 caracteres. |
| "Os nomes de classe não podem conter : " ( ) < ou >. As pesquisas dão um significado a esses caracteres." | Remova esses caracteres. Outras letras, dígitos, espaços e pontuação são permitidos. Os nomes de classe existentes continuam válidos. |
| "Outra classe já usa este nome. Escolha um diferente." | Os nomes de classe são únicos (sem diferenciar maiúsculas e minúsculas). |
| ""X" é uma palavra-chave de pesquisa (como em x:…). Escolha outro nome de classe." | As chaves de pesquisa (class, label, name, number, description, is, relationship, in, under, diagram, id, order) e AND, OR, NOT não podem nomear uma classe, porque uma pesquisa leria a classe como essa chave. |
| "Esse pai tornaria esta classe sua própria ancestral." | Escolha um pai fora da subárvore da classe. |
| "Esta classe tem subclasses. Exclua-as ou mova-as para outro pai primeiro." | Uma classe com subclasses não pode ser excluída. |
| ""X" (ou uma subclasse) tem N entidades. Mude a classe delas ou exclua-as primeiro, ou oculte a classe." | Uma classe com entidades não pode ser excluída. |
| "Insira um nome de atributo." | O nome do atributo está vazio. |
| "O nome do atributo contém caracteres que não são permitidos." | Use letras, dígitos, espaços e _ - $ ( ) . , /. |
| "Nome, Número e Descrição são nativos; escolha outro nome de atributo." | Estes são campos da entidade, não atributos. |
| "Já existe um atributo com este nome aqui." | A classe, um pai ou uma subclasse já o tem. |
| "Adicione pelo menos uma opção." | ENUMERATION e MULTISELECT precisam de opções. |
| "Insira um nome de rótulo." / "O nome do rótulo contém caracteres que não são permitidos." / "Outro rótulo já usa este nome." / "Um rótulo não pode estar dentro de si mesmo. Escolha outro pai." | Checagens do diálogo de rótulo. Os rótulos também podem usar & e '. |
| "Insira um nome de relação e um nome inverso." / "O nome da relação e o nome inverso precisam ser diferentes." / "Já existe uma relação chamada "X"." | Checagens do diálogo de relação. |
| "Não é um arquivo JSON." / "Este arquivo não é um esquema: ele precisa de classes, relações, atributos e rótulos." | Importar esquema… precisa de um arquivo JSON de esquema ou de projeto. |
| "Esquema mesclado: N item(ns) adicionado(s)" / "Esquema substituído" | Importação concluída. |
| "Nenhuma classe com fluxo de trabalho. Escolha uma classe com Adicionar uma classe… para definir suas transições de status." | Nenhum fluxo de trabalho foi definido ainda. |
Antes de uma mudança destrutiva, uma confirmação informa a consequência:
| Confirmação | Texto |
|---|---|
| Remover atributo | "N entidades têm um valor que será limpo." |
| Alterar tipo e limpar valores | "N entidades têm um valor "X". Alterar o tipo de A para B limpa esses valores." |
| Excluir classe | "Excluir a classe "X" com seus atributos e destinos?" |
| Remover destino (× em Outras classes) | "N relacionamento(s) existente(s) permanece(m), embora o esquema não os permita mais." |
| Excluir relação | "N relacionamento(s) que a usa(m) também é(são) removido(s)." |
| Excluir rótulo | "Ele é removido de N entidades." |
| Remover rótulo dos itens | "Remover "X" de N entidades?" |
| Redefinir esquema | "As classes, atributos, relações e rótulos personalizados são removidos do esquema (os dados das entidades permanecem; Desfazer está disponível)." |
Limites
- Nomes de classes e de rótulos: 100 caracteres.
- Nomes de atributos criados por importações: 80 caracteres.
- Um atributo monitorado por classe.
- As transições simples são aplicadas pelos editores de atributo, pelas células da grade e pelo quadro Kanban. As transições com aprovação também recusam mudanças diretas e em massa. Novos itens podem ser criados em qualquer estado.
- Bloquear se aplica a itens LML. Os elementos SysML v2 não são bloqueados.
- Nomes de estados: 100 caracteres.
- Mesclar não adiciona novas opções a um atributo que já existe; adicione-as no diálogo de atributo.
- Adicionar novos itens nativos… só aparece depois que você abre a página de novo, quando o esquema já se tornou personalizado.
Relacionado
- Modelo e banco de dados: entidades, editores de atributo, consultas e edições em massa.
- Requisitos: os atributos de requisito, as checagens de qualidade e as aprovações.
- Rastreabilidade: como as relações alimentam a matriz e as checagens de cobertura.
- Importação e exportação: mapeamento de atributos e esquema em arquivos de intercâmbio.
- Ajuda: Esquema, Noções básicas de LML.