モデル
スキーマと拡張
カスタムクラス、属性、選択肢、関係、ラベル、ステータスワークフローでプロジェクトの LML スキーマを調整し、各変更が既存のデータにどう影響するかを確認します。
概要
スキーマは、プロジェクトのモデルが保持できるものを定義します:
- エンティティのクラス、
- 各クラスが持つ属性、
- クラスを結べる関係、
- エンティティにタグを付けるラベル、
- 省略可能なワークフロー:クラスごとのステータス属性の状態、その変わり方、および承認が必要な変更。
すべてのプロジェクトは、既定の Lifecycle Modeling Language(LML)スキーマから始まります。スキーマエディターは、1 つのプロジェクトについてだけそれを変更します。最初の編集でプロジェクト自身のコピーが作成されるので、他のプロジェクトには影響しません。スキーマの編集はそれぞれ 1 回の元に戻すで取り消せます。
Holarch は、すべてのプロジェクトに組み込みの拡張も追加します。たとえば、要求の優先度とOwner、リスクのHandling Strategyです。組み込みの拡張を参照してください。
エンティティ、属性、関係の日々の扱いについては、モデルとデータベースを参照してください。
概念
プロジェクトのスキーマ
- 既定のスキーマ:Holarch に付属する LML のクラス、関係、属性、ラベル。アプリ内のヘルプトピックLML Classes (schema)、LML Relationships (schema)、Labels (schema)に、開いているプロジェクトのものが現在の状態で一覧表示されます。
- プロジェクトのスキーマ:プロジェクト内に保存されるコピー。最初の編集で作成されます。エクスポートではプロジェクトとともに移動し、それを開くすべてのメンバーに届きます。
- 組み込みの拡張:Holarch の機能に必要な追加分。プロジェクトを開くたびに名前で適用されます。そのため、ほとんどのプロジェクトはすでに独自のコピーを持ち、使用状況ページには「このプロジェクトは独自に編集したスキーマを使用しています。」と表示されます。
クラス
クラスは、RequirementやAssetなどのエンティティの種類です。名前、説明、親、色と、2 つのフラグ(抽象と非表示)があります。
- 親:サブクラスは、親の属性と関係のターゲットを継承します。親を対象とするすべてのクエリ、フィルター、ダイアグラムに表示されます。たとえば、Actionのカスタムサブクラスはアクション図を持ちます。Requirementのカスタムサブクラスは、品質チェックと承認のコントロールを持ちます。
- 抽象:クラスはサブクラスをまとめるもので、直接作成することはできません。
- 非表示:エンティティの作成時やクラスの変更時に、このクラスは表示されません。このクラスとそのサブクラスは、データベースのクラスフィルターから除外されます。既存のエンティティは残ります。
- 色:クラスのバッジと色見本の色。指定がない場合、カスタムクラスは最も近い組み込みの祖先の色を使います。バッジには名前の最初の 2 文字が表示されます。
属性
属性は、要求の優先度のように、クラスのすべてのエンティティが持つフィールドです。属性は関係に属することもできます。
属性には、名前、Type、クラスの順序の中の位置があります。Allowed values、既定値、説明を持つこともできます。説明は、属性のラベルにポインターを合わせると表示されます。
型(属性のダイアログでの分類どおり。括弧内は保存される型の ID で、エクスポート、インポート、API で使われます):
| グループ | 種類 | 内容 |
|---|---|---|
| テキスト | 短いテキスト(TEXT)、長いテキスト(BIG_TEXT)、リッチテキスト(HTML) | 1 行、複数行、書式付きテキスト |
| 数値 | Number(NUMBER)、パーセント(PERCENT)、Duration(DURATION) | 数値または分布、0~100、時間の単位付きの数値または分布 |
| 日付と時刻 | 日付と時刻(DATETIME) | 日付と時刻 |
| 選択肢 | 一覧から 1 つ(ENUMERATION)、一覧から複数(MULTISELECT)、はい/いいえ(BOOLEAN) | 1 つの値、複数の値、Yes または No |
| リンク | Web アドレス(URI)、ファイル(FILE) | リンク、アップロードされたファイル |
| 特殊 | Location(GEOPOINT)、Equation(EQUATION)、Computed(COMPUTABLE)、個人またはチーム(USER_TEAM)、多重度(MULTIPLICITY)、品質チェック(QUALITY) | 緯度と経度、LaTeX のテキスト、他のエンティティの属性から計算される値、個人またはチームの名前、n、n..m、n..*、*、品質チェックで設定される Yes/No の基準 |
各型のエディターについては、属性の型とエディターで説明しています。
親クラスから継承した属性が先に、その後にクラス自身の属性が、各クラスのページで設定した順序で一覧表示されます(行をドラッグするか、↑ / ↓)。新しい属性は最後になります。
非表示の属性は値を保持します。再び表示されるまで、エディター、フィルター、列、検索、レポートから消えます。
関係とターゲット
- 関係は常に、名前と逆方向の名前の組です(例:satisfies / satisfied by)。1 つを作成すると両方が作成されます。
- ターゲットは、あるクラスから別のクラスへの関係を許可します(例:Requirement verified by Test Case)。あるクラスへのターゲットは、そのサブクラスも許可します。サブクラスは親のターゲットを継承します。
- 関係は属性を持てます(例:decomposed byの多重度)。関係に追加した属性は、その逆方向の関係にも適用されます。
- 非表示の関係は、スキーマエディターで淡色表示され、ヘルプの参照一覧から除外されます。使用は引き続きできます。
ラベル
ラベルは、Stakeholder Needのようにエンティティに付けるタグです。フィールドは追加されず、構造は何も変わりません。
ラベルには、名前、説明、適用先のClass(es)があります。親ラベルを持てるので、ラベルは入れ子にできます。
- クラスを選択しない場合、ラベルはすべてのクラスに適用されます。
- あるクラスのラベルは、そのサブクラスにも適用されます。
- 非表示のラベルは、それを持つエンティティには残りますが、選択肢には表示されなくなります。
ワークフロー
ワークフローは、クラスの 1 つのENUMERATION属性(通常はStatus)がどのように変わるかを制御します。ワークフローには次のものがあります:
- 状態:クラスが使う値(順序付き)。カスタムの状態は追加、名前の変更、並べ替え、除去ができます。要求のApprovedなどの組み込みの状態は、廃止することしかできません。属性を継承しているサブクラス(例:Requirementの下のSoftware Requirement)は、独自の状態を保持します。
- 遷移(From → To):許可された変更。遷移がない場合、どの状態からでもどの状態にも移れます。
- 遷移の承認:その変更には承認された変更要求が必要です。既定では、変更要求 → 設定で設定した承認者が決定します。代わりに、遷移ごとに独自の承認者(オーナー、編集者、または指名した人)と、そのうち何人が承認する必要があるか(最大 5 人、または指名したすべての人)を指定できます。
- この遷移の後に項目をロック(遷移の⋯メニュー):変更の後に項目がロックされます。
その後、属性のエディターには現在の値と許可された次の状態だけが表示されます。承認が必要な状態には(needs approval)と表示されます。
使い方
使う場面と理由
スキーマは、プロジェクトの開始時、つまりモデリングの手法を決めるときとデータをインポートする前に調整します。主な理由:
- 手法や規格を採用する:プロセスで必要な属性(アセットの TRL や要求の Safety Integrity Level など)を追加します。ドキュメントのテンプレートが想定するラベルを追加します。
- クラスを特化する:Riskの下のHazardやAssetの下のPayload Instrumentなどのサブクラスを追加します。するとクエリ、フィルター、レポートでそれらを区別でき、それらは LML のすべての関係を保持します。
- 手法に必要な関係を許可する:ターゲット、または新しい関係の組を追加します。
- レビューのプロセスを徹底する:要求の Status が Draft → In Review → Approved と進むようにワークフローを追加します。するとエディターはステップの飛ばしを決して許しません。In Review → Approved を承認として設定すると、その移行はプロジェクトの承認者を経由します。
- プロジェクト間で再利用する:あるプロジェクトからスキーマをエクスポートし、次のプロジェクトにインポートします。
スキーマは「このモデルで何を表現できるか」という問いに答えます。慎重に変更してください。クエリ、保存した列、レポート、インポートは、クラス、属性、関係を名前で参照します。
クラスに属性を追加する
- ナビゲーションレールで設定 → スキーマ(下部のツール)をクリックします。
- サイドバーのクラスの下でクラス(例:Asset)をクリックします。
- 属性カードで+ 属性をクリックします。
- 名前を入力します。
- Typeを選択します(例:Choices の下の一覧から 1 つ)。
- 一覧から 1 つまたは一覧から複数の場合:Allowed valuesに選択肢を 1 行に 1 つずつ入力します。
- 省略可能:既定値を設定します。そのクラスの新しいエンティティはこの値で始まります。
- 省略可能:説明を入力します。
- 属性を追加をクリックします。
トースト「属性を保存しました」が表示されます。属性はクラスの一覧の最後になり、そのクラスとサブクラスで、インスペクター、項目ビュー、データベースの列とフィルター、検索、レポート、インポートのマッピングに表示されます。
- 移動するには、属性の表でその行をドラッグするか、行の↑と↓を使います。移動はそれぞれ 1 回の元に戻すで取り消せます。
既存の属性に選択肢を追加する
- 属性を定義しているクラスを開きます。定義先列にそれが表示されます。継承された属性は、それを定義しているクラスで編集します。
- 行の✎(属性を編集)をクリックします。
- Allowed valuesに新しい選択肢を 1 行で追加します。
- 保存をクリックします。
一覧から 1 つの場合、各選択肢の前にある四角(一覧の下)で値の色を設定します。その属性の値を列とするかんばんボードでは、これが列の色として使われます。
選択肢を除去するには、同じダイアログでその行を削除します。その値をすでに持っているエンティティは値を保持しますが、エディターには表示されなくなります。選択肢を除去する前に、属性のクエリ(例:Requirement:"Priority=Urgent")でそれらのエンティティを見つけ、現在の選択肢を設定します。
サブクラスを作成する
- 親クラスを開きます。
- + サブクラスをクリックします。
(またはサイドバーの+ クラスをクリックし、親を選択します。)
- 名前と説明を入力します。
- 必要に応じて抽象、非表示、色を設定します。
- クラスを作成をクリックします。
新しいクラスが表示されます。継承されたすべての属性とターゲットをすでに持っています。
既存のエンティティを新しいクラスに移すには、データベースでそれらを選択し、クラスを変更…を使います。クラスを変更を参照してください。
ラベルを追加する
- サイドバーの+ ラベル、またはラベルページの+ 新しいラベルをクリックします。
- 名前と説明を入力します。
- ラベルが別のラベルの下に属する場合は、その親を選択します。
- 適用先のClass(es)を選択します。⌘ / Ctrl/Ctrl+クリックで複数を選択します。何も選択しない場合、ラベルはすべてのクラスに適用されます。
- ラベルを作成をクリックします。
ラベルを適用するには、インスペクターまたは項目ビューの+ ラベル、またはデータベースの一括操作バーのラベル ▾を使います。
新しい関係を許可する
2 つのクラス間の関係は、ターゲットが許可している場合にだけ許可されます。許可するにはターゲットを追加します。
- ソースのクラスを開きます。
- 関係で+ 関係をクリックします。
- Relationを選択します。
- もう一方のクラスを選択します。
- 逆方向の関係をもう一方のクラスにも追加にチェックを入れたままにします。するとどちらの端からでもリンクを作成できます。
- 関係を追加をクリックします。
もう一方のクラスに逆方向の関係がない場合、このクラスに戻る列に+ on <class>が表示されます。クリックすると、そこに逆方向の関係が追加されます。
必要な関係が存在しない場合は、先に作成します:
- ダイアログの新しい関係の種類…(またはサイドバーの+ 関係)をクリックします。
- 名前と逆方向の名前、およびそれらの説明を入力します。
- 関係を作成をクリックします。
- 上の手順 3 で新しい関係を選択します。
ステータスのワークフローを定義する
- サイドバーのワークフローをクリックします。
- クラスを追加…でクラスを選択します。
クラスのカードが表示されます。ワークフローは、クラスの最初の列挙型の属性を監視します。
- 必要に応じて、監視の一覧で別の属性を選択します。変更すると遷移が消去されます。
- + 遷移を追加をクリックします。
- 遷移の名前、From、Toを設定します。Fromは(初期 — 値なし)または状態です。
- 変更に承認された変更要求が必要な場合は、承認にチェックを入れます。変更の後に項目をロックするには、行の⋯メニューを開き(または行を右クリックし)、この遷移の後に項目をロックを選択します。すると行に項目をロックしますと表示されます。
- 許可する各ステップについて、手順 4~6 を繰り返します。
遷移の承認者を選ぶには、遷移の承認者を選ぶを参照してください。
これで属性のエディターには、許可された次の状態だけが⇢ ワークフローの印付きで表示されます。
ワークフローの状態を追加または変更する
- ワークフローページで、クラスのカードを見つけます。項目列は各状態の項目を数えます。値のない項目は属性の既定値として数えられます(ステータスのないテストケースは、テストセンターでの表示と同じくNot Runとして数えられます)。
- 状態を追加するには、新しい状態に名前を入力し、+ 状態を追加をクリックします。
状態がクラスと属性の選択肢に追加されます。
- 状態の順序を決めるには、↑または↓をクリックします。ピッカーとボードの列はこの順序に従います。
- カスタムの状態の名前を変更するには、名前を変更…をクリックし、新しい名前を入力します。
その状態の項目、遷移、値の色に新しい名前が付きます。1 回の元に戻すですべて取り消せます。
- 状態を除去するには、除去…(カスタム)または廃止…(組み込み)をクリックします。
- どの項目も持っていない状態は除去されます。
- 項目がその状態を持っている場合は、移動先の状態とともに移動して除去を選ぶか、廃止として保持を選びます。廃止された状態はその項目に残り、(廃止)と表示され、選択肢には表示されなくなります。その状態から出る遷移は残るので、項目はその状態から移れます。復元で再び選択肢に表示されます。
このページでのどの変更も、値を消去することはありません。
遷移の承認者を選ぶ
- ワークフローページで、遷移の承認にチェックを入れます。
その横にボタンが表示されます:Change Request settings ▾。
- ボタンをクリックします。
遷移の承認者が開きます。
- 承認者で 1 つを選択します:
- As set in Change Requests → Settings:プロジェクトの承認者が決定します(既定)。
- Ownersまたはオーナーと編集者。
- 指名された人:承認するプロジェクトメンバーにチェックを入れます。デスクトップアプリでは、各人が環境設定 → Your nameに入力したとおりに、名前をカンマで区切って入力します。
- Approvals neededで、何人が承認する必要があるか(1~5、または指名されたすべての人)を選択します。
- 保存をクリックします。
ボタンにはルールが表示されます(例:All 3 named ▾)。この変更は 1 回の元に戻すで取り消せます。
複数の状態の変更を含む要求には、適用されるすべてのルールが必要です。承認できる人が 1 人でも却下すると、要求は却下されます。ホスト型サービスでは、指名された承認者が数えられるのは、プロジェクトのオーナーが最後にワークフローを設定した場合だけです。それ以外の場合、遷移には同じ数のオーナーの承認が必要です。
状態の変更の承認を要求する
- インスペクターまたは項目ビューで、(needs approval)の印が付いた状態を選択します。要求の場合は、レビューストリップでその遷移(…で終わります)をクリックすることもできます。
承認を要求が開きます。
- 必要に応じて理由を入力し、要求を提出をクリックします。
状態の変更を含む変更要求が作成されて提出されます。ダイアログにはその承認者(遷移自身の承認者、または変更要求 → 設定で設定された承認者)が示されます。項目は状態を保持します。
要求が未解決の間、要求のレビューストリップには、その件数とともに表示されます(例:CR-4: 1 of 3 approvals)。
- 承認者が承認します。
最後の承認者がプロジェクトを編集できる場合は、最後の承認で項目が新しい状態に移ります。それ以外の場合は、編集者が要求を開いて変更を適用をクリックします。項目の履歴にはvia CR-nと表示され、要求の承認記録には、すべての承認者と要求が記載されます。
そのような状態への直接の変更は、「… には承認が必要です。要求するには、項目で「X」を選択してください。」で拒否されます:一括の属性…、グリッドのセル、ボードでの移動、AI による変更。要求が未解決の間にその状態を再び選択すると、その要求が開きます。
プロジェクト間でスキーマを共有する
- ソースのプロジェクトで、レールの設定 → スキーマを開きます。
- スキーマをエクスポートをクリックします。
JSON ファイルがダウンロードされます。
- ターゲットのプロジェクトで、レールの設定 → スキーマを開きます。
- その他 ▾ → スキーマをインポート…をクリックし、ファイルを選択します。
- モードを選択します:
- Merge (add the classes, attributes, relations and labels this project lacks, matched by name)、または
- このプロジェクトのスキーマを置き換え。
- インポートをクリックします。
作業例:CubeSat EO-1
この例では、アセットに技術成熟度レベル(TRL)を追加し、クラスを特化し、レビューのワークフローを追加します。プロジェクトを管理 → プロジェクトファイル ▾ → 新しいデモプロジェクトでデモを作成し、レールの設定 → スキーマを開きます。
モデルを確認します。
- 使用状況ページを読みます。
クラスの表には、最もよく使われるクラスが先に、その項目、属性、関係とともに一覧表示されます。未使用には、デモで使われていないクラス、ラベル、関係が一覧表示されます。
アセットに TRL を追加します。
- Asset、次に+ 属性をクリックします。
- Name に
TRLを入力し、Type として一覧から 1 つを選択します。 - Allowed valuesに選択肢
1~9を 1 行に 1 つずつ入力します。 - Description に
Technology readiness levelを入力します。 - 属性を追加をクリックします。
値を入力します。
- Architecture → アセットを開きます。
- 1.2.1 Reaction Wheel Assembly を選択し、インスペクターでTRLを
7に設定します。 - 同じようにして、1.2.2 Star Tracker を
6に、1.1 Payload Camera を5に設定します。クエリを実行します。
- 検索ボックスに
Asset:"TRL>=6"と入力し、Enter を押します。クエリがクエリバーのフィルターチップになります。表にはリアクションホイールとスタートラッカーが一覧表示されます。数値である選択肢の値は、数値として比較されます。
クラスを特化します。
- スキーマエディターに戻り、Assetを開いて+ サブクラスをクリックします。
- 名前を
Payload Instrumentにし、クラスを作成をクリックします。 - データベースで 1.1 Payload Camera にチェックを入れ、クラスを変更…をクリックします。
- 新しいクラスとしてPayload Instrumentを選択します。
ダイアログには「1 個の項目が Payload Instrument になります。」と表示され、除去されるものは一覧にありません。サブクラスは Asset のすべての属性とターゲットを継承するためです。
- クラスを変更をクリックします。
カメラは、その TRL、performsのリンク、分解構造の中の位置を保持します。
レビューのワークフローを追加します。
- ワークフローを開き、クラスを追加…でRequirementを選択します。
- Statusを監視していることを確認します。
- 次の遷移を追加します:Initial → Draft、Draft → In Review、In Review → Approved、In Review → Rejected、Rejected → Draft。
- 2.4 Target Slew を開きます。その Status は Draft です。
そのStatusの一覧には、下書きとIn Reviewだけが表示されるようになります。
元に戻すか、保持します。
- 実験を元に戻すには、変更ごとに 1 回 ⌘Z / Ctrl+Z を押します。または変更を保持し、スキーマをエクスポートをクリックして次の CubeSat プロジェクトで再利用します。
ヒントとよい進め方
- 新しい最上位のクラスより、サブクラスとラベルを優先します。サブクラスは、親の LML のすべての関係、ダイアグラム、チェックを保持します。ラベルは構造をまったく変えません。
- 削除する代わりに非表示にします。クラス、属性、ラベルを非表示にしても既存のデータはそのまま残り、元に戻せます。
- インポートの前にスキーマを設定します。インポートのマッピングには、存在する属性が表示されます。新しい属性にマッピングした列は、推測した型で自動的に作成されます。インポートとエクスポートを参照してください。
- 組み込みの追加分は残します。不要な組み込みの拡張は非表示にします。名前を変更したり削除したりしないでください。失われたものは、次にプロジェクトを開いたときに空の値で再び追加されます。
- カスタムの要素はすべて記述します。その説明に書きます。説明は、エディターのツールチップとヘルプのスキーマの表に表示されます。
- 「より小さい」の属性テストは、値のないエンティティにも一致します。たとえば
Asset:"TRL<6"には、TRL のないアセットも含まれます。そのようなテストは肯定のテストと組み合わせるか、補集合に>=を使います。
よくある間違い
- 属性の型を変更すると、その値が消去されます。Holarch は「N 個のエンティティに「X」の値があります。型を A から B に変更すると、それらの値は消去されます。」と警告します。古い値が必要な場合は、先に CSV レポートをエクスポートします。1 回の元に戻すで、型の変更と消去された値の両方を取り消せます。そのような値が 5,000 を超えるプロジェクトでは、消去中に進行状況カードが表示されます。
- 関係を削除すると、その関係のリンクも削除されます。確認にはその数が示されます。元に戻すと復元されます。
- ターゲットを除去すると、スキーマが許可しなくなった関係が残ります。既存のリンクは残ります。モデルチェックは、それらをルール Global.9(スキーマが許可しない関係)の下に一覧表示します。ターゲットを除去する前か後に、それらを除去するか関係を変更します。確認にはその数が示されます。
- エンティティを持つクラスは削除できません。先にそのクラスを変更するか削除するか、クラスを非表示にします。
- 通常の遷移はエディターを案内するだけです。一括の属性…、インポート、AI による変更では、承認が不要な任意の状態を引き続き設定できます。変更がレビューを迂回してはならない場合は、遷移を承認として設定します。
- 組み込みの状態の名前は変更できません。承認、構成管理、検証がそれらに依存しています。代わりに新しい状態を追加するか、組み込みの状態を廃止します。
他の機能との関係
- データベース、インスペクター、項目ビューは属性を表示して編集します。スキーマが許可する関係を提供します。クエリは、クラス、属性、ラベル、関係を名前で参照します。モデルとデータベースを参照してください。
- ダイアグラム:エンティティが持てるダイアグラムの種類は、そのクラスと上位のクラスによって決まります。カスタムのサブクラスはそれらを継承します。
- 要求の機能(品質、承認、TBD/TBR、確認が必要なリンク)は、Status、TBD/TBR、品質基準などの組み込みの属性に依存しています。要求を参照してください。
- トレーサビリティマトリックスとモデルチェックは、関係のターゲットを使って、何が許可され何が欠けているかを判断します。トレーサビリティを参照してください。
- インポートとエクスポートは名前で属性にマッピングし、プロジェクトの JSON、
.holarch、ReqIF のファイルでスキーマを運びます。インポートとエクスポートを参照してください。
スキーマエディター
スキーマエディターでは、スキーマのすべての変更を行います。ナビゲーションレールの設定 → スキーマ(下部のツール)から開きます。アドレス schema?class=<id> でクラスを直接開けます(以前の組み込みクラスの番号も引き続き使えます)。
エディターには、ページヘッダー、サイドバー、メインエリアがあります。メインエリアには、使用状況ページ、クラス、または関係、ラベル、ワークフローのページが表示されます。
ページヘッダー
| コントロール | 機能 |
|---|---|
| スキーマをエクスポート | プロジェクトのスキーマを JSON(<Project_name>_schema.json)としてダウンロードします。 |
| その他 ▾ → スキーマをインポート… | スキーマの JSON ファイル(スキーマを含むプロジェクトの JSON も可)をMergeまたは置換でインポートします。 |
| 新しい組み込み要素を追加… | プロジェクトが独自のスキーマを持つ場合に表示されます。既定のスキーマにあってこのコピーにないクラス、関係、属性、ラベル(名前で照合)を一覧表示し(LML 2.0 の追加分や、既存のものの LML 2.0 の値と許可される関係など:Decision の Status の Open と Closed、Logical の decomposed by Logical、Connection の transfers Input/Output)、それらを追加します。1 回の元に戻すですべて取り消せます。既存のクラス、属性、選択肢、データは変わりません。新しい値は既存の値の後に追加されます。 |
| その他 ▾ → Reset to Default… | プロジェクトが独自のスキーマを持つ場合に表示されます。確認の後、既定の LML スキーマに置き換えます。 |
サイドバー
- クラス、属性、関係、ラベルを検索…でクラスツリーを絞り込みます。メインエリアには、一致するクラス、属性、見つかった関係、見つかったラベル、または「一致するクラス、属性、関係、ラベルはありません。別の検索語をお試しください。」が表示されます。
- 使用状況。
- + クラス、+ ラベル、+ 関係。
- クラス:色見本、「(abstract)」と「(hidden)」の印、エンティティ数(サブクラスを含む)付きのクラスツリー。
- その他:関係(件数付き)、ラベル(件数付き)、ワークフロー。
使用
最初に使用状況が開きます。そのステータス行には「既定の LML スキーマです。最初の編集で、このプロジェクト用のコピーが作成されます。」または「このプロジェクトは独自に編集したスキーマを使用しています。」と表示されます。
- クラス:非表示でないクラスの表(最もよく使われるものが先):クラス(クリックで開きます)、項目(サブクラスを含む)、属性(そのクラス自身のもの)、関係(許可されたもの。継承分を含む)、最終変更(その項目のいずれかが最後に変更された日時)。
- 未使用:開くことのできる 3 つの一覧。プロジェクトのどこでも使われていないクラス、ラベル、関係で、それぞれ件数付きです。行の非表示は、そのクラス、ラベル、関係の組を非表示にします(1 回の元に戻すですべて取り消せます)。非表示の項目はスキーマに残り、そのページまたはダイアログで再び表示できます。
クラスのページ
サイドバーでクラスをクリックすると、そのページが開きます。上から順に:
- 親クラスのパンくずリスト。クリックするとそのクラスが開きます。
- ヘッダー:クラスのアイコンと名前、抽象と非表示のチップ、✎ クラスを編集、+ サブクラス、削除。N entities in project ›は、そのクラスで絞り込んだデータベースを開きます。
- 説明カード:説明、チップId N、Attributes N(一部が親から来ている場合は「(k inherited)」付き)、Relations N、Entities N、およびSubclasses。
- 属性カード:+ 属性と、次の列を持つ表:
- クラス自身の属性の順序のコントロール:行をドラッグするか、↑ / ↓(移動はそれぞれ 1 回の元に戻すで取り消せます)。
- 名前、Type(型の名前。ポインターを合わせると保存される ID が表示されます)。
- 詳細:選択肢と既定値。
- 定義先:「this class」または祖先のクラス。
- 説明。
- このクラスで定義された属性の操作:✎(属性を編集)、⊘ / 👁(属性を非表示 / 属性を表示)、×(属性を除去)。
- 関係カード:+ 関係と、両方向を示す表:Relation、その他のクラス、このクラスに戻る(逆方向の名前と、逆方向の関係がないもう一方のクラスの場合は+ on <class>)、説明。その他のクラスでは、× でこのクラスで定義された関係を除去します。継承されたものには「(inherited from X)」と表示されます。
- ラベルカード:そのクラスで使えるラベル。
*は、すべてのクラスで使えるラベルを示します。
クラスの編集ダイアログ
タイトルは新しいクラスを作成またはEdit Class — Xです。フィールド:名前、説明、親((なし — 最上位)またはクラス)、非表示、抽象、色。クラスを作成またはクラスを保存をクリックします。
エンティティを持つ組み込みのクラスは、親を変更できません:「エンティティがこの組み込みのクラスを使っているため、親は固定されています。」
属性のダイアログ
タイトルは新しい属性またはEdit Attribute — Xです。関係の属性の場合、タイトルに「(relation「…」)」が付きます。属性を追加または保存をクリックします。
- 名前とType(分類:Text、Numbers、Date and time、Choices、Links、Special)。順序のフィールドはありません。新しい属性は最後になります。
- 許可される値(1 行に 1 つ):一覧から 1 つと一覧から複数の場合のみ。空の行と重複した値は除かれます。一覧には少なくとも 2 つの値が必要です:「列挙型には少なくとも 2 つの選択肢が必要です。選択肢をもう 1 つ追加してください。」(一覧から複数では「複数選択には…」)。すでに値が 1 つしかない属性も、その一覧を変更しない限り保存できます。一覧から 1 つの場合は、一覧の後に値ごとの色の四角が表示されます。
- 既定値:FILE、COMPUTABLE、QUALITY、HTML、USER_TEAM では使えません。
- 説明。
関係のページ
サイドバーの関係をクリックすると、すべての関係の組が表示されます。ページには+ 関係と、次の列を持つ表があります:
- Relationと逆方向。
- ソース → ターゲット:許可されたすべてのクラスの組。
- 属性:属性ごとの ✎ と+ 属性。
- 使用中:関係のリンクの数。
- 説明。
- ✎(関係を編集)と×(関係を削除)。
関係のダイアログのタイトルは新しい関係またはEdit Relation — Xです。名前、逆方向の名前、説明、逆方向の説明、非表示、色(または既定の色)があります。スパイダー図はこの色で関係を描きます。ダイアグラムでは、関係のリンクごとに独自の色を選ぶこともできます。Relation列には色が色見本として表示されます。編集時には、関係の属性も+ 属性を追加とともに一覧表示されます。関係を作成または保存をクリックします。
ラベルのページ
サイドバーのラベルをクリックすると、すべてのラベルが表示されます。ページには、Add DoDAF LabelsとAdd UAF Labels(このプロジェクトにないフレームワークのラベル。最初の DoDAF プロダクトまたは UAF ビューでも追加されます)、+ 新しいラベル、およびツリー順で次の列を持つ表があります:
- ラベル。
- 適用対象:クラスのチップまたは「All classes」。
- Entities:件数。
- 説明。
- 操作:✎(ラベルを編集)、⊖(Take this label off every entity。使用中の場合に表示)、×(ラベルを削除)。1 回の元に戻すで、ラベルを外したすべてのエンティティにラベルが戻ります。エンティティが 5,000 を超える場合は、進行状況カードが表示されます。
ラベルのダイアログのタイトルは新しいラベルを作成またはEdit Label — Xです。名前、説明、親((なし)またはラベル)、クラス(未選択の場合はすべてのクラス)、非表示があります。ラベルを作成またはラベルを保存をクリックします。
ワークフローのページ
サイドバーのワークフローをクリックします。ページには「列挙型の属性(Status など)で許可する値の変更を設定します。」と表示されます。
ページには「クラスの状態と、それらの間のどの変更を許可するか、または承認が必要かを設定します。」と表示されます。
クラスを追加…には、列挙型の属性があり、まだワークフローのないクラスが一覧表示されます。クラスにStatusがある場合はそれを監視します。ワークフローのある各クラスには、次のものを含むカードがあります:
- クラスのチップ、監視、監視する属性。ワークフローに遷移がある場合、変更する前に確認されます。
- Remove:クラスのワークフローを除去します。項目の値は残ります。
- 状態:状態(組み込みまたは(廃止)の印付き)、項目(件数)、および↑、↓、名前を変更…、除去…または廃止…、または復元の表。その下に新しい状態と+ 状態を追加。属性を継承しているサブクラスでは「X の独自の状態。Y は継承されています。」と表示されます。
- 遷移:+ 遷移を追加は、(初期 — 値なし)から最初の状態への「New Transition」を追加します。表:名前、From、To、承認、およびこの遷移の後に項目をロックと遷移を削除のある⋯メニュー(行を右クリックするか、行で ⇧F10 / Shift+F10 を押しても開きます)。Name、From、To はテキストとして表示されます。クリックする(またはその上で Enter か F2 を押す)と変更できます。遷移がない場合、カードには「遷移がありません。どの状態からでもどの状態にも移れます。」と表示されます。
ホスト型サービスでは、ワークフローを変更できるのはプロジェクトのオーナーだけです。それ以外のユーザーには、ページが読み取り専用で「ワークフローを変更できるのはプロジェクトのオーナーだけです。」とともに表示されます。
スキーマの変更が既存のデータに与える影響
すでにデータがあるスキーマの要素を変更する前に、この表を確認してください。
| 変更 | エンティティと関係への影響 |
|---|---|
| クラス、属性、関係、ラベルの名前を変更する | すべてが ID で保存されているため、データは保持されます。古い名前を使っている保存したクエリ、検索テキスト、列のタイトルは一致しなくなります。それらを更新してください。 |
| クラスの親を変更する | エディターでは、クラスは新しい親の属性とターゲットを得て、古い親のものを失います。保存されている値は残ります。エンティティを持つ組み込みのクラスでは許可されません。 |
| クラスを抽象または非表示にする | 既存のエンティティは残ります。そのクラスは、新しいエンティティやクラスの変更の選択肢に表示されなくなります。 |
| クラスを削除する | クラスにサブクラスもエンティティもない場合にだけ許可されます。そのクラス自身の属性とターゲットは除去されます。ラベルは、そのクラス一覧からそのクラスを外します。 |
| 属性を追加する | 既存のエンティティには値がありません。新しいエンティティには既定値が設定されます。 |
| 属性の型を変更する | 確認の後、その属性のすべての値が消去されます。 |
| 選択肢を除去する | エンティティは古い値を保持します。エディターには表示されなくなります。 |
| 属性を非表示にする | 値は保持されますが、再び表示されるまで、表示、検索、エクスポートされません。 |
| 属性を除去する | 確認の後、すべてのエンティティと関係のリンクでその値が消去されます。 |
| ターゲットを追加する | それらのクラス(とそのサブクラス)の間で関係が使えるようになります。 |
| ターゲットを除去する | スキーマが許可しなくなっても、既存の関係のリンクは残ります。モデルチェックのルール Global.9 がそれらを一覧表示します。 |
| 関係を削除する | 関係の組、そのターゲット、それを使うすべての関係のリンクが除去されます。 |
| ラベルを削除する | すべてのエンティティから除去されます。その子ラベルは、その親の下に移ります。 |
| スキーマのインポート(Merge) | 名前で照合して欠けているクラス、関係、ターゲット、属性、ラベルを追加します。既存のものは何も変更も除去もされません。 |
| 新しい組み込み要素を追加 | 名前で照合して欠けている既定のスキーマのクラス、関係、属性、ラベルを、既定の ID で追加します。追加したクラスと関係のターゲット、および既存のクラス間の LML 2.0 のターゲットが追加され、LML 2.0 の Decision の Status の値が末尾に追加されます。既存のものは何も変更も除去もされません。 |
| スキーマのインポート(置換)または既定に戻す | スキーマが置き換えられます。エンティティのデータは残りますが、存在しなくなった属性の値は表示されません。組み込みの拡張は、次にプロジェクトを開いたときに再び追加されます。 |
どの変更も 1 回の元に戻すで取り消せ、⌘Z / Ctrl+Z でスキーマと、それによって除去されたデータが一緒に復元されます。
組み込みの拡張
Holarch の機能に必要なため、Holarch はプロジェクトを開くときに、すべてのプロジェクトに次の要素を追加します。
- 大文字と小文字を区別せず、名前で照合されます。
- 欠けている場合にだけ追加され、名前の変更や除去は行われません。
- それらへの編集は保持されます。
| 分類 | 追加される属性 |
|---|---|
| 要求 | 優先度とCriticality(High、Medium、Low)、Owner、Source、TBD/TBR(None、TBD、TBR)、TBD Owner、TBD Due Date、Verification Method(複数選択:Analysis、Demonstration、Inspection、Test)、検証レベル(Component、Subsystem、System)、成功基準 |
| Risk | Owner、Handling Strategy(Accept、Avoid、Transfer、Mitigate、Watch)、Residual Probability、Residual Consequence、Need-by Date、トリガー、クローズの根拠。Statusには選択肢 Mitigating と Watch が加わります |
| Test Case | テスト担当者、テスト日、構成、供試体、Test Evidence(ファイル) |
| タスク | Board Column(列挙型)。独自の列名を持つかんばんボードを作成または変換したときに追加されます。その値は列名です。 |
| Input/Output | Data Rate、Data Rate Units、Protocol/Format、Message/Data Definition |
| Conduit | Connector/Pins、中、Owner、Interface Status(Draft、Proposed、Agreed、Baselined)、TBD/TBR(None、TBD、TBR) |
| Port | Conjugated |
| 指標 | Weight、Improvement Direction(N/A、Positive、Negative)、Scoring Method(Direct 1-10、Direct 1-5、Linear、Thresholds)、Score Thresholds、現在の推定値 |
| 判断 | Status(Open、In Analysis、Decided、Deferred、Superseded)、Decision Date、Decided By |
| 特性 | Units |
| Asset | Quantity |
追加されるラベル:Stakeholder Needとインターフェース要求(Requirement)、Interface Block(Asset、Block の下)、Trade Studyとホワイトボード(Artifact)、基準とTPM(Measure)。
追加される関係のターゲット:Decision alternative Asset、Action、Artifact、Resource、Statement、Requirement と、逆方向の alternative of。
フレームワークのページ(DoDAF と UAF)は、そのプロダクトを初めて追加したときに、プロダクトが使うラベルを作成します。
キーボードショートカット
| キー | 場所 | Action |
|---|---|---|
| Enter | 属性のダイアログのAllowed valuesフィールド | 次の選択肢を始める(1 行に 1 つ) |
| ⌘ / Ctrl/Ctrl+クリック | ラベルのダイアログのClass(es)一覧 | 複数のクラスを選択 |
| ⌘ / Ctrl+Z / ⌘ / Ctrl+Shift+Z | どこでも | スキーマの変更を元に戻す / やり直す |
オプションと設定
- プロジェクトのスキーマはプロジェクトに保存され、それを開けるすべてのメンバーと共有されます。
- 閲覧者のロールを持つメンバーは変更できません(「閲覧のみ:編集権限をオーナーに依頼してください。」)。
- スキーマをエクスポートのファイルは
holarch-schema形式で、クラス、関係、属性、ラベル、ワークフローを含みます。
メッセージ
| メッセージ | 意味と対処法 |
|---|---|
| 「クラス名を入力してください。」 | クラス名が空です。 |
| 「クラス名が長すぎます。短くしてください。」 | クラス名とラベル名は 100 文字までです。 |
| 「クラス名には : " ( ) < > を含めることはできません。これらの文字は検索で意味を持ちます。」 | それらの文字を除きます。その他の文字、数字、スペース、句読点は使えます。既存のクラス名は引き続き有効です。 |
| 「この名前はすでに別のクラスで使われています。別の名前を選んでください。」 | クラス名は一意です(大文字と小文字を区別しません)。 |
| 「「X」は検索のキーワードです(x:… のように使います)。別のクラス名を選んでください。」 | 検索キー(class、label、name、number、description、is、relationship、in、under、diagram、id、order)と AND、OR、NOT は、検索がクラスをそのキーとして読んでしまうため、クラス名にできません。 |
| 「その親を設定すると、このクラスが自身の祖先になってしまいます。」 | クラスのサブツリーの外にある親を選択します。 |
| 「このクラスにはサブクラスがあります。先にそれらを削除するか、別の親に移してください。」 | サブクラスを持つクラスは削除できません。 |
| 「「X」(またはそのサブクラス)には N 個のエンティティがあります。先にそれらのクラスを変更するか削除するか、クラスを非表示にしてください。」 | エンティティを持つクラスは削除できません。 |
| 「属性名を入力してください。」 | 属性名が空です。 |
| 「属性名に使用できない文字が含まれています。」 | 文字、数字、スペース、_ - $ ( ) . , / を使います。 |
| 「Name、Number、Description は組み込みです。別の属性名を選んでください。」 | これらは属性ではなく、エンティティのフィールドです。 |
| 「この名前の属性はここにすでに存在します。」 | そのクラス、親、またはサブクラスがすでにその属性を持っています。 |
| 「選択肢を 1 つ以上追加してください。」 | ENUMERATION と MULTISELECT には選択肢が必要です。 |
| 「ラベル名を入力してください。」 / 「ラベル名に使用できない文字が含まれています。」 / 「この名前はすでに別のラベルで使われています。」 / 「ラベルをそれ自身の中に入れることはできません。別の親を選んでください。」 | ラベルのダイアログのチェック。ラベルには & と ' も使えます。 |
| 「関係名と逆方向の名前を入力してください。」 / 「関係名と逆方向の名前は異なる必要があります。」 / 「「X」という名前の関係はすでに存在します。」 | 関係のダイアログのチェック。 |
| 「JSON ファイルではありません。」 / 「このファイルはスキーマではありません。クラス、関係、属性、ラベルが必要です。」 | スキーマをインポート…には、スキーマまたはプロジェクトの JSON ファイルが必要です。 |
| 「スキーマをマージしました:N 個の項目を追加しました」 / 「スキーマを置き換えました」 | インポートが完了しました。 |
| 「ワークフローのクラスがありません。ステータスの遷移を定義するには、クラスを追加…でクラスを選択してください。」 | ワークフローがまだ定義されていません。 |
破壊的な変更の前には、確認で結果が示されます:
| 確認 | テキスト |
|---|---|
| 属性を除去 | 「N 個のエンティティの値が消去されます。」 |
| 型を変更して値を消去 | 「N 個のエンティティに「X」の値があります。型を A から B に変更すると、それらの値は消去されます。」 |
| クラスを削除 | 「クラス「X」をその属性とターゲットとともに削除しますか?」 |
| ターゲットを除去(その他のクラスの ×) | 「スキーマが許可しなくなっても、既存の N 個の関係は残ります。」 |
| 関係を削除 | 「それを使う N 個の関係も除去されます。」 |
| ラベルを削除 | 「N 個のエンティティから除去されます。」 |
| 項目からラベルを除去 | 「N 個のエンティティから「X」を除去しますか?」 |
| スキーマをリセット | 「カスタムのクラス、属性、関係、ラベルがスキーマから除去されます(エンティティのデータは残ります。元に戻すことができます)。」 |
制限事項
- クラス名とラベル名:100 文字。
- インポートで作成される属性の名前:80 文字。
- 監視する属性はクラスごとに 1 つ。
- 通常の遷移は、属性のエディター、グリッドのセル、かんばんボードで適用されます。承認の遷移は、直接の変更と一括の変更も拒否します。新しい項目はどの状態でも作成できます。
- ロックは LML の項目に適用されます。SysML v2 の要素はロックされません。
- 状態の名前:100 文字。
- Mergeは、すでに存在する属性に新しい選択肢を追加しません。属性のダイアログで追加します。
- 新しい組み込み要素を追加…は、スキーマがカスタムになった後、ページを開き直したときにだけ表示されます。
関連
- モデルとデータベース:エンティティ、属性のエディター、クエリ、一括編集。
- 要求:要求の属性、品質チェック、承認。
- トレーサビリティ:関係がマトリックスとカバレッジのチェックにどう使われるか。
- インポートとエクスポート:属性のマッピングと交換ファイル内のスキーマ。
- ヘルプ:スキーマ、LML の基本。