検証
モデルチェック
75 のルールベースのチェックと独自のルールセットをモデル全体に実行し、重大度、クラス、ルール、ラベルで指摘事項を絞り込み、その場で修正し、意図どおりのものは無視し、各ルールの厳しさを設定します。
このページの内容
概要
検証 → モデルチェックは、プロジェクト内のすべての項目に対してルールのカタログを実行し、各ルールが見つけたものを一覧表示します。ルールは、モデルを信頼しにくくしたりレビューしにくくしたりする欠落を探します:名前や番号の欠落、孤立した項目、誰も実行しないアクション、何も運ばないインターフェース、配分も検証もされていない要求、対応計画のないリスク、しきい値を満たさない尺度。
チェックはモデルが変わるたびに再実行されるので、このページ、ホームのモデルチェックカード、検証のバッジは常に一致します。
概念
- ルール:番号(例:Requirement.10)、見つけるものを示す見出し、よいモデルがどうあるべきかの記述、修正方法を持つ 1 つのチェック。ルールは、チェックするクラスごとにグループ化されます:Global(すべての項目)、Action、Asset、Conduit、Input/Output、Requirement、Risk、Test Case、Measure。
- 指摘事項:1 つのルールに違反する 1 つの項目。指摘事項は関連項目を示すことがあります。例:名前の重複、親の子。
- 重大度:各ルールはエラーまたは警告として報告するか、無視に設定されて実行されません。既定値は警告です。ただし、スキーマのコピーが LML 2.0 より前のプロジェクトでの LML 2.0 のルール Global.10 と Global.11 は除きます(ルールを参照)。
- 無視した指摘事項:1 つの項目について受け入れた指摘事項。数えられなくなり、無視した項目を表示で復元付きで一覧表示されます。
- 適用可能なチェック:そのクラスの項目 1 つ以上に対して実行されたルール。見出し行は、指摘事項のない適用可能なチェックの数を数えます。
- ルールセット:プロジェクトに保存され、まとめてオン・オフを切り替える、独自のルールの名前付きグループ。そのルールは組み込みのチェックと一緒に実行され、その指摘事項は同じ一覧、修正、無視を使います。ルールセットを参照してください。
使い方
各レビューの前、大量のインポートの後、およびホームにモデルチェックのエラーが表示されたときにチェックを実行します。チェックが答えるのは、ほかの人が読む前に、モデルのどこに対応が必要かという問いです。
指摘事項に対応する
- 検証 → モデルチェックを開きます。見出し行には、例えば「84% of applicable checks pass」と表示され、続いてエラーと警告の数、前回の実行からの変化が表示されます。
- 一覧はルールでグループ化され、エラーが先に並びます。ルールの見出しをクリックすると開きます。その説明に、ルールが重要な理由が書かれています。
- 指摘事項ごとに修正をクリックします。修正のダイアログには、項目、ルール、提案される修正が表示されます:入力するフィールド、追加する関係、統合する重複、または項目やそのダイアグラムを開くボタン。
- 修正を保存します。指摘事項が消え、件数が更新されます。
- 指摘事項が意図どおりの場合(例:2 つの親の下で再利用されるアクション)は、無視をクリックします。
1 つの領域に絞る
- 左側のファセットで、重大度の下のエラーにチェックを入れると、エラーだけが表示されます。
- クラスの下のクラス(指摘事項のある項目のクラス)、ルールの下のルール、またはラベルの下のラベルにチェックを入れます。1 つのファセット内のチェックは OR で、ファセット同士は AND で組み合わされます。各値には指摘事項の数が表示されます。
- 指摘事項を絞り込みに入力すると、項目名またはルールの見出しに一致させられます。
- ファセットをクリアをクリックすると、再びすべてが表示されます。
1 つの項目の指摘事項をまとめてレビューする
- フィルターの横で項目でグループ化を選びます。
- 各項目が、そのすべての指摘事項とともに番号順に 1 回ずつ一覧表示されます。エラーのある項目は、見出しにエラーのバッジが表示されます。
実例:CubeSat EO-1 のデモ
- CubeSat EO-1 デモプロジェクトを開き、検証 → モデルチェックへ移動します。
- クラスの下の Requirement にチェックを入れます。残ったルールで、親のない要求、配分のない要求(Requirement.8)、検証するテストケースのない要求(Requirement.10)がわかります。
- Requirement.10 を開き、指摘事項の修正をクリックして、それを検証するテストケースをリンクします。指摘事項が一覧から消え、見出し行の値が上がります。
- 項目でグループ化を選ぶと、1 つの要求の残りの指摘事項がすべて一度に表示されます。
独自のルールを書く
- ページヘッダーのルールセット…をクリックし、+ 新しいルールセットをクリックします。セットに名前(例:「Program Rules」)を付け、OK をクリックします。
- セットの下で+ ルールを追加をクリックします。ID R1 でルールエディターが開きます。
- ルールが見つけるものを示す名前を入力します。例:「Requirements with no verifying test case」。
- 適用対象で Requirement を選びます。
- 次の場合に項目を報告で関係がないを選び、関係で verified by を選びます。
- 重大度をエラーに設定し、メッセージを書きます。例:「Link the test case that verifies the requirement.」
- フィールドの下のプレビューを読みます。例:「Reports 3 items now: SYS-2 Top Speed, …」。保存をクリックします。
- 閉じるをクリックします。ルールの指摘事項が一覧の R1 の下に、エラーを先にして表示されます。修正をクリックしてテストケースをリンクすると、指摘事項が一覧から消えます。
単位付きで質量予算をチェックする
- CubeSat EO-1 のデモでルールセット…を開き、+ 新しいルールセットをクリックして、「Mass Budget」という名前を付けます。
- + ルールを追加をクリックします。「Assemblies over their mass allocation」という名前を付け、適用対象で Asset を選びます。
- 次の場合に項目を報告で関連する値の合計を値と比較を選びます。関数を合計に、関係を decomposed by に、各関連項目の値を Mass に、比較を is more than に、比較対象を Mass Allocation に設定します。
- 重大度をエラーに設定して保存をクリックし、続いて閉じるをクリックします。
- パーツの質量が配分を超える組立品が一覧表示されます。例:「Total Mass of 『decomposed by』 2.34 kg is more than Mass Allocation 1.35 kg」。グラムとキログラムの質量は合算されます。メートルで入力された質量は「Cannot add mass and length: the dimensions differ (kg vs m).」として一覧表示されます。
ルールを別のプロジェクトと共有する
- ルールセット…で、セットの横のエクスポートをクリックします。
program-rules.holarch-rules.jsonのような名前のファイルがダウンロードされます。 - もう一方のプロジェクトでルールセット…を開き、インポート…をクリックし、ファイルを選択…をクリックして(またはファイルのテキストを貼り付けて)、インポートをクリックします。
- ライブラリを通じて共有するには、ルールセットをライブラリプロジェクトに置き、リリースを公開します。そのライブラリを使うプロジェクトでライブラリから…をクリックし、セットにチェックを入れてコピーをクリックします。
- ライブラリがそのセットを含む新しいリリースを公開すると、ルールセット…のコピーの横に「新しいバージョンがあります」と表示されます。更新…をクリックして変更を確認し、両方で変更された各ルールについて自分の版を保持またはライブラリの版を採用を選び、更新をクリックします。コピーへのその他の編集は保持されます。
ヒント
- チームが阻害要因として扱うルールは、設定でエラーにしておくと、ホームに問題として一覧表示されます。
- 指摘事項を無視するのは意図どおりの場合だけにし、その理由を項目の説明やコメントに書きます。無視した項目を表示で、レビュー担当者は何が受け入れられたかを確認できます。
- インポート後に名前に関する指摘事項が大量に出た場合は、通常、データベースで名前を編集するのが最も早い解決策です。
- ベースラインを保存する前にチェックを実行し、既知の欠落をベースラインに持ち込まないようにします。
ページ
ページヘッダー
| コントロール | 機能 |
|---|---|
| エクスポート… | Findings (CSV) 付きでエクスポートのダイアログを開きます:無視されていないすべての指摘事項(ルール、重大度、見出し、項目の ID、番号、名前、クラス、注記、関連項目付き)。 |
| 設定 | 各ルールの重大度とレベルごとの子の数を設定します(設定を参照)。 |
| ↻ チェックを実行 | すべてのチェックを再実行し、件数を前回の実行として記録します。 |
見出し行
- 「N% of applicable checks pass」:指摘事項にエラーが 1 つでもあれば赤、警告だけなら琥珀色、修正するものがなければ緑。
- 指摘事項、エラー、警告の数。
- このデバイスでの前回の実行からの変化。例:「3 findings fewer than the last run.」前回の実行は、ページを開いたとき、ページを離れたとき、↻ チェックを実行をクリックしたときに記録されます。初回の表示では「First run on this device.」と表示されます。
大きなプロジェクトでは、チェックはバックグラウンドで実行されるので、ページは使える状態のままです。初回の表示では「Running the model checks…」と表示され、その後の表示では新しい指摘事項の準備ができるまで前回の指摘事項が表示されます。1 秒を超える実行では進捗カードが表示されます。
ツールバー
- ルールでグループ化(既定値)または項目でグループ化。選択はこのデバイスに記憶されます。
- 指摘事項を絞り込み:項目名、ルール番号、ルールの見出しに一致します。
- すべて展開とすべて折りたたむで、すべてのグループを開閉します。
ファセット
| ファセット | 値 |
|---|---|
| 重大度 | エラー、警告 |
| 分類 | 指摘事項のある各項目のクラス |
| ルール | 指摘事項のある各ルール(番号と見出し) |
| ラベル | 指摘事項のある項目の各ラベル |
| 無視済み | 無視した項目を表示で、無視した指摘事項が「無視済み」の印と復元付きで一覧に加わります |
件数はほかのファセットとフィルターに従うので、その値にチェックを入れたら何が残るかを示します。
指摘事項
各指摘事項には、項目(項目でグループ化した場合はルール)、注記(例:「Vague words: adequate, TBD」、「14 children」)、関連項目、修正と無視のボタン(無視した指摘事項では復元)が表示されます。1 回の元に戻すで、無視または復元を取り消せます。
修正
| 対処 | 使用するルール | 機能 |
|---|---|---|
| フィールドを編集 | 名前、番号、説明の欠落。動詞と名詞のチェック | 現在の値でフィールドを開きます。 |
| 先頭を大文字にする | 小文字の名前 | 先頭を大文字にした名前を提示します。 |
| 関係を追加 | 親、実行者、入力、出力、Conduit、規格、トレースの欠落 | その関係についてスキーマが許可する項目を一覧表示します。チェックを入れて関係を追加をクリックします。 |
| マージ | 似た名前、子が 1 つだけ | 1 つの項目を残し、ほかの項目のすべての関係をそこへ移し、説明を結合して、ほかの項目を削除します(1 回の元に戻すですべて取り消せます)。 |
| 関連項目を削除 | 使用後に生成される入力を持つアクション | 存在する前に消費される入出力を削除します。 |
| traced to を追加 | 関係のないエンティティを名指ししている要求 | 要求から、その本文が名前を挙げる各項目へ traced to を追加します。 |
| Issue を作成 | Issue がリンクされていない不合格のテストケース | テストケースと、それが検証する要求にリンクした Issue を作成します。 |
| 開く | 長い子の一覧、交換、規格、しきい値、スキーマが許可しない関係 | 項目またはそのダイアグラムを開きます。 |
| UAF ビューを開く | 表示できない UAF ビュー | ルートのビューを問題とともに一覧表示し、最初のビューを開きます。 |
設定
- レベルごとの子の数:Action.9 と Asset.9 は、子がこの数より多い親を報告します。既定値は 9 で、人が 1 つのレベルで扱えるのは約 7 ± 2 個というガイドラインに基づきます。許容値は 2~99 で、それ以外の値では「レベルごとの子の数は 2~99 の整数で指定してください。」と表示されます。
- ルールごとの重大度:エラー、警告、または無視。無視したルールは実行されません。
- 既定値に戻すは、すべてのルールを既定値(警告。Requirement.11 は無視。スキーマのコピーが LML 2.0 より前のプロジェクトでは Global.10 と Global.11 も無視)に、レベルごとの子の数を 9 に戻します。
設定はプロジェクトに保存され、プロジェクトの全員で共有され、元に戻せます。
ルールセット
ページヘッダーのルールセット…で、ルールセットのダイアログが開きます。独自のルールは、モデルチェックで組み込みのチェックと一緒に実行されます。その指摘事項にはルールの ID(例:R1)と名前が表示され、見出し行で数えられ、ファセットのルールの下に表示され、ほかの指摘事項と同様に修正、無視、エクスポート…を使えます。ルールセットはプロジェクトに保存され、プロジェクトの全員で共有され、変更はそれぞれ 1 回の元に戻す操作です。
ルールセットのダイアログ
| コントロール | 機能 |
|---|---|
| + 新しいルールセット | 名前を尋ね、オンの状態の空のセットを追加します。 |
| インポート… | ルールセットファイルのルールセットを追加します:ファイルを選択…またはテキストを貼り付けてから、インポート。すべてのルールが先にチェックされ、問題のあるファイルは拒否されて問題が一覧表示されます。すでに使われている名前には「 (2)」が付きます。 |
| ライブラリから… | このプロジェクトが使うライブラリのリリースにあるルールセットを一覧表示します。チェックを入れてコピーをクリックします。コピーは、そのライブラリとリリースを記憶します。 |
| 更新… | コピーしたセットの横に、そのライブラリがセットを含む新しいリリースを公開したときに表示されます(「新しいバージョンがあります」)。ライブラリで追加、変更、削除されたルール、保持される自分の編集、ここでもライブラリでも変更されたルールをプレビューします。後者それぞれについて自分の版を保持またはライブラリの版を採用を選び、更新をクリックします。1 回の元に戻すですべて取り消せます。 |
| セットの横のチェックボックス | セットのオン・オフを切り替えます。オフのセットは実行されません。 |
| 名前を変更… | セットの名前を変更します。 |
| エクスポート | セットを JSON のルールセットファイルとしてダウンロードします。 |
| 削除 | 確認の後、セットとそのルールを削除します。元に戻すと復元されます。 |
| + ルールを追加、編集、削除 | セットにルールを追加、変更、削除します。 |
このプロジェクトで実行できないルール(例:スキーマにないクラスや関係を指定しているもの)は、名前の下に問題が赤で表示され、何も報告しません。
ルールエディター
| フィールド | 設定する内容 |
|---|---|
| 名前 | ルールの指摘事項の見出し:ルールが見つけるもの。 |
| ID | セット内で短く一意のもの(例:R1、SYS-NUM)。英字、数字、ドット、ダッシュ、アンダースコアで最大 40 文字。 |
| 適用対象 | 任意の項目、クラス(サブクラスを含む。Test Case は Action でもあります)、または SysML v2 プロジェクトでは Part や Requirement などのモデルの種類。 |
| 次に一致する項目のみ | 任意:最初に項目を絞り込む、データベースのフィルター言語によるフィルター。例:is:leaf。 |
| 次の場合に項目を報告 | 条件(下記)。 |
| 重大度 | エラーまたは警告。 |
| メッセージ | 行うべき修正。修正のダイアログに表示されます。 |
フィールドの下の行に、ルールが現在報告する項目の数と、最初の 5 件の名前が表示されます。
| 条件 | フィールド | 項目を報告する場合 |
|---|---|---|
| 属性が空 | 属性 | 属性に値がない。 |
| 属性がパターンに一致する | 属性、パターン、大文字と小文字を区別しない | 属性のテキストに、パターン(正規表現)に一致する部分がある。 |
| 属性がパターンに一致しない | 属性、パターン、大文字と小文字を区別しない | 属性のテキストに一致する部分がない。例:SYS- で始まる必要がある番号には ^SYS-\d+$。 |
| 関係がない | 関係、対象の項目 | 項目に、(そのクラスの項目への)その関係のリンクがない。 |
| 関係がある | 関係、対象の項目 | 項目にそのようなリンクがある。 |
| 関連項目の数が N 以上 | 関係、対象の項目、N | 項目に N 個以上の関連項目がある。例:子が 9 個を超える。 |
| 関連項目の数が N 以下 | 関係、対象の項目、N | 項目の関連項目が N 個以下。 |
| 値が範囲外にある | 属性、最小値、最大値、単位 | 属性の数値が最小値を下回るか、最大値を上回る。範囲の上限または下限を空欄にすると、片側が開いた範囲になります。 |
| 値が範囲内にある | 属性、最小値、最大値、単位 | 属性の数値が範囲内にある(境界を含む)。 |
| 関連する値の合計を値と比較 | 関数、関係、対象の項目、各関連項目の値、比較、比較対象 | 関連項目にわたる値の合計、最小、最大(または項目数)が、項目の属性(例:Mass Allocation)または単位付きの値(12 kg)より大きい、以上、より小さい、以下、等しい、または異なる。値を持たない関連項目はスキップされます。 |
| 式に一致する | 式 | 項目が式に一致する。 |
属性は項目上と同じ名前で指定します:名前、Number、説明(SysML v2 プロジェクトでは Short Name とドキュメント)、またはクラスの任意の属性。SysML v2 プロジェクトでは、mass のような要素の属性ユーセージも指定できます。クラスにそのような属性がない項目はスキップされます。LML の項目の値には、それが specified by される Characteristic(Value 2.4、Units kg の Mass Characteristic は 2.4 kg として読み取られます)と、その予算の配分(予算からの Mass Allocation)も含まれます。単位がない場合、範囲は値の先頭の数値を読み取り(1,500 kg と 1500 [kg] は 1500 として読み取られます)、数値でない値はスキップします。kg などの単位がある場合は、値がまず換算され(25000 g は 25 kg として読み取られます)、3 m のような別の種類の値は、それ自体が指摘事項になります:「Cannot compare length and mass: the dimensions differ (m vs kg).」合計と式も同じ方法で単位を換算し、不一致も同じ方法で報告します。黙って比較することはありません。
式のルール
式はデータベースのフィルターバーのフィルター言語で書くので、そこで問題の項目を見つけるフィルターはそのままルールとして使えます。一致するすべての項目が報告されます。例:
| 式 | レポート |
|---|---|
class:Requirement is:leaf NOT relationship:"verified by" | どのテストケースも検証していないリーフ要求。 |
class:Requirement Requirement:"Status=Draft" | まだ Draft の要求。 |
class:Action is:root NOT relationship:"performed by" | 何も実行していない最上位のアクション。 |
class:Asset (name:%TBD% OR description:TBD) | 名前または説明に TBD を含む Asset。 |
class:Asset value:"sum(decomposed by → Mass) > Mass Allocation" | 単位がどのように混在していても、パーツの質量が配分を超える組立品。 |
単位付きの算術:value:"Mass * 1.1 <= 12 kg" や value:"sum(decomposed by → Mass) > Mass Allocation" は、項目の値と、その関連項目にわたる合計(sum、min、max、count)を、+、-、*、/、かっこ、数値の後の単位(12 kg、9.81 [m/s^2])を使って比較します。Asset:"Mass>2 kg" のような単位付きの属性比較も換算されます。
条件:フリーテキスト、name:(% は任意のテキストに一致)、number:(* は任意のテキストに一致)、description:、class:、label:、relationship:"…"、status:、id:、under:"<number>"、is:root、is:leaf、is:orphan、is:top、is:locked、is:diagram、Requirement:"Priority>=3" のような属性比較(=、~ 含む、<、<=、>、>=。値のない = は空を意味します)、AND、OR、NOT、かっこ。未知のクラスなど、プロジェクト内の何も指さない条件は問題として表示されます。
ルールセットのファイル
ルールセットファイルは JSON で、"format": "holarch-rule-set"、"version": 1、name、任意の description、rules のリストを持ちます。各ルールは id、name、severity、message、任意の target({"class": "Requirement"})、任意の where フィルター、check を持ちます。正確な形はセットをエクスポートして確認してください。同じファイルが、公開 API と MCP のモデルチェックでも実行されます。SysML v2 プロジェクトでも実行されます。その場合、API と MCP はプロジェクトのルールセットだけを実行し(組み込みのルールはアプリで実行)、Holarch がコネクションとフローから読み取る関係(connected by、transfers、generates、receives)に関するルールはアプリでのみ実行されます。
ルール
| ルール | Heading | よいモデル |
|---|---|---|
| Global.1 | 同じまたはほぼ同じ名前 | クラス内で、2 つのエンティティが名前を共有することはありません。名前は言語を問わず、大文字と小文字、空白、句読点、文字幅を無視して比較されます(「ABS制御」は「ABS制御」と等しい)。アクセント付きの文字は区別されます(「Größe」と「Grüße」は異なる)。 |
| Global.2 | 小文字の名前 | すべてのエンティティ名は大文字で始まります。 |
| Global.4 | クラス内の重複番号 | 同じクラス内で、すべての番号は一意です。 |
| Global.5 | 名前または説明のあいまいな語 | 名前と説明には正確な語を使用しています。 |
| Global.6 | 関係を持たないエンティティ | すべてのエンティティに関係があります。 |
| Global.7 | 存在しない対象を指すライブ値 | ライブ値、マトリックスブロック、ライブテーブル(表、件数、合計)、説明内の相互参照は、存在するエンティティ、ドキュメント、クラス、ラベル、関係、図、表を指しています。 |
| Global.8 | 表示できない UAF ビュー | すべての UAF ビューは、そのビュータイプが受け付けるルート、クラス、関係を使用します。 |
| Global.9 | スキーマで許可されていない関係 | すべての関係は、スキーマがその関係種別に許可するクラスを結びます。 |
| Global.10 | 名前も番号もないエンティティ | すべてのエンティティに名前または番号があります。 |
| Global.11 | 属性の選択肢外の値 | すべての列挙値と複数選択値は、その属性の選択肢のいずれかで、1 回だけ選択されています。 |
| Action.1 | 動詞で始まらない Action 名 | すべての Action 名は動詞で始まります。 |
| Action.2 | 小文字の Action 名 | すべての Action 名は大文字で始まります。 |
| Action.3 | 名前のないアクション | 各アクションに名前があります。 |
| Action.4 | 番号のないアクション | 各アクションに番号があります。 |
| Action.5 | 説明のないアクション | 各アクションに説明があります。 |
| Action.6 | 親も子もないアクション | すべてのアクションに親または子があります。 |
| Action.7 | 子が 1 つだけのアクション | 子が 1 つだけのアクションはありません。 |
| Action.9 | 子が 9 個を超えるアクション | 子が 9 個を超えるアクションはありません。 |
| Action.10 | 複数の親を持つアクション | 複数の親を持つアクションはありません。 |
| Action.11 | どのアセットも実行しないアクション | 各アクションをいずれかのアセットが実行します。 |
| Action.12 | 何も生成しないアクション | すべてのアクションが入出力を生成します。 |
| Action.13 | 何も消費しないアクション | すべてのアクションが入出力を消費します。 |
| Action.14 | 入力も出力もないアクション | すべてのアクションが入出力を消費または生成します。 |
| Action.15 | 生成するが何も消費しないアクション | 出力を生成するすべてのアクションは、入力も消費します。 |
| Action.16 | 消費するが何も生成しないアクション | 入力を消費するすべてのアクションは、出力も生成します。 |
| Action.17 | 使用後に生成される入力を持つアクション | 後のアクションが生成する入出力を受け取るアクションはありません。 |
| Action.18 | 要求にトレースされていないアクション | すべてのアクションが要求にトレースされます。 |
| Action.19 | 終了できないループ | すべてのループは終了できます。EXIT を妨げている 0 % の OR 分岐とそのループの名前を示します。 |
| Asset.1 | 名詞のないアセット名 | すべてのアセット名は名詞または名詞句です。 |
| Asset.2 | 小文字のアセット名 | すべてのアセット名は大文字で始まります。 |
| Asset.3 | 名前のないアセット | 各アセットに名前があります。 |
| Asset.4 | 番号のないアセット | 各アセットに番号があります。 |
| Asset.5 | 説明のないアセット | 各アセットに説明があります。 |
| Asset.6 | 親も子もないアセット | すべてのアセットに親または子があります。 |
| Asset.7 | 子が 1 つだけのアセット | 子が 1 つだけのアセットはありません。 |
| Asset.9 | 子が 9 個を超えるアセット | 子が 9 個を超えるアセットはありません。 |
| Asset.10 | 複数の親を持つアセット | 複数の親を持つアセットはありません。 |
| Asset.11 | どのアクションも実行しないアセット | 各アセットは何らかのアクションを実行します。 |
| Asset.12 | コンジットで接続されていないアセット | すべてのアセットがコンジットで接続されています。 |
| Asset.13 | 共通のコンジットがない、やり取りするアセット | 入出力をやり取りするアセットは、コンジットで接続されています。 |
| Asset.14 | 共通の規格がない、相互作用するアセット | 相互作用するアセットは同じ規格を参照します。 |
| Asset.15 | 何もやり取りしないアセット | すべてのアセットが別のアセットと入出力をやり取りします。 |
| Conduit.1 | 名詞で始まらないコンジット名 | すべてのコンジット名は名詞で始まります。 |
| Conduit.2 | 名前のないコンジット | 各コンジットに名前があります。 |
| Conduit.3 | 番号のないコンジット | 各コンジットに番号があります。 |
| Conduit.4 | 説明のないコンジット | 各コンジットに説明があります。 |
| Conduit.5 | 3 つ以上のアセットを持つコンジット | 3 つ以上のアセットをつなぐコンジットはありません。 |
| Conduit.6 | アセットが 2 つ未満のコンジット | すべてのコンジットが 2 つのアセットをつなぎます。 |
| Conduit.7 | アセットと共通の規格がないコンジット | コンジットとそれがつなぐアセットは、同じ規格を参照します。 |
| Conduit.8 | 何も転送しないコンジット | 各コンジットは何らかの入出力を転送します。 |
| Conduit.9 | 要求にトレースされていないコンジット | すべてのコンジットが要求にトレースされます。 |
| IO.1 | 名前のない入出力 | 各入出力に名前があります。 |
| IO.2 | 番号のない入出力 | 各入出力に番号があります。 |
| IO.3 | 説明のない入出力 | 各入出力に説明があります。 |
| IO.4 | 複数の親を持つ入出力 | 親が 2 つ以上ある入出力はありません。 |
| IO.5 | どのアクションも生成しない入出力 | 各入出力をいずれかのアクションが生成します。 |
| IO.6 | どのアクションも消費しない入出力 | 各入出力をいずれかのアクションが消費します。 |
| IO.7 | どのアクションも使用しない入出力 | すべての入出力は、アクションによって生成または消費されます。 |
| IO.8 | アクションが生成と消費の両方を行う入出力 | 自身が生成する入出力を消費するアクションはありません。 |
| IO.9 | アセットと共通の規格がない入出力 | 入出力とそれをやり取りするアセットは、同じ規格を参照します。 |
| IO.10 | 要求にトレースされていない入出力 | すべての入出力が要求にトレースされます。 |
| Requirement.1 | 関係のないエンティティを名指ししている要求 | 要求は、その本文が名前を挙げるすべてのエンティティに関連付けられています。 |
| Requirement.2 | 「shall」のない末端要求 | すべての末端要求で「shall」という語を使用しています。 |
| Requirement.3 | 名前のない要求 | 各要求に名前があります。 |
| Requirement.4 | 番号のない要求 | 各要求に番号があります。 |
| Requirement.5 | 説明のない要求 | 各要求に説明があります。 |
| Requirement.6 | 親も子もない要求 | すべての要求に親または子があります。 |
| Requirement.7 | 複数の親を持つ要求 | 複数の親を持つ要求はありません。 |
| Requirement.8 | どの設計エンティティにも満たされていない末端の要求 | すべての末端要求は Action、Asset、Input/Output、Conduit のいずれかに関連付けられています。 |
| Requirement.9 | 複数の Input/Output に満たされている要求 | 複数の入出力によって満たされる要求はありません。 |
| Requirement.10 | 検証するテストケースがない末端の要求 | 各末端要求は Test Case によって検証されます。 |
| Requirement.11 | EARS パターンに沿っていない要求 | 「shall」を含む各末端要求は、EARS パターンのいずれかに従っています。重大度を設定するまではオフ(無視)です。 |
| Risk.1 | 軽減策のない最上位レベルのリスク | リスクマトリックスの最上位レベルにある未解決のリスクには、それぞれ何らかの軽減策があります。 |
| Risk.2 | 管理策の変更より古いハザードの受け入れ | 管理策やその検証の変更より前に残留リスクの受け入れが行われたハザードはありません。 |
| TestCase.1 | Issue がリンクされていない不合格のテストケース | 不合格の各 Test Case は Issue にリンクされています。 |
| Measure.1 | しきい値を逸脱した Measure | 各 Measure の予測値(または現在値)がしきい値を満たしています。 |
ルールに関する注記:
- 要求の書き方に関するルールは、INCOSE Guide to Writing Requirements に基づいています:あいまいな語(R7 あいまいな用語、R8 逃げ道となる条項)、「shall」(R1 構造化された文)、大文字(R39 スタイルガイド)。書き方の完全なチェックは要求の品質です。
- タスク、テストケース、状態遷移、ポート、リソースは Action と Asset のルールではスキップされますが、Global のルールは適用されます。
- 分解された項目は、その子孫のいずれかが実行されている、入力がある、何かを生成している、またはトレースされているとき、そのようにみなされます。ループ状に互いを分解している項目は、まとめて数えられます。
- Global.9 は各項目を 1 回報告し、スキーマが許可しない関係の相手側と、関係とクラスを注記に示します。例:「Not allowed: decomposed by → Risk」。スキーマがどちらかの方向で許可していれば、その関係は許可されているとみなされます。このような関係は、スキーマエディターでターゲットを除去した後に残ったり、インポートで入ってきたりします。
- Global.10 と Global.11 は LML 2.0 に由来します:エンティティは名前または番号で識別され(§2.1)、列挙型または複数選択の値は属性の一覧から選ばれます(§2.5.6、§2.5.12)。Global.11 は 1 つの項目のすべての問題を注記にまとめます。例:
Status: "Pending" is not a choice、Verification Method: "Test" chosen twice。どちらも、スキーマに LML 2.0 の組み込み要素がある場合(既定のスキーマ、またはスキーマ → 新しい組み込み要素を追加…後のプロジェクト独自のコピー)は既定で実行されます。スキーマのコピーが古いプロジェクトでは無視で始まるので、LML 1.x で作ったモデルには以前と同じ指摘事項が表示されます。実行するには設定で警告またはエラーに設定します。スキーマエディターでは、一覧を作成または変更するときに 2 つ以上の値が求められます。 - ポートはパートではなくインターフェースの点です。子としては数えられず、ポート上の Conduit はそのポートを所有する Asset のものとして数えられます。
- ユースケース(Use Case ラベルの付いた Action)は、動詞のルールと入出力のルールの対象外です。
- Requirement.11 は、「shall」を含む文を 6 つの EARS パターン(EARS テンプレートで書く)と照合し、最初に修正すべき点を示します。例:「Event-driven: Put a comma after the \"When\" condition, before the system name.」ほかの文にある根拠や注記はチェックされません。
- SysML v2 プロジェクトでは、ルールのうち 17 個が SysML v2 の用語で実行されます:Global.1、.2、.4~.8、Requirement.2~.5、.8、.10、.11、Risk.1、TestCase.1、Measure.1。Action、Asset、Conduit、Input/Output のルールは適用されません。モデルの名前、型、構造はエディターの診断でチェックされます。要求のルールは要求のユーセージをチェックします。例えば、Requirement.8 は「Leaf requirements nothing satisfies」(それを満たすパートまたはアクション)、Requirement.10 は「Leaf requirements with no verification case」と表示されます。Global.1、.2、.6 は、リスク、タスク、ドキュメントなど、モデルの横にある項目をチェックします。
プロダクトラインのルール
プロジェクトに Feature または Configuration ができると、モデルチェックは組み込みのルールセットプロダクトライン(ルール ProductLine.1~ProductLine.11 と 13~17、クラスプロダクトライン)も実行します。Applies To にない Feature や Configuration(ProductLine.1)、ルールに違反するか不完全な構成(ProductLine.3)、要求がその構成で検証されていない Released の構成(ProductLine.16)はエラーで、ほかのルールは警告です。ProductLine.10 と 11 は、すべての構成から各構成の完全性をチェックします。ProductLine.13 と 14 は、項目のリビジョン(supersedes)をチェックします:同じユニットに対して 2 つが有効になっているもの、および 1 つもないユニット。構成ビューでは、すべてのルールがその構成をチェックします。プロダクトラインと構成を参照してください。
メッセージ
| メッセージ | 意味 |
|---|---|
| 「指摘事項はありません。適用可能なすべてのチェックに合格しています。」 | 修正するものがない。 |
| 「指摘事項はありません。N 件の指摘事項を無視しています。「無視した項目を表示」で一覧表示されます。」 | 残りの指摘事項がすべて無視された。 |
| 「フィルターに一致する指摘事項はありません。フィルターまたはファセットをクリアしてください。」 | ファセットまたはフィルターで、すべての指摘事項が非表示になっている。 |
| 「スキーマは、クラス … にこれらの関係を 1 つも許可していません」 | 修正に、プロジェクトのスキーマがそのクラスに許可していない関係が必要。スキーマエディターで追加するか、別の方法で指摘事項を修正します。 |
| 「パターンが有効な正規表現ではありません(…)。修正してください。」 | ルールエディターまたはインポートしたファイルに、読み取れないパターンがある。 |
| 「ID『…』はこのルールセットですでに使用されています。別の ID を選択してください。」 | 1 つのセット内の 2 つのルールには、異なる ID が必要。 |
| 「関係『…』はこのプロジェクトのスキーマにありません。」 | ルールが、このプロジェクトにない関係を指定している。変更するまで何も報告しません。 |
| 「この式は、クラス『…』について何も指していません。」 | 式またはフィルターが、プロジェクトにないクラス、ラベル、関係、項目を指定している。 |
| 「バージョン N はサポートされていません。このバージョンの Holarch が読み取れるのはバージョン 1 です。」 | ルールセットファイルが、より新しい Holarch で書かれた。 |
制限事項
- 一覧には、グループごとに最大 200 件の指摘事項が表示されます。残りを見るには一覧を絞り込んでください。
- 1 つのルールセットには最大 500 個のルール、1 つのファイルには最大 50 個のルールセットと 2 MB まで入ります。パターンは最大 300 文字で、値の最初の 20,000 文字をチェックします。
- 前回の実行からの変化は、プロジェクトではなく、デバイスとブラウザーごとに保持されます。
- 公開 API と MCP ツールは、プロジェクトの設定で同じ指摘事項を返します。結果は保存しません。