Holarch

Weryfikacja

Kontrole modelu

Uruchamiaj 75 kontroli opartych na regułach i własne zestawy reguł na całym modelu, zawężaj ustalenia według ważności, klasy, reguły i etykiety, poprawiaj je na miejscu, ignoruj zamierzone i ustawiaj, jak rygorystyczna jest każda reguła.

Jak z niego korzystać →

Na tej stronie
  1. Przegląd
  2. Pojęcia
  3. Jak z niego korzystać
    1. Praca z ustaleniami
    2. Skupienie na jednym obszarze
    3. Przegląd wszystkich ustaleń jednego elementu
    4. Przykład: demo CubeSat EO-1
    5. Pisanie własnej reguły
    6. Sprawdzanie budżetu masy z jednostkami
    7. Udostępnianie reguł innemu projektowi
    8. Wskazówki
  4. Strona
    1. Nagłówek strony
    2. Linia nagłówka
    3. Pasek narzędzi
    4. Aspekty
    5. Ustalenia
    6. Poprawki
  5. Ustawienia
  6. Zestawy reguł
    1. Okno Zestawy reguł
    2. Edytor reguł
    3. Reguły z wyrażeniami
    4. Pliki zestawów reguł
  7. Reguły
    1. Reguły linii produktów
  8. Komunikaty
  9. Limity
  10. Powiązane

Przegląd

Weryfikacja → Kontrole modelu uruchamia katalog reguł na każdym elemencie projektu i wymienia, co znajduje każda reguła. Reguły szukają luk, przez które modelowi trudno ufać lub trudno go przeglądać: brakujących nazw i numerów, elementów bez powiązań, akcji, których nikt nie wykonuje, interfejsów, które niczego nie przenoszą, wymagań nieprzydzielonych lub niezweryfikowanych, ryzyk bez planu postępowania i miar, które nie osiągają progu.

Kontrole uruchamiają się ponownie przy każdej zmianie modelu, więc strona, karta Kontrole modelu na Stronie głównej i plakietka przy Weryfikacja zawsze są zgodne.

Pojęcia

  • Reguła: jedna kontrola z numerem (np. Requirement.10), nagłówkiem mówiącym, co znajduje, opisem dobrego modelu i poprawką. Reguły są pogrupowane według sprawdzanej klasy: Global (każdy element), Action, Asset, Conduit, Input/Output, Requirement, Risk, Test Case i Measure.
  • Ustalenie: jeden element, który narusza jedną regułę. Ustalenie może wymieniać powiązane elementy, np. duplikaty nazwy lub elementy podrzędne elementu nadrzędnego.
  • Ważność: każda reguła zgłasza jako Błąd lub Ostrzeżenie albo jest ustawiona na Ignoruj i się nie uruchamia. Domyślnie jest to Ostrzeżenie, z wyjątkiem reguł LML 2.0 Global.10 i Global.11 w projekcie, którego kopia schematu pochodzi sprzed LML 2.0 (zobacz Reguły).
  • Zignorowane ustalenie: ustalenie zaakceptowane dla jednego elementu. Przestaje się liczyć, a Pokaż ignorowane wymienia je z przyciskiem Przywróć.
  • Kontrola mająca zastosowanie: reguła, która została uruchomiona na co najmniej jednym elemencie swojej klasy. Linia nagłówka podaje, ile kontroli mających zastosowanie nie ma ustaleń.
  • Zestaw reguł: nazwana grupa własnych reguł, przechowywana w projekcie i włączana lub wyłączana w całości. Jej reguły działają razem z wbudowanymi kontrolami, a ich ustalenia korzystają z tej samej listy, przycisków Napraw i Ignoruj. Zobacz Zestawy reguł.

Jak z niego korzystać

Uruchamiaj kontrole przed każdym przeglądem, po dużym imporcie i zawsze, gdy Strona główna pokazuje błędy kontroli modelu. Odpowiadają na jedno pytanie: co w modelu wymaga uwagi, zanim przeczyta go ktoś inny?

Praca z ustaleniami

  1. Otwórz Weryfikacja → Kontrole modelu. Linia nagłówka pokazuje np. “84% mających zastosowanie kontroli zakończonych powodzeniem”, a dalej liczbę błędów i ostrzeżeń oraz zmianę od ostatniego uruchomienia.
  2. Lista jest pogrupowana według reguł, błędy najpierw. Kliknij nagłówek reguły, aby ją otworzyć; jej opis wyjaśnia, dlaczego reguła ma znaczenie.
  3. Dla każdego ustalenia kliknij Napraw. Okno poprawki pokazuje element, regułę i sugerowaną poprawkę: pole do wypełnienia, relacje do dodania, duplikaty do scalenia lub przycisk otwierający element albo jego diagram.
  4. Zapisz poprawkę. Ustalenie znika, a liczniki się aktualizują.
  5. Gdy ustalenie jest zamierzone (np. akcja użyta ponownie pod dwoma elementami nadrzędnymi), kliknij Ignoruj.

Skupienie na jednym obszarze

  1. W aspektach po lewej zaznacz Błędy w grupie Ważność, aby widzieć tylko błędy.
  2. Zaznacz klasę w grupie Klasa (klasę elementu z ustaleniem), regułę w grupie Reguła lub etykietę w grupie Etykieta. Zaznaczenia w jednym aspekcie łączą się przez LUB; aspekty łączą się przez I. Każda wartość pokazuje liczbę swoich ustaleń.
  3. Wpisz tekst w Filtruj ustalenia, aby dopasować nazwę elementu lub nagłówek reguły.
  4. Kliknij Wyczyść aspekty, aby znowu pokazać wszystko.

Przegląd wszystkich ustaleń jednego elementu

  1. Wybierz Grupuj według elementu obok filtra.
  2. Każdy element jest wymieniony raz ze wszystkimi swoimi ustaleniami, w kolejności numerów. Element z błędem ma w nagłówku plakietkę Błąd.

Przykład: demo CubeSat EO-1

  1. Otwórz projekt demonstracyjny CubeSat EO-1 i przejdź do Weryfikacja → Kontrole modelu.
  2. Zaznacz Requirement w grupie Klasa. Pozostałe reguły pokazują, które wymagania nie mają elementu nadrzędnego, przydziału (Requirement.8) lub weryfikującego przypadku testowego (Requirement.10).
  3. Otwórz Requirement.10, kliknij Napraw przy ustaleniu i powiąż przypadek testowy, który je weryfikuje. Ustalenie znika z listy, a wynik w linii nagłówka rośnie.
  4. Wybierz Grupuj według elementu, aby zobaczyć naraz wszystkie pozostałe ustalenia jednego wymagania.

Pisanie własnej reguły

  1. Kliknij Zestawy reguł… w nagłówku strony, a następnie + Nowy zestaw reguł. Nazwij zestaw, np. “Program Rules”, i kliknij OK.
  2. W zestawie kliknij + Dodaj regułę. Edytor reguł otwiera się z identyfikatorem R1.
  3. Wpisz Nazwę, która mówi, co reguła znajduje, np. “Requirements with no verifying test case”.
  4. W polu Dotyczy wybierz Requirement.
  5. W polu Zgłoś element, gdy wybierz Brakuje relacji, a następnie wybierz verified by w polu Relacja.
  6. Ustaw Ważność na Błąd i wpisz Komunikat, np. “Link the test case that verifies the requirement.”
  7. Przeczytaj podgląd pod polami, np. “Reports 3 items now: SYS-2 Top Speed, …”. Kliknij Zapisz.
  8. Kliknij Zamknij. Ustalenia reguły pojawiają się na liście pod R1, błędy najpierw. Kliknij Napraw, aby powiązać przypadek testowy; ustalenie znika z listy.

Sprawdzanie budżetu masy z jednostkami

  1. W demonstracji CubeSat EO-1 otwórz Zestawy reguł…, kliknij + Nowy zestaw reguł i nazwij go “Mass Budget”.
  2. Kliknij + Dodaj regułę. Nazwij ją “Assemblies over their mass allocation” i wybierz Asset w polu Dotyczy.
  3. W polu Zgłoś element, gdy wybierz Suma powiązanych wartości porównana z wartością. Ustaw Funkcja na Suma, Relacja na decomposed by, Wartość każdego powiązanego elementu na Mass, Porównanie na jest większa niż i Porównaj z na Mass Allocation.
  4. Ustaw Ważność na Błąd i kliknij Zapisz, a następnie Zamknij.
  5. Zespół, którego części ważą więcej niż jego przydział, jest wymieniany, np. “Total Mass of “decomposed by” 2.34 kg is more than Mass Allocation 1.35 kg”. Masy w gramach i kilogramach się sumują; masa wpisana w metrach jest wymieniana jako “Cannot add mass and length: the dimensions differ (kg vs m).”

Udostępnianie reguł innemu projektowi

  1. W Zestawy reguł… kliknij Eksportuj obok zestawu. Pobiera się plik o nazwie podobnej do program-rules.holarch-rules.json.
  2. W drugim projekcie otwórz Zestawy reguł…, kliknij Importuj…, a następnie Wybierz plik… (lub wklej tekst pliku) i kliknij Importuj.
  3. Aby udostępnić przez bibliotekę, trzymaj zestawy reguł w projekcie biblioteki i opublikuj wydanie. W projekcie korzystającym z biblioteki kliknij Z biblioteki…, zaznacz zestawy i kliknij Kopiuj.
  4. Gdy biblioteka opublikuje nowsze wydanie z zestawem, Zestawy reguł… pokazuje obok kopii “A newer version is available”. Kliknij Aktualizuj…, przejrzyj zmiany, wybierz Zachowaj moje lub Przyjmij z biblioteki dla każdej reguły zmienionej w obu miejscach i kliknij Aktualizuj. Pozostałe zmiany w kopii zostają zachowane.

Wskazówki

  • Reguły, które zespół traktuje jako blokujące, ustaw na Błąd w Ustawienia, aby Strona główna wymieniała je jako problemy.
  • Ignoruj ustalenie tylko wtedy, gdy jest zamierzone, i podaj powód w opisie elementu lub w komentarzu. Pokaż ignorowane pozwala recenzentom zobaczyć, co zostało zaakceptowane.
  • Długą listę ustaleń dotyczących nazw po imporcie zwykle najszybciej naprawia się, edytując nazwy w Bazie danych.
  • Uruchamiaj kontrole przed zapisaniem linii bazowej, aby linia bazowa nie zawierała znanych luk.

Strona

Element sterującyCo robi
Eksportuj…Otwiera okno Eksport z Ustalenia (CSV): każde niezignorowane ustalenie z regułą, ważnością, nagłówkiem, identyfikatorem elementu, numerem, nazwą, klasą, notatką i powiązanymi elementami.
UstawieniaUstawia ważność każdej reguły i liczbę elementów podrzędnych na poziom (zobacz Ustawienia).
↻ Uruchom kontrolePonownie uruchamia wszystkie kontrole i zapisuje liczniki jako ostatni przebieg.

Linia nagłówka

  • “N% mających zastosowanie kontroli zakończonych powodzeniem”: czerwony, gdy którekolwiek ustalenie jest błędem, bursztynowy, gdy są tylko ostrzeżenia, zielony, gdy nie ma nic do naprawienia.
  • Liczba ustaleń, błędów i ostrzeżeń.
  • Zmiana od ostatniego przebiegu na tym urządzeniu, np. “3 ustalenia mniej niż w ostatnim przebiegu.” Ostatni przebieg jest zapisywany przy otwarciu lub opuszczeniu strony oraz po kliknięciu ↻ Uruchom kontrole. Przy pierwszej wizycie widnieje “Pierwszy przebieg na tym urządzeniu.”

W dużym projekcie kontrole działają w tle, więc strony można dalej używać: pierwsza wizyta pokazuje “Uruchamianie kontroli modelu…”, kolejne pokazują poprzednie ustalenia, dopóki nowe nie będą gotowe, a karta postępu pokazuje przebieg trwający dłużej niż sekundę.

Pasek narzędzi

  • Grupuj według reguły (domyślnie) lub Grupuj według elementu. Wybór jest zapamiętywany na tym urządzeniu.
  • Filtruj ustalenia: dopasowuje nazwy elementów, numery reguł i nagłówki reguł.
  • Rozwiń wszystko i Zwiń wszystko otwierają lub zamykają wszystkie grupy.

Aspekty

AspektWartości
WażnośćBłędy, Ostrzeżenia
KlasaKlasa każdego elementu z ustaleniem
RegułaKażda reguła z ustaleniem, według numeru i nagłówka
EtykietaKażda etykieta elementu z ustaleniem
IgnorowanePokaż ignorowane dodaje do listy zignorowane ustalenia, oznaczone jako Ignorowane, z przyciskiem Przywróć

Liczniki uwzględniają pozostałe aspekty i filtr, więc pokazują, co zostanie po zaznaczeniu wartości.

Ustalenia

Każde ustalenie pokazuje element (lub, przy grupowaniu według elementu, regułę), uwagę (np. “Vague words: adequate, TBD” lub “14 children”), powiązane elementy oraz przyciski Napraw i Ignoruj albo Przywróć dla zignorowanego ustalenia. Jedno polecenie Cofnij wycofuje Ignoruj lub Przywróć.

Poprawki

NaprawaUżywana przezCo robi
Edycja polaBrakująca nazwa, numer lub opis; kontrole czasownika i rzeczownikaOtwiera pole z bieżącą wartością.
Wielka literaNazwy pisane małą literąProponuje nazwę z wielką pierwszą literą.
Dodanie relacjiBrakujący element nadrzędny, wykonawca, wejścia, wyjścia, kanały, standardy, śladyWymienia elementy, na które schemat zezwala dla tej relacji; zaznacz je i kliknij Dodaj relacje.
ScalPodobne nazwy, pojedyncze elementy podrzędneZachowuje jeden element, przenosi do niego wszystkie relacje pozostałych, łączy opisy i usuwa pozostałe (jedno polecenie Cofnij wycofuje całość).
Usunięcie powiązanychAkcje z wejściem wytwarzanym po jego użyciuUsuwa wejścia/wyjścia, które są zużywane, zanim powstaną.
Dodanie traced toWymagania wymieniające niepowiązane encjeDodaje traced to od wymagania do każdego elementu wymienionego w jego treści.
Utwórz IssueNieudane przypadki testowe bez powiązanego problemuTworzy element Issue powiązany z przypadkiem testowym i weryfikowanymi przez niego wymaganiami.
OtwarcieDługie listy elementów podrzędnych, wymiany, standardy, progi, relacje niedozwolone przez schematOtwiera element lub jego diagram.
Otwórz widok UAFWidoki UAF, których nie można pokazaćWymienia widoki elementu głównego z ich problemami i otwiera pierwszy.

Ustawienia

  • Elementy podrzędne na poziom: Action.9 i Asset.9 zgłaszają element nadrzędny, który ma więcej elementów podrzędnych niż ta liczba. Domyślnie 9, zgodnie z zasadą, że ludzie radzą sobie z około 7 ± 2 elementami na jednym poziomie. Dozwolone wartości to od 2 do 99; inna wartość pokazuje “Liczba elementów podrzędnych na poziom musi być liczbą całkowitą od 2 do 99.”
  • Ważność każdej reguły: Błąd, Ostrzeżenie lub Ignoruj. Zignorowana reguła się nie uruchamia.
  • Przywróć domyślne przywraca każdej regule wartość domyślną (Ostrzeżenie; Requirement.11 Ignoruj; Global.10 i Global.11 Ignoruj w projekcie, którego kopia schematu pochodzi sprzed LML 2.0) i ustawia liczbę elementów podrzędnych na poziom z powrotem na 9.

Ustawienia są przechowywane w projekcie, wspólne dla wszystkich jego uczestników i można je cofnąć.

Zestawy reguł

Zestawy reguł… w nagłówku strony otwiera okno Zestawy reguł. Własne reguły działają w Kontrolach modelu razem z wbudowanymi kontrolami: ich ustalenia pokazują identyfikator reguły (np. R1) i nazwę, liczą się w linii nagłówka, pojawiają się w aspekcie Reguła i korzystają z Napraw, Ignoruj i Eksportuj… jak każde ustalenie. Zestawy reguł są przechowywane w projekcie, wspólne dla wszystkich jego uczestników, a każda zmiana to jeden krok cofania.

Okno Zestawy reguł

Element sterującyCo robi
+ Nowy zestaw regułPyta o nazwę i dodaje pusty, włączony zestaw.
Importuj…Dodaje zestawy reguł z pliku zestawu reguł: Wybierz plik… lub wklej jego tekst, a następnie Importuj. Każda reguła jest najpierw sprawdzana; plik z problemem jest odrzucany, a problemy są wymieniane. Nazwa, która jest już używana, otrzymuje “ (2)”.
Z biblioteki…Wymienia zestawy reguł w wydaniach bibliotek używanych przez ten projekt; zaznacz je i kliknij Kopiuj. Kopia pamięta swoją bibliotekę i wydanie.
Aktualizuj…Pojawia się obok skopiowanego zestawu, gdy jego biblioteka opublikowała nowsze wydanie zawierające ten zestaw (“Dostępna jest nowsza wersja”). Pokazuje podgląd reguł dodanych, zmienionych i usuniętych w bibliotece, zachowywanych zmian wprowadzonych przez Ciebie oraz reguł zmienionych zarówno tutaj, jak i w bibliotece; dla każdej z nich wybierz Zachowaj moje lub Przyjmij z biblioteki, a potem kliknij Aktualizuj. Jedno polecenie Cofnij wycofuje całość.
Pole wyboru obok zestawuWłącza lub wyłącza zestaw. Wyłączony zestaw się nie uruchamia.
Zmień nazwę…Zmienia nazwę zestawu.
EksportPobiera zestaw jako plik zestawu reguł w formacie JSON.
UsuńUsuwa zestaw i jego reguły po potwierdzeniu. Cofnij je przywraca.
+ Dodaj regułę, Edytuj, UsuńDodaj regułę do zestawu, zmień ją lub usuń.

Reguła, której nie da się uruchomić w tym projekcie, np. taka, która wymienia klasę lub relację nieobecną w schemacie, pokazuje problem na czerwono pod swoją nazwą i niczego nie zgłasza.

Edytor reguł

PoleCo ustawia
Imię i nazwiskoNagłówek ustaleń reguły: co reguła znajduje.
IDKrótki i unikatowy w zestawie, np. R1 lub SYS-NUM; do 40 liter, cyfr, kropek, łączników i podkreśleń.
DotyczyDowolny element, klasa (łącznie z podklasami: Test Case jest też Action) lub w projekcie SysML v2 rodzaj modelu, np. Part lub Requirement.
Tylko elementy pasujące doOpcjonalnie: filtr w języku filtrów Bazy danych, który najpierw zawęża elementy, np. is:leaf.
Zgłoś element, gdyWarunek, poniżej.
WażnośćBłąd lub Ostrzeżenie.
WiadomośćPoprawka do wykonania, pokazywana w oknie Napraw.

Linia pod polami podaje, ile elementów reguła zgłasza obecnie, i wymienia pierwsze pięć.

WarunekPolaZgłasza element, gdy
Atrybut jest pustyAtrybutAtrybut nie ma wartości.
Atrybut pasuje do wzorcaAtrybut, Wzorzec, Ignoruj wielkość literTekst atrybutu zawiera dopasowanie wzorca, czyli wyrażenia regularnego.
Atrybut nie pasuje do wzorcaAtrybut, Wzorzec, Ignoruj wielkość literTekst atrybutu nie ma dopasowania, np. ^SYS-\d+$ dla numerów, które muszą zaczynać się od SYS-.
Brakuje relacjiRelacja, Elementów klasyElement nie ma powiązania tej relacji (z elementami tej klasy).
Relacja istniejeRelacja, Elementów klasyElement ma takie powiązanie.
Liczba powiązanych elementów wynosi co najmniej NRelacja, Elementów klasy, NElement ma N lub więcej powiązanych elementów, np. ponad 9 elementów podrzędnych.
Liczba powiązanych elementów wynosi co najwyżej NRelacja, Elementów klasy, NElement ma N lub mniej powiązanych elementów.
Wartość jest poza zakresemAtrybut, Minimum, Maksimum, JednostkaLiczba w atrybucie jest poniżej minimum lub powyżej maksimum. Pozostaw jedną granicę pustą, aby zakres był otwarty.
Wartość jest w zakresieAtrybut, Minimum, Maksimum, JednostkaLiczba w atrybucie mieści się w zakresie, łącznie z granicami.
Suma powiązanych wartości porównana z wartościąFunkcja, Relacja, Elementów klasy, Wartość każdego powiązanego elementu, Porównanie, Porównaj zSuma, Najmniejsza lub Największa wartość z powiązanych elementów (albo Liczba elementów) jest większa niż, co najmniej, mniejsza niż, co najwyżej, równa lub różna od atrybutu elementu (np. Mass Allocation) albo wartości z jednostką (12 kg). Powiązane elementy bez tej wartości są pomijane.
Wyrażenie pasujeWyrażenieElement pasuje do wyrażenia.

Atrybuty nazywa się tak jak w elemencie: Nazwa, Numer i Opis (w projekcie SysML v2 Nazwa skrócona i Dokumentacja) lub dowolny atrybut klasy. W projekcie SysML v2 można też podać użycie atrybutu elementu, np. mass. Element, którego klasa nie ma takiego atrybutu, jest pomijany. Wartości elementu LML obejmują też charakterystyki, przez które jest specified by (charakterystyka Mass z Value 2.4 i Units kg jest odczytywana jako 2,4 kg), oraz jego przydziały budżetowe (Mass Allocation, z Budżetów). Bez Jednostki zakres odczytuje początkową liczbę wartości (1,500 kg i 1500 [kg] są odczytywane jako 1500) i pomija wartości, które nie są liczbami. Z Jednostką, np. kg, wartości są najpierw przeliczane (25000 g jest odczytywane jako 25 kg), a wartość innego rodzaju, np. 3 m, jest osobnym ustaleniem: “Cannot compare length and mass: the dimensions differ (m vs kg).” Sumy i wyrażenia przeliczają jednostki w ten sam sposób i zgłaszają niezgodność tak samo, nigdy jako ciche porównanie.

Reguły z wyrażeniami

Wyrażenie zapisuje się w języku filtrów paska filtra Bazy danych, więc filtr, który tam znajduje problematyczne elementy, działa jako reguła: zgłaszany jest każdy pasujący element. Przykłady:

WyrażenieRaporty
class:Requirement is:leaf NOT relationship:"verified by"Wymagania liście, których nie weryfikuje żaden przypadek testowy.
class:Requirement Requirement:"Status=Draft"Wymagania nadal w stanie Draft.
class:Action is:root NOT relationship:"performed by"Akcje najwyższego poziomu, których nic nie wykonuje.
class:Asset (name:%TBD% OR description:TBD)Zasoby z TBD w nazwie lub opisie.
class:Asset value:"sum(decomposed by → Mass) > Mass Allocation"Zespoły, których części ważą więcej niż ich przydział, przy dowolnym połączeniu jednostek.

Arytmetyka z jednostkami: value:"Mass * 1.1 <= 12 kg" lub value:"sum(decomposed by → Mass) > Mass Allocation" porównuje wartości elementu i sumy po jego powiązanych elementach (sum, min, max, count), z +, -, *, /, nawiasami i jednostkami po liczbach (12 kg, 9.81 [m/s^2]). Porównania atrybutów z jednostką, np. Asset:"Mass>2 kg", też są przeliczane.

Wyrażenia: dowolny tekst, name: (% pasuje do dowolnego tekstu), number: (* pasuje do dowolnego tekstu), description:, class:, label:, relationship:"…", status:, id:, under:"<number>", is:root, is:leaf, is:orphan, is:top, is:locked, is:diagram, porównania atrybutów, np. Requirement:"Priority>=3" (=, ~ zawiera, <, <=, >, >=; = bez wartości oznacza pustą), AND, OR, NOT i nawiasy. Wyrażenie, które niczego w projekcie nie wskazuje, np. nieznana klasa, jest pokazywane jako problem.

Pliki zestawów reguł

Plik zestawu reguł to JSON z "format": "holarch-rule-set", "version": 1, polem name, opcjonalnym description i listą rules, każda z id, name, severity, message, opcjonalnym target ({"class": "Requirement"}), opcjonalnym filtrem where i check. Wyeksportuj zestaw, aby zobaczyć dokładną postać. Te same pliki działają w kontrolach modelu publicznego API i MCP. Działają też w projektach SysML v2: tam API i MCP uruchamiają tylko zestawy reguł projektu (wbudowane reguły działają w aplikacji), a reguła dotycząca relacji, które Holarch odczytuje z połączeń i przepływów (connected by, transfers, generates, receives), działa tylko w aplikacji.

Reguły

RegułaNagłówekDobry model
Global.1Takie same lub prawie takie same nazwyW obrębie klasy żadne dwie encje nie mają tej samej nazwy. Nazwy są porównywane w każdym języku z pominięciem wielkości liter, odstępów, interpunkcji i szerokości znaków (“ABS制御” równa się “ABS制御”); litery ze znakami diakrytycznymi się liczą (“Größe” i “Grüße” się różnią).
Global.2Nazwy pisane małą literąKażda nazwa encji zaczyna się wielką literą.
Global.4Powtórzone numery w klasieW obrębie klasy każdy numer jest unikatowy.
Global.5Nieprecyzyjne słowa w nazwach lub opisachNazwy i opisy używają precyzyjnych słów.
Global.6Encje bez relacjiKażda encja ma relację.
Global.7Wartości dynamiczne wskazujące brakujące celeWartości dynamiczne, bloki macierzy, tabele dynamiczne (tabele, liczniki i sumy) i odsyłacze w opisach wskazują istniejące encje, dokumenty, klasy, etykiety, relacje, rysunki i tabele.
Global.8Widoki UAF, których nie można pokazaćKażdy widok UAF używa elementu głównego, klasy i relacji akceptowanych przez jego typ widoku.
Global.9Relacje niedozwolone przez schematKażda relacja łączy klasy, na które schemat zezwala dla jej typu relacji.
Global.10Encje bez nazwy i bez numeruKażda encja ma nazwę lub numer.
Global.11Wartości spoza listy wyboru atrybutuKażda wartość wyliczeniowa i wielokrotnego wyboru należy do listy wyboru atrybutu i jest wybrana raz.
Action.1Nazwy akcji bez czasownika na początkuKażda nazwa Action zaczyna się od czasownika.
Action.2Nazwy akcji pisane małą literąKażda nazwa Action zaczyna się wielką literą.
Action.3Akcje bez nazwyKażda akcja ma nazwę.
Action.4Akcje bez numeruKażda akcja ma numer.
Action.5Akcje bez opisuKażda akcja ma opis.
Action.6Akcje bez rodzica i dzieckaKażda akcja ma rodzica lub dziecko.
Action.7Akcje z jednym dzieckiemŻadna akcja nie ma tylko jednego dziecka.
Action.9Akcje z ponad 9 dziećmiŻadna akcja nie ma ponad 9 dzieci.
Action.10Akcje z kilkoma rodzicamiŻadna akcja nie ma kilku rodziców.
Action.11Akcje niewykonywane przez żaden zasóbKażdą akcję wykonuje jakiś zasób.
Action.12Akcje, które niczego nie wytwarzająKażda akcja wytwarza wejście/wyjście.
Action.13Akcje, które niczego nie zużywająKażda akcja zużywa wejście/wyjście.
Action.14Akcje bez wejść i wyjśćKażda akcja zużywa lub wytwarza wejście/wyjście.
Action.15Akcje, które wytwarzają, ale niczego nie zużywająKażda akcja wytwarzająca wyjścia zużywa też wejście.
Action.16Akcje, które zużywają, ale niczego nie wytwarzająKażda akcja zużywająca wejścia wytwarza też wyjście.
Action.17Akcje z wejściem wytwarzanym po jego użyciuŻadna akcja nie otrzymuje wejścia/wyjścia generowanego przez późniejszą akcję.
Action.18Akcje niepowiązane z wymaganiemKażda akcja jest powiązana z wymaganiem.
Action.19Pętle, które nigdy się nie kończąKażda pętla może się zakończyć. Wymienia pętlę i gałąź OR z prawdopodobieństwem 0 %, która blokuje jej EXIT.
Asset.1Nazwy zasobów bez rzeczownikaKażda nazwa zasobu jest rzeczownikiem lub frazą rzeczownikową.
Asset.2Nazwy zasobów pisane małą literąKażda nazwa zasobu zaczyna się wielką literą.
Asset.3Zasoby bez nazwyKażdy zasób ma nazwę.
Asset.4Zasoby bez numeruKażdy zasób ma numer.
Asset.5Zasoby bez opisuKażdy zasób ma opis.
Asset.6Zasoby bez rodzica i dzieckaKażdy zasób ma rodzica lub dziecko.
Asset.7Zasoby z jednym dzieckiemŻaden zasób nie ma tylko jednego dziecka.
Asset.9Zasoby z ponad 9 dziećmiŻaden zasób nie ma ponad 9 dzieci.
Asset.10Zasoby z kilkoma rodzicamiŻaden zasób nie ma kilku rodziców.
Asset.11Zasoby, które nie wykonują żadnej akcjiKażdy zasób wykonuje jakąś akcję.
Asset.12Zasoby niepołączone kanałemKażdy zasób jest połączony kanałem.
Asset.13Wymieniające się zasoby bez wspólnego kanałuZasoby wymieniające wejście/wyjście są połączone kanałem.
Asset.14Współdziałające zasoby bez wspólnego standarduWspółdziałające zasoby odwołują się do tego samego standardu.
Asset.15Zasoby, które niczego nie wymieniająKażdy zasób wymienia wejście/wyjście z innym zasobem.
Conduit.1Nazwy kanałów bez rzeczownika na początkuKażda nazwa kanału zaczyna się od rzeczownika.
Conduit.2Kanały bez nazwyKażdy kanał ma nazwę.
Conduit.3Kanały bez numeruKażdy kanał ma numer.
Conduit.4Kanały bez opisuKażdy kanał ma opis.
Conduit.5Kanały z ponad dwoma zasobamiŻaden kanał nie łączy ponad dwóch zasobów.
Conduit.6Kanały z mniej niż dwoma zasobamiKażdy kanał łączy dwa zasoby.
Conduit.7Kanały bez wspólnego standardu z ich zasobamiKanał i łączone przez niego zasoby odwołują się do tego samego standardu.
Conduit.8Kanały, które niczego nie przenosząKażdy kanał przenosi jakieś wejście/wyjście.
Conduit.9Kanały niepowiązane z wymaganiemKażdy kanał jest powiązany z wymaganiem.
IO.1Wejścia/wyjścia bez nazwyKażde wejście/wyjście ma nazwę.
IO.2Wejścia/wyjścia bez numeruKażde wejście/wyjście ma numer.
IO.3Wejścia/wyjścia bez opisuKażde wejście/wyjście ma opis.
IO.4Wejścia/wyjścia z kilkoma rodzicamiŻadne wejście/wyjście nie ma więcej niż jednego rodzica.
IO.5Wejścia/wyjścia niewytwarzane przez żadną akcjęKażde wejście/wyjście wytwarza jakaś akcja.
IO.6Wejścia/wyjścia niezużywane przez żadną akcjęKażde wejście/wyjście zużywa jakaś akcja.
IO.7Wejścia/wyjścia nieużywane przez żadną akcjęKażde wejście/wyjście jest wytwarzane lub zużywane przez akcję.
IO.8Wejścia/wyjścia, które akcja zarówno wytwarza, jak i zużywaŻadna akcja nie zużywa wejścia/wyjścia, które sama wytwarza.
IO.9Wejścia/wyjścia bez wspólnego standardu z ich zasobamiWejście/wyjście i wymieniające je zasoby odwołują się do tego samego standardu.
IO.10Wejścia/wyjścia niepowiązane z wymaganiemKażde wejście/wyjście jest powiązane z wymaganiem.
Requirement.1Wymagania wymieniające niepowiązane encjeWymaganie jest powiązane z każdą encją, którą wymienia.
Requirement.2Wymagania liście bez “shall”Każde wymaganie liść używa słowa “shall”.
Requirement.3Wymagania bez nazwyKażde wymaganie ma nazwę.
Requirement.4Wymagania bez numeruKażde wymaganie ma numer.
Requirement.5Wymagania bez opisuKażde wymaganie ma opis.
Requirement.6Wymagania bez elementu nadrzędnego ani podrzędnegoKażde wymaganie ma rodzica lub dziecko.
Requirement.7Wymagania z kilkoma elementami nadrzędnymiŻadne wymaganie nie ma kilku rodziców.
Requirement.8Wymagania końcowe, których nie spełnia żadna encja projektowaKażde wymaganie liść jest powiązane z Action, Asset, Input/Output lub Conduit.
Requirement.9Wymagania spełniane przez kilka wejść/wyjśćŻadne wymaganie nie jest spełniane przez więcej niż jedno wejście/wyjście.
Requirement.10Wymagania końcowe bez weryfikującego przypadku testowegoKażde wymaganie liść jest weryfikowane przez Test Case.
Requirement.11Wymagania spoza wzorców EARSKażde wymaganie liść ze słowem “shall” jest zgodne z jednym ze wzorców EARS. Wyłączone (Ignoruj), dopóki nie ustawisz jego ważności.
Risk.1Ryzyka najwyższego poziomu bez działań łagodzącychKażde otwarte ryzyko na najwyższym poziomie macierzy ryzyka jest czymś łagodzone.
Risk.2Akceptacje zagrożeń starsze niż zmiana środka kontroliAkceptacja ryzyka szczątkowego żadnego zagrożenia nie jest starsza niż zmiana jego środków kontroli lub ich weryfikacji.
TestCase.1Nieudane przypadki testowe bez powiązanego problemuKażdy nieudany Test Case jest powiązany z Issue.
Measure.1Miary przekraczające prógPrzewidywana (lub bieżąca) wartość każdej miary (Measure) spełnia jej próg.

Uwagi do reguł:

  • Reguły pisania wymagań powołują się na INCOSE Guide to Writing Requirements: nieprecyzyjne słowa (R7, terminy nieprecyzyjne; R8, klauzule furtki), “shall” (R1, zdania ustrukturyzowane) i wielkie litery (R39, przewodnik stylu). Pełna kontrola redakcji to Jakość wymagań.
  • Zadania, przypadki testowe, przejścia stanów, porty i zasoby typu Resource są pomijane przez reguły Action i Asset; reguły Global nadal ich dotyczą.
  • Zdekomponowany element liczy się jako wykonywany, zasilany, wytwarzający lub powiązany, gdy dotyczy to któregokolwiek z jego potomków. Elementy, które dekomponują się nawzajem w pętli, liczą się razem.
  • Global.9 zgłasza każdy element raz, z drugimi końcami jego relacji niedozwolonych przez schemat, a w uwadze podaje relację i klasę, np. “Not allowed: decomposed by → Risk”. Relacja liczy się jako dozwolona, gdy schemat zezwala na nią w którymkolwiek kierunku. Takie relacje pozostają po usunięciu celu w Edytorze schematu i mogą pojawić się z importami.
  • Global.10 i Global.11 pochodzą z LML 2.0: encję identyfikuje nazwa lub numer (§2.1), a wartość wyliczeniową lub wielokrotnego wyboru wybiera się z listy jej atrybutu (§2.5.6, §2.5.12). Global.11 umieszcza wszystkie problemy jednego elementu w jego uwadze, np. Status: "Pending" is not a choice lub Verification Method: "Test" chosen twice. Obie działają domyślnie tam, gdzie schemat ma wbudowane elementy LML 2.0: w schemacie domyślnym lub we własnej kopii projektu po Schemat → Dodaj nowe wbudowane…. W projekcie ze starszą kopią schematu zaczynają od Ignoruj, więc model utworzony w LML 1.x pokazuje te same ustalenia co wcześniej; ustaw je na Ostrzeżenie lub Błąd w Ustawienia, aby je uruchomić. Edytor schematu wymaga co najmniej dwóch wartości przy tworzeniu lub zmianie listy.
  • Porty są punktami interfejsu, a nie częściami: nie liczą się jako elementy podrzędne, a kanał na porcie liczy się dla zasobu, który jest jego właścicielem.
  • Przypadki użycia (elementy Action z etykietą Use Case) są wyłączone z reguły czasownika i z reguł wejść/wyjść.
  • Requirement.11 sprawdza zdanie zawierające “shall” względem sześciu wzorców EARS (Pisanie z szablonami EARS) i wskazuje pierwszą rzecz do poprawienia, np. “Event-driven: Put a comma after the \“When\” condition, before the system name.” Uzasadnienia i uwagi w innych zdaniach nie są sprawdzane.
  • Projekty SysML v2 uruchamiają 17 reguł, w terminologii SysML v2: Global.1, .2, .4 do .8, Requirement.2 do .5, .8, .10 i .11, Risk.1, TestCase.1 i Measure.1. Reguły Action, Asset, Conduit i Input/Output nie mają zastosowania; diagnostyka Edytora sprawdza nazwy, typy i strukturę modelu. Reguły Requirement sprawdzają użycia wymagań: np. Requirement.8 brzmi “Wymagania liście, których nic nie spełnia” (część lub akcja, która je spełnia), a Requirement.10 “Wymagania liście bez przypadku weryfikacji”. Global.1, .2 i .6 sprawdzają elementy obok modelu, takie jak ryzyka, zadania i dokumenty.

Reguły linii produktów

Gdy projekt ma element Feature lub Configuration, Kontrole modelu uruchamiają też wbudowany zestaw reguł Linia produktów (reguły ProductLine.1 do ProductLine.11 i 13 do 17, klasa Linia produktów). Brakujące cechy lub konfiguracje w Applies To (ProductLine.1), konfiguracje naruszające regułę lub niekompletne (ProductLine.3) oraz konfiguracje Released z wymaganiami w nich niezweryfikowanymi (ProductLine.16) są błędami; pozostałe reguły to ostrzeżenia. ProductLine.10 i 11 sprawdzają kompletność każdej konfiguracji z widoku Wszystkie konfiguracje. ProductLine.13 i 14 sprawdzają rewizje elementu (supersedes): dwie obowiązujące dla tego samego egzemplarza oraz egzemplarze bez żadnej. W widoku konfiguracji każda reguła sprawdza tę konfigurację. Zobacz Linie produktów i konfiguracje.

Komunikaty

WiadomośćZnaczenie
“Brak ustaleń. Wszystkie mające zastosowanie kontrole zakończyły się powodzeniem.”Nie ma nic do naprawienia.
“Brak ustaleń. Zignorowano: N ustaleń; Pokaż ignorowane wyświetla je.”Wszystkie pozostałe ustalenia zostały zignorowane.
“Żadne ustalenie nie pasuje do filtru. Wyczyść filtr lub aspekty.”Aspekty lub filtr ukrywają wszystkie ustalenia.
“Schemat nie zezwala na żadną z tych relacji dla klasy …”Poprawka wymaga relacji, na którą schemat projektu nie zezwala dla tej klasy. Dodaj ją w Edytorze schematu lub napraw ustalenie w inny sposób.
“The pattern is not a valid regular expression (…). Correct it.” (Wzorzec nie jest prawidłowym wyrażeniem regularnym; popraw go.)Edytor reguł lub zaimportowany plik zawiera wzorzec, którego nie da się odczytać.
“Identyfikator “…” jest już używany w tym zestawie reguł. Wybierz inny.”Dwie reguły w jednym zestawie muszą mieć różne identyfikatory.
“The relationship “…” is not in this project’s schema.” (Relacji nie ma w schemacie tego projektu.)Reguła wymienia relację, której ten projekt nie ma; niczego nie zgłasza, dopóki jej nie zmienisz.
“The expression names nothing for class “…”.” (Wyrażenie nie wskazuje niczego dla klasy.)Wyrażenie lub filtr wymienia klasę, etykietę, relację lub element, których projekt nie ma.
“Version N is not supported. This version of Holarch reads version 1.” (Wersja N nie jest obsługiwana; ta wersja Holarch odczytuje wersję 1.)Plik zestawu reguł został zapisany przez nowszą wersję Holarch.

Limity

  • Lista pokazuje do 200 ustaleń na grupę; przefiltruj listę, aby zobaczyć resztę.
  • Zestaw reguł zawiera do 500 reguł; plik zawiera do 50 zestawów reguł i 2 MB. Wzorce mają do 300 znaków i sprawdzają pierwsze 20 000 znaków wartości.
  • Zmiana od ostatniego przebiegu jest przechowywana dla urządzenia i przeglądarki, nie w projekcie.
  • Publiczne API i narzędzia MCP zwracają te same ustalenia z ustawieniami projektu; nie zapisują wyników.