Verifikation
Modellprüfungen
Führen Sie 75 regelbasierte Prüfungen und Ihre eigenen Regelsätze über das gesamte Modell aus, grenzen Sie die Befunde nach Schweregrad, Klasse, Regel und Label ein, beheben Sie sie direkt, ignorieren Sie beabsichtigte Befunde und legen Sie fest, wie streng jede Regel ist.
Auf dieser Seite
Überblick
Verifikation → Modellprüfungen führt einen Katalog von Regeln über jedes Element im Projekt aus und listet, was jede Regel findet. Die Regeln suchen nach Lücken, die ein Modell schwer vertrauenswürdig oder prüfbar machen: fehlende Namen und Nummern, isolierte Elemente, Actions, die niemand ausführt, Schnittstellen, die nichts tragen, Anforderungen, die nicht zugeordnet oder nicht verifiziert sind, Risiken ohne Behandlungsplan und Measures, die ihren Schwellenwert verfehlen.
Die Prüfungen laufen bei jeder Änderung des Modells erneut, sodass die Seite, die Karte Modellprüfungen auf der Startseite und das Abzeichen an Verifikation immer übereinstimmen.
Konzepte
- Regel: eine Prüfung mit einer Nummer (zum Beispiel Requirement.10), einer Überschrift, die benennt, was sie findet, einer Beschreibung, wie ein gutes Modell aussieht, und einer Korrektur. Regeln sind nach der Klasse gruppiert, die sie prüfen: Global (jedes Element), Action, Asset, Conduit, Input/Output, Requirement, Risk, Test Case und Measure.
- Befund: ein Element, das gegen eine Regel verstößt. Ein Befund kann verwandte Elemente nennen, zum Beispiel die Duplikate eines Namens oder die untergeordneten Elemente eines übergeordneten.
- Schweregrad: Jede Regel meldet als Fehler oder Warnung oder ist auf Ignorieren gesetzt und läuft nicht. Standard ist Warnung, außer bei den LML-2.0-Regeln Global.10 und Global.11 in einem Projekt, dessen Schemakopie älter als LML 2.0 ist (siehe Regeln).
- Ignorierter Befund: ein Befund, den Sie für ein Element akzeptiert haben. Er zählt nicht mehr, und Ignorierte anzeigen listet ihn mit Wiederherstellen.
- Zutreffende Prüfung: eine Regel, die über mindestens ein Element ihrer Klasse gelaufen ist. Die Kopfzeile zählt, wie viele zutreffende Prüfungen keinen Befund haben.
- Regelsatz: eine benannte Gruppe eigener Regeln, im Projekt gespeichert und als Ganzes ein- oder ausgeschaltet. Seine Regeln laufen mit den integrierten Prüfungen, und ihre Befunde verwenden dieselbe Liste, Beheben und Ignorieren. Siehe Regelsätze.
So setzen Sie es ein
Führen Sie die Prüfungen vor jedem Review, nach einem großen Import und immer dann aus, wenn die Startseite Fehler der Modellprüfungen zeigt. Sie beantworten eine Frage: Was im Modell braucht Aufmerksamkeit, bevor jemand anderes es liest?
Die Befunde abarbeiten
- Öffnen Sie Verifikation → Modellprüfungen. Die Kopfzeile zeigt zum Beispiel „84 % der zutreffenden Prüfungen bestanden“, gefolgt von der Anzahl der Fehler und Warnungen und der Änderung seit dem letzten Lauf.
- Die Liste ist nach Regel gruppiert, Fehler zuerst. Klicken Sie auf eine Regelüberschrift, um sie zu öffnen; ihre Beschreibung sagt, warum die Regel wichtig ist.
- Klicken Sie bei jedem Befund auf Beheben. Der Korrekturdialog zeigt das Element, die Regel und die vorgeschlagene Korrektur: ein auszufüllendes Feld, hinzuzufügende Beziehungen, zusammenzuführende Duplikate oder eine Schaltfläche, die das Element oder sein Diagramm öffnet.
- Speichern Sie die Korrektur. Der Befund verschwindet und die Anzahlen werden aktualisiert.
- Wenn ein Befund beabsichtigt ist (zum Beispiel eine unter zwei übergeordneten Elementen wiederverwendete Action), klicken Sie auf Ignorieren.
Auf einen Bereich konzentrieren
- Aktivieren Sie in den Facetten links unter Schweregrad Fehler, um nur Fehler zu sehen.
- Aktivieren Sie eine Klasse unter Klasse (die Klasse des Elements mit dem Befund), eine Regel unter Regel oder ein Label unter Label. Aktivierungen innerhalb einer Facette werden mit ODER verknüpft, Facetten untereinander mit UND. Jeder Wert zeigt, wie viele Befunde er hat.
- Geben Sie etwas in Befunde filtern ein, um einen Elementnamen oder eine Regelüberschrift zu finden.
- Klicken Sie auf Facetten zurücksetzen, um wieder alles anzuzeigen.
Die Befunde eines Elements gemeinsam prüfen
- Wählen Sie neben dem Filter Nach Entität gruppieren.
- Jedes Element wird einmal mit allen seinen Befunden aufgeführt, in Nummernreihenfolge. Ein Element mit einem Fehler zeigt in seiner Überschrift ein Abzeichen Fehler.
Durchgehendes Beispiel: die CubeSat-EO-1-Demo
- Öffnen Sie das Demoprojekt CubeSat EO-1 und gehen Sie zu Verifikation → Modellprüfungen.
- Aktivieren Sie Requirement unter Klasse. Die verbleibenden Regeln zeigen, welche Anforderungen kein übergeordnetes Element, keine Zuordnung (Requirement.8) oder keinen verifizierenden Testfall (Requirement.10) haben.
- Öffnen Sie Requirement.10, klicken Sie bei einem Befund auf Beheben und verknüpfen Sie den Testfall, der die Anforderung verifiziert. Der Befund verschwindet aus der Liste, und der Wert in der Kopfzeile steigt.
- Wählen Sie Nach Entität gruppieren, um alle verbleibenden Befunde einer Anforderung auf einmal zu sehen.
Eine eigene Regel schreiben
- Klicken Sie im Seitenkopf auf Regelsätze… und dann auf + Neuer Regelsatz. Benennen Sie den Satz, zum Beispiel „Program Rules“, und klicken Sie auf OK.
- Klicken Sie unter dem Satz auf + Regel hinzufügen. Der Regeleditor öffnet sich mit der ID R1.
- Geben Sie einen Name ein, der sagt, was die Regel findet, zum Beispiel „Anforderungen ohne verifizierenden Testfall“.
- Wählen Sie unter Gilt für Requirement.
- Wählen Sie unter Ein Element melden, wenn Eine Beziehung fehlt und dann unter Beziehung verified by.
- Setzen Sie Schweregrad auf Fehler und schreiben Sie die Meldung, zum Beispiel „Verknüpfen Sie den Testfall, der die Anforderung verifiziert.“
- Lesen Sie die Vorschau unter den Feldern, zum Beispiel „Meldet derzeit 3 Elemente: SYS-2 Top Speed, …“. Klicken Sie auf Speichern.
- Klicken Sie auf Schließen. Die Befunde der Regel erscheinen in der Liste unter R1, Fehler zuerst. Klicken Sie auf Beheben, um einen Testfall zu verknüpfen; der Befund verschwindet aus der Liste.
Ein Massenbudget mit Einheiten prüfen
- Öffnen Sie im Demoprojekt CubeSat EO-1 Regelsätze…, klicken Sie auf + Neuer Regelsatz und nennen Sie ihn „Mass Budget“.
- Klicken Sie auf + Regel hinzufügen. Nennen Sie sie „Baugruppen über ihrer Massenzuordnung“ und wählen Sie unter Gilt für Asset.
- Wählen Sie unter Ein Element melden, wenn Eine Summe verbundener Werte wird mit einem Wert verglichen. Setzen Sie Funktion auf Gesamt, Beziehung auf decomposed by, Wert jedes verbundenen Elements auf Mass, Vergleich auf ist größer als und Vergleichen mit auf Mass Allocation.
- Setzen Sie Schweregrad auf Fehler und klicken Sie auf Speichern, dann auf Schließen.
- Eine Baugruppe, deren Teile mehr wiegen als ihre Zuordnung, wird aufgeführt, zum Beispiel „Total Mass of „decomposed by“ 2.34 kg is more than Mass Allocation 1.35 kg“. Massen in Gramm und Kilogramm werden addiert; eine in Metern eingegebene Masse wird aufgeführt als „Cannot add mass and length: the dimensions differ (kg vs m).“
Regeln mit einem anderen Projekt teilen
- Klicken Sie in Regelsätze… neben dem Satz auf Exportieren. Eine Datei mit einem Namen wie
program-rules.holarch-rules.jsonwird heruntergeladen. - Öffnen Sie im anderen Projekt Regelsätze…, klicken Sie auf Importieren…, dann auf Datei auswählen… (oder fügen Sie den Text der Datei ein) und klicken Sie auf Importieren.
- Um Regeln über eine Bibliothek zu teilen, halten Sie die Regelsätze im Bibliotheksprojekt und veröffentlichen Sie ein Release. Klicken Sie in einem Projekt, das die Bibliothek verwendet, auf Aus Bibliothek…, aktivieren Sie die Sätze und klicken Sie auf Kopieren.
- Veröffentlicht die Bibliothek ein neueres Release mit dem Satz, zeigt Regelsätze… neben der Kopie „Eine neuere Version ist verfügbar“. Klicken Sie auf Aktualisieren…, prüfen Sie die Änderungen, wählen Sie für jede an beiden Stellen geänderte Regel Meine behalten oder Die der Bibliothek übernehmen und klicken Sie auf Aktualisieren. Ihre anderen Änderungen an der Kopie bleiben erhalten.
Tipps
- Setzen Sie in Einstellungen die Regeln, die Ihr Team als blockierend betrachtet, auf Fehler, damit die Startseite sie als Probleme aufführt.
- Ignorieren Sie einen Befund nur, wenn er beabsichtigt ist, und begründen Sie das in der Beschreibung des Elements oder in einem Kommentar. Ignorierte anzeigen lässt Reviewer sehen, was akzeptiert wurde.
- Eine lange Liste von Namensbefunden nach einem Import lässt sich meist am schnellsten durch Bearbeiten der Namen in der Datenbank beheben.
- Führen Sie die Prüfungen vor dem Speichern einer Baseline aus, damit die Baseline keine bekannten Lücken enthält.
Die Seite
Seitenkopf
| Steuerelement | Was sie tut |
|---|---|
| Exportieren… | Öffnet den Exportdialog mit Findings (CSV): jeder nicht ignorierte Befund mit Regel, Schweregrad, Überschrift, Element-ID, Nummer, Name, Klasse, Hinweis und verwandten Elementen. |
| Einstellungen | Legt den Schweregrad jeder Regel und die untergeordneten Elemente je Ebene fest (siehe Einstellungen). |
| ↻ Prüfungen ausführen | Führt jede Prüfung erneut aus und erfasst die Anzahlen als letzten Lauf. |
Kopfzeile
- „N % der zutreffenden Prüfungen bestanden“: rot, wenn ein Befund ein Fehler ist, gelb, wenn es nur Warnungen gibt, grün, wenn nichts zu beheben ist.
- Die Anzahl der Befunde, Fehler und Warnungen.
- Die Änderung seit dem letzten Lauf auf diesem Gerät, zum Beispiel „3 Befunde weniger als beim letzten Lauf.“ Der letzte Lauf wird erfasst, wenn Sie die Seite öffnen oder verlassen und wenn Sie auf ↻ Prüfungen ausführen klicken. Beim ersten Besuch steht „Erster Lauf auf diesem Gerät.“
In einem großen Projekt laufen die Prüfungen im Hintergrund, sodass die Seite benutzbar bleibt: Der erste Besuch zeigt „Modellprüfungen werden ausgeführt…“, spätere Besuche zeigen die vorherigen Befunde, bis die neuen bereit sind, und eine Fortschrittskarte zeigt einen Lauf, der länger als eine Sekunde dauert.
Symbolleiste
- Nach Regel gruppieren (Standard) oder Nach Entität gruppieren. Die Wahl wird auf diesem Gerät gespeichert.
- Befunde filtern: durchsucht Elementnamen, Regelnummern und Regelüberschriften.
- Alle ausklappen und Alle einklappen öffnen oder schließen jede Gruppe.
Facetten
| Facette | Werte |
|---|---|
| Schweregrad | Fehler, Warnungen |
| Klasse | Die Klasse jedes Elements mit einem Befund |
| Regel | Jede Regel mit einem Befund, nach Nummer und Überschrift |
| Beschriftung | Jedes Label an einem Element mit einem Befund |
| Ignoriert | Ignorierte anzeigen fügt der Liste die ignorierten Befunde hinzu, als Ignoriert markiert, mit Wiederherstellen |
Die Anzahlen folgen den anderen Facetten und dem Filter und zeigen daher, was das Aktivieren eines Werts übrig ließe.
Befunde
Jeder Befund zeigt das Element (oder, nach Entität gruppiert, die Regel), den Hinweis (zum Beispiel „Vage Wörter: adequate, TBD“ oder „14 untergeordnete Elemente“), die verwandten Elemente und die Schaltflächen Beheben und Ignorieren bzw. Wiederherstellen für einen ignorierten Befund. Ein einziges Rückgängigmachen nimmt ein Ignorieren oder ein Wiederherstellen zurück.
Korrekturen
| Behebung | Verwendet von | Was sie tut |
|---|---|---|
| Ein Feld bearbeiten | Fehlender Name, fehlende Nummer oder Beschreibung; Verb- und Substantivprüfungen | Öffnet das Feld mit dem aktuellen Wert. |
| Großschreiben | Namen in Kleinbuchstaben | Bietet den Namen mit großem Anfangsbuchstaben an. |
| Beziehungen hinzufügen | Fehlendes übergeordnetes Element, fehlender Ausführender, Inputs, Outputs, Conduits, Normen, Nachverfolgungen | Listet die Elemente, die das Schema für die Beziehung zulässt; aktivieren Sie sie und klicken Sie auf Beziehungen hinzufügen. |
| Zusammenführen | Ähnliche Namen, einzelne untergeordnete Elemente | Behält ein Element, verschiebt jede Beziehung der anderen dorthin, fasst die Beschreibungen zusammen und löscht die anderen (ein einziges Rückgängigmachen nimmt alles zurück). |
| Verwandte löschen | Aktionen mit einem Input, der erst nach seiner Verwendung erzeugt wird | Löscht die Input/Outputs, die verbraucht werden, bevor sie existieren. |
| traced to hinzufügen | Anforderungen, die nicht verknüpfte Entitäten nennen | Fügt traced to von der Anforderung zu jedem Element hinzu, das ihr Text nennt. |
| Problem erstellen | Fehlgeschlagene Testfälle ohne verknüpftes Issue | Erstellt ein Issue, das mit dem Testfall und den von ihm verifizierten Anforderungen verknüpft ist. |
| Öffnen | Lange Listen untergeordneter Elemente, Austausche, Normen, Schwellenwerte, Beziehungen, die das Schema nicht zulässt | Öffnet das Element oder sein Diagramm. |
| UAF-Sicht öffnen | UAF-Sichten, die nicht angezeigt werden können | Listet die Sichten der Wurzel mit ihren Problemen und öffnet die erste. |
Einstellungen
- Untergeordnete Elemente je Ebene: Action.9 und Asset.9 melden ein übergeordnetes Element mit mehr untergeordneten Elementen als diese Zahl. Standard ist 9, nach der Richtlinie, dass Menschen etwa 7 ± 2 Elemente auf einer Ebene erfassen. Zulässig sind 2 bis 99; ein anderer Wert zeigt „Untergeordnete Elemente je Ebene muss eine ganze Zahl von 2 bis 99 sein.“
- Schweregrad je Regel: Fehler, Warnung oder Ignorieren. Eine ignorierte Regel läuft nicht.
- Standardwerte wiederherstellen setzt jede Regel auf ihren Standard zurück (Warnung; Requirement.11 Ignorieren; Global.10 und Global.11 Ignorieren in einem Projekt, dessen Schemakopie älter als LML 2.0 ist) und die untergeordneten Elemente je Ebene auf 9.
Die Einstellungen werden im Projekt gespeichert, mit allen darin geteilt und lassen sich rückgängig machen.
Regelsätze
Regelsätze… im Seitenkopf öffnet den Dialog Regelsätze. Ihre eigenen Regeln laufen in den Modellprüfungen mit den integrierten Prüfungen: Ihre Befunde zeigen ID (zum Beispiel R1) und Name der Regel, zählen in der Kopfzeile, erscheinen in den Facetten unter Regel und verwenden Beheben, Ignorieren und Exportieren… wie jeder Befund. Regelsätze werden im Projekt gespeichert, mit allen darin geteilt, und jede Änderung ist ein Rückgängig-Schritt.
Der Dialog Regelsätze
| Steuerelement | Was sie tut |
|---|---|
| + Neuer Regelsatz | Fragt nach einem Namen und fügt einen leeren, eingeschalteten Satz hinzu. |
| Importieren… | Fügt die Regelsätze einer Regelsatzdatei hinzu: Datei auswählen… oder ihren Text einfügen, dann Importieren. Jede Regel wird zuerst geprüft; eine Datei mit einem Problem wird abgelehnt und die Probleme werden aufgeführt. Ein bereits verwendeter Name erhält „ (2)“. |
| Aus Bibliothek… | Listet die Regelsätze in den Releases der Bibliotheken, die dieses Projekt verwendet; aktivieren Sie sie und klicken Sie auf Kopieren. Die Kopie merkt sich ihre Bibliothek und ihr Release. |
| Aktualisieren… | Neben einem kopierten Satz, wenn seine Bibliothek ein neueres Release mit dem Satz veröffentlicht hat („Eine neuere Version ist verfügbar“). Zeigt eine Vorschau der in der Bibliothek hinzugefügten, geänderten und entfernten Regeln, Ihrer beibehaltenen Änderungen und der sowohl hier als auch in der Bibliothek geänderten Regeln; wählen Sie für jede davon Meine behalten oder Die der Bibliothek übernehmen und klicken Sie dann auf Aktualisieren. Ein einziges Rückgängigmachen nimmt alles zurück. |
| Kontrollkästchen neben einem Satz | Schaltet den Satz ein oder aus. Ein ausgeschalteter Satz läuft nicht. |
| Umbenennen… | Benennt den Satz um. |
| Export | Lädt den Satz als JSON-Regelsatzdatei herunter. |
| Löschen | Löscht den Satz und seine Regeln nach einer Bestätigung. Rückgängig stellt sie wieder her. |
| + Regel hinzufügen, Bearbeiten, Löschen | Dem Satz eine Regel hinzufügen, sie ändern oder löschen. |
Eine Regel, die in diesem Projekt nicht laufen kann, etwa eine, die eine Klasse oder Beziehung nennt, die das Schema nicht hat, zeigt das Problem rot unter ihrem Namen und meldet nichts.
Der Regeleditor
| Feld | Was es festlegt |
|---|---|
| Name | Die Überschrift der Befunde der Regel: was die Regel findet. |
| ID | Kurz und innerhalb des Satzes eindeutig, zum Beispiel R1 oder SYS-NUM; bis zu 40 Buchstaben, Ziffern, Punkte, Bindestriche und Unterstriche. |
| Gilt für | Beliebiges Element, eine Klasse (Unterklassen eingeschlossen: ein Test Case ist auch eine Action) oder in einem SysML-v2-Projekt eine Modellart wie Part oder Requirement. |
| Nur Elemente, die passen zu | Optional: ein Filter in der Filtersprache der Datenbank, der die Elemente zuerst eingrenzt, zum Beispiel is:leaf. |
| Ein Element melden, wenn | Die Bedingung, siehe unten. |
| Schweregrad | Fehler oder Warnung. |
| Nachricht | Die vorzunehmende Korrektur, angezeigt im Korrekturdialog. |
Die Zeile unter den Feldern gibt an, wie viele Elemente die Regel derzeit meldet, und nennt die ersten fünf.
| Bedingung | Felder | Meldet ein Element, wenn |
|---|---|---|
| Ein Attribut ist leer | Attribut | Das Attribut hat keinen Wert. |
| Ein Attribut entspricht einem Muster | Attribut, Muster, Groß-/Kleinschreibung ignorieren | Der Text des Attributs enthält einen Treffer des Musters, eines regulären Ausdrucks. |
| Ein Attribut entspricht keinem Muster | Attribut, Muster, Groß-/Kleinschreibung ignorieren | Der Text des Attributs hat keinen Treffer, zum Beispiel ^SYS-\d+$ für Nummern, die mit SYS- beginnen müssen. |
| Eine Beziehung fehlt | Beziehung, Von Elementen der Klasse | Das Element hat keine Verknüpfung dieser Beziehung (zu Elementen dieser Klasse). |
| Eine Beziehung ist vorhanden | Beziehung, Von Elementen der Klasse | Das Element hat eine solche Verknüpfung. |
| Mindestens N verbundene Elemente | Beziehung, Von Elementen der Klasse, N | Das Element hat N oder mehr verwandte Elemente, zum Beispiel mehr als 9 untergeordnete Elemente. |
| Höchstens N verbundene Elemente | Beziehung, Von Elementen der Klasse, N | Das Element hat N oder weniger verwandte Elemente. |
| Ein Wert liegt außerhalb eines Bereichs | Attribut, Minimum, Maximum, Einheit | Die Zahl des Attributs liegt unter dem Minimum oder über dem Maximum. Lassen Sie eine Grenze leer für einen offenen Bereich. |
| Ein Wert liegt innerhalb eines Bereichs | Attribut, Minimum, Maximum, Einheit | Die Zahl des Attributs liegt innerhalb des Bereichs, Grenzen eingeschlossen. |
| Eine Summe verbundener Werte wird mit einem Wert verglichen | Funktion, Beziehung, Von Elementen der Klasse, Wert jedes verbundenen Elements, Vergleich, Vergleichen mit | Gesamt, Kleinster oder Größter eines Werts über die verwandten Elemente (oder die Anzahl der Elemente) ist größer als, mindestens, kleiner als, höchstens, gleich oder verschieden von einem Attribut des Elements (zum Beispiel Mass Allocation) oder einem Wert mit Einheit (12 kg). Verwandte Elemente ohne den Wert werden übersprungen. |
| Ein Ausdruck trifft zu | Ausdruck | Das Element entspricht dem Ausdruck. |
Attribute werden wie am Element benannt: Name, Number und Beschreibung (in einem SysML-v2-Projekt Short Name und Dokumentation) oder ein beliebiges Attribut der Klasse. In einem SysML-v2-Projekt kann auch eine Attribut-Usage des Elements wie mass genannt werden. Ein Element, dessen Klasse kein solches Attribut hat, wird übersprungen. Die Werte eines LML-Elements umfassen auch die Characteristics, von denen es specified by ist (eine Characteristic Mass mit Value 2.4 und Units kg wird als 2.4 kg gelesen), und seine Budgetzuordnungen (Mass Allocation, aus Budgets). Ohne Einheit liest ein Bereich die führende Zahl des Werts (1,500 kg und 1500 [kg] werden als 1500 gelesen) und überspringt Werte, die keine Zahlen sind. Mit einer Einheit wie kg werden Werte zuerst umgerechnet (25000 g wird als 25 kg gelesen), und ein Wert einer anderen Art, etwa 3 m, ist ein eigener Befund: „Cannot compare length and mass: the dimensions differ (m vs kg).“ Summen und Ausdrücke rechnen Einheiten auf dieselbe Weise um und melden einen Konflikt auf dieselbe Weise, nie als stillen Vergleich.
Ausdrucksregeln
Ein Ausdruck wird in der Filtersprache der Filterleiste der Datenbank geschrieben, sodass ein Filter, der dort die problematischen Elemente findet, als Regel funktioniert: Jedes passende Element wird gemeldet. Beispiele:
| Ausdruck | Berichte |
|---|---|
class:Requirement is:leaf NOT relationship:"verified by" | Blatt-Anforderungen, die kein Testfall verifiziert. |
class:Requirement Requirement:"Status=Draft" | Anforderungen noch im Status Entwurf. |
class:Action is:root NOT relationship:"performed by" | Actions der obersten Ebene, die nichts ausführt. |
class:Asset (name:%TBD% OR description:TBD) | Assets mit TBD im Namen oder in der Beschreibung. |
class:Asset value:"sum(decomposed by → Mass) > Mass Allocation" | Baugruppen, deren Teile mehr wiegen als ihre Zuordnung, bei beliebiger Mischung von Einheiten. |
Arithmetik mit Einheiten: value:"Mass * 1.1 <= 12 kg" oder value:"sum(decomposed by → Mass) > Mass Allocation" vergleicht Werte des Elements und Summen über seine verwandten Elemente (sum, min, max, count), mit +, -, *, /, Klammern und Einheiten nach Zahlen (12 kg, 9.81 [m/s^2]). Attributvergleiche mit Einheit, etwa Asset:"Mass>2 kg", rechnen ebenfalls um.
Terme: freier Text, name: (% passt auf beliebigen Text), number: (* passt auf beliebigen Text), description:, class:, label:, relationship:"…", status:, id:, under:"<number>", is:root, is:leaf, is:orphan, is:top, is:locked, is:diagram, Attributvergleiche wie Requirement:"Priority>=3" (=, ~ enthält, <, <=, >, >=; = ohne Wert bedeutet leer), AND, OR, NOT und Klammern. Ein Term, der im Projekt nichts benennt, etwa eine unbekannte Klasse, wird als Problem angezeigt.
Regelsatzdateien
Eine Regelsatzdatei ist JSON mit "format": "holarch-rule-set", "version": 1, einem name, einer optionalen description und einer Liste von rules, jede mit id, name, severity, message, einem optionalen target ({"class": "Requirement"}), einem optionalen Filter where und einem check. Exportieren Sie einen Satz, um die genaue Form zu sehen. Dieselben Dateien laufen in den Modellprüfungen der öffentlichen API und von MCP. Sie laufen auch in SysML-v2-Projekten: Dort führen API und MCP nur die Regelsätze des Projekts aus (die integrierten Regeln laufen in der App), und eine Regel zu den Beziehungen, die Holarch aus Connections und Flows liest (connected by, transfers, generates, receives), läuft nur in der App.
Regeln
| Regel | Heading | Ein gutes Modell |
|---|---|---|
| Global.1 | Gleiche oder nahezu gleiche Namen | Innerhalb einer Klasse haben keine zwei Entitäten denselben Namen. Namen werden in jeder Sprache verglichen, ohne Rücksicht auf Groß-/Kleinschreibung, Leerraum, Satzzeichen und Zeichenbreite („ABS制御“ gleich „ABS制御“); Akzentbuchstaben zählen („Größe“ und „Grüße“ unterscheiden sich). |
| Global.2 | Namen in Kleinbuchstaben | Jeder Entitätsname beginnt mit einem Großbuchstaben. |
| Global.4 | Wiederholte Nummern in einer Klasse | Innerhalb einer Klasse ist jede Nummer eindeutig. |
| Global.5 | Vage Wörter in Namen oder Beschreibungen | Namen und Beschreibungen verwenden präzise Wörter. |
| Global.6 | Entitäten ohne Beziehungen | Jede Entität hat eine Beziehung. |
| Global.7 | Live-Werte, die auf fehlende Ziele zeigen | Live-Werte, Matrixblöcke, Live-Tabellen (Tabellen, Anzahlen und Summen) und Querverweise in Beschreibungen zeigen auf vorhandene Entitäten, Dokumente, Klassen, Labels, Beziehungen, Abbildungen und Tabellen. |
| Global.8 | UAF-Sichten, die nicht angezeigt werden können | Jede UAF-Sicht verwendet eine Wurzel, Klasse und Beziehung, die ihr Sichttyp akzeptiert. |
| Global.9 | Beziehungen, die das Schema nicht zulässt | Jede Beziehung verbindet Klassen, die das Schema für ihre Relation zulässt. |
| Global.10 | Entitäten ohne Namen und ohne Nummer | Jede Entität hat einen Namen oder eine Nummer. |
| Global.11 | Werte außerhalb der Auswahl ihres Attributs | Jeder Enumeration- und Multiselect-Wert ist einer der Auswahlwerte seines Attributs und nur einmal gewählt. |
| Action.1 | Aktionsnamen ohne führendes Verb | Jeder Name einer Action beginnt mit einem Verb. |
| Action.2 | Aktionsnamen in Kleinbuchstaben | Jeder Name einer Action beginnt mit einem Großbuchstaben. |
| Action.3 | Aktionen ohne Namen | Jede Aktion hat einen Namen. |
| Action.4 | Aktionen ohne Nummer | Jede Aktion hat eine Nummer. |
| Action.5 | Aktionen ohne Beschreibung | Jede Aktion hat eine Beschreibung. |
| Action.6 | Aktionen ohne übergeordnetes oder untergeordnetes Element | Jede Aktion hat ein übergeordnetes oder untergeordnetes Element. |
| Action.7 | Aktionen mit einem einzigen untergeordneten Element | Keine Aktion hat ein einziges untergeordnetes Element. |
| Action.9 | Aktionen mit mehr als 9 untergeordneten Elementen | Keine Aktion hat mehr als 9 untergeordnete Elemente. |
| Action.10 | Aktionen mit mehreren übergeordneten Elementen | Keine Aktion hat mehrere übergeordnete Elemente. |
| Action.11 | Aktionen, die kein Asset ausführt | Jede Aktion wird von einem Asset ausgeführt. |
| Action.12 | Aktionen, die nichts erzeugen | Jede Aktion erzeugt ein Input/Output. |
| Action.13 | Aktionen, die nichts verbrauchen | Jede Aktion verbraucht ein Input/Output. |
| Action.14 | Aktionen ohne Inputs oder Outputs | Jede Aktion verbraucht oder erzeugt ein Input/Output. |
| Action.15 | Aktionen, die erzeugen, aber nichts verbrauchen | Jede Aktion, die Outputs erzeugt, verbraucht auch einen Input. |
| Action.16 | Aktionen, die verbrauchen, aber nichts erzeugen | Jede Aktion, die Inputs verbraucht, erzeugt auch einen Output. |
| Action.17 | Aktionen mit einem Input, der erst nach seiner Verwendung erzeugt wird | Keine Aktion empfängt ein Input/Output, das eine spätere Aktion erzeugt. |
| Action.18 | Aktionen ohne Nachverfolgung zu einer Anforderung | Jede Aktion ist zu einer Anforderung nachverfolgbar. |
| Action.19 | Schleifen, die nie enden können | Jede Schleife kann enden. Nennt die Schleife und den OR-Zweig mit 0 %, der ihr EXIT blockiert. |
| Asset.1 | Asset-Namen ohne Substantiv | Jeder Asset-Name ist ein Substantiv oder eine Nominalphrase. |
| Asset.2 | Asset-Namen in Kleinbuchstaben | Jeder Asset-Name beginnt mit einem Großbuchstaben. |
| Asset.3 | Assets ohne Namen | Jedes Asset hat einen Namen. |
| Asset.4 | Assets ohne Nummer | Jedes Asset hat eine Nummer. |
| Asset.5 | Assets ohne Beschreibung | Jedes Asset hat eine Beschreibung. |
| Asset.6 | Assets ohne übergeordnetes oder untergeordnetes Element | Jedes Asset hat ein übergeordnetes oder untergeordnetes Element. |
| Asset.7 | Assets mit einem einzigen untergeordneten Element | Kein Asset hat ein einziges untergeordnetes Element. |
| Asset.9 | Assets mit mehr als 9 untergeordneten Elementen | Kein Asset hat mehr als 9 untergeordnete Elemente. |
| Asset.10 | Assets mit mehreren übergeordneten Elementen | Kein Asset hat mehrere übergeordnete Elemente. |
| Asset.11 | Assets, die keine Aktion ausführen | Jedes Asset führt eine Aktion aus. |
| Asset.12 | Assets ohne Verbindung über ein Conduit | Jedes Asset ist über ein Conduit verbunden. |
| Asset.13 | Austauschende Assets ohne gemeinsames Conduit | Assets, die ein Input/Output austauschen, sind über ein Conduit verbunden. |
| Asset.14 | Interagierende Assets ohne gemeinsame Norm | Interagierende Assets referenzieren dieselbe Norm. |
| Asset.15 | Assets, die nichts austauschen | Jedes Asset tauscht ein Input/Output mit einem anderen Asset aus. |
| Conduit.1 | Conduit-Namen ohne führendes Substantiv | Jeder Conduit-Name beginnt mit einem Substantiv. |
| Conduit.2 | Conduits ohne Namen | Jedes Conduit hat einen Namen. |
| Conduit.3 | Conduits ohne Nummer | Jedes Conduit hat eine Nummer. |
| Conduit.4 | Conduits ohne Beschreibung | Jedes Conduit hat eine Beschreibung. |
| Conduit.5 | Conduits mit mehr als zwei Assets | Kein Conduit verbindet mehr als zwei Assets. |
| Conduit.6 | Conduits mit weniger als zwei Assets | Jedes Conduit verbindet zwei Assets. |
| Conduit.7 | Conduits ohne gemeinsame Norm mit ihren Assets | Ein Conduit und die Assets, die es verbindet, referenzieren dieselbe Norm. |
| Conduit.8 | Conduits, die nichts übertragen | Jedes Conduit überträgt ein Input/Output. |
| Conduit.9 | Conduits ohne Nachverfolgung zu einer Anforderung | Jedes Conduit ist zu einer Anforderung nachverfolgbar. |
| IO.1 | Input/Outputs ohne Namen | Jedes Input/Output hat einen Namen. |
| IO.2 | Input/Outputs ohne Nummer | Jedes Input/Output hat eine Nummer. |
| IO.3 | Input/Outputs ohne Beschreibung | Jedes Input/Output hat eine Beschreibung. |
| IO.4 | Input/Outputs mit mehreren übergeordneten Elementen | Kein Input/Output hat mehr als ein übergeordnetes Element. |
| IO.5 | Input/Outputs, die keine Aktion erzeugt | Jedes Input/Output wird von einer Aktion erzeugt. |
| IO.6 | Input/Outputs, die keine Aktion verbraucht | Jedes Input/Output wird von einer Aktion verbraucht. |
| IO.7 | Input/Outputs, die keine Aktion verwendet | Jedes Input/Output wird von einer Aktion erzeugt oder verbraucht. |
| IO.8 | Input/Outputs, die eine Aktion sowohl erzeugt als auch verbraucht | Keine Aktion verbraucht ein Input/Output, das sie selbst erzeugt. |
| IO.9 | Input/Outputs ohne gemeinsame Norm mit ihren Assets | Ein Input/Output und die Assets, die es austauschen, referenzieren dieselbe Norm. |
| IO.10 | Input/Outputs ohne Nachverfolgung zu einer Anforderung | Jedes Input/Output ist zu einer Anforderung nachverfolgbar. |
| Requirement.1 | Anforderungen, die nicht verknüpfte Entitäten nennen | Eine Anforderung ist mit jeder Entität verknüpft, die sie nennt. |
| Requirement.2 | Blatt-Anforderungen ohne „shall“ | Jede Blatt-Anforderung verwendet das Wort „shall“. |
| Requirement.3 | Anforderungen ohne Namen | Jede Anforderung hat einen Namen. |
| Requirement.4 | Anforderungen ohne Nummer | Jede Anforderung hat eine Nummer. |
| Requirement.5 | Anforderungen ohne Beschreibung | Jede Anforderung hat eine Beschreibung. |
| Requirement.6 | Anforderungen ohne übergeordnetes oder untergeordnetes Element | Jede Anforderung hat ein übergeordnetes oder untergeordnetes Element. |
| Requirement.7 | Anforderungen mit mehreren übergeordneten Elementen | Keine Anforderung hat mehrere übergeordnete Elemente. |
| Requirement.8 | Blattanforderungen, die kein Designelement erfüllt | Jede Blatt-Anforderung ist mit einer Action, einem Asset, einem Input/Output oder einem Conduit verknüpft. |
| Requirement.9 | Anforderungen, die von mehreren Input/Outputs erfüllt werden | Keine Anforderung wird von mehr als einem Input/Output erfüllt. |
| Requirement.10 | Blattanforderungen ohne verifizierenden Testfall | Jede Blatt-Anforderung wird durch einen Test Case verifiziert. |
| Requirement.11 | Anforderungen außerhalb der EARS-Muster | Jede Blatt-Anforderung mit „shall“ folgt einem der EARS-Muster. Aus (Ignorieren), bis Sie ihren Schweregrad festlegen. |
| Risk.1 | Risiken der höchsten Stufe ohne Minderung | Jedes offene Risiko der höchsten Stufe der Risikomatrix wird durch etwas gemindert. |
| Risk.2 | Gefährdungsakzeptanzen, die älter als eine Maßnahmenänderung sind | Keine Akzeptanz des Restrisikos einer Gefährdung ist älter als eine Änderung ihrer Maßnahmen oder deren Verifikation. |
| TestCase.1 | Fehlgeschlagene Testfälle ohne verknüpftes Issue | Jeder fehlgeschlagene Test Case ist mit einem Issue verknüpft. |
| Measure.1 | Measures, die ihren Schwellenwert verletzen | Der projizierte (oder aktuelle) Wert jedes Measure erfüllt seinen Schwellenwert. |
Hinweise zu den Regeln:
- Regeln zum Schreiben von Anforderungen beziehen sich auf den INCOSE Guide to Writing Requirements: vage Wörter (R7, vage Begriffe; R8, Ausweichklauseln), „shall“ (R1, strukturierte Aussagen) und Großbuchstaben (R39, Stilrichtlinie). Die vollständige Schreibprüfung ist Anforderungsqualität.
- Tasks, Testfälle, Zustandsübergänge, Ports und Resources werden von den Action- und Asset-Regeln übersprungen; die Global-Regeln gelten für sie weiterhin.
- Ein zerlegtes Element gilt als ausgeführt, gespeist, produktiv oder nachverfolgt, wenn einer seiner Nachkommen es ist. Elemente, die einander in einer Schleife zerlegen, zählen gemeinsam.
- Global.9 meldet jedes Element einmal, mit den anderen Enden seiner vom Schema nicht zugelassenen Beziehungen sowie Relation und Klasse im Hinweis, zum Beispiel „Not allowed: decomposed by → Risk“. Eine Beziehung gilt als zugelassen, wenn das Schema sie in einer der beiden Richtungen zulässt. Solche Beziehungen bleiben bestehen, nachdem ein Ziel im Schema-Editor entfernt wurde, und können mit Importen hereinkommen.
- Global.10 und Global.11 stammen aus LML 2.0: Eine Entität wird durch einen Namen oder eine Nummer identifiziert (§2.1), und ein Enumeration- oder Multiselect-Wert wird aus der Liste seines Attributs gewählt (§2.5.6, §2.5.12). Global.11 fasst jedes Problem eines Elements in seinem Hinweis zusammen, zum Beispiel
Status: "Pending" is not a choiceoderVerification Method: "Test" chosen twice. Beide laufen standardmäßig, wo das Schema die integrierten Elemente von LML 2.0 hat: das Standardschema oder die eigene Kopie eines Projekts nach Schema → Neue integrierte Elemente hinzufügen…. In einem Projekt mit älterer Schemakopie starten sie auf Ignorieren, sodass ein mit LML 1.x erstelltes Modell dieselben Befunde zeigt wie zuvor; setzen Sie sie in Einstellungen auf Warnung oder Fehler, um sie auszuführen. Der Schema-Editor verlangt mindestens zwei Werte, wenn Sie eine Liste erstellen oder ändern. - Ports sind Schnittstellenpunkte, keine Teile: Sie zählen nicht als untergeordnete Elemente, und ein Conduit an einem Port zählt für das Asset, dem der Port gehört.
- Use Cases (Actions mit dem Label Use Case) sind von der Verb-Regel und den Input/Output-Regeln ausgenommen.
- Requirement.11 prüft den Satz mit „shall“ gegen die sechs EARS-Muster (Mit EARS-Vorlagen schreiben) und nennt das Erste, was zu beheben ist, zum Beispiel „Event-driven: Put a comma after the „When“ condition, before the system name.“ Begründungen und Hinweise in anderen Sätzen werden nicht geprüft.
- SysML-v2-Projekte führen 17 der Regeln aus, in SysML-v2-Begriffen: Global.1, .2, .4 bis .8, Requirement.2 bis .5, .8, .10 und .11, Risk.1, TestCase.1 und Measure.1. Die Action-, Asset-, Conduit- und Input/Output-Regeln gelten nicht; die Diagnosen des Editors prüfen Namen, Typen und Struktur des Modells. Anforderungsregeln prüfen Requirement-Usages: Zum Beispiel lautet Requirement.8 „Blatt-Anforderungen, die nichts erfüllt“ (ein Part oder eine Action, die sie erfüllt) und Requirement.10 „Blatt-Anforderungen ohne Verifikationsfall“. Global.1, .2 und .6 prüfen die Elemente neben dem Modell, etwa Risiken, Aufgaben und Dokumente.
Regeln für Produktlinien
Sobald ein Projekt ein Feature oder eine Configuration hat, führen die Modellprüfungen auch den integrierten Regelsatz Produktlinie aus (Regeln ProductLine.1 bis ProductLine.11 und 13 bis 17, Klasse Produktlinie). Fehlende Features oder Konfigurationen in Applies To (ProductLine.1), Konfigurationen, die eine Regel verletzen oder unvollständig sind (ProductLine.3), und freigegebene Konfigurationen mit darin nicht verifizierten Anforderungen (ProductLine.16) sind Fehler; die anderen Regeln sind Warnungen. ProductLine.10 und 11 prüfen die Vollständigkeit jeder Konfiguration aus Alle Konfigurationen. ProductLine.13 und 14 prüfen Revisionen eines Elements (supersedes): zwei gleichzeitig gültige für dieselbe Einheit und Einheiten ohne gültige Revision. In einer Konfigurationsansicht prüft jede Regel diese Konfiguration. Siehe Produktlinien und Konfigurationen.
Meldungen
| Nachricht | Bedeutung |
|---|---|
| „Keine Befunde. Jede zutreffende Prüfung ist bestanden.“ | Nichts zu beheben. |
| „Keine Befunde. N Befunde ignoriert; Ignorierte anzeigen listet sie.“ | Jeder verbleibende Befund wurde ignoriert. |
| „Kein Befund entspricht dem Filter. Setzen Sie den Filter oder die Facetten zurück.“ | Die Facetten oder der Filter blenden jeden Befund aus. |
| „Das Schema lässt keine dieser Beziehungen für die Klasse … zu“ | Die Korrektur braucht eine Beziehung, die das Projektschema für diese Klasse nicht zulässt. Fügen Sie sie im Schema-Editor hinzu oder beheben Sie den Befund auf andere Weise. |
| „Das Muster ist kein gültiger regulärer Ausdruck (…). Korrigieren Sie es.“ | Der Regeleditor oder eine importierte Datei enthält ein Muster, das nicht gelesen werden kann. |
| „Die ID „…“ wird in diesem Regelsatz bereits verwendet. Eine andere wählen.“ | Zwei Regeln in einem Satz brauchen verschiedene IDs. |
| „Die Beziehung „…“ ist nicht im Schema dieses Projekts.“ | Eine Regel nennt eine Beziehung, die dieses Projekt nicht hat; sie meldet nichts, bis Sie sie ändern. |
| „Der Ausdruck benennt nichts für die Klasse „…“.“ | Ein Ausdruck oder Filter nennt eine Klasse, ein Label, eine Beziehung oder ein Element, die das Projekt nicht hat. |
| „Version N wird nicht unterstützt. Diese Version von Holarch liest Version 1.“ | Die Regelsatzdatei wurde von einer neueren Holarch-Version geschrieben. |
Grenzen
- Die Liste zeigt bis zu 200 Befunde je Gruppe; filtern Sie die Liste, um den Rest zu sehen.
- Ein Regelsatz enthält bis zu 500 Regeln; eine Datei enthält bis zu 50 Regelsätze und 2 MB. Muster haben bis zu 300 Zeichen und prüfen die ersten 20,000 Zeichen eines Werts.
- Die Änderung seit dem letzten Lauf wird je Gerät und Browser gespeichert, nicht im Projekt.
- Die öffentliche API und die MCP-Tools liefern dieselben Befunde mit den Einstellungen des Projekts; sie speichern keine Ergebnisse.