מדריך · SysML v2
העברת מודל SysML v1 ל-SysML v2: הגירה צעד אחר צעד
אפשר להמיר מודל SysML v1 ל-SysML v2 באופן אוטומטי, אבל הגירה היא יותר מהמרת קובץ: מישהו צריך להחליט איך המודל המומר צריך להיראות ולבדוק שהוא עדיין אומר את מה שמודל ה-v1 אמר. המדריך הזה עובר על הגירה בשמונה צעדים, ממיפוי מודל ה-v1 ועד המעבר, עם מודל קטן שמומר ונקרא שורה אחר שורה.
בדף זה
לפני שמתחילים: תרגום, לא שדרוג
SysML v2 היא שפה חדשה, לא גרסה חדשה של פורמט הקובץ של SysML v1. בלוקים הופכים להגדרות part, ports מוקלדים לפי הגדרות port, דרישות נושאות תנאים, ודיאגרמות הופכות לתצוגות שהמודל מגדיר. SysML v1 מול v2 מסביר את ההבדלים אחד אחד.
ממיר עושה את החלק המכני: כל רכיב שיש לו מקבילה ב-SysML v2 נכתב ב-SysML v2, והשאר מדווח. מה שממיר אינו יכול לעשות הוא להחליט איך הצוות שלכם רוצה להשתמש בשפה החדשה. יש לתכנן את ההגירה כמשימת מידול עם בעלים, סקירה ונקודה שבה מודל ה-v2 הופך לייחוס.
המדריך הזה משתמש בממיר של Holarch, שמייבא מודל SysML 1.x לפרויקט SysML v2 ומדווח על כל רכיב כהומר, קורב או הושמט. צעדי התכנון חלים על כל ממיר.
1. מיפוי מודל ה-v1
לפני שמייצאים משהו, כדאי לברר מה המודל מכיל ומי תלוי בו. מצאי קצר חוסך עבודה חוזרת בהמשך.
- חבילות ובעלים. יש לפרט את החבילות ברמה העליונה, מי מתחזק כל אחת, ואילו מהן מודלים או מסמכים אחרים מפנים אליהן. חבילות הן היחידה שתמירו ותסקרו.
- דיאגרמות חשובות. יש לרשום את הדיאגרמות שאנשים באמת משתמשים בהן בסקירות ובמסמכים. פריסות דיאגרמה אינן עוברות ל-SysML v2, ולכן אלה הופכות לתצוגות שבונים מחדש.
- פרופילים וסטריאוטיפים. יש לפרט את הסטריאוטיפים שלכם ואת ה-tagged values שלהם. הם הופכים להגדרות metadata, ויש להסכים מחדש על המשמעות שלהם במודל החדש.
- התנהגות שנכתבה כקוד. התנהגויות אטומות (opaque), תנאי שמירה ואילוצים ב-OCL, בשפת פעולה או בסקריפטים של כלי נשמרים כטקסט בשפה המקורית שלהם; הם אינם מתורגמים.
- רכיבים ללא שם. קשרים שמצביעים על רכיבים בלי שם אי אפשר לכתוב בטקסט SysML v2, שמפנה לרכיבים לפי שם. יש לתת שמות לרכיבים שאתם עוקבים אליהם עכשיו, בכלי ה-v1.
- גודל. Holarch ממיר קובץ אחד של עד 64 MB ו-250,000 רכיבים בכל פעם. מודלים גדולים יותר מיוצאים חבילה אחת בכל פעם.
2. ייצוא המודל מכלי ה-SysML v1
הממיר קורא את המודל מ-XMI, פורמט ההחלפה שכלי SysML v1 כותבים. כל כלי מייצא אותו קצת אחרת:
| כלי | מה לייבא |
|---|---|
| Cameo Systems Modeler, MagicDraw | קובץ הפרויקט .mdzip, או File ← Export To ← Eclipse UML2 (v5.x) XMI File ואת הקובץ .xmi |
| Enterprise Architect | יש לבחור את החבילה, Publish ← Export XML, לבחור XMI 2.1, ולייבא את הקובץ .xml. קובצי פרויקט (.eap, .qea) אינם נקראים ישירות. |
| IBM Rhapsody | ייצוא XMI 2.x מה-XMI toolkit |
| Eclipse Papyrus | קובץ ה-.uml של המודל |
יש לשמור את הקובץ המיוצא עם רשומות ההגירה: זה קלט ה-v1 המדויק שהסקירה שלכם מתייחסת אליו.
3. המרת חבילת פיילוט
כדאי להתחיל בחבילה אחת שמייצגת אבל אינה הגדולה ביותר: תת-מערכת עם מבנה, ממשקים, קצת התנהגות והדרישות שלה. הפיילוט מראה איך ההמרה של המודל שלכם נראית לפני שמחייבים את כל הצוות.
- יש ליצור פרויקט SysML v2, או לפתוח את הפרויקט שהמודל המומר צריך להיכנס אליו, וללחוץ על מודל ← ייבוא וייצוא.
- תחת ייבוא, יש לבחור לפרויקט SysML v2 חדש לפיילוט, כך ששום דבר אחר לא ייפגע.
- יש לגרור את הקובץ המיוצא אל התיבה. כרטיס התקדמות מציג את השלבים: קריאת קובץ ה-XMI, המרה ל-SysML v2, בדיקת התוצאה.
עדיין לא יובא דבר. המסך הבא הוא התצוגה המקדימה עם דוח ההמרה.
4. קריאת דוח ההמרה
המרה מ-SysML v1 בראש התצוגה המקדימה נותן את מספר הרכיבים שהומרו, קורבו והושמטו, והאם טקסט ה-SysML v2 עובר בדיקה בלי בעיות. לכל רכיב של מודל ה-v1 יש תוצאה אחת:
- הומר: לרכיב יש מקבילה ישירה ב-SysML v2, כמו בלוק שהופך ל-
part def. - קורב: הרכיב נשמר בצורה משתנה, למשל מעבר דרך choice שהופך למעבר אחד לכל נתיב. אלה המקומות שבהם המשמעות עשויה להיות שונה ממודל ה-v1.
- הושמט: אין לו מקבילה ב-SysML v2, או שהרכיב מצביע על משהו שאינו בקובץ.
יש להשתמש ב-הצגה כדי לפרט את הרכיבים שקורבו והושמטו. כל שורה מציגה את הרכיב, את סוג ה-SysML v1 שלו, למה הוא הפך עם שם ה-SysML v2 שלו, ולמה. אפשר לפתוח את הצגת הטקסט של SysML v2 כדי לקרוא את התוצאה, וללחוץ על הורדת הדוח כדי לשמור את הדוח כקובץ CSV. קובץ ה-CSV הוא רשימת העבודה לצעד 5: יש למיין אותו לפי סיבה ולתת לכל קבוצה בעלים.
דוגמה מלאה: מודל רובר קטן
מודל SysML v1 קטן של נתיב ההספק של רובר פלנטרי, בשלוש חבילות:
| חבילה | רכיבי SysML v1 |
|---|---|
| Types | value type בשם Power עם היחידה W; בלוק Charge; interface block בשם Power Interface עם שתי flow properties יוצאות, charge (Charge) ו-voltage (Real) |
| מבנה | בלוק מכומס Rover עם part properties בשם battery ו-computer, value property בשם power budget של 120 W, connector בשם power bus בין ה-ports שלהם ו-item flow בשם power flow של Charge עליו. בלוק Battery עם proxy port בשם out; בלוק Computer עם proxy port מצומד בשם in ו-full port בשם raw. שניהם נושאים סטריאוטיפ משתמש «Hardware» עם tagged values. association שהקצה שלה נמצא בבעלות ה-association. |
| דרישות | דרישות R-1 Mission ו-R-2 Power Margin; R-2 נגזרת מ-R-1; R-2 ממולאת על ידי ה-part של הסוללה; trace מ-Computer אל Battery |
אחרי ההמרה, כך הוא נקרא. הרשימה היא הפלט של הממיר, ללא שינוי:
package 'Rover Model' {
package Types {
attribute def Power :> ISQ::PowerValue;
part def Charge;
port def 'Power Interface' {
out item charge : Charge;
out attribute voltage : ScalarValues::Real;
}
}
package Structure {
part def Rover {
doc /* Six-wheeled science rover. */
@SysMLv1Library::BlockData { isEncapsulated = true; }
part battery : Battery;
part computer : Computer;
attribute 'power budget' : Types::Power = 120 [SI::W];
connection 'power bus' connect battery.'out' to computer.'in';
satisfy Requirements::'Power Margin' by battery;
flow 'power flow' of Types::Charge from battery.'out' to computer.'in';
}
part def Battery {
@'SysML v1 Profiles'::rov::Hardware { qualified = "true"; vendor = "Acme Cells"; }
port 'out' : Types::'Power Interface';
attribute capacity : Types::Power;
}
part def Computer {
@'SysML v1 Profiles'::rov::Hardware { vendor = "Orbital Logic"; }
port 'in' : ~Types::'Power Interface';
part raw : Types::Charge {
@SysMLv1Library::PortData { isFullPort = true; }
}
}
}
package Requirements {
requirement <'R-1'> Mission {
doc /* The rover shall explore the landing site. */
}
requirement <'R-2'> 'Power Margin' {
doc /* Keep a 50 % power margin. */
}
connection : DerivationConnections::Derivation connect 'Power Margin' to Mission;
dependency from Structure::Computer to Structure::Battery {
@SysMLv1Library::TraceData { isTrace = true; }
}
}
}
package 'SysML v1 Profiles' {
package rov {
metadata def Hardware {
attribute qualified : ScalarValues::String;
attribute vendor : ScalarValues::String;
}
}
}
מה קרה לכל חלק של מודל ה-v1:
- Value type עם יחידה. Power בוואטים מתמחה מ-
ISQ::PowerValueשל הספרייה הסטנדרטית, וערך ברירת המחדל נכתב עם היחידה שלו:120 [SI::W]. Value type שהיחידה שלו אינה יחידת SI ממופה נשאר מספר ממשי, עם היחידה בתיעוד שלו, ומדווח כקורב. - בלוקים ומאפיינים. בלוקים הופכים ל-
part defו-part properties הופכות ל-part. ל-isEncapsulated של הבלוק אין מילת מפתח ב-SysML v2, ולכן הוא נשמר כ-metadata מסוגSysMLv1Library::BlockData. - Interface block ו-ports. ה-interface block הופך ל-
port defשה-flow properties שלו הם features מכוונים:out itemלזה שמוקלד לפי בלוק,out attributeלערך. ה-proxy port המצומד מוקלד~Types::'Power Interface'. ה-full port הופך ל-part עם metadata מסוגSysMLv1Library::PortData, כי port ב-SysML v2 מוקלד לפי הגדרת port. - Connector ו-item flow. ה-connector הופך ל-
connectionבין שני ה-ports, וה-item flow שעליו ל-flowשל Charge בין אותם ports. - דרישות. כל דרישה שומרת את המזהה שלה כשם קצר,
<'R-1'>, ואת הטקסט שלה כ-doc. קשר ה-satisfy נמצא בבלוק שמחזיק את ה-part הממלא; קשר ה-derive הופך ל-derivation connection; ה-trace הופך ל-dependency עםSysMLv1Library::TraceData. - סטריאוטיפ המשתמש. «Hardware» הופך ל-
metadata defבחבילה'SysML v1 Profiles', שמוחל על כל בלוק עם ה-tagged values שלו. שתי ההחלות שלו מדווחות כקורבו: ערכי התגיות הפכו למאפייני טקסט, לא משנה מה היה הטיפוס שלהם בפרופיל. - ה-association. ל-association בלי מחלקה אין כאן מקבילה ב-SysML v2, וגם הקצה שלה שבבעלות ה-association אינו מומר. שניהם מדווחים כהושמטו; המאפיינים שבבלוקים נושאים את המבנה.
הדוח של המודל הזה: 31 רכיבים, 27 הומרו, 2 קורבו, 2 הושמטו, והטקסט עובר בדיקה בלי שגיאות ובלי אזהרות. שמות שאינם מזהים פשוטים, כמו 'power budget' או 'out' (מילת מפתח של SysML v2), מוקפים במירכאות כדי לשמור על האיות שלהם מ-v1.
5. עיבוד מחדש של מה שקורב או הושמט
יש לעבור על השורות שקורבו והושמטו בדוח לפי סיבה. רוב הסיבות מחייבות אחת מכמה החלטות:
| מה הדוח אומר | מה להחליט |
|---|---|
| port מוקלד לפי בלוק שאינו interface block; הוא הפך ל-port בלי טיפוס | להגדיר הגדרת port עם ה-features שחוצים את הגבול, ולהקליד את ה-port לפיה. |
| מעברים דרך choice, junction, fork או join; כל נתיב הפך למעבר אחד | לבדוק שתנאי השמירה המאוחדים עדיין אומרים את מה שדיאגרמת ה-v1 התכוונה; לפשט במקום שבו הנתיבים קלים יותר לקריאה עכשיו. |
| trigger נשמר כתיעוד | לכתוב מחדש change triggers ו-time triggers כ-triggers של SysML v2 במקום שבו המשמעות ברורה, כמו accept after משך זמן. |
| יחידה אינה יחידת SI ש-Holarch ממפה; ה-value type הוא מספר ממשי | להחליט אם גודל סטנדרטי מתאים, או להשאיר את המספר הממשי ואת היחידה המתועדת. |
| סוג פעולה שאינו call, opaque או accept action הפך לפעולה רגילה | לכתוב מחדש פעולות send ופעולות מסוימות אחרות עם פעולת ה-SysML v2 שעושה אותו דבר. |
| activity partitions אינן מומרות | לציין איזה part עושה מה באמצעות perform ב-part, במקום מסלול שחייה. |
| הוא מצביע על רכיב בלי שם | לתת שם ליעד בכלי ה-v1 ולהמיר שוב, או להוסיף את הקשר במודל ה-v2. |
| השם שלו משמש פעמיים באותו מקום; שמו שונה עם סיומת | לתת לכל רכיב שם שאומר מה הוא. |
| tagged values הפכו למאפייני טקסט של ה-metadata | לתת למאפייני ה-metadata את הטיפוסים שהם צריכים, ולהסכים מה כל סטריאוטיפ אומר עכשיו. |
שני סוגי טקסט צריכים מבט גם כשהם הומרו בצורה נקייה. גופים אטומים (opaque) נשמרים כייצוגים טקסטואליים בשפה המקורית שלהם, כמו language "OCL" /* … */; Holarch בודק רק גופים שנכתבו ב-SysML או ב-KerML, ולכן יש לכתוב מחדש תנאי שמירה או אילוץ כביטוי SysML במקום שבו המודל צריך לחשב אותו. ותרגומים מילוליים שומרים על מעקפים של v1, כמו property-specific types שנוצרו רק כדי לקבוע ערך: ב-SysML v2 אלה redefinitions פשוטות על usages. מה צריך חשיבה מחדש מפרט את המקרים הנפוצים.
6. בנייה מחדש של התצוגות החשובות
דיאגרמות והפריסה שלהן אינן מומרות. יש לקחת את רשימת הדיאגרמות מצעד 1 וליצור תצוגה לכל אחת שעדיין נחוצה: general view למבנה ולדרישות, interconnection view ל-parts ולחיבורים, action flow view לפעילויות, state transition view למכונות מצבים. יש לבנות מחדש רק את מה שאנשים משתמשים בו; המודל מחזיק את כל השאר בכל מקרה. ראו ההפניה לתצוגות.
7. בדיקה וסקירה של מודל ה-v2
- הטקסט עובר בדיקה נקייה. הייבוא מציג את הבדיקה של הטקסט המומר לפני שמשהו משתנה; אחרי העיבוד מחדש, העורך מסמן כל בעיה חדשה תוך כדי הקלדה.
- הספירות תואמות. יש להשוות כמה מספרים בין מודל ה-v1 למודל ה-v2: דרישות, parts, ports, חיבורים, קשרי אימות. הבדל שאי אפשר להסביר מהדוח שווה בדיקה.
- האנשים שמשתמשים במודל סוקרים אותו. יש לעבור על חבילת הפיילוט עם הבעלים שלה, החל מהרכיבים שקורבו ומהתצוגות שנבנו מחדש.
- תיעוד ההחלטות. יש לרשום את דפוסי המידול שהוחלט עליהם עבור ports, triggers, יחידות וסטריאוטיפים, כך ששאר ההגירה תעקוב אחריהם.
8. המרת השאר והמעבר
יש להמיר את החבילות שנותרו אחת אחת, לאותו פרויקט SysML v2. כל ייבוא מציג את אותה תצוגה מקדימה: חבילה שכבר נמצאת בפרויקט מוצגת כשונה או ללא שינוי, חבילה חדשה כחדש, ובוחרים אילו חבילות לייבא. כל ייבוא הוא צעד ביטול אחד.
יש לשמור את מודל ה-v1 כייחוס עד שמודל ה-v2 נסקר, ואז להקפיא אותו ולהפוך את פרויקט ה-SysML v2 למודל הרשמי. מאותה נקודה, שינויים נכנסים רק למודל ה-v2.
רשימת תיוג להגירה
- החבילות, הבעלים והדיאגרמות החשובות מפורטים.
- לרכיבים שקשרים מצביעים עליהם יש שמות.
- קובץ ה-XMI המיוצא נשמר עם רשומות ההגירה.
- חבילת פיילוט הומרה, הדוח שלה הורד, ולכל שורה שקורבה או הושמטה יש החלטה.
- דפוסי המידול עבור ports, triggers, יחידות וסטריאוטיפים כתובים.
- התצוגות הנחוצות נבנו מחדש; הטקסט עובר בדיקה נקייה.
- המשתמשים במודל סקרו את הפיילוט.
- החבילות שנותרו הומרו באותה דרך, ומודל ה-v1 הוקפא.
לאן ממשיכים
- מ-SysML v1 ל-SysML v2 ב-Holarch: מה הממיר קורא וכותב, ודוגמת CubeSat EO-1.
- ייבוא מודלים של SysML v1: כל צעד, מיפוי, מגבלה והודעה בתיעוד.
- SysML v1 מול v2: במה שתי השפות נבדלות.
- מדריך SysML v2: בניית מודל בסימון הטקסטואלי.
- כיסוי שפת SysML v2: מה פרויקטים של SysML v2 תומכים בו והפערים הידועים.
Cameo Systems Modeler, MagicDraw, Enterprise Architect, Rhapsody ו-Eclipse Papyrus הם סימנים מסחריים של בעליהם. Holarch אינו קשור אליהם ואינו מאושר על ידם.