Holarch

模型

結構描述與擴充

以自訂類別、屬性、選項、關係、標籤與狀態工作流程調整專案的 LML 結構描述,並查看每項變更如何影響現有資料。

使用方式 →

本頁內容
  1. 概觀
  2. 概念
    1. 專案結構描述
    2. 課程
    3. 屬性
    4. 關聯與目標
    5. 標籤
    6. 工作流程
  3. 使用方式
    1. 使用時機與原因
    2. 為類別新增屬性
    3. 為現有屬性新增選項
    4. 建立子類別
    5. 新增標籤
    6. 允許新的關係
    7. 定義狀態工作流程
    8. 新增或變更工作流程的狀態
    9. 選擇轉換的核准者
    10. 請求核准狀態變更
    11. 在專案之間共用結構描述
    12. 實例演練:CubeSat EO-1
    13. 提示與良好做法
    14. 常見錯誤
    15. 與其他功能的關聯
  4. 結構描述編輯器
    1. 頁首
    2. 側邊欄
    3. 用法
    4. 類別頁面
    5. 編輯類別對話方塊
    6. 屬性對話方塊
    7. 關聯頁面
    8. 標籤頁面
    9. 工作流程頁面
  5. 結構描述變更如何影響現有資料
  6. 內建擴充
  7. 鍵盤快速鍵
  8. 選項與設定
  9. 訊息
  10. 限制
  11. 相關內容

概觀

結構描述定義專案的模型可以包含什麼:

  • 實體的類別,
  • 每個類別具有的屬性,
  • 可連接類別的關聯,
  • 為實體加上標記的標籤,
  • 選用的工作流程:每個類別中某個狀態屬性的狀態、它們可以如何變更,以及哪些變更需要核准。

每個專案都從預設的生命週期建模語言(LML)結構描述開始。結構描述編輯器只會為單一專案變更它。第一次編輯會建立專案自己的副本,因此其他專案不受影響。每次結構描述編輯都能以一次復原撤回。

Holarch 也會為每個專案加入內建擴充,例如需求上的優先順序與擁有者,以及風險上的處理策略。請參閱內建擴充。

關於日常處理實體、屬性與關係,請參閱模型與資料庫。

概念

專案結構描述

  • 預設結構描述:Holarch 隨附的 LML 類別、關聯、屬性與標籤。應用程式內的說明主題 LML Classes (schema)、LML Relationships (schema) 與 Labels (schema) 會即時列出開啟專案的這些內容。
  • 專案結構描述:儲存在專案內的副本。它在第一次編輯時建立。它會隨專案一起匯出,並提供給每個開啟專案的成員。
  • 內建擴充:Holarch 功能所需的增補。每次開啟專案時都會依名稱套用。因此大多數專案已有自己的副本,使用情況頁面會顯示「此專案使用其自己編輯過的結構描述。」

課程

類別是一種實體,例如 Requirement 或 Asset。它有名稱、描述、父類別與色彩,以及兩個旗標(抽象與隱藏)。

  • 父類別:子類別會繼承其父類別的屬性與關聯目標。它會出現在涵蓋父類別的每個查詢、篩選與圖中。例如,Action 的自訂子類別會有 Action 圖。Requirement 的自訂子類別會有品質檢查與核准控制項。
  • 抽象:該類別用於將子類別分組,無法直接建立。
  • 隱藏:建立實體或變更其類別時不會提供該類別。它及其子類別不會出現在資料庫的類別篩選中。現有實體會保留。
  • 色彩:類別徽章與色票的顏色。沒有設定時,自訂類別會採用最近之內建祖先的顏色。徽章會顯示名稱的前兩個字母。

屬性

屬性是類別中每個實體都具有的欄位,例如需求上的優先順序。屬性也可以屬於關聯。

屬性有名稱、類型以及在類別順序中的位置。它可以有允許的值、預設值與描述。將指標移到屬性的標籤上時會顯示描述。

類型依屬性對話方塊中的分組列出(括號內為儲存的類型 ID;匯出、匯入與 API 會使用它):

群組類型內容
文字短文字(TEXT)、長文字(BIG_TEXT)、豐富文字(HTML)一行;多行;格式化文字
數字數字(NUMBER)、百分比(PERCENT)、持續時間(DURATION)數字或分布;0 到 100;帶時間單位的數字或分布
日期和時間日期和時間(DATETIME)日期和時間
選項清單之一(ENUMERATION)、清單中的多項(MULTISELECT)、是或否(BOOLEAN)一個值;多個值;是或否
連結網址(URI)、檔案(FILE)一個連結;一個上傳的檔案
特殊位置(GEOPOINT)、方程式(EQUATION)、計算值(COMPUTABLE)、人員或團隊(USER_TEAM)、多重性(MULTIPLICITY)、品質檢查(QUALITY)緯度與經度;LaTeX 文字;由其他實體的屬性計算出的值;人員或團隊名稱;n、n..m、n..* 或 *;由品質檢查設定的是/否準則

每種類型的編輯器說明請參閱屬性類型與編輯器。

從父類別繼承的屬性先列出,接著是該類別自身的屬性,依各類別頁面上設定的順序排列(拖曳某一列,或使用 ↑ / ↓)。新屬性會排在最後。

隱藏的屬性會保留其值。在再次顯示之前,它會從編輯器、篩選、欄、搜尋與報告中消失。

關聯與目標

  • 關聯一律成對出現:一個名稱與一個反向名稱,例如 satisfies / satisfied by。建立其中一個就會同時建立兩者。
  • 目標允許從一個類別到另一個類別的關聯,例如 Requirement verified by Test Case。指向某個類別的目標也允許其子類別。子類別會繼承其父類別的目標。
  • 關聯可以帶有屬性,例如 decomposed by 上的多重性。新增到關聯的屬性也適用於其反向關聯。
  • 隱藏的關聯在結構描述編輯器中以變暗方式顯示,並從說明參考清單中省略。它仍可使用。

標籤

標籤是您加在實體上的標記,例如 Stakeholder Need。它不會新增欄位,也不會變更任何結構。

標籤有名稱、描述與其適用的類別。它可以有父標籤,因此標籤可以巢狀。

  • 未選取任何類別時,標籤適用於每個類別。
  • 適用於某個類別的標籤也適用於其子類別。
  • 隱藏的標籤會保留在已有它的實體上,但不再提供。

工作流程

工作流程控制類別中某個 ENUMERATION 屬性(通常是狀態)可以如何變更。它具有:

  • 狀態:該類別使用的值,依順序排列。您可以新增、重新命名、重新排序與移除自訂狀態。內建狀態(例如需求的Approved)只能淘汰。屬性為繼承而來的子類別(例如 Requirement 下的 Software Requirement)會保有自己的狀態。
  • 轉換(從 → 到):允許的變更。沒有轉換時,每個狀態都可以接在其他任何狀態之後。
  • 轉換上的核准:此變更需要已核准的變更請求。預設由變更請求 → 設定中設定的核准者決定。轉換也可以改為指定自己的核准者:擁有者、編輯者或指名的人員,以及其中必須有多少人核准(最多 5 人,或每位指名人員)。
  • 此轉換後鎖定項目(位於轉換的 ⋯ 選單中):變更後項目會被鎖定。

之後屬性的編輯器只會提供目前的值與允許的下一個狀態。需要核准的狀態會顯示(需要核准)。

使用方式

使用時機與原因

請在專案開始時調整結構描述:在您設定建模方法時,以及匯入資料之前。典型的原因:

  • 採用某種方法或標準:新增您的流程所需的屬性,例如資產上的 TRL 或需求上的 Safety Integrity Level。新增您的文件範本所需的標籤。
  • 特化類別:新增子類別,例如 Risk 下的 Hazard,或 Asset 下的 Payload Instrument。之後查詢、篩選與報告就能區分它們,而它們仍保有每個 LML 關係。
  • 允許方法所需的關係:新增目標,或新的關聯配對。
  • 強制執行審查流程:新增工作流程,讓需求的狀態依 Draft → In Review → Approved 移動。之後編輯器絕不會讓它跳過任何步驟。將 In Review → Approved 標記為核准,讓此移動經由專案的核准者處理。
  • 跨專案重複使用:從一個專案匯出結構描述,並匯入下一個專案。

結構描述回答的問題是「這個模型能表達什麼?」。請審慎變更它。查詢、已儲存的欄、報告與匯入都是依名稱參照類別、屬性與關聯。

為類別新增屬性

  1. 在導覽列中,按一下設定 → 結構描述(與底部的工具在一起)。
  2. 在側邊欄的類別下,按一下該類別,例如 Asset。
  3. 在屬性卡片中,按一下+ 屬性。
  4. 輸入名稱。
  5. 選擇類型,例如「選項」下的清單之一。
  6. 對於清單之一或清單中的多項:在允許的值中輸入選項,每行一個。
  7. 選用:設定預設值。該類別的新實體會以此值開始。
  8. 選用:輸入描述。
  9. 按一下新增屬性。

    您會看到通知「已儲存屬性」。該屬性會排在類別清單的最後,並出現在該類別及其子類別的屬性面板、項目檢視、資料庫欄與篩選、搜尋、報告以及匯入對應中。

  10. 若要移動屬性,請在屬性表格中拖曳其列,或使用該列上的 ↑ 與 ↓。每次移動都能以一次復原撤回。

為現有屬性新增選項

  1. 開啟定義該屬性的類別。定義於欄會顯示它。繼承的屬性要在定義它的類別上編輯。
  2. 按一下該列上的 ✎(編輯屬性)。
  3. 在允許的值中將新選項單獨放在一行。
  4. 按一下儲存。

對於清單之一,每個選項前(清單下方)的方塊會設定該值的色彩。以該屬性的值作為欄的看板會將其用作欄色彩。

若要移除選項,請在同一個對話方塊中刪除其所在行。已具有該值的實體會保留它,但編輯器不再提供該值。移除選項之前,請以屬性查詢(例如 Requirement:"Priority=Urgent")找出這些實體,並為它們指定目前的選項。

建立子類別

  1. 開啟父類別。
  2. 按一下 + 子類別。

    (或在側邊欄中按一下 + 類別,然後選擇父類別。)

  3. 輸入名稱與描述。
  4. 視需要設定抽象、隱藏與色彩。
  5. 按一下建立類別。

    您會看到新類別。它已具有所有繼承的屬性與目標。

若要將現有實體移入新類別,請在資料庫中選取它們並使用變更類別…。請參閱變更類別。

新增標籤

  1. 按一下側邊欄中的 + 標籤,或標籤頁面上的 + 新增標籤。
  2. 輸入名稱與描述。
  3. 若標籤屬於另一個標籤之下,請選擇該父標籤。
  4. 選取標籤所適用的類別。⌘ / Ctrl/Ctrl+按一下可選取多個。未選取任何類別時,標籤適用於所有類別。
  5. 按一下建立標籤。

若要套用標籤,請使用屬性面板或項目檢視中的 + 標籤,或資料庫大量操作列中的標籤 ▾。

允許新的關係

只有在目標允許時,兩個類別之間才能建立關係。新增目標即可允許它。

  1. 開啟來源類別。
  2. 在關係中按一下 + 關係。
  3. 選擇關係。
  4. 選擇另一個類別。
  5. 保持勾選同時向另一個類別新增反向關係。如此即可從任一端建立關聯。
  6. 按一下新增關係。

若另一個類別缺少反向關係,返回此類別欄會顯示 + on <class>:按一下它即可在該處新增反向關係。

若您需要的關係不存在,請先建立它:

  1. 在對話方塊中按一下新增關係類型…(或側邊欄中的 + 關係)。
  2. 輸入名稱與反向名稱,以及它們的描述。
  3. 按一下建立關係。
  4. 在上方步驟 3 中選擇新的關係。

定義狀態工作流程

  1. 按一下側邊欄中的工作流程。
  2. 在新增類別…中選擇類別。

    您會看到該類別的卡片。工作流程會監看該類別的第一個列舉屬性。

  3. 如有需要,請在監看清單中選擇其他屬性。變更它會清除轉換。
  4. 按一下 + 新增轉換。
  5. 設定轉換的名稱、從與到。從為(初始 — 無值)或某個狀態。
  6. 若該變更需要已核准的變更請求,請勾選核准。若要在變更後鎖定項目,請開啟該列的 ⋯ 選單(或在該列上按右鍵)並選擇此轉換後鎖定項目;該列隨即顯示鎖定項目。
  7. 對每個允許的步驟重複步驟 4 到 6。

若要選擇由誰核准轉換,請參閱選擇轉換的核准者。

該屬性的編輯器現在只提供允許的下一個狀態,並標示 ⇢ 工作流程。

新增或變更工作流程的狀態

  1. 在工作流程頁面上找到該類別的卡片。項目欄會計算每個狀態中的項目數;沒有值的項目會計入該屬性的預設值(沒有狀態的測試案例計為 Not Run,與測試中心的顯示相同)。
  2. 若要新增狀態,請在新狀態中輸入其名稱,然後按一下 + 新增狀態。

    該狀態會新增到類別與該屬性的選項中。

  3. 若要排列狀態順序,請按一下 ↑ 或 ↓。選擇器與看板欄會依照此順序。
  4. 若要重新命名自訂狀態,請按一下重新命名…並輸入新名稱。

    處於該狀態的項目、轉換與值色彩都會採用新名稱。一次復原即可全部撤回。

  5. 若要移除狀態,請按一下移除…(自訂)或停用…(內建)。
    • 沒有任何項目使用的狀態會被移除。
    • 當有項目使用它時,請選擇移動並移除並指定要將項目移往的狀態,或選擇保留為已淘汰。已淘汰的狀態會保留在其項目上,顯示(已停用),且不再提供。其傳出轉換會保留,因此項目仍可離開該狀態。還原會再次提供它。

此頁面上的任何變更都不會清除值。

選擇轉換的核准者

  1. 在工作流程頁面上,勾選該轉換的核准。

    其旁邊會出現一個按鈕:變更請求設定 ▾。

  2. 按一下該按鈕。

    轉換核准者隨即開啟。

  3. 在核准者中選擇其一:
    • 依變更請求 → 設定中的設定:由專案的核准者決定(預設)。
    • 擁有者或擁有者和編輯者。
    • 指定人員:勾選負責核准的專案成員。在桌面應用程式中,請輸入他們的姓名並以逗號分隔,寫法與每個人在偏好設定 → 您的姓名中輸入的相同。
  4. 在所需核准數中選擇需要多少人核准:1 到 5,或所有指定人員。
  5. 按一下儲存。

    按鈕會顯示規則,例如全部 3 位指定人員 ▾。按一次復原即可撤回此變更。

包含多個狀態變更的請求需要符合所有適用的規則。有權核准者的一次駁回即會駁回該請求。在託管服務上,只有當最後設定工作流程的是專案擁有者時,指定的核准者才會計入;否則該轉換需要相同數量的擁有者核准。

請求核准狀態變更

  1. 在屬性面板或項目檢視中,選擇標示(需要核准)的狀態。對於需求,您也可以按一下審查列中的轉換(以 … 結尾)。

    請求核准隨即開啟。

  2. 可選擇輸入原因,然後按一下提交請求。

    系統會建立並提交包含該狀態變更的變更請求。對話方塊會列出其核准者:轉換本身的核准者,或變更請求 → 設定中設定的核准者。項目會保留其狀態。

    請求開啟期間,需求的審查列會顯示它及其計數,例如 CR-4:3 項核准中的 1 項。

  3. 核准者核准該請求。

    最後一項核准完成後,若該核准者可以編輯專案,項目就會移至新狀態。否則由編輯者開啟請求並按一下套用變更。項目的歷程記錄會顯示 via CR-n,而需求的核准記錄會列出每位核准者與該請求。

直接變更為此類狀態會被拒絕,並顯示「… 需要核准。在項目上選擇「X」以提出請求。」:包括大量屬性…、表格儲存格、看板移動與 AI 變更。請求開啟期間再次選擇該狀態會開啟該請求。

在專案之間共用結構描述

  1. 在來源專案中,開啟導覽列中的設定 → 結構描述。
  2. 按一下匯出結構描述。

    系統會下載一個 JSON 檔案。

  3. 在目標專案中,開啟導覽列中的設定 → 結構描述。
  4. 按一下更多 ▾ → 匯入結構描述…並選擇該檔案。
  5. 選擇模式:
    • 合併(依名稱比對,新增此專案缺少的類別、屬性、關係與標籤),或
    • 取代此專案的結構描述。
  6. 按一下匯入。

實例演練:CubeSat EO-1

此範例為資產新增技術成熟度等級(TRL)、特化一個類別並新增審查工作流程。請以管理專案 → 專案檔案 ▾ → 新增示範專案建立示範,然後開啟導覽列中的設定 → 結構描述。

查看模型。

  1. 閱讀使用情況頁面。

    類別表格會先列出最常用的類別,並附上其項目、屬性與關係。尚未使用會列出示範未使用的類別、標籤與關係。

為資產新增 TRL。

  1. 按一下 Asset,然後按一下 + 屬性。
  2. 輸入名稱 TRL 並選擇類型清單之一。
  3. 在允許的值中輸入選項 1 到 9,每行一個。
  4. 輸入描述 Technology readiness level。
  5. 按一下新增屬性。

    填入值。

  6. 開啟架構 → 資產。
  7. 選取 1.2.1 Reaction Wheel Assembly,並在屬性面板中將 TRL 設為 7。
  8. 以相同方式將 1.2.2 Star Tracker 設為 6,將 1.1 Payload Camera 設為 5。

    查詢它。

  9. 在搜尋方塊中輸入 Asset:"TRL>=6" 並按 Enter。

    查詢會成為查詢列中的篩選晶片。表格會列出反應輪與星象儀。為數字的選項值會以數字比較。

特化一個類別。

  1. 回到結構描述編輯器,開啟 Asset 並按一下 + 子類別。
  2. 將其命名為 Payload Instrument,然後按一下建立類別。
  3. 在資料庫中勾選 1.1 Payload Camera,然後按一下變更類別…。
  4. 選擇 Payload Instrument 作為新類別。

    對話方塊會顯示「1 個項目將變成 Payload Instrument。」且未列出任何要移除的內容:子類別會繼承所有 Asset 屬性與目標。

  5. 按一下變更類別。

    相機會保留其 TRL、其 performs 關聯以及其在分解中的位置。

新增審查工作流程。

  1. 開啟工作流程,並在新增類別…中選擇 Requirement。
  2. 確認它監看的是 Status。
  3. 新增這些轉換:Initial → Draft、Draft → In Review、In Review → Approved、In Review → Rejected、Rejected → Draft。
  4. 開啟 2.4 Target Slew。其 Status 為 Draft。

    其 Status 清單現在只提供 Draft 與 In Review。

復原或保留。

  1. 每項變更按一次 ⌘Z / Ctrl+Z 即可復原此實驗。或保留變更並按一下匯出結構描述,以便在下一個 CubeSat 專案中重複使用。

提示與良好做法

  • 優先使用子類別與標籤,而非新的最上層類別。子類別會保留其父類別的所有 LML 關係、圖與檢查。標籤則完全不改變任何結構。
  • 以隱藏取代刪除。隱藏類別、屬性或標籤會保持現有資料完整,且可以還原。
  • 在匯入前先設定結構描述。匯入對應會提供現有的屬性。對應到新增屬性的欄會自動建立,並採用推測的類型。請參閱匯入與匯出。
  • 保留內建新增項目。隱藏您不需要的內建擴充。不要重新命名或刪除它:缺少的內建擴充會在下次開啟專案時以空值重新加入。
  • 為每個自訂元素撰寫文件,寫在其描述中。它會作為編輯器中的工具提示,並顯示在說明的結構描述表格中。
  • 小於的屬性測試也會符合沒有值的實體。例如,Asset:"TRL<6" 會包含沒有 TRL 的資產。請將此類測試與正向測試結合,或對補集使用 >=。

常見錯誤

  • 變更屬性的類型會清除其值。Holarch 會警告「N 個實體具有「X」值。將類型從 A 變更為 B 會清除這些值。」若您需要舊值,請先匯出 CSV 報告。按一次復原即可同時撤回類型變更與清除的值;在此類值超過 5,000 個的專案上,清除期間會顯示進度卡片。
  • 刪除關係類型會刪除其所有關係。確認對話方塊會計算其數量。復原可還原它們。
  • 移除目標會留下結構描述不再允許的關係。現有關聯會保留;模型檢查會在規則 Global.9(結構描述不允許的關係)下列出它們。請在移除目標之前或之後移除它們或變更其關係;確認對話方塊會計算其數量。
  • 類別有實體時無法刪除。請先變更它們的類別或刪除它們,或隱藏該類別。
  • 一般轉換只會引導編輯器。大量屬性…、匯入與 AI 變更仍可設定任何不需要核准的狀態。當變更不得略過審查時,請將轉換標示為核准。
  • 無法重新命名內建狀態。核准、組態控制與驗證都依賴它們。請改為新增狀態,或淘汰內建狀態。

與其他功能的關聯

  • 資料庫、屬性面板與項目檢視會顯示並編輯屬性。它們會提供結構描述允許的關係。查詢會依名稱參照類別、屬性、標籤與關係。請參閱模型與資料庫。
  • 圖:實體可擁有的圖類型取決於其類別及其上層類別。自訂子類別會繼承它們。
  • 需求功能(品質、核准、TBD/TBR、待審查的關聯)依賴內建屬性,例如 Status、TBD/TBR 與品質準則。請參閱需求。
  • 可追溯性矩陣與模型檢查使用關係目標來判斷哪些是允許的、哪些是缺少的。請參閱可追溯性。
  • 匯入與匯出依名稱對應到屬性,並在專案 JSON、.holarch 與 ReqIF 檔案中攜帶結構描述。請參閱匯入與匯出。

結構描述編輯器

所有結構描述變更都在結構描述編輯器中進行。從導覽列中的設定 → 結構描述開啟它(工具位於底部)。位址 schema?class=<id> 會直接開啟某個類別(較早的內建類別編號仍然有效)。

編輯器有頁首、側邊欄與主要區域。主要區域會顯示使用情況頁面、某個類別,或關係、標籤或工作流程頁面。

控制項功能
匯出結構描述將專案的結構描述下載為 JSON(<Project_name>_schema.json)。
更多 ▾ → 匯入結構描述…以合併或取代匯入結構描述 JSON 檔案(也可以是包含結構描述的專案 JSON)。
新增新的內建項目…在專案擁有自己的結構描述時顯示。列出預設結構描述具有而此副本缺少的類別、關係、屬性與標籤(依名稱比對),例如 LML 2.0 新增項目,以及現有項目的 LML 2.0 值與允許的關係(Decision Status Open 與 Closed;Logical decomposed by Logical;Connection transfers Input/Output),並將它們加入,一次復原即可全部撤回。現有的類別、屬性、選項與資料保持不變;新值會排在現有值之後。
更多 ▾ → 重設為預設值…在專案擁有自己的結構描述時提供。確認後會以預設 LML 結構描述取代它。
  • 搜尋類別、屬性、關係、標籤…會篩選類別樹。主要區域會顯示符合的類別、屬性、找到的關係與找到的標籤,或顯示「沒有符合的類別、屬性、關係或標籤。請嘗試其他搜尋字詞。」
  • 使用情況。
  • + 類別、+ 標籤、+ 關係。
  • 類別:類別樹,附有色票、「(抽象)」與「(隱藏)」標記,以及實體數量(包含子類別)。
  • 其他:關係(附數量)、標籤(附數量)與工作流程。

用法

使用情況會最先開啟。其狀態列會顯示「預設 LML 結構描述。第一次編輯會為此專案建立副本。」或「此專案使用其自己已編輯的結構描述。」

  • 類別:未隱藏類別的表格,最常用的排在最前:類別(按一下即可開啟)、項目(含其子類別)、屬性(其自身的)、關係(允許的,包含繼承的)與上次變更(其項目最後一次變更的時間)。
  • 尚未使用:三個可展開的清單,列出專案中未被使用的類別、標籤與關係,各附數量。列上的隱藏會隱藏該類別、標籤或關係對(一次復原即可全部撤回);隱藏的項目會保留在結構描述中,並可在其頁面或對話方塊中再次顯示。

類別頁面

按一下側邊欄中的類別即可開啟其頁面。由上而下:

  • 父類別的導覽路徑。按一下其中一個即可開啟。
  • 頁首:類別圖示與名稱、抽象與隱藏晶片、✎ 編輯類別、+ 子類別與刪除。專案中有 N 個實體 ›會開啟篩選為該類別的資料庫。
  • 描述卡片:描述,晶片 Id N、屬性 N(部分來自父類別時附「(k 個繼承)」)、關係 N 與實體 N,以及子類別。
  • 屬性卡片:+ 屬性以及含下列欄的表格:
    • 類別自身屬性的排序控制項:拖曳該列,或使用 ↑ / ↓(每次移動都能以一次復原撤回)。
    • 名稱、類型(類型的名稱;指向它可查看儲存的 id)。
    • 詳細資料:選項與預設值。
    • 定義於:「此類別」或祖先類別。
    • 描述。
    • 動作(適用於在此類別上定義的屬性):✎(編輯屬性)、⊘ / 👁(隱藏屬性 / 顯示屬性)與 ×(移除屬性)。
  • 關係卡片:+ 關係以及雙向的表格:關係、其他類別、返回此類別(反向名稱,以及針對缺少反向關係的其他類別的 + on <class>)與描述。在其他類別中,× 會移除在此類別上定義的關係。繼承的關係會顯示「(繼承自 X)」。
  • 標籤卡片:此類別可用的標籤。* 標示所有類別都可用的標籤。

編輯類別對話方塊

標題為建立新類別或編輯類別 — X。欄位:名稱、描述、父類別((無 — 最上層)或某個類別)、隱藏、抽象與色彩。按一下建立類別或儲存類別。

具有實體的內建類別無法變更其父類別:「實體使用此內建類別,因此其父類別是固定的。」

屬性對話方塊

標題為新增屬性或編輯屬性 — X。對於關係屬性,標題會加上「(關係「…」)」。按一下新增屬性或儲存。

  • 名稱與類型(分組:文字、數字、日期與時間、選項、關聯、特殊)。沒有順序欄位:新屬性會排在最後。
  • 允許的值(每行一個):僅適用於清單之一與清單中的多項。空白行與重複的值會被捨棄。清單至少需要兩個值:「列舉至少需要兩個選項。請再新增一個選項。」(清單中的多項則為「多選 …」)。已只有單一值的屬性,在其清單未變更時仍可儲存。對於清單之一,清單之後會有每個值的色彩方塊。
  • 預設值:不適用於 FILE、COMPUTABLE、QUALITY、HTML 與 USER_TEAM。
  • 描述。

關聯頁面

按一下側邊欄中的關係即可查看所有關係對。此頁面有 + 關係以及含下列欄的表格:

  • 關係與反向。
  • 來源 → 目標:允許的每個類別對。
  • 屬性:每個屬性的 ✎,以及 + 屬性。
  • 已使用:關係的數量。
  • 描述。
  • ✎(編輯關係)與 ×(刪除關係)。

關係對話方塊的標題為新增關係或編輯關係 — X。它有名稱、反向名稱、描述、反向描述、隱藏與色彩(或預設色彩)。Spider 圖會以此色彩繪製該關係;圖仍可為每個關係選擇自己的色彩。關係欄會以色票顯示該色彩。編輯時,它也會列出該關係的屬性,並附 + 新增屬性。按一下建立關係或儲存。

標籤頁面

按一下側邊欄中的標籤即可查看所有標籤。此頁面有新增 DoDAF 標籤與新增 UAF 標籤(此專案缺少的框架標籤;在第一個 DoDAF 產品或 UAF 檢視上也會自動加入)、+ 新增標籤,以及依樹狀順序排列、含下列欄的表格:

  • 標籤。
  • 適用於:類別晶片或「所有類別」。
  • 實體:數量。
  • 描述。
  • 動作:✎(編輯標籤)、⊖(從所有實體移除此標籤,在使用中時顯示)與 ×(刪除標籤)。按一次復原即可將標籤放回所有被移除的實體上;實體超過 5,000 個時會顯示進度卡片。

標籤對話方塊的標題為建立新標籤或編輯標籤 — X。它有名稱、描述、父標籤((無)或某個標籤)、類別(未選擇時:所有類別)與隱藏。按一下建立標籤或儲存標籤。

工作流程頁面

按一下側邊欄中的工作流程。此頁面會顯示「設定列舉屬性(例如 Status)允許哪些值變更。」

此頁面會顯示「設定類別的狀態,以及哪些狀態之間的變更是允許的或需要核准。」

新增類別…會列出具有列舉屬性且尚無工作流程的類別。類別有 Status 時,會監看該屬性。每個工作流程類別都有一張卡片,包含:

  • 類別晶片、監看與被監看的屬性。工作流程有轉換時,變更它會先詢問。
  • 移除:移除該類別的工作流程。項目的值會保留。
  • 狀態:表格,含狀態(標示內建或(已停用))、項目(數量)與 ↑、↓、重新命名…、移除…或停用…,或還原。其下方是新狀態與 + 新增狀態。具有繼承屬性的子類別會顯示「X 的自身狀態;Y 為繼承。」
  • 轉換:+ 新增轉換會新增從(初始 — 無值)到第一個狀態的「新轉換」。表格:名稱、從、到、核准,以及含此轉換後鎖定項目與刪除轉換的 ⋯ 選單(也可在該列上按右鍵,或在其上按 ⇧F10 / Shift+F10)。名稱、從與到以文字顯示;按一下其中一個(或在其上按 Enter 或 F2)即可變更。沒有轉換時,卡片會顯示「沒有轉換:每個狀態都可以接在任何其他狀態之後。」

在託管服務上,只有專案擁有者可以變更工作流程;其他人看到的頁面為唯讀,並顯示「只有專案擁有者可以變更工作流程。」

結構描述變更如何影響現有資料

在變更已有資料的結構描述元素之前,請先查看此表格。

變更對實體與關係的影響
重新命名類別、屬性、關係或標籤資料會保留,因為所有內容都依 id 儲存。使用舊名稱的已儲存查詢、搜尋文字與欄標題將不再符合。請更新它們。
變更類別的父類別在編輯器中,該類別會取得新父類別的屬性與目標,並失去舊父類別的屬性與目標。儲存的值會保留。不允許用於具有實體的內建類別。
將類別標示為抽象或隱藏現有實體會保留。該類別不再提供給新實體或變更類別使用。
刪除類別只有在類別沒有子類別且沒有實體時才允許。其自身的屬性與目標會被移除。標籤會將它從其類別清單中移除。
新增屬性現有實體沒有值。新實體會取得預設值。
變更屬性的類型確認後,該屬性的所有值都會被清除。
移除選項實體會保留舊值。編輯器不再提供它。
隱藏屬性值會保留,但在再次顯示之前不會被顯示、搜尋或匯出。
移除屬性確認後,每個實體與關係上的該值都會被清除。
新增目標該關係會在這些類別(及其子類別)之間變得可用。
移除目標現有關係會保留,即使結構描述不再允許它們。模型檢查規則 Global.9 會列出它們。
刪除關係類型關係對、其目標以及使用它的每個關係都會被移除。
刪除標籤它會從每個實體上移除。其子標籤會上移到其父標籤之下。
匯入結構描述(合併)新增依名稱比對缺少的類別、關係、目標、屬性與標籤。現有的任何內容都不會被變更或移除。
新增新的內建項目新增預設結構描述中依名稱比對缺少的類別、關係、屬性與標籤,並使用其預設 id。系統會為新增的類別與關係加入目標,並加入現有類別之間的 LML 2.0 目標;LML 2.0 Decision Status 值會附加在後。現有的任何內容都不會被變更或移除。
匯入結構描述(取代)或重設為預設值結構描述會被取代。實體資料會保留,但不再存在之屬性的值不會顯示。內建擴充會在下次開啟專案時重新加入。

每項變更都能以一次復原撤回,⌘Z / Ctrl+Z 會還原結構描述以及它所移除的任何資料。

內建擴充

Holarch 會在每個專案開啟時加入這些元素,因為其功能需要它們。

  • 它們依名稱比對,不區分大小寫。
  • 它們只在缺少時才會加入,且永遠不會被重新命名或移除。
  • 您對它們所做的編輯會保留。
等級新增的屬性
需求Priority 與 Criticality(High、Medium、Low)、Owner、Source、TBD/TBR(None、TBD、TBR)、TBD Owner、TBD Due Date、Verification Method(多選:Analysis、Demonstration、Inspection、Test)、Verification Level(Component、Subsystem、System)、Success Criteria
RiskOwner、Handling Strategy(Accept、Avoid、Transfer、Mitigate、Watch)、Residual Probability、Residual Consequence、Need-by Date、Trigger、Closure Rationale;Status 新增選項 Mitigating 與 Watch
Test CaseTested By、Test Date、Configuration、Test Article、Test Evidence(檔案)
任務Board Column(列舉),在建立或轉換具有自訂欄名稱的看板時加入。其值為欄名稱。
Input/OutputData Rate、Data Rate Units、Protocol/Format、Message/Data Definition
ConduitConnector/Pins、Medium、Owner、Interface Status(Draft、Proposed、Agreed、Baselined)、TBD/TBR(None、TBD、TBR)
PortConjugated
量測項目Weight、Improvement Direction(N/A、Positive、Negative)、Scoring Method(Direct 1-10、Direct 1-5、Linear、Thresholds)、Score Thresholds、Current Estimate
決策Status(Open、In Analysis、Decided、Deferred、Superseded)、Decision Date、Decided By
特性Units
AssetQuantity

新增的標籤:Stakeholder Need 與 Interface Requirement(Requirement)、Interface Block(Asset,位於 Block 之下)、Trade Study 與 Whiteboard(Artifact)、Criteria 與 TPM(Measure)。

新增的關係目標:Decision alternative Asset、Action、Artifact、Resource、Statement 與 Requirement,反向為 alternative of。

框架頁面(DoDAF 與 UAF)會在您第一次新增其產品時,建立這些產品所使用的標籤。

鍵盤快速鍵

按鍵位置動作
Enter屬性對話方塊中的允許的值欄位開始下一個選項(每行一個)
⌘ / Ctrl/Ctrl+按一下標籤對話方塊中的類別清單選取多個類別
⌘ / 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 為內建欄位;請選擇其他屬性名稱。」這些是實體欄位,不是屬性。
「此處已有同名的屬性。」該類別、其父類別或其子類別已有此屬性。
「至少新增一個選項。」ENUMERATION 與 MULTISELECT 需要選項。
「輸入標籤名稱。」/「標籤名稱包含不允許的字元。」/「另一個標籤已使用此名稱。」/「標籤不能位於自身之內。請選擇其他父標籤。」標籤對話方塊的檢查。標籤也可以使用 & 與 '。
「輸入關係名稱與反向名稱。」/「關係名稱與反向名稱必須不同。」/「名為「X」的關係已存在。」關係對話方塊的檢查。
「不是 JSON 檔案。」/「此檔案不是結構描述:它需要類別、關係、屬性與標籤。」匯入結構描述…需要結構描述或專案 JSON 檔案。
「已合併結構描述:已新增 N 個項目」/「已取代結構描述」匯入完成。
「沒有工作流程類別。請以「新增類別…」選擇類別,以定義其狀態轉換。」尚未定義任何工作流程。

在進行破壞性變更之前,確認對話方塊會說明其後果:

確認文字
移除屬性「N 個實體的值將被清除。」
變更類型並清除值「N 個實體具有「X」值。將類型從 A 變更為 B 會清除這些值。」
刪除類別「要刪除類別「X」及其屬性與目標嗎?」
移除目標(其他類別中的 ×)「N 個現有關係會保留,即使結構描述不再允許它們。」
刪除關係「使用它的 N 個關係也會被移除。」
刪除標籤「它會從 N 個實體上移除。」
從項目移除標籤「要從 N 個實體上移除「X」嗎?」
重設結構描述「自訂類別、屬性、關係與標籤會從結構描述中移除(實體資料會保留;可以復原)。」

限制

  • 類別與標籤名稱:100 個字元。
  • 由匯入建立的屬性名稱:80 個字元。
  • 每個類別一個監看屬性。
  • 一般轉換由屬性編輯器、表格儲存格與看板套用。核准轉換還會拒絕直接變更與大量變更。新項目可以在任何狀態下建立。
  • 鎖定適用於 LML 項目。SysML v2 元素不會被鎖定。
  • 狀態名稱:100 個字元。
  • 合併不會為已存在的屬性新增選項;請在屬性對話方塊中新增它們。
  • 新增新的內建項目…只有在結構描述變為自訂後,再次開啟頁面時才會出現。