SysML v2
SysML v2 プロジェクトの要求と検証
要求、品質、TBD/TBR、確認するリンク、承認、RVTM、検証ケース、トレーサビリティマトリックスの各ページで、SysML v2 モデルの要求と検証ケースを作成、チェック、承認、追跡します。
このページの内容
概要
SysML v2 プロジェクトには、LML プロジェクトと同じ要求と検証のページがあります。これらはモデルに対して機能します:要求はモデルの requirement 要素、テストケースはモデルの verification ケースです。
| レールのグループ | ページ |
|---|---|
| ニーズと要求 | 要求、品質、TBD/TBR、確認するリンク、承認 |
| 検証 | RVTM、検証ケース、トレーサビリティマトリックス、モデルチェック |
検証ケースは、LML プロジェクトでテストセンターと呼ばれるページです。
一部のデータは SysML テキストで、一部はモデルの隣に保存される Holarch のデータです。
- テキスト内:番号(ショートネーム)、名前、説明(doc)、入れ子、
satisfy、verify、dependency、派生の関係、単位付きの属性値。 - Holarch のデータ:Status、Priority、Verification Method などの要求の属性、ラベル、テストの状態、結果、ステップ、テストサイクル。他の SysML v2 ツールはこれらを読み取りません。
概念
モデル内の要求
要求は requirement 使用または requirement def です。Holarch はそのフィールドをテキストから読み取ります。
| Holarch のフィールド | SysML v2 テキスト |
|---|---|
| 番号 | ショートネーム:<'VR-1'> |
| 名前 | 名前:CurbMass |
| 説明 | doc コメント:doc /* … */ |
| 子要求(decomposed by) | その要求が所有する要求 |
requirement def <'VR-1'> CurbMass {
doc /* The car's curb mass shall not exceed the mass limit. */
subject car : Car;
attribute limit : MassValue;
require constraint { car.curbMass <= limit }
}
ページでは名前が単語ごとの大文字表記で表示されるため、sedanMass は Sedan Mass と表示されます。
しきい値と目標値
要求は、その require 制約の 1 つが量と値を比較する場合に定量的です:car.curbMass <= limit や range >= 800 [km]。その値がしきい値、つまり許容できる最低限の値です。<= は上限(低いほど良い)、>= は下限(高いほど良い)になります。
SysML v2 には、しきい値を超えて目指す値である目標値のキーワードがありません。Holarch はこれを、HolarchRequirements ライブラリパッケージ(標準ライブラリ、フォルダー Holarch)のメタデータ @Objective として書き込みます。
requirement def <'VR-1'> CurbMass {
subject car : Car;
attribute limit : MassValue;
require constraint { car.curbMass <= limit }
@Objective { value = 1600 [kg]; }
}
- 要求定義の目標値は、その各使用に適用されます。使用は独自の目標値を持つこともできます。
- しきい値は、制約に書かれた値(
12 [kg])、または要求や再定義が設定する属性(attribute :>> limit = maxCurbMass;)にできます。 - 他の SysML v2 ツールは、
@Objectiveを通常のメタデータとして読み取ります。 - 予算と TPMは、しきい値を、要求を充足する各パートの割り当てとして使い、要求をそのしきい値と目標値とともにTPMタブに一覧表示します(予算と TPM)。
関係
| Holarch の関係 | SysML v2 テキスト |
|---|---|
| satisfied by | satisfy carSpec by fleet.sedan; |
| verified by(検証) | 検証ケースの目的内の verify carSpec.sedanMass; |
| performed by | perform または allocate |
| traced to(トレース) | dependency |
| decomposed by | 所有:別の要求が所有する要求 |
どのページでこれらの 1 つを追加または除去しても、テキストが変わります。1 回の元に戻すですべて取り消せます。
テストケースとテストスイート
- テストケースは
verification使用またはverification defです。 - テストケースが検証する要求は、その目的の
verifyメンバーです。 - 検証ケースを所有するパッケージはテストスイートです。
verification def CurbMassTest {
doc /* Weigh the car on a scale with full fluids and no driver. */
subject car : Car;
objective massObjective {
verify carSpec.sedanMass;
}
}
TBD と TBR
次のいずれかに当てはまる場合、要求はオープン(TBD または TBR)です。
- TBD/TBR属性が TBD または TBR である。
- 名前または doc に TBD、TBR、TBS が含まれる。
- 属性値の 1 つに TBD または TBR のメタデータが付いている。
値の代わりに TBD と書くのは有効な SysML ではありません。代わりに、Holarch ライブラリパッケージ HolarchMetadata のメタデータで属性に印を付けます(値を TBD または TBR として指定するを参照)。
使い方
使う場面と理由
これらのページは、モデルに最初の要求を書いた後に使い始め、検証の間も使い続けます。
- 書いている間は要求と品質:各要求は適切に書かれているか。
- レビューでは承認:誰がサインオフしたか。
- 設計が変わる間はTBD/TBRと確認するリンク:何がまだオープンで、何を見直す必要があるか。
- 検証を計画・実行する間はトレーサビリティマトリックス、検証ケース、RVTM:すべての要求が充足され、検証されているか。
要求を書く
- ニーズと要求 → 要求を開きます。
- + 新規をクリックします。パッケージ Requirements に、次の番号で要求使用が追加されます。
- インスペクターまたは表で名前と説明を入力します。テキストはすぐに変わり、編集はそれぞれ 1 回の元に戻すで取り消せます。
- LML の要求と同じセクションで、インスペクターに Holarch のデータを設定します:レビューストリップのStatus、ワークフローの下の優先度、Criticality、Owner、検証の下のVerification Methodと検証レベル、Requirementの下の根拠とSource。これらは Holarch のデータであり、テキストは変わりません。各編集は 1 回の元に戻すで取り消せ、要求の表、RVTM、VCRM には同じ値が表示されます。
エディターで要求を書くこともできます。テキストが構文解析されるとすぐに、要求ページに表示されます。
ドキュメントで要求を書く
ドキュメントには、1 つのパッケージの要求使用を含めることができます。
- ドキュメントで書く ▾ → Requirements Package…を選択し、パッケージを選びます。新しいドキュメントには、その名前にちなんだパッケージと最初の要求が作成されます。
- LML ドキュメントと同様に、要求を追加、インデント、アウトデント、移動します。
- セクションの下の要求はパッケージに属します。
- 別の要求の下の要求は、その中に入れ子になります。
- 番号はそのショートネームです。他の項目を追加、除去、移動しても番号が振り直されるのはセクションだけで、ショートネームは変わりません。新しい要求は、ドキュメントでの番号をショートネームとして持ちます。上に移動と下に移動は 2 つの要求のショートネームを入れ替え、番号を振り直す…はプレビューの後にそれらを変更します。
- エディターでそのパッケージに書いた要求は、ドキュメントに表示されます。
除去は、確認の後、パッケージの要求を削除します。要求を削除せずにドキュメントから外すには、エディターで別のパッケージに移動します。
品質をチェックする
- ニーズと要求 → 品質を開きます。
- 品質をチェックをクリックします。各要求の説明が、LML プロジェクトと同じルールで 9 つの基準により採点されます。
- 最も低いスコアから修正します。
Stale と表示されたスコアは古いテキストのものです。もう一度品質をチェックしてください。
要求を承認する
要求の Status は、Draft → In Review → Approved または Rejected と進みます。
- 要求の Status を In Review に設定します。要求は承認に一覧表示され、レビュー担当者のマイワークでは Awaiting review の下に表示されます。レビュー担当者には通知が届きます。
- レビュー担当者として、要求を選択します。インスペクターに、承認、却下…、Reopenとともに状態が表示されます。
- 承認をクリックするか、任意の理由を添えて却下…をクリックします。インスペクターに、誰がいつ状態を設定したかが記録されます。
Reviewer ロールを持つ人は承認と却下ができます。Approved の要求のテキストを編集すると、In Review に戻ります。
しきい値と目標値を設定する
- しきい値は、1 つの量と値を比較する
require制約として書きます(例:require constraint { battery.mass <= 50 [kg] })。 - 要求を選択します。インスペクターに、数量としきい値(At most または At least)を含むしきい値と目的が表示されます。
- Objectiveに目指す値(例:
45 kg)を入力し、Enter を押します。Holarch は要求に
@HolarchRequirements::Objective { value = 45 [kg]; }を書き込みます。除去するにはフィールドを空にします。 satisfyで、要求をそれを満たすパートにリンクします。パートがしきい値を満たしても目標値に届かない場合、エディターがそれを指摘します。
値を TBD または TBR として指定する
- 要求のパッケージにメタデータパッケージをインポートします:
private import HolarchMetadata::*;。 - 値がまだ決まっていない属性の前に
#TBDと書きます。値は省略するか、見積もりを入れます。 - 値をレビューする必要がある属性の前に
#TBRと書きます。 - 担当者と理由を記録するには、属性の本体で長い形式を使います。
#TBR attribute limit : TimeValue = 0.5 [h];
attribute chargerPower : PowerValue {
@TBD { owner = "Powertrain lead"; rationale = "The fast-charging standard is not chosen yet."; due = "2026-12-01"; }
}
エディターの挿入 ▾ → TBD ValueとTBR 値で、これらを書き込めます。TBD と TBR は ModelingMetadata::StatusInfo を特化しているため、他の SysML v2 ツールは状態の注釈として読み取ります。@StatusInfo { status = StatusKind::tbd; } も数えられます。このパッケージは、標準ライブラリの Holarch の下に一覧表示されます。
TBD または TBR をクローズする
- ニーズと要求 → TBD/TBRを開きます。各オープン項目に担当者、期限、経過日数が表示され、オープン項目のバーンダウンもあります。
- テキストまたはインスペクターで最終的な値を入力し、行の閉じるをクリックします。TBD/TBR 属性は None に戻り、値から TBD/TBR メタデータが除去されます。
doc 内の印は、doc を編集するとクローズします。XLSX をエクスポートで登録簿をエクスポートします。
変更されたリンクを確認する
要求が変わると、それに依存するリンクがその変更の一部としてレビュー対象として印を付けられ、1 回の元に戻すで両方を取り消せます。
- ニーズと要求 → 確認するリンクを開きます。各リンクには、何が、いつ、誰によって変更されたかが表示されます。
- 差分をクリックすると古い名前と新しい名前、doc が表示され、テキストで表示をクリックするとエディターで要求が開きます。
- リンク先の要素を確認します。合わなくなっている場合は更新します。
- レビュー済みにする…をクリックし、必要に応じてコメントを追加して確定します。
確認するリンクを持つ要素には、インスペクターにレビュー…付きのバナー、表に Review バッジも表示されます。データベースのビュー Links to review にそれらが一覧表示されます。
検証を計画して実行する
- 検証 → 検証ケースを開きます。
- + 新規 ▾ → テストスイート…をクリックしてパッケージを追加し、次に+ 新規 ▾ → Test Case…をクリックして検証使用を追加します。
- 要求をテストケースにリンクします。テストケースの目的に
verifyが追加されます。 - ステップを追加し、スイートを実行でスイートを実行して、各テストケースの状態を設定します。状態、期待される結果と実際の結果、ステップ、サイクルは Holarch のデータです。
- 検証 → RVTMを開くと、各要求がその検証方法、検証するテストケース、サブ要求から集計された状態とともに表示されます。
作業例:Hybrid Car デモ
まずデモを作成します:プロジェクトを管理 → プロジェクトファイル ▾ → 新しいデモプロジェクト → Hybrid Car (SysML v2)。その要求はパッケージ VehicleRequirements にあります。
- ニーズと要求 → 要求を開きます。その中には、VR-1 Curb Mass から VR-6 Battery Mass Limit までと、その下に VR-1.1 Sedan Mass、VR-2.1 Sedan Acceleration、VR-4.1 Sedan Range を持つ要求
carSpecがあります。 - VR-1.1 Sedan Mass を選択します。この要求は、目的内の
verify carSpec.sedanMass;を通じて、検証ケースCurbMassTestによって検証されています。 - TBD/TBRを開きます。VR-5 Charge Time がオープンです:その
limitには#TBRが付き、chargerPowerには担当者 Powertrain lead を含む@TBDが付いています。 - エディターで、
maxCurbMassを1650 [kg]から1600 [kg]に変更します。VR-1.1 Sedan Mass はmaxCurbMassを上限として使っているため、そのリンクがレビュー対象として印を付けられます。 - 確認するリンクを開きます。VR-1.1 Sedan Mass の verified by リンクが一覧表示されます。差分をクリックし、テストを確認してから、レビュー済みにする…をクリックします。
- 要求を行、アセットを列にして検証 → トレーサビリティマトリックスを開きます。
carSpecとfleet.sedanのセルには、satisfy carSpec by fleet.sedan;による satisfied by が表示されます。
ヒントとよい進め方
- すべての要求にショートネームを付けます。これは、すべてのページとドキュメントでの番号になります。
- 値は doc ではなく属性として書きます。
attribute :>> limit = maxCurbMass;は評価でき、パラメトリックビューでチェックでき、確認するリンクで追跡できます。 - オープンな値には、値に「TBD」と書くのではなく、
#TBDまたは#TBRで印を付けます。テキストは有効なままで、登録簿がそれらを見つけます。 - テストケースは専用のパッケージに置きます。そのパッケージが検証ケースページのテストスイートになります。
よくある間違い
- Status がテキストにあると考える。Status、Priority、Verification Method は Holarch のデータです。交換ファイルにはこれらは含まれません。
limit = TBDと書く。これは有効な SysML ではなく、テキストは下書きのままです。#TBD attribute limit : TimeValue;を使ってください。- 要求を移動するためにドキュメントから除去する。除去はモデルから削除します。代わりにエディターで別のパッケージに移動してください。
他の機能との関係
- ビュー:要求ビューは、同じ要求と、satisfy、verify、derive、refine の関係を描きます(SysML v2 ビュー)。
- シミュレーター:要求に照らしてチェック…は、要求の require 制約から基準を取り、結果を検証ケースに記録します(評価、単位、分析)。
- ドキュメント:RTM、RVTM、VCRM、フローダウン、割り当てマトリックスのブロックが、モデルの要求を一覧表示します。
- 変更管理:ベースラインはモデルを保持します。比較は要求の変更を一覧表示します(SysML v2 プロジェクトでの Holarch の機能)。
要求と品質
要求ページ
要求は、Requirement クラスで絞り込んだデータベースです。データベースのフィルター、ビュー、列、ツリーモード、インライン編集、一括ツール、エクスポートを備えています(要求)。
- + 新規は、パッケージ Requirements に次の番号で要求使用を追加します。
- 番号、名前、説明を編集するとモデルのテキストが変わり、変更はそれぞれ 1 回の元に戻すで取り消せます。
- Table と Definitions のエクスポートには、種類、Type、多重度、値が含まれ、個体を持つモデルではIndividual、ポーション(portion)、インスタンスも含まれます。
- 要求を選択すると、SysML v2 インスペクターに表示されます。そのリンクでブラウザーに開きます。
モデル要素では利用できません:クラスの変更、複製、ロック、子と一緒にコピー、およびプロジェクトデータ(JSON)とプロジェクトパッケージ(.holarch)のエクスポート。プロジェクトをエクスポート…は、プロジェクト全体を .holarch としてバックアップします。
品質ページ
品質は、各要求の説明を LML プロジェクトの 9 つの基準で採点します:Appropriate、Complete、Conforming、Correct、Feasible、Necessary、Singular、Unambiguous、Verifiable(要求の品質)。スコアは Holarch のデータです。Stale と表示されたスコアは古いテキストのものです。
LML プロジェクトと同様に絞り込みます(品質ページを絞り込む):Quality、Fails a criterion、Rule finding のグループを持つ+ フィルター、要求の属性とラベル、入力した quality: 条件、検索テキスト、ビュー ▾。
変更管理
確認が必要なリンク
リンクの反対側の項目が、そのリンクの最後のレビュー後に変更された場合、そのリンクはレビューが必要です(他のツールでは疑わしいリンクとも呼ばれます)。リンクがまだ成り立つことを確認してから、レビュー済みにします。要求の変更により、次のリンクがレビュー対象になります:satisfied by(satisfy)、verified by(verify)、decomposed by(所有された要求)、traced to(dependency)。
変更とは、次のいずれかの編集です。
- 要求の名前または doc。
- 主要な属性:Priority、Criticality、Verification Method、Verification Level。
- 要求が所有する属性の値(例:
attribute :>> limit = maxCurbMass;)、またはその制約の 1 つ。 - それらの値や制約が指定する対象の属性(例:
attribute maxCurbMass : MassValue = 1650 [kg];)。
どこで行っても数えられます:エディター、ビュー、インスペクター、表。Verification Method または Verification Level を変更すると verified by リンクだけがレビュー対象になり、最初に設定したときはどれもレビュー対象になりません。
確認するリンクページには、リンクごとに差分、テキストで表示、レビュー済みにする…があります。
承認
承認は In Review の要求を一覧表示します。インスペクターには、承認、却下…、Reopenとともに状態と、誰がいつ設定したかが表示されます。状態はモデルの隣にある Holarch のデータで、SysML テキストの一部ではありません。
TBD/TBR 登録簿
登録簿は、各オープン要求を担当者、期限、経過日数とともに一覧表示し、オープン項目のバーンダウンとXLSX をエクスポートがあります。閉じるは TBD/TBR 属性を None に戻し、値の TBD/TBR メタデータを除去します。
期限は要求の唯一の期限であり、インスペクターのワークフローグループと項目ビューの期限と同じ日付です。
- 要求の値に付いた
@TBD/@TBRメタデータの最も早いdue(例:@TBD { owner = "Powertrain lead"; due = "2027-06-30"; })。 - それがなければ TBD Due Date 属性。
- それもなければ要求自身の期限。
登録簿は読み取り専用です。日付はテキストで変更するか、インスペクターで期限を設定します。期限は、要求の各 @TBD/@TBR メタデータ本体に due = "<date>"; を書き込み(本体にない場合は追加し)、要求の期限を設定します。1 回の元に戻すですべて取り消せます。接頭辞形式の #TBD/#TBR には本体がないため、その方法だけで印を付けた値は要求の期限を使います。
検証ページ
検証ケース
スイート、テストケース、状態、ステップ、テストサイクル、スイートを実行、レポートは LML プロジェクトと同様に動作します(検証)。
- + 新規 ▾ → Test Case…は検証使用を追加し、テストスイート…はパッケージを追加します。
- 要求をリンクすると、テストケースの目的に
verifyが追加されます。 - 状態、期待される結果と実際の結果、ステップ、サイクルは、モデルの隣に保存される Holarch のデータです。
RVTM
各要求を、その検証方法、検証するテストケース、サブ要求から集計された状態とともに表示します(RVTM)。⚠ は、satisfy、verify、分解のリンクがレビューを必要とする要求と、verify リンクがレビューを必要とする検証ケースを示します。
トレーサビリティマトリックス
行、列、関係は LML プロジェクトと同様に機能します(トレーサビリティマトリックス)。
- アセットはパート使用(システム内のパート)、Actionsはアクション使用です。
- クラスの軸では、Elements → 定義で代わりに定義が一覧表示されます。
- モデル要素間のセルには、satisfied by(
satisfy)、verified by(verify)、performed by(allocateまたはperform)、traced to(dependency)、decomposed by(所有)を入れられます。その他の関係は許可されないものとして表示されます。 - 各クリックは 1 回の元に戻すで取り消せ、モデルのテキストを変更します。
モデルチェック
モデルに適用されるルールが実行されます(モデルチェック)。SysML v2 の用語では次のとおりです。
- 名前、ショートネーム(リーフ要求)、説明(自身または定義のもの)、
satisfy、verifyのいずれかを持たない要求使用、および「shall」を含まないリーフ要求。 - 重複したショートネーム、あいまいな語、存在しない対象を指すライブ値、表示できない UAF ビュー。
- 軽減策のないオープンな最上位のリスク、Issue のない不合格の検証ケース、しきい値を超えた TPM。
- モデルの隣にある項目(リスク、タスク、判断、ドキュメント)で、同じ名前のもの、または関係を持たないもの。
エディターのチェッカーが名前、型、構造を扱うため、LML の機能分析ルール(Action、Asset、Conduit、Input/Output)は実行されず、設定にはこれらのルールだけが一覧表示されます。モデル要素にはマージの修正は提示されません。
メッセージ
| メッセージ | 意味と対処法 |
|---|---|
| SysML v2 プロジェクトでは利用できません:エディターでモデルを変更してください。 | この操作は LML エンティティでのみ機能します。エディターで変更してください。 |
| 変更は適用されませんでした。 | この編集によってテキストが無効になります。横のメッセージに問題が示されます。 |
| Stale — re-run | 前回の品質チェックの後に要求のテキストが変更されました。もう一度品質をチェックしてください。 |
| “…” meets “…”, but … does not reach the objective …. | 情報:パートはしきい値を満たしていますが、目標値に届いていません。設計を改善するか、目標値を変更してください。 |
| “…” has an objective but no threshold to compare it with. … | 要求に @Objective がありますが、量と値を比較する require 制約がありません。追加してください。 |
| “…” has more than one threshold (…), so its objective is ambiguous. … | 要求が複数の量を比較しています。量ごとに 1 つの要求に分割してください。 |
| The objective … of “…” is not below (above) its threshold …. | 目標値はしきい値を超えている必要があります:上限なら下回り、下限なら上回る値です。 |
| The objective … of “…” is in …, but its threshold … is in …. | 目標値の単位が、しきい値とは別の量の単位です。しきい値の量の単位を使ってください。 |
| @Objective applies to requirements, but “…” is …. | 注釈が要求の外にあります。要求の中に移動してください。 |
制限事項
- Status、Verification Method、その他の要求の属性、ラベル、テスト結果は Holarch のデータです。SysML v2 の交換ファイルにはこれらは含まれません。
- クラスの変更、複製、ロック、子と一緒にコピーは、モデル要素では利用できません。
- モデルチェックのマージの修正は、モデル要素では提示されません。
関連ページ
SysML® および OMG® は、米国およびその他の国における Object Management Group, Inc. の登録商標です。