Holarch

指南 · SysML v2

SysML v2 工具:選擇之前要檢查什麼

收聽本指南 16 分鐘

SysML v2 工具的評估指南:任何候選工具都要檢查的項目、如何分辨真正的支援與簡報上的宣稱、用來評分的檢查清單表格,以及一個可載入每個工具的小型測試模型。

本頁內容
  1. 為什麼 SysML v2 工具需要自己的評估
  2. 要檢查什麼
    1. 語言涵蓋範圍,以及缺口如何記錄
    2. 文字表示法:編輯與檢查
    3. 圖形檢視,以及文字與圖的同步
    4. 標準庫
    5. Systems Modeling API
    6. JSON 交換與往返
    7. 從 SysML v1 遷移
    8. 協作與版本控制
    9. 模型上的需求與驗證
    10. 帶有單位的分析與評估
    11. 部署:雲端或自行託管
    12. 授權與成本
    13. 訓練課程
  3. 評估檢查清單
  4. 可載入任何候選工具的測試模型
    1. 給檢查器的兩項探測
  5. 執行評估
  6. Holarch 對檢查清單的回答
  7. 在 Holarch 中試試看
  8. 下一步

為什麼 SysML v2 工具需要自己的評估

SysML v2 是一種新語言,而不是 SysML v1 的修訂版(SysML v1 與 v2 的差異 有詳細比較)。它除了圖形表示法之外還有文字表示法、以 KerML 為正式語意基礎、包含量、單位與檢視種類的標準庫,以及讀寫模型的標準 API。工具可能聲稱支援 SysML v2,卻只涵蓋其中一部分,而它遺漏的部分可能正是您的計畫所依賴的。

規格很龐大,每個工具都是分階段實作的。這很正常。評估時重要的是,您知道工具已經完成了哪些階段、還有哪些沒有,以及廠商是否坦白告訴您。以下的檢查適用於任何 SysML v2 工具,無論其價格或部署方式為何,而 測試模型 為每個候選工具提供相同的輸入。

若要尋找候選工具,請從 OMG 維護的 SysML v2 工具清單,以及 INCOSE 與 OMG 為支援從 SysML v1 移轉而發布的 SysML v2 工具能力摘要開始。兩者都只是起點:從中取得名稱,然後親自測試每個工具。

要檢查什麼

語言涵蓋範圍,以及缺口如何記錄

要求提供涵蓋範圍聲明:語言的每個領域(套件、定義與用法、特化與重新定義、多重性、值與單位、約束、結構、動作、狀態、需求、使用案例、分析與驗證案例、檢視、中繼資料、變異性、個體與時間切片),並為每個領域標明程度。有用的程度區分四種情況:

  • 工具會剖析、檢查並使用該結構;
  • 工具會這樣做,但有明確列出的限制;
  • 工具完全依原樣保留該結構,但不賦予它任何意義(它能在來回轉換中保留下來,但沒有任何東西檢查或計算它);
  • 工具不接受該結構。

公布已知缺口的廠商,比只列出功能的廠商更容易規劃。沒有涵蓋範圍表的「支援 SysML v2」應視為未知,並測試您的模型所使用的結構。

文字表示法:編輯與檢查

文字表示法是 SysML v2 與 v1 差異最大之處,也是各工具差異最大之處。請檢查:

  • 編輯:語法著色、名稱與關鍵字自動完成、跳至定義、在整個模型中重新命名、尋找與取代。
  • 輸入時檢查:語法錯誤是最低要求。有用的檢查器還會透過匯入解析每個名稱、回報重複與模稜兩可的名稱、依繼承內容檢查重新定義、比較單位的因次,並比較連接兩端埠與流動的方向。
  • 文字就是模型:編輯之後,其他所有檢視是否都看到變更,還是文字只是工具偶爾匯入的一個檔案?
  • 非由工具撰寫的文字:載入手寫或由其他工具撰寫的文字。文字中的註解、文件說明與版面配置都應保留下來。

圖形檢視,以及文字與圖的同步

在 SysML v2 中,檢視是一個模型元素:它說明自己公開與篩選的內容,再由工具繪製出來。標準庫定義了 General、Interconnection、Action Flow、State Transition、Sequence 與 Grid 檢視。請檢查工具會繪製其中哪些、可在哪些檢視中編輯,以及如何處理規格交由工具決定的版面配置。

關鍵測試是雙向同步。在文字中重新命名一個零件,並查看每一張顯示它的圖。在圖中新增一個連接,並閱讀它產生的文字。接著,如果兩個人可以同時編輯,就同時修改兩邊,看看工具如何處理衝突。

標準庫

SysML v2 的許多意義都存在於它的標準庫中:純量值、國際量制、SI 與美制單位、標準檢視定義,以及 KerML 核心庫。工具應隨附這個庫、依據它解析名稱,並用它進行評估。請檢查 ISQ 量的種類與 SI 單位能否解析、庫是否不會被意外修改,以及工具使用哪個版本的庫。

Systems Modeling API

Systems Modeling API 是模型儲存庫的標準 REST 介面:專案、分支、提交與元素。它讓工具不需檔案就能交換模型,也讓您自己的腳本能讀取模型。工具可以扮演兩種角色,任何一種都可以是唯讀的:

  • 用戶端:工具從另一個提供此 API 的儲存庫拉取資料,並推送到該儲存庫。
  • 伺服器:工具提供此 API,讓其他工具讀取(也可能寫入)它的模型。

請詢問是哪種角色、哪些路由,以及是否提供寫入、查詢、差異比較與較舊的提交。唯讀伺服器對報表與提供資料給分析工具仍然有用;但當另一個工具必須修改模型時就不夠了。

JSON 交換與往返

除了文字之外,模型也以 SysML v2 JSON 在工具之間移動:這是 API 的元素格式,每個元素都有一個 id。id 很重要:文字不帶 id,因此重新匯入文字的工具只能依名稱比對元素,而 JSON 能在交換過程中保持識別。請測試來回轉換:從工具 A 匯出、匯入工具 B、再次匯出並匯入 A。接著比較元素數量、名稱、帶單位的值與關係,並查看每個工具如何回報它捨棄了什麼。工具不支援的元素種類,正是來回轉換遺失資料之處。

從 SysML v1 遷移

從 v1 到 v2 沒有無損的自動轉換:兩種語言的結構不同,而 v1 圖帶有在 v2 中沒有單一對應的版面配置與構造型。請詢問工具如何匯入 v1 模型(通常是帶有 SysML 1.x 設定檔的 XMI)、會將區塊、零件、埠、活動、狀態機與需求對應成什麼,以及是否產生未轉換內容的報告。請用您自己的一個 v1 模型試試,而不是用廠商的範例。

協作與版本控制

系統模型是團隊工作。請檢查多人能否同時編輯、衝突如何顯示與解決、有哪些角色(編輯、審查、檢視)、歷程記錄與基準線如何運作,以及能否逐元素和以文字比較兩個版本。如果您的組織將模型存放在儲存庫中,請檢查分支、合併,以及工具本身的版本歷程與儲存庫提交之間的關係。

模型上的需求與驗證

SysML v2 將需求定義為對主體的約束,並以 satisfy 與 verify 關係連結到設計與驗證案例。請檢查工具是否將需求文字與約束放在一起、依據模型的值評估約束,並從 verify 關聯建立驗證矩陣。也請檢查工具在語言之外保留了什麼:需求狀態、核准、測試結果,以及變更後的可疑關聯。這些不屬於 SysML v2 文字,因此請詢問它們存放在哪裡,以及是否會隨匯出一起帶走。

帶有單位的分析與評估

SysML v2 模型中的每個值都可以帶有單位,而運算式會將它們組合起來。請檢查工具是否以單位評估運算式(由三個零件質量算出以公斤表示的總質量)、是否將因次錯誤回報為錯誤,以及是否依據結果評估需求約束。接著檢查您需要的較大型分析功能:參數求解、預算與彙總、權衡研究、動作流程或狀態機的模擬。請詢問哪些是從模型評估的,哪些需要額外的工具專屬資料。

部署:雲端或自行託管

請檢查模型存放在哪裡、由誰執行工具:託管服務、桌面安裝,或您自己環境中的伺服器。對於受管制或受出口限制的資料,請詢問自行託管、資料位置、登入選項,以及 AI 功能(若有)如何設定或關閉。

授權與成本

請比較您團隊的總成本,而不是每個席位的定價:檢視者與審查者、學術或評估用途、API 或伺服器選項的費用,以及停止付費後您的模型會如何。請檢查每個方案是否都能以標準格式匯出,讓您的模型始終屬於您。

訓練課程

SysML v2 對大多數工程師而言都是新的,包括熟悉 v1 的工程師。請尋找涵蓋工具所支援表示法的參考文件、實作範例、可以探索的示範模型,以及針對工具本身畫面的引導教材。語言訓練與工具訓練是不同的需求;請確認兩者都有涵蓋。

評估檢查清單

以相同的問題與相同的輸入為每個候選工具評分。「已展示」表示您在測試模型或您自己的模型上看到它運作,而不是在簡報投影片上。

領域要問的問題如何測試
語言涵蓋範圍是否有公布的涵蓋範圍表並列出已知缺口?在表中找出您的模型使用的結構;載入測試模型
文字表示法編輯器是否在輸入時檢查名稱、重新定義、單位與方向?載入兩個探針模型;每個都應回報一個問題
圖形檢視繪製並可編輯哪些標準檢視?開啟測試模型的 Interconnection View 與狀態轉換檢視
文字與圖同步任一邊的變更是否立即出現在另一邊?在文字中重新命名 controller;在圖中新增一個連接並閱讀產生的文字
標準庫ISQ 量、SI 單位與標準檢視能否解析?測試模型匯入 ISQ、SI 與 StandardViewDefinitions
Systems Modeling API用戶端、伺服器,還是兩者皆是?唯讀還是可讀寫?從另一個工具或以腳本讀取測試模型的元素
JSON 來回轉換是否保留元素 id?捨棄了什麼,是否有回報?匯出、匯入第二個工具、再次匯出、比較
v1 移轉是否有從 SysML v1 匯入的途徑,並附報告?轉換您自己的一個 v1 模型
協作同時編輯、角色、基準線、比較?兩個人編輯同一個套件;與基準線比較
需求與驗證是否評估約束並建立驗證矩陣?將質量上限降到 20 kg,看需求不成立
帶單位的分析值是否以單位評估?還會計算什麼?檢查 totalMass 評估為 23 kg
部署託管、桌面、自行託管?要求以書面提供選項,並附資料位置
授權與成本作者、審查者與檢視者的總成本;每個方案都能匯出?為您的團隊估價,包括審查者
訓練課程語言參考、範例、工具指南?讓一位新使用者只靠文件為測試系統建模

可載入任何候選工具的測試模型

這個模型小到可以手動輸入,卻仍涵蓋評估所需的大部分內容:從標準庫匯入、帶有重新定義值與單位的零件定義與用法、共軛埠、連接與一個繫結、一個狀態機、一個帶有接續的動作、兩個帶有約束的需求、一個 satisfy、一個驗證案例,以及兩個檢視。將它儲存為 pump-station.sysml,並載入每個工具。

這個系統是一台太陽能水泵:太陽能板供電給控制器,控制器驅動水泵。整機重量不得超過 25 kg,且太陽能板的峰值功率必須比水泵的額定功率至少高 20 %。如果您不熟悉這種表示法,SysML v2 教學 會介紹這個模型使用的每個結構。

package PumpStation {
  doc /* A solar-powered water pump: a small probe model for evaluating SysML v2 tools. */

  private import ScalarValues::*;
  private import ISQ::*;
  private import SI::*;

  port def PowerPort {
    out attribute voltage : ElectricPotentialValue;
  }

  port def WaterPort {
    out attribute pressure : PressureValue;
  }

  part def SolarPanel {
    attribute mass : MassValue;
    attribute peakPower : PowerValue;
    port powerOut : PowerPort;
  }

  part def Controller {
    attribute mass : MassValue;
    port powerIn : ~PowerPort;
    port motorOut : PowerPort;
  }

  part def Pump {
    attribute mass : MassValue;
    attribute ratedPower : PowerValue;
    port powerIn : ~PowerPort;
    port outlet : WaterPort;
  }

  item def StartSignal;
  item def StopSignal;

  state def PumpModes {
    entry; then idle;
    state idle;
    state pumping;
    transition first idle accept StartSignal then pumping;
    transition first pumping accept StopSignal then idle;
  }

  action def DeliverWater {
    action convertSunlight;
    action regulatePower;
    action driveImpeller;
    first start then convertSunlight;
    first convertSunlight then regulatePower;
    first regulatePower then driveImpeller;
    first driveImpeller then done;
  }

  part def PumpUnit {
    part panel : SolarPanel {
      attribute redefines mass = 12 [kg];
      attribute redefines peakPower = 400 [W];
    }
    part controller : Controller {
      attribute redefines mass = 2 [kg];
    }
    part pump : Pump {
      attribute redefines mass = 9 [kg];
      attribute redefines ratedPower = 300 [W];
    }
    port outlet : WaterPort;

    connect panel.powerOut to controller.powerIn;
    connect controller.motorOut to pump.powerIn;
    bind outlet = pump.outlet;

    attribute totalMass : MassValue = panel.mass + controller.mass + pump.mass;
    exhibit state modes : PumpModes;
  }

  part pumpUnit : PumpUnit {
    perform action delivery : DeliverWater;
  }
}

package PumpRequirements {
  private import PumpStation::*;
  private import ScalarValues::*;
  private import ISQ::*;
  private import SI::*;

  requirement def <'PS-1'> MassLimit {
    doc /* The pump unit shall weigh no more than the mass limit, so that one person can carry it. */
    subject unit : PumpUnit;
    attribute limit : MassValue;
    require constraint { unit.totalMass <= limit }
  }

  requirement def <'PS-2'> PowerMargin {
    doc /* The panel's peak power shall exceed the pump's rated power by at least 20 %. */
    subject unit : PumpUnit;
    require constraint { unit.panel.peakPower >= 1.2 * unit.pump.ratedPower }
  }

  requirement pumpSpec {
    subject unit : PumpUnit;
    requirement mass : MassLimit {
      attribute redefines limit = 25 [kg];
    }
    requirement power : PowerMargin;
  }

  satisfy pumpSpec by pumpUnit;

  verification def <'VC-1'> WeighUnit {
    doc /* Weigh the assembled pump unit on a calibrated scale. */
    subject unit : PumpUnit;
    objective {
      verify pumpSpec.mass;
    }
    return verdict : Boolean = unit.totalMass <= pumpSpec.mass.limit;
  }
}

package PumpViews {
  private import PumpStation::*;
  private import StandardViewDefinitions::*;

  view unitConnections : InterconnectionView {
    expose PumpStation::PumpUnit;
  }

  view pumpStates : StateTransitionView {
    expose PumpStation::PumpModes;
  }
}

支援這些結構的工具應顯示:

  • 沒有錯誤也沒有警告。在這裡回報問題的工具,不是缺少某個結構,就是對標準庫的解讀不同;請詢問是哪一種。
  • totalMass 評估為 23 kg:12 kg + 2 kg + 9 kg。
  • 兩個需求都成立:23 kg 在 25 kg 之內,而 400 W 大於 1.2 × 300 W = 360 W。
  • unitConnections 繪製出太陽能板、控制器與水泵及其埠、兩個連接,以及繫結到整機邊界的出口。
  • pumpStates 繪製出兩個狀態,帶有一個初始轉移與兩個由觸發引起的轉移。
  • 驗證矩陣列出由 VC-1 驗證的 PS-1,以及沒有驗證案例的 PS-2。

給檢查器的兩項探測

檢查器的價值在於找出錯誤。請分別載入每個探針模型;每個都恰好含有一個問題。

第一個將功率的值以公斤表示。會檢查因次的工具會在該值上回報錯誤:

package UnitProbe {
  private import ISQ::*;
  private import SI::*;

  part def Pump {
    attribute ratedPower : PowerValue;
  }

  part pump : Pump {
    attribute redefines ratedPower = 300 [kg];
  }
}

第二個能順利剖析與解析,但它的需求不成立:整機重 11 kg,而上限為 10 kg。會評估需求約束的工具會回報這個問題;只做剖析的工具則會默默接受。

package RequirementProbe {
  private import ISQ::*;
  private import SI::*;

  part def Pump {
    attribute mass : MassValue;
  }

  part def Unit {
    part pump : Pump {
      attribute redefines mass = 9 [kg];
    }
    attribute totalMass : MassValue = pump.mass + 2 [kg];
  }

  requirement def Light {
    subject unit : Unit;
    require constraint { unit.totalMass <= 10 [kg] }
  }

  part unit : Unit;
  requirement light : Light;
  satisfy light by unit;
}

兩個探針模型都與測試模型一樣,以語言引擎檢查過:模型沒有任何問題,而每個探針模型恰好產生所述的那一個問題。

執行評估

  1. 先寫下您的需求。您的模型使用哪些結構、審查者閱讀哪些檢視、哪些工具必須交換模型,以及資料可以存放在哪裡。依此為檢查清單的各列設定權重。
  2. 閱讀每家廠商的涵蓋範圍聲明與已知缺口。將檢查清單的每一列標記為已聲明、未聲明或未說明。
  3. 將測試模型與探針模型載入每個候選工具。逐字記錄每個工具回報的內容。
  4. 載入您自己的一個模型。真實模型能找出範例找不到的問題:規模、命名、少見的結構。
  5. 與您最常交換模型的工具做一次來回轉換。
  6. 讓一位新使用者只靠工具的文件建立測試模型,並計時。

將證據(螢幕截圖、匯出的檔案、每個工具給出的訊息)與評分一起保存。對審查委員會而言,顯示實際測試內容的決策紀錄,比從廠商資料複製來的功能矩陣更有價值。

Holarch 對檢查清單的回答

Holarch 是本頁螢幕截圖所使用的工具,因此以下是它自己的回答,每一項都附有佐證頁面。「部分」與「尚未」就是字面上的意思。

領域層級Holarch 現況
語言涵蓋範圍部分一張公布的表格,列出每個領域的程度、限制與已知缺口。變異性、個體與時間切片、使用者定義的關鍵字與語意中繼資料都會被檢查與評估;尚未匯入 .kerml 檔案;SysML 與 KerML 中的文字表示會被檢查,其他語言則保留為文字。SysML v2 語言涵蓋範圍
文字表示法支援一個在輸入時檢查(語法、名稱、型別、多重性、單位、方向、評估)的編輯器,具備自動完成、跳至定義、重新命名與尋找與取代。編輯器、檢查
圖形檢視部分General、Interconnection、Action Flow、State Transition、Sequence 與 Grid 檢視,全部可編輯。序列檢視繪製生命線之間的訊息與組合片段(alt、opt、loop 與 par)。SysML v2 檢視
文字與圖同步支援文字與每個檢視背後都是同一個模型;任一邊的編輯都會顯示在另一邊。文字與檢視保持同步
標準庫支援已載入且唯讀,包含 ISQ、SI 與美制單位,以及標準檢視定義。標準庫
Systems Modeling API部分作為用戶端:從提供此 API 的儲存庫的一個分支拉取並推送。作為伺服器:其他工具讀取目前的模型,並提交到變更請求分支,再由核准者在 Holarch 中套用。拉取與推送、Systems Modeling API
JSON 來回轉換部分SysML v2 JSON 匯入與匯出,並保留元素 id。Holarch 不解讀的元素種類會依匯入時的樣子保留,並在匯出時原封不動寫回。交換 SysML v2 模型
v1 移轉部分將 SysML 1.x 模型(Cameo 或 MagicDraw 的 .mdzip,或來自 Cameo、Enterprise Architect、Rhapsody 或 Papyrus 的 XMI)直接匯入 SysML v2 專案,轉換為 SysML v2 文字並加以檢查,並附上報告,說明哪些內容已轉換、近似處理或省略,以及原因。圖及其版面配置不會轉換。匯入 SysML v1 模型
協作支援即時編輯,在編輯器中逐成員合併、角色、保存模型的基準線,以及依元素與依套件文字比較。協作、基準線
需求與驗證支援依據模型評估需求約束、從 verify 關聯建立 RVTM 與測試中心、核准、TBD/TBR,以及待審查的關聯。需求與驗證
帶單位的分析部分帶單位的評估、每個約束求解一個未知數的參數檢視、預算、權衡研究,以及動作流程與狀態機的模擬。分析案例只有在每個輸入都有值時才會被評估。評估、單位與分析
部署支援託管的網頁應用程式,並可應要求在您自己的環境中自行託管部署。安全性、聯絡我們
授權與成本支援Free 方案供學生、教師、個人專案與個人評估使用;公司可免費試用 Individual 方案 1 個月;付費方案供商業用途;每個方案都有免費的審查者與檢視者。價格
訓練課程部分每個 SysML v2 頁面的 Docs 參考、逐步教學、Hybrid Car 示範、九個應用程式內的 SysML v2 引導式教學,以及建立 Hybrid Car 模型的 SysML v2 影片教學系列。影片訓練課程涵蓋 LML 專案。入門、SysML v2 教學、SysML v2 教學

在 Holarch 中試試看

  1. 將測試模型儲存為 pump-station.sysml。
  2. 開啟 模型 → 匯入和匯出,選擇 匯入到新的 SysML v2 專案,然後拖放檔案。請參閱 將檔案匯入新專案。
  3. 開啟 模型 → 編輯器。狀態列顯示「無問題」,而每個套件都是一份文件。
  4. 開啟 圖 清單,然後按一下 unitConnections 或 pumpStates。
  5. 開啟 驗證 → RVTM,查看需求以及驗證它們的案例。
編輯器中的測試模型,沒有任何問題。
unitConnections 檢視:共軛埠、兩個連接與一個繫結。
由模型的 verify 關聯建立的 RVTM。

下一步