SysML v2
החלפת מודלים של SysML v2
ייבוא קובצי .sysml, ארכיוני zip ו-SysML v2 JSON לפרויקט SysML v2 עם תצוגה מקדימה, וייצוא המודל או חבילה כטקסט .sysml או כ-SysML v2 JSON.
בדף זה
- סקירה כללית
- מושגים
- איך להשתמש בה
- מתי ולמה
- ייבוא קבצים לפרויקט הזה
- ייבוא קבצים לפרויקט חדש
- עדכון חבילה מגרסה חדשה
- שינוי שם והעברה של אלמנטים בטקסט תוך שמירת המזהים שלהם
- ייבוא גדול בשירות המתארח
- ייצוא המודל או חבילה
- ייבוא וייצוא של דרישות ReqIF
- משיכה ממאגר ודחיפה אליו
- דוגמה מעשית: הדגמת Hybrid Car
- עצות ושיטות עבודה טובות
- טעויות נפוצות
- כיצד זה מתחבר לתכונות אחרות
- הדף ייבוא וייצוא
- מאגר
- כיצד קבצים נקראים
- הודעות
- מגבלות
- דפים קשורים
סקירה כללית
פרויקטים של SysML v2 מחליפים מודלים עם כלי SysML v2 אחרים כקבצים. הדף ייבוא וייצוא (מודל → ייבוא וייצוא) עושה את שניהם:
- ייבוא קורא קובצי
.sysml, קובץ.zipשל קובצי.sysml, או קובץ SysML v2 JSON. הוא מציג תצוגה מקדימה של מה שמשתנה, ואז מחיל אותו על הפרויקט הזה (ביטול פעולה אחד מחזיר הכול לאחור) או יוצר פרויקט SysML v2 חדש. - ייצוא כותב את המודל כולו או חבילה אחת כטקסט SysML v2 (
.sysml) או כ-SysML v2 JSON (.json). - קובצי ReqIF (
.reqif,.reqifz) מכלי דרישות מיובאים כדרישות SysML v2, ודרישות מיוצאות כ-ReqIF: ראו ייבוא וייצוא של דרישות ReqIF.
אפשר גם ליצור פרויקט ישירות מקבצים: בניהול פרויקטים, יש ללחוץ על קובצי פרויקט ▾ → ייבוא קובצי SysML v2….
טיפ: כדי לשמור את המודל מתואם עם מאגר מודלים של SysML v2 שמציע את Systems Modeling API, יש להשתמש בקטע מאגר באותו דף: ראו משיכה ממאגר ודחיפה אליו.
מושגים
תבניות קבצים
| פורמט | מה היא מכילה | ייבוא | ייצוא |
|---|---|---|---|
טקסט SysML v2 (.sysml) | הסימון הטקסטואלי, קובץ אחד לכל חבילה ברמה העליונה. | כן | כן |
ארכיון Zip (.zip) | כמה קובצי .sysml. תיקיות הופכות לחבילות. | כן | כן, כשמיוצאים כמה קבצים |
SysML v2 JSON (.json) | רשימה שטוחה של אלמנטים, לכל אחד @id ו-@type, כפי שה-Systems Modeling API משתמש. | כן | כן |
ReqIF (.reqif, .reqifz) | דרישות עם התכונות, ההיררכיה והקשרים שלהן, מ-DOORS, Polarion, Jama, codebeamer ומכלי דרישות אחרים. | כן, מומרות לדרישות | כן, הדרישות |
קובצי KerML (.kerml) עדיין אינם מיובאים.
מזהים והתאמה
לכל אלמנט בפרויקט SysML v2 יש מזהה. שתי התבניות שומרות אותו באופן שונה:
- JSON שומר מזהים. אלמנט שמיובא שוב מ-JSON מותאם לאלמנט עם אותו מזהה.
- הפניות לספרייה הסטנדרטית מובנות. JSON מה-Systems Modeling API, מה-SysML v2 Pilot Implementation או ממאגר אחר מציין אלמנטים של הספרייה הסטנדרטית (יחידות כמו
ISQ::mass,ScalarValues::Real,Parts::Part) לפי המזהים הסטנדרטיים. הייבוא קורא אותם כאותם אלמנטי ספרייה, כך שיחידות וטיפוסים נשארים מזוהים. - טקסט שומר מזהים כשמבקשים זאת. יש לסמן הכללת מזהי רכיבים בייצוא טקסט
.sysml. כל הגדרה, שימוש וחבילה בעלי שם נושאים אז את המזהה שלהם כשורה הראשונה בגוף שלהם,@HolarchMetadata::ElementId { id = "…"; }. כשהטקסט הזה מיובא שוב, כל אלמנט עם מזהה מותאם לאלמנט עם אותו מזהה, גם אם שמו שונה, הוא הועבר לבעלים אחר או לחבילה אחרת ברמה העליונה, או שסדרו השתנה. מיקומי הדיאגרמה, ההערות, העקיבות והקישורים שלו נשמרים. - טקסט ללא מזהים מותאם לפי שם. Holarch מתאים חבילות ברמה העליונה לפי שם, ואת האלמנטים שבתוכן לפי השמות והמיקומים שלהם. המזהים נשמרים היכן שהאלמנטים מותאמים. אלמנט ששמו שונה עדיין מותאם כשהוא נשאר במקומו; אלמנט ששמו שונה והוא הועבר בו-זמנית הופך לאלמנט חדש.
הייצוא מציין זאת מתחת לפקדי הייצוא: "מזהי רכיבים נשמרים ב-JSON. בטקסט .sysml, יש לסמן הכללת מזהי רכיבים כדי לשמור אותם: הרכיבים שומרים אז על מיקומי הדיאגרמה, ההערות והעקיבות שלהם כשהטקסט הערוך מיובא שוב, גם אחרי שינוי שם או העברה. ללא מזהים, הרכיבים מותאמים לפי שם."
מזהי אלמנטים בטקסט
@HolarchMetadata::ElementId { id = "…"; } הוא מטא-נתונים רגילים של SysML v2: ElementId היא הגדרת מטא-נתונים בחבילת הספרייה של Holarch עצמו, HolarchMetadata (בספרייה הסטנדרטית תחת Holarch), לצד TBD ו-TBR. כלי SysML v2 אחרים קוראים את השורה כסימון מטא-נתונים; כדי לזהות את השם שלה הם צריכים את HolarchMetadata.sysml מאותה ספרייה.
- המזהה שייך לאלמנט שהגוף שלו מכיל את השורה. אלמנטים ללא שם (חיבורים, רצפים, הערות) אינם נושאים מזהה ומותאמים לפי התוכן שלהם, כמו קודם.
- Holarch אינו שומר את השורה כאלמנט. העורך מציג את המודל ללא השורות האלה, ואלמנט שהגוף שלו הכיל רק את השורה מוצג כ-
part engine : Engine;. - מזהים חייבים להיות ייחודיים. כשאותו מזהה מופיע פעמיים (למשל אחרי העתקה של בלוק בטקסט), האלמנט הראשון שומר אותו והעותק הופך לאלמנט חדש.
- מזהה שאינו UUID (למשל
"R-17") הופך ל-UUID קבוע, כך שאותה מחרוזת תמיד נותנת את אותו אלמנט, כמו בייבוא JSON. - מזהה שאין לפרויקט נשמר עבור האלמנט החדש. מחיקת אלמנט ב-Holarch וייבוא הטקסט שוב מחזירים אותו תחת המזהה הישן שלו.
- בעורך, שורה מודבקת פועלת בתוך החבילה שבעריכה: מזהה ששייך לאלמנט של חבילה אחרת מתעלמים ממנו שם, והאלמנט מותאם לפי שם. כדי להעביר אלמנטים בין חבילות ולשמור את המזהים שלהם, יש לייצא עם מזהים ולייבא את הקבצים הערוכים.
הגדרת החלק Car של הדגמת Hybrid Car נושאת שורה כזו בקובץ המקור שלה, ולכן המזהה שלה זהה בכל עותק של ההדגמה.
תיקיות הופכות לחבילות
בארכיון zip, כל תיקייה הופכת לחבילה שמכילה את הקבצים ותיקיות המשנה שלה. קובץ powertrain/engine.sysml בתוך הארכיון נקרא כאילו נכתב בתוך package powertrain { … }. קבצים ברמה העליונה של הארכיון נקראים כפי שהם. תיקיות וקבצים נקראים לפי סדר השמות.
מה התצוגה המקדימה משווה
לתצוגה המקדימה יש שורה אחת לכל חבילה ברמה העליונה (או, לפרויקט חדש, לכל אלמנט ברמה העליונה). לכל שורה יש תוצאה:
| תוצאה | משמעות | מיובא כברירת מחדל |
|---|---|---|
| חדש | לפרויקט אין חבילה בשם הזה (או עם המזהה הזה). היא נוספת. | כן |
| שונה | לפרויקט יש את החבילה; הייבוא מוסיף, משנה או מסיר בה אלמנטים. הפירוט מציין כמה, למשל "3 נוספו, 1 השתנה (המזהים נשמרים היכן שהאלמנטים מותאמים)". | כן |
| ללא שינוי | החבילה זהה לזו שבפרויקט הזה. | לא (אין מה לעשות) |
| התנגשות | אי אפשר למזג את החבילה. הפירוט מסביר מדוע ומה לעשות. | לא |
איך להשתמש בה
מתי ולמה
את ייבוא וייצוא משתמשים כשמודל עובר בין Holarch לכלי SysML v2 אחר, או בין פרויקטים של Holarch:
- התחלת פרויקט Holarch ממודל שנכתב במקום אחר.
- הבאת חבילה שצוות אחר מתחזק, כמו ספריית רכיבים, ועדכון שלה כשהם שולחים גרסה חדשה.
- מסירת חבילה לספק או לכלי שקורא טקסט או JSON של SysML v2.
- שמירת קובצי
.sysmlבמערכת ניהול גרסאות לצד פרויקט Holarch.
ייבוא קבצים לפרויקט הזה
- יש לפתוח את מודל → ייבוא וייצוא.
- תחת ייבוא, יש לבחור לפרויקט הזה.
- יש לשחרר את הקבצים על אזור השחרור, או ללחוץ עליו ולבחור אותם.
מופיע "קורא את הקבצים…", ואחר כך התצוגה המקדימה: מספר החבילות ברמה העליונה והקבצים, בעיות אם יש, וטבלה עם ייבוא, חבילה, רכיבים ותוצאה.
- יש לקרוא את רשימת הבעיות, אם קיימת. היא מציינת כל קובץ ושורה שאינם מנותחים וכל קובץ שדולג.
- יש לבטל את הסימון של כל חבילה שאין צורך לייבא. כדי להחליף חבילה שמתנגשת בשמה, יש לסמן אותה.
בתוכנית עם מגבלת פריטים, התצוגה המקדימה סופרת את הפריטים שיהיו בפרויקט אחרי הייבוא (קשרים אינם נספרים). אם המספר חורג מהמגבלה, היא מציינת זאת, למשל "הייבוא הזה יביא את הפרויקט ל-1,804 פריטים; תוכנית Free מתירה 1,000.", ו-ייבוא N חבילות נשאר כבוי עד שמבטלים את הסימון של מספיק חבילות. דבר אינו מוחל או נשלח לשרת. ייבוא לפרויקט חדש נבדק באותו אופן מול המגבלה לפרויקט של התוכנית שלך.
- יש ללחוץ על ייבוא N חבילות.
ההודעה הקופצת מציגה "יובאו N חבילות." הדף מציג "יובאו N חבילות (M אלמנטים). ביטול פעולה מבטל את הייבוא בצעד אחד." יש ללחוץ על פתיחת הטקסט כדי לראות אותן.
ייבוא קבצים לפרויקט חדש
- יש לפתוח את מודל → ייבוא וייצוא ולבחור לפרויקט SysML v2 חדש.
- יש לגרור את הקבצים לכאן או לבחור אותם.
התצוגה המקדימה מפרטת את האלמנטים ברמה העליונה, כולם מסומנים.
- יש לבטל את הסימון של אלה שאין בהם צורך ולערוך את שם הפרויקט. ברירת המחדל היא שם הקובץ היחיד, או שם החבילה הראשונה.
- יש ללחוץ על יצירת פרויקט.
הפרויקט החדש נפתח בעורך.
מתוך ניהול פרויקטים, קובצי פרויקט ▾ → ייבוא קובצי SysML v2… עושה את אותו הדבר בצעד אחד. אם לא ניתן לקרוא חלקים מהקבצים, היא שואלת קודם: "נמצאו N בעיות: חלקים מהקבצים הושמטו. ליצור את הפרויקט עם השאר? כדי לראות את הבעיות קודם, יש לפתוח פרויקט SysML v2 ולהשתמש בייבוא וייצוא." יש ללחוץ על יצירת פרויקט כדי להמשיך.
עדכון חבילה מגרסה חדשה
- יש לייצא או לקבל את הגרסה החדשה כקובצי
.sysmlאו כ-JSON. - יש לייבא אותה לפרויקט הזה.
החבילה מוצגת כ-שונה, עם מספר האלמנטים שנוספו, שונו והוסרו.
- יש ללחוץ על ייבוא חבילה 1.
אלמנטים שמותאמים שומרים על המזהים שלהם, כך שהקישורים אליהם (קישורי דרישות, סיכונים, פריסות תצוגה, הערות) נשמרים. אלמנטים שכבר אינם בקובץ עוברים לסל המחזור.
שינוי שם והעברה של אלמנטים בטקסט תוך שמירת המזהים שלהם
- יש לייצא את החבילות כ-טקסט SysML v2 כשהאפשרות הכללת מזהי רכיבים מסומנת.
- יש לערוך את הקבצים: לשנות שמות של אלמנטים, להעביר אותם לבעלים אחרים או לקובץ חבילה אחר, לשנות את הסדר שלהם. כל שורת
@HolarchMetadata::ElementIdצריכה להישאר בתוך הגוף של האלמנט שלה. - יש לייבא את הקבצים הערוכים לפרויקט הזה.
החבילות מוצגות כ-שונה. אלמנטים ששמם שונה או שהועברו נספרים כשונו, לא כנוספו והוסרו.
- יש ללחוץ על ייבוא N חבילות.
האלמנטים שומרים על המזהים שלהם: המיקומים שלהם בדיאגרמות, ההערות, העקיבות והקישורים נשמרים. אלמנטים שהועברו לחבילה אחרת יוצאים מהחבילה שבה היו.
ייבוא גדול בשירות המתארח
בשירות המתארח, ייבוא של 5,000 אלמנטים ומעלה מוחל על ידי השרת, לא על ידי הדפדפן שלך. כשכל חבילה מסומנת היא חדש או מחליפה התנגשות, השרת קורא את הקבצים בעצמו (השלבים שלהלן). כשחבילה מסומנת היא שונה, הדפדפן שלך מחשב את המיזוג כרגיל ומעלה את השינויים פעם אחת; השרת כותב אותם אז בצעד אחד, עם אותו כרטיס התקדמות, ביטול הייבוא וביטול הייבוא.
- יש לבחור את הקבצים ולבדוק את התצוגה המקדימה כמו בכל ייבוא.
- יש ללחוץ על ייבוא N חבילות (או יצירת פרויקט).
הקבצים מועלים פעם אחת. השרת קורא אותם עם אותן בדיקות ואותם מזהי אלמנטים כמו בתצוגה המקדימה, וכותב את התוצאה בצעד אחד.
- אפשר לעקוב אחר ההתקדמות בכרטיס שבתחתית החלון: הוא מציג את השלב (העלאה, קריאה, בדיקה, החלה, עדכון אינדקס הפרויקט) ואת הזמן שנותר.
אפשר לעזוב את הדף או לסגור את הכרטיסייה. הייבוא ממשיך בשרת, וכשפותחים שוב את הפרויקט התוצאה שלו נמצאת שם. כל עותק פתוח של הפרויקט נטען מחדש כשהייבוא מוחל; עריכות שלא נשלחו נשלחות שוב אחרי הטעינה מחדש.
- חברים אחרים רואים "שם מייבא את הקובץ…" באותו כרטיס ובדף ייבוא וייצוא.
- ייבוא אחד בכל פעם: ייבוא גדול שני לאותו פרויקט ממתין עד שהראשון מסתיים.
- ביטול הייבוא (מי שהתחיל אותו, או בעלים) עוצר את הייבוא לפני שהוא מוחל. דבר אינו משתנה.
- ביטול הייבוא: ⌘Z / Ctrl+Z בדפדפן אינו מבטל ייבוא בשרת. יש ללחוץ על ביטול הייבוא בדף ייבוא וייצוא כדי להחזיר את הפרויקט למצבו לפני הייבוא האחרון. המצב שלפני הביטול נשמר בהיסטוריה, כך שאפשר לשחזר משם עריכות שנעשו אחרי הייבוא.
- פעילות הפרויקט והיסטוריה מציגות את הייבוא כרשומה אחת של מי שהתחיל אותו.
ייצוא המודל או חבילה
- יש לפתוח את מודל → ייבוא וייצוא.
- תחת ייצוא, יש לבחור מה לייצא: כל המודל, או חבילה לפי השם המלא שלה.
- יש לבחור את התבנית: טקסט SysML v2 (.sysml; .zip לכמה חבילות) או SysML v2 JSON (.json).
- לטקסט שיערך ויובא שוב, יש לסמן את הכללת מזהי רכיבים.
- יש ללחוץ על ייצוא.
קובץ אחד יורד, או קובץ zip כשהייצוא מכיל כמה קבצים. ההודעה הקופצת מציגה "יוצא <file>." או "יוצאו N קבצים כ-zip."
כדי לייצא חבילה אחת במהירות, אפשר להשתמש בדפדפן: בתפריט השורה של חבילה יש ייצוא כ-.sysml וייצוא כ-JSON.
ייבוא וייצוא של דרישות ReqIF
ReqIF היא תבנית ההחלפה של כלי דרישות. קובץ ReqIF מיובא כחבילה אחת של דרישות SysML v2, ודרישות מיוצאות חזרה כ-ReqIF, כך שכלי דרישות ופרויקט SysML v2 יכולים להחליף את אותן דרישות בשני הכיוונים.
ייבוא קובץ ReqIF:
- יש לפתוח את מודל → ייבוא וייצוא (או ללחוץ על ייבוא… בדף הדרישות, או לבחור ייבוא ReqIF… ב-⌘K / Ctrl+K).
- יש לגרור את קובץ ה-
.reqifאו ה-.reqifzאל התיבה, או ללחוץ על התיבה כדי לבחור אותו. קובץ ReqIF אחד לכל ייבוא. - חלונית ReqIF מציגה את מספר הדרישות, הפרקים והיחסים, כמה מהם הומרו, הומרו בקירוב או הושמטו, והאם טקסט SysML v2 נבדק ללא בעיות.
- תחת שמות מקוצרים מ-, יש לבחור מזהה חיצוני (המספר שאנשים רואים בכלי המקור, כמו
SRS-12) או מזהה ReqIF (המזהה הפנימי של הכלי). דרישות ללא מזהה חיצוני מקבלות את המזהה. - תחת סוגי יחסים, יש לבחור למה כל סוג יחס הופך: גזירה, עידון, תלות או השמטה. התצוגה המקדימה מחושבת מחדש, והבחירה נשמרת לייבוא הבא של אותו קובץ.
- יש ללחוץ על ייבוא חבילה 1. ביטול פעולה אחד מבטל את הייבוא כולו. ההודעה הקופצת מציגה "יובאו N דרישות מ-<title>."
מה הייבוא יוצר:
| ReqIF | SysML v2 |
|---|---|
| דרישה (spec object) | requirement, עם המזהה החיצוני או המזהה כשם מקוצר, השם, והטקסט כ-doc |
| סוג דרישה | requirement def, עם תכונה אחת לכל תכונת ReqIF |
| סוג נתונים של מניה | enum def |
| תכונת סטטוס (Draft, Proposed, Approved וכן הלאה) | הסטטוס של הדרישה ב-Holarch |
| כותרת פרק | package עם מספר הפרק כשם מקוצר |
| דרישה מקוננת | requirement מקוננת |
| יחס derived from | חיבור גזירה (Derivation) |
| יחס refines | תלות עם ההערה Refinement |
| satisfies, verified by ויחסים אחרים | תלות (הדוח מסביר למה) |
| מפרט (Specification) | package בתוך החבילה של הקובץ |
טבלאות הופכות לשורות טקסט עם | בין התאים, רשימות הופכות לשורות שמתחילות במקף, ועיצוב וקישורים שומרים רק את הטקסט שלהם; הדרישות האלה הן בקירוב. תמונות ואובייקטים מוטמעים אינם מיובאים; הדרישה שהכילה אחד מהם מופיעה ברשימה עם הסיבה, כך שאפשר לצרף אליה את הקובץ. הורדת הדוח שומרת כל דרישה ויחס עם התוצאה שלהם כ-CSV; הורדת טקסט SysML v2 שומרת את הטקסט.
ייבוא עותק חדש יותר של הקובץ: יש לייבא אותו לאותו פרויקט. Holarch מוצא את החבילה של הייבוא הקודם ומשווה דרישה אחר דרישה:
- הדרישות שומרות על מזהי האלמנטים שלהן, כך שדיאגרמות, קישורי satisfy ו-verify, סקירות והיסטוריה נשארים מחוברים. דרישות ששמן שונה או שהועברו מתעדכנות במקומן.
- דרישות שחסרות בקובץ החדש נשמרות. יש לסמן את הסרת N הדרישות שחסרות בקובץ הזה כדי להעביר אותן לסל המחזור.
- חלקים, מקרי אימות וקישורים שהוספת ב-Holarch נשמרים.
- דרישה ששונתה רק ב-Holarch שומרת על השינוי שלך. דרישה ששונתה גם כאן וגם בקובץ מקבלת את הטקסט של הקובץ; הטקסט הקודם נשאר בהיסטוריה. התצוגה המקדימה מציגה אותן תחת שונו כאן וגם בקובץ.
ייצוא כ-ReqIF:
- תחת ייצוא, יש לבחור חבילה או כל המודל, ו-ReqIF (.reqif) או ארכיון ReqIF (.reqifz).
- יש ללחוץ על ייצוא. ההודעה הקופצת מציגה "יוצאו N דרישות כ-<file>."
ייצוא… → דרישות (ReqIF) במסד הנתונים או בדף הדרישות מייצא את הדרישות המוצגות (או הנבחרות) באותו אופן.
הקובץ מכיל את השם המקוצר של כל דרישה (כ-ReqIF.ForeignID), השם, ה-doc (כ-XHTML), הסטטוס וערכי התכונות, את היררכיית החבילות כמפרט, ואת קשרי הגזירה, העידון והתלות. דרישות שיובאו מ-ReqIF שומרות על המזהים, הסוגים וסוגי היחסים המקוריים שלהן, כך שכלי המקור מעדכן את הדרישות שלו במקום להוסיף עותקים; ייצוא וייבוא חוזר של הקובץ מציגים כל חבילה כ-ללא שינוי. ערכי תכונות מחושבים נכתבים כטקסט. קישורי satisfy ו-verify נשארים ב-Holarch: ב-ReqIF אין חלקים או מקרי אימות.
משיכה ממאגר ודחיפה אליו
אפשר לחבר את הפרויקט לענף אחד של מאגר מודלים של SysML v2 כדי לקרוא את ה-commit האחרון שלו ולשלוח את השינויים שלך חזרה.
- יש לפתוח את מודל → ייבוא וייצוא ולמצוא את המקטע מאגר.
- יש להזין את כתובת המאגר (כתובת ה-https של ה-Systems Modeling API שלו) ואם המאגר דורש, את אסימון גישה.
- יש ללחוץ על טעינת פרויקטים, ואז לבחור את הפרויקט ואת הענף. כדי להתחיל פרויקט מאגר חדש מהמודל הזה, יש ללחוץ במקום זאת על פרויקט מאגר חדש.
- יש ללחוץ על משיכה…. Holarch קורא את ה-commit האחרון של הענף ומפרט כל הבדל: חדש, שונה, הוסר או התנגשות. כשאין מה למשוך מוצגת ההודעה "מעודכן: אין שינויים במאגר."
- יש לבטל את הסימון של ההבדלים שאין בהם צורך, ואז ללחוץ על החלת המשיכה. ביטול פעולה אחד מבטל את המשיכה כולה.
- אחרי שינוי המודל, יש ללחוץ על דחיפה. השינויים שלך מאז ה-commit המסונכרן האחרון נשלחים לענף כ-commit חדש אחד. מוצגת למשל ההודעה "נדחפו 3 שינויים כ-commit 1a2b3c4d."
התנגשות היא אלמנט ששונה גם כאן וגם במאגר מאז הסנכרון האחרון. התנגשות שאינה מסומנת שומרת את הגרסה של הפרויקט הזה.
הערה: דחיפה נדחית כשבענף יש commits שהפרויקט הזה לא משך: "בענף המאגר יש commits שהפרויקט הזה לא משך. יש למשוך קודם, ואז לדחוף שוב."
דוגמה מעשית: הדגמת Hybrid Car
קודם יש ליצור את ההדגמה: בניהול פרויקטים, יש ללחוץ על קובצי פרויקט ▾ → פרויקט הדגמה חדש → Hybrid Car (SysML v2).
- יש לפתוח את מודל → ייבוא וייצוא. תחת ייצוא, יש לבחור כל המודל ו-טקסט SysML v2, ואז ללחוץ על ייצוא.
יורד קובץ zip עם קובץ אחד לכל חבילה ברמה העליונה, כמו
Vehicles.sysml,VehicleRequirements.sysml,VehicleBehavior.sysmlו-VehicleViews.sysml. - יש לפתוח את
VehicleRequirements.sysmlבעורך טקסט, לשנות אתattribute maxCurbMass : MassValue = 1650 [kg];ל-1600 [kg]ולשמור. - בחזרה בייבוא וייצוא, יש לבחור לפרויקט הזה ולגרור את
VehicleRequirements.sysml.התצוגה המקדימה מציגה את VehicleRequirements כ-שונה, עם מספר האלמנטים שהשתנו. החבילות האחרות אינן בקובץ, ולכן אינן מופיעות.
- יש ללחוץ על ייבוא חבילה 1.
הערך משתנה במודל. הדרישה Sedan Mass (VR-1.1) מציינת את
maxCurbMass, ולכן הקישורים שלה מסומנים לסקירה (ראו דרישות ואימות בפרויקטים של SysML v2). יש להקיש ⌘Z / Ctrl+Z כדי לבטל את הייבוא. - כדי להתחיל פרויקט שני מאותם קבצים, יש לבחור לפרויקט SysML v2 חדש, לגרור את קובץ ה-zip וללחוץ על יצירת פרויקט.
עצות ושיטות עבודה טובות
- כדאי להשתמש ב-JSON כדי להעביר מודל בין כלי SysML v2 כשהמזהים חשובים, למשל כשהכלי השני שומר קישורים לפי מזהה. כדאי להשתמש בטקסט כשאנשים קוראים או סוקרים את הקבצים; יש לסמן את הכללת מזהי רכיבים כשהטקסט חוזר ל-Holarch אחרי עריכה.
- כדאי להשמיט את המזהים מטקסט שנמסר לאנשים שרק קוראים אותו: הם מוסיפים שורה אחת לכל אלמנט.
- כדאי לשמור חבילה אחת ברמה העליונה בכל קובץ. הייצוא כותב קבצים כך, וייבוא מאוחר יותר מתאים אז חבילה אחר חבילה.
- כדאי לייבא חבילה מצוות אחר לחבילה משלה ברמה העליונה. עדכונים נוגעים אז רק בחבילה הזו.
- יש לבדוק את רשימת הבעיות לפני הייבוא. חברים שאינם מנותחים מושמטים.
טעויות נפוצות
- חבילה מוצגת כהתנגשות: "קיימת חבילה בשם X עם מזהים אחרים." בפרויקט יש חבילה בשם הזה שלא יובאה מה-JSON הזה. יש לסמן את השורה כדי להחליף אותה (החבילה הישנה עוברת לסל המחזור), או לייבא לפרויקט חדש.
- "הייבוא מכיל שתי חבילות ברמה העליונה בשם X; רק הראשונה מיובאת." שני קבצים מצהירים על אותה חבילה ברמה העליונה. יש למזג אותם לקובץ אחד, או לשנות את השם של אחד מהם.
- אלמנט ששמו שונה יובא כחדש. בטקסט לא היו מזהי אלמנטים, ושם האלמנט שונה והוא הועבר בבת אחת (או שהסוג והשם שלו השתנו שניהם). יש לייצא עם הכללת מזהי רכיבים, לבצע את השינוי ולייבא שוב.
- אלמנטים חסרים אחרי הייבוא. חבר שאינו מנותח מושמט: "החבר הזה אינו מנותח והוא מושמט." יש לתקן את השורה שרשימת הבעיות מציינת, ואז לייבא שוב.
- ייבוא JSON נדחה. יש לייבא קובץ SysML v2 JSON אחד בכל פעם, ללא קובצי
.sysml.
כיצד זה מתחבר לתכונות אחרות
- עורך: חבילות מיובאות נפתחות שם; קבצים מיוצאים הם הטקסט שרואים שם.
- ביטול פעולה וסל המחזור: ביטול פעולה אחד מבטל ייבוא שלם לפרויקט הזה; אלמנטים שהוא מסיר או מחליף עוברים לסל המחזור.
- בקרת שינויים: ערכים ותיעוד שמשתנים דרך ייבוא מסמנים קישורי דרישות לסקירה, כמו כל עריכה אחרת.
- קובצי פרויקט של Holarch: ייצוא הפרויקט הזה… בניהול פרויקטים שומר את כל פרויקט ה-Holarch, עם סיכונים, מסמכים ונתוני Holarch אחרים.
.sysmlו-JSON מכילים רק את המודל. - המרה: כדי להעביר מודל בין LML ל-SysML v2, יש ליצור עותק מומר (ראו המרה בין LML ל-SysML v2).
הדף ייבוא וייצוא
ייבוא
| פקד | שימוש |
|---|---|
| לפרויקט הזה | מיזוג הקבצים לפרויקט הפתוח. לא זמין למי שיכולים רק לצפות בפרויקט; עבורם, ייבוא יוצר פרויקט חדש. |
| לפרויקט SysML v2 חדש | יצירת פרויקט חדש מהקבצים. |
| אזור גרירה | "יש לגרור קבצים לכאן או ללחוץ כדי לבחור אותם". מקבל קובצי .sysml, קובץ .zip של קובצי .sysml, או קובץ SysML v2 JSON אחד. |
| טבלת התצוגה המקדימה | ייבוא (תיבת סימון), חבילה (שם וסוג), רכיבים (ספירה), תוצאה (חדש, שונה, ללא שינוי או התנגשות, עם פירוט). |
| שם הפרויקט | (פרויקט חדש בלבד) שם הפרויקט החדש, עד 200 תווים. |
| ייבוא N חבילות / יצירת פרויקט | החלת הייבוא. |
| ביטול | סגירת התצוגה המקדימה ללא ייבוא. |
אלמנטים מחוץ לכל חבילה בטקסט .sysml מופיעים יחד בשורה אחת, מחוץ לחבילות.
כשהמודל משתנה בזמן שתצוגה מקדימה פתוחה (כרטיסייה אחרת, משתף פעולה, או ביטול פעולה), התצוגה המקדימה מחושבת מחדש.
ייצוא
| פקד | שימוש |
|---|---|
| ייצוא (היקף) | כל המודל, או כל חבילה לפי שם מלא. |
| בתור (תבנית) | טקסט SysML v2 (.sysml; .zip לכמה חבילות) או SysML v2 JSON (.json). |
| הכללת מזהי רכיבים | (טקסט בלבד; כבוי כברירת מחדל) כתיבת המזהה של כל אלמנט בעל שם לתוך הטקסט כ-@HolarchMetadata::ElementId { id = "…"; }, כך שעותק ערוך שמיובא שוב שומר על המזהים גם אחרי שינויי שם והעברות. |
| ייצוא | הורדת הקובץ. |
ייצוא טקסט כותב קובץ אחד לכל חבילה ברמה העליונה, הנקרא על שמה (Vehicles.sysml). אלמנטים מחוץ לחבילות נכנסים ל-Outside packages.sysml. ייצוא JSON כותב קובץ אחד הנקרא על שם הפרויקט או החבילה.
מאגר
המקטע מאגר מקשר את הפרויקט לענף אחד של מאגר שמציע את ה-Systems Modeling API.
- כתובת המאגר: כתובת ה-https של ה-API של המאגר. Holarch מתחבר רק לכתובות https במארחים ציבוריים; מנהלי האתר יכולים להגביל את המארחים והיציאות.
- אסימון גישה: נשמר מוצפן עבור החשבון שלך והפרויקט הזה, ונשלח רק לכתובת הזו. הוא לעולם אינו מוצג שוב; כדי לשמור על האסימון השמור, יש להשאיר את השדה ריק.
- טעינת פרויקטים, פרויקט וענף: בחירת היעד לסנכרון. פרויקט מאגר חדש יוצר פרויקט במאגר עבור המודל הזה.
- משיכה…, החלת המשיכה: קריאת ה-commit האחרון, סקירת ההבדלים והחלתם, וביטול פעולה אחד מחזיר הכול לאחור. Holarch משווה מול ה-commit שסנכרן לאחרונה, כך שהוא יכול להבחין בין השינויים שלך לשינויים של המאגר.
- דחיפה: שליחת השינויים מאז ה-commit המסונכרן האחרון כ-commit אחד. "אין מה לדחוף: המודל תואם ל-commit המסונכרן האחרון." פירושו שאין שום דבר חדש.
- הגדרות… משנה את החיבור. ניתוק מסיר את האסימון השמור ואת מצב הסנכרון; המודל נשאר.
- פעולות מאגר דורשות את תפקיד העורך. צופים אינם יכולים למשוך או לדחוף.
- דחיפות נדחות בפרויקטים עם סימוני נתונים מפוקחים.
כיצד קבצים נקראים
- הקבצים נבדקים לפני שדבר נקרא: הגדלים, הכמויות, הקינון ואורכי הטקסט שלהם.
- בקובץ zip, קבצים מוסתרים ותיקיות
__MACOSXאינם נלקחים בחשבון. קישורים, קבצים שאינם.sysmlועותק שני של אותו נתיב מדולגים, ורשימת הבעיות מסבירה למה. - הטקסט חייב להיות UTF-8. סימן סדר בתים (BOM) מותר.
- כל אלמנט מיובא נבדק לפני שהוא נכתב. אלמנט שנדחה לוקח איתו את החברים שבבעלותו; רשימת הבעיות סופרת אותם.
- ב-JSON, אלמנטים מסוגים ש-Holarch אינו מפרש נשמרים כפי שיובאו: ראו אלמנטים ש-Holarch אינו מפרש.
אלמנטים ש-Holarch אינו מפרש
SysML v2 JSON יכול להכיל סוגי אלמנטים ש-Holarch אינו ממדל, כמו behaviors, steps או interactions של KerML. Holarch שומר אותם במקום להשמיט אותם:
- כל אחד מהם נשאר במודל עם המזהה, השם, הבעלים וה-JSON המקורי שלו, כולל הקשרים שלו (typings, specializations ואחרים) ומה שבבעלותם. החברים שלו שומרים אותו כבעלים שלהם.
- הדפדפן מציג את הסוג המקורי שלו עם התג לא מפורש; הצבעה על התג מציגה את ההסבר. חלונית המאפיינים מציגה את הסוג שלו, את המזהה שלו בקובץ ואת מה שהקשרים שלו מצביעים עליו.
- אי אפשר לשנות את שמו או לערוך אותו ב-Holarch. יש לשנות אותו בכלי שממנו הגיע ולייבא אותו שוב. אפשר להעביר או למחוק אותו.
- אין לו טקסט SysML. העורך משמיט אותו, וכל מה שבבעלותו, מהטקסט, והערה מעל הטקסט מציינת כמה אלמנטים אינם מוצגים. עריכת הטקסט לעולם אינה מסירה אותם. גם ייצוא
.sysmlמשמיט אותם. - ייצוא JSON כותב אותו חזרה ללא שינוי. רק מה שהשתנה במודל מותאם: חבר שמחקת או הוספת, חבר ששינית את שמו, או בעלים חדשים.
- התצוגה המקדימה של הייבוא מציגה כל סוג שנשמר פעם אחת, כהערה, למשל 2 אלמנטים מסוג Behavior נשמרים כפי שיובאו. הערות אינן בעיות.
לא נשמרים: מרחב השמות הבסיסי ללא שם שחלק מהכלים עוטפים בו ייצוא שלם (החברים שלו הופכים לאלמנטים ברמה העליונה), ואלמנטים לא נתמכים בתוך ערך, שמופיעים כבעיות. אלמנט שה-JSON שלו גדול מ-256 KB שומר רק את הסוג והמזהה שלו.
הודעות
| הודעה | משמעות ותיקון |
|---|---|
| יש לבחור קובצי .sysml, קובץ .zip של קובצי .sysml או קובץ SysML v2 JSON. | לא נבחרו קבצים. |
| לא נמצאו קובצי .sysml. יש לבחור קובצי .sysml, קובץ .zip של קובצי .sysml או קובץ SysML v2 JSON. | הארכיון או הבחירה אינם מכילים קובצי .sysml. |
| יש לייבא קובץ SysML v2 JSON אחד בכל פעם, ללא קובצי .sysml. | נבחרו כמה קובצי JSON, או JSON מעורב בטקסט. |
| <file> אינו קובץ ReqIF (…). יש לייצא אותו מכלי המקור כ-ReqIF 1.0 ומעלה ולייבא אותו שוב. | הקובץ אינו ReqIF XML, או שהוא מכיל DOCTYPE, ש-Holarch אינו קורא. |
| <file> אינו מכיל דרישות (אין אלמנטים מסוג SPEC-OBJECT). יש לייצא את המפרטים עם האובייקטים שלהם ולייבא את הקובץ שוב. | בקובץ ה-ReqIF יש סוגים אבל אין דרישות. |
| ב-<title> יש N דרישות, יותר ממה שייבוא אחד מקבל (בערך M). יש לייצא את המפרטים כקובצי ReqIF נפרדים. | טקסט SysML v2 יחרוג ממגבלת 8 MB. יש לייבא את המפרטים קובץ אחד בכל פעם. |
| <file> אינו טקסט UTF-8. יש לשמור אותו כ-UTF-8 ולייבא אותו שוב. | יש להמיר את הקידוד של הקובץ. |
| <file> אינו ארכיון ZIP תקין. יש ליצור את הארכיון מחדש. | הארכיון פגום. |
| <file> מכיל קבצים מוצפנים. יש ליצור את הארכיון ללא סיסמה. | ארכיונים מוגני סיסמה אינם נקראים. |
| <path> דחוס יותר מ-200:1, דבר האופייני לפצצת zip. יש ליצור את הארכיון מחדש. | הארכיון נדחה מטעמי בטיחות. |
| הארכיון משתמש בשיטת דחיסה שאינה נתמכת. יש ליצור אותו עם דחיסת ZIP רגילה. | יש להשתמש בדחיסה רגילה (deflate). |
| קובצי KerML עדיין אינם מיובאים. | קובצי .kerml מדולגים. |
| מארכיון מיובאים רק קובצי .sysml. | קבצים אחרים בקובץ zip מדולגים. |
| קישורים אינם מיובאים. | קישורים סימבוליים בקובץ zip מדולגים. |
| הארכיון מכיל את הקובץ הזה פעמיים; העותק הראשון מיובא. | לשתי רשומות יש אותו נתיב. |
| <file> אינו JSON תקין. יש לייצא את המודל שוב. | קובץ ה-JSON פגום. |
| <file> אינו SysML v2 JSON (רשימה של אלמנטים עם @id ו-@type). יש לבחור ייצוא SysML v2 JSON. | ה-JSON בתבנית אחרת. |
| שורה N של <file> ארוכה מ-64 KB. יש לפצל את השורה, ואז לייבא את הקובץ שוב. | שורות ארוכות מאוד נדחות. |
| החבר הזה אינו מנותח והוא מושמט. | יש לתקן את השורה שמצוינת ברשימת הבעיות. |
| אלמנט עם המזהה הזה נמצא בתוך <element> בפרויקט הזה. יש להעביר אותו קודם לרמה העליונה, או לייבא לפרויקט חדש. | (התנגשות) החבילה ברמה העליונה של ה-JSON כבר קיימת עמוק יותר במודל. |
| N ממזהי האלמנטים שלה בשימוש במקום אחר בפרויקט הזה. יש לייבא לפרויקט חדש במקום זאת. | (התנגשות) ה-JSON משתמש מחדש במזהים של אלמנטים אחרים. |
| טקסט החבילה אינו מנותח אחרי ההדפסה. יש לייבא אותו לפרויקט חדש. | (התנגשות) לא ניתן היה למזג את החבילה. |
| N אלמנטים מסוג <kind> נשמרים כפי שיובאו (לא מפורשים): … | (הערה) אלמנטים מסוג ש-Holarch אינו מפרש נשמרים ללא שינוי. ראו אלמנטים ש-Holarch אינו מפרש. |
| אלמנט מסוג <kind> בתוך ערך אינו נתמך והוא מושמט. | ערך (ביטוי) מכיל אלמנט ש-Holarch אינו יכול לקרוא. שאר הערך נשמר כטקסט. |
| אלמנט מסוג <kind> גדול מכדי לשמור אותו במלואו; נשמרים רק הסוג והמזהה שלו. | ה-JSON שלו גדול מ-256 KB. |
| הייבוא לא הוחל: … דבר לא השתנה. | הייבוא נכשל; הפרויקט לא השתנה. |
| המודל ריק. יש להוסיף חבילה, ואז לייצא שוב. | אין מה לייצא. |
| החבילה לייצוא כבר לא קיימת. יש לבחור חבילה אחרת. | החבילה נמחקה בזמן שהדף היה פתוח. |
מגבלות
| מגבלה | ערך |
|---|---|
| קבצים לכל ייבוא | 2,000 |
טקסט .sysml לכל ייבוא (לא דחוס) | 8 MB |
| ארכיון zip | 16 MB, 10,000 רשומות |
| קינון תיקיות בקובץ zip | 32 תיקיות |
| אלמנטים לכל ייבוא (טקסט או JSON) | 100,000 |
| קובץ JSON | 24 MB, קינון של 64 רמות |
| JSON של אלמנט אחד ש-Holarch אינו מפרש | 256 KB, קינון של 12 רמות |
| אורך שורה | 64 KB |
קובץ ReqIF (.reqif, או .reqif בתוך .reqifz) | 64 MB; טקסט SysML v2 שנוצר ממנו חייב להיכנס במגבלת הטקסט של 8 MB (בערך 8,000 עד 20,000 דרישות) |
- תשובות המאגר מוגבלות ל-64 MB למשיכה שלמה, וכל פעולת מאגר נעצרת אחרי 120 שניות.
- כל חשבון יכול להריץ לכל היותר 300 פעולות מאגר בשעה.
- קובצי KerML (
.kerml) עדיין אינם מיובאים. - באפליקציה המתארחת, השרת קורא ייבוא של עד 1.5 MB של טקסט
.sysml. ייבוא גדול יותר נקרא בדפדפן שלך, עם אותה תוצאה. - נתוני Holarch שלצד המודל (סטטוס דרישות, סיכונים, תקציבים, הגדרות הסימולטור, פריסות תצוגה) אינם חלק מקובצי
.sysmlאו JSON. כדי לשמור אותם, יש להשתמש ב-ייצוא הפרויקט הזה… בניהול פרויקטים.
דפים קשורים
- עורך הטקסט והדפדפן
- המרה בין LML ל-SysML v2
- תחילת העבודה עם פרויקטים של SysML v2
- ייבוא מודלים של SysML v1: XMI מכלי SysML 1.x, מומר ל-SysML v2.
- ייבוא וייצוא לפרויקטי LML (כולל ReqIF ל-LML) ולקובצי פרויקט של Holarch.
SysML® ו-OMG® הם סימנים מסחריים רשומים של Object Management Group, Inc. בארצות הברית ובמדינות אחרות.