Модель
Схема та розширення
Налаштовуйте схему LML проєкту під себе: власні класи, атрибути, варіанти вибору, зв’язки, мітки та робочі процеси статусів, і дивіться, як кожна зміна впливає на наявні дані.
На цій сторінці
- Огляд
- Поняття
- Як користуватися
- Коли й навіщо
- Додавання атрибута до класу
- Додавання варіантів до наявного атрибута
- Створення підкласу
- Додавання мітки
- Дозвіл нового зв’язку
- Визначення робочого процесу статусу
- Додавання чи зміна станів робочого процесу
- Вибір затверджувачів переходу
- Запит затвердження зміни стану
- Спільне використання схеми між проєктами
- Приклад: CubeSat EO-1
- Поради та добрі практики
- Типові помилки
- Як це пов’язано з іншими функціями
- Редактор схеми
- Як зміни схеми впливають на наявні дані
- Вбудовані розширення
- Комбінації клавіш
- Параметри й налаштування
- Повідомлення
- Обмеження
- Пов’язане
Огляд
Схема визначає, що може містити модель проєкту:
- класи сутностей,
- атрибути, які має кожен клас,
- відношення, що можуть поєднувати класи,
- мітки, що позначають сутності,
- необов’язкові робочі процеси: стани атрибута статусу для кожного класу, як вони можуть змінюватися і які зміни потребують затвердження.
Кожен проєкт починається зі схеми Lifecycle Modeling Language (LML) за замовчуванням. Редактор схеми змінює її лише для одного проєкту. Перша зміна створює власну копію проєкту, тож інші проєкти не зачіпаються. Кожна зміна схеми відміняється одним натисканням “Відмінити”.
Holarch також додає до кожного проєкту вбудовані розширення, як-от Priority і Owner у вимогах і Handling Strategy у ризиках. Див. Вбудовані розширення.
Про щоденну роботу із сутностями, атрибутами й зв’язками див. Модель і база даних.
Поняття
Схема проєкту
- Схема за замовчуванням: класи, відношення, атрибути й мітки LML, з якими постачається Holarch. Теми вбудованої Довідки LML Classes (schema), LML Relationships (schema) і Labels (schema) перелічують їх наживо для відкритого проєкту.
- Схема проєкту: копія, що зберігається всередині проєкту. Вона створюється під час першої зміни. Вона переміщується разом із проєктом в експортах і доходить до кожного учасника, який його відкриває.
- Вбудовані розширення: доповнення, потрібні функціям Holarch. Вони застосовуються за назвою щоразу, коли відкривається проєкт. Тож більшість проєктів уже мають власну копію, а сторінка Використання показує "Цей проєкт використовує власну відредаговану схему."
Навчальні курси
Клас — це вид сутності, як-от Requirement або Asset. Він має Назва, Опис, Батьківський і Колір, а також два прапорці (Абстрактний і Прихований).
- Батьківський: підклас успадковує атрибути й цілі відношень батьківського класу. Він з’являється в кожному запиті, фільтрі й діаграмі, що охоплюють батьківський. Наприклад, власний підклас Action отримує діаграми дій. Власний підклас Requirement отримує перевірки якості й елементи керування затвердженням.
- Абстрактний: клас групує підкласи, і його не можна створити напряму.
- Прихований: клас не пропонується, коли ви створюєте сутності чи змінюєте їхній клас. Він і його підкласи не потрапляють у фільтр класів Бази даних. Наявні сутності лишаються.
- Колір: колір значка класу й зразка. Без нього власний клас бере колір найближчого вбудованого предка. Значок показує перші дві літери назви.
Атрибути
Атрибут — це поле, яке має кожна сутність класу, як-от Priority у вимогах. Атрибут також може належати відношенню.
Атрибут має Назва, Тип і місце в порядку класу. Він може мати Дозволені значення, Типове значення і Опис. Опис показується, коли ви наводите вказівник на мітку атрибута.
Типи, згруповані так, як їх перелічує діалог атрибута (збережений ідентифікатор типу — у дужках; його використовують експорт, імпорт і 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 класу, зазвичай Status. Він має:
- Стани: значення, які використовує клас, у порядку. Власні стани можна додавати, перейменовувати, перевпорядковувати й вилучати. Вбудовані стани, як-от Approved вимоги, можна лише вивести. Підклас з успадкованим атрибутом (наприклад, Software Requirement під Requirement) зберігає власні стани.
- Переходи (З → До): дозволені зміни. Без переходів кожен стан може йти за будь-яким іншим.
- Затвердження на переході: зміна потребує затвердженого запиту на зміну. За замовчуванням вирішують затверджувачі, задані в Запити на зміну → Налаштування. Перехід натомість може називати власних затверджувачів: власників, редакторів або названих людей, і скільки з них мають затвердити (до 5 або кожна названа особа).
- Блокувати елемент після цього переходу (у меню ⋯ переходу): елемент блокується після зміни.
Редактори атрибута тоді пропонують лише поточне значення й дозволені наступні стани. Стан, що потребує затвердження, має напис (потребує затвердження).
Як користуватися
Коли й навіщо
Налаштовуйте схему на початку проєкту: коли визначаєте метод моделювання і перед імпортом даних. Типові причини:
- Перейняти метод чи стандарт: додайте атрибути, яких вимагає ваш процес, наприклад TRL в активах або Safety Integrity Level у вимогах. Додайте мітки, яких очікують ваші шаблони документів.
- Спеціалізувати класи: додайте підкласи, як-от Hazard під Risk або Payload Instrument під Asset. Запити, фільтри й звіти тоді можуть їх розрізняти, а вони зберігають кожен зв’язок LML.
- Дозволити зв’язок, потрібний методу: додайте ціль або нову пару відношень.
- Запровадити процес рецензування: додайте робочий процес, щоб Status вимоги проходив Draft → In Review → Approved. Тоді редактор ніколи не дозволить пропустити крок. Позначте In Review → Approved як Затвердження, щоб перехід проходив через затверджувачів проєкту.
- Повторно використовувати між проєктами: експортуйте схему з одного проєкту й імпортуйте її в наступний.
Схема відповідає на запитання "Що може сказати ця модель?". Змінюйте її свідомо. Запити, збережені стовпці, звіти й імпорт посилаються на класи, атрибути й відношення за назвою.
Додавання атрибута до класу
- На панелі навігації натисніть Налаштування → Схема (серед інструментів унизу).
- На бічній панелі в розділі Класи клацніть клас, наприклад Asset.
- У картці Атрибути натисніть + Атрибут.
- Введіть Назва.
- Виберіть Тип, наприклад Один зі списку у групі Варіанти.
- Для Один зі списку або Кілька зі списку: введіть варіанти в Дозволені значення, по одному на рядок.
- Необов’язково: задайте Типове значення. Нові сутності класу починаються з нього.
- Необов’язково: введіть Опис.
- Натисніть Додати атрибут.
Ви бачите сповіщення "Атрибут збережено". Атрибут останній у списку класу й з’являється для цього класу та його підкласів: в інспекторі, Поданні елемента, стовпцях і фільтрах Бази даних, пошуках, звітах і зіставленнях імпорту.
- Щоб перемістити атрибут, перетягніть його рядок у таблиці Атрибути або скористайтеся кнопками ↑ і ↓ у рядку. Кожне переміщення відміняється одним натисканням “Відмінити”.
Додавання варіантів до наявного атрибута
- Відкрийте клас, який визначає атрибут. Його показує стовпець Визначено в. Успадкований атрибут редагується в класі, що його визначає.
- Натисніть ✎ (Редагувати атрибут) у рядку.
- Додайте новий варіант окремим рядком у Дозволені значення.
- Натисніть Зберегти.
Для Один зі списку квадрат перед кожним варіантом (під списком) задає колір значення. Дошки Kanban, стовпці яких є значеннями цього атрибута, використовують його як колір стовпця.
Щоб вилучити варіант, видаліть його рядок у тому самому діалозі. Сутності, які вже мають це значення, зберігають його, але редактор більше його не пропонує. Перш ніж вилучити варіант, знайдіть ці сутності запитом за атрибутом (наприклад, Requirement:"Priority=Urgent") і задайте їм чинний варіант.
Створення підкласу
- Відкрийте батьківський клас.
- Натисніть + Підклас.
(Або натисніть + Клас на бічній панелі й виберіть Батьківський.)
- Введіть Назву й Опис.
- За потреби задайте Абстрактний, Прихований і Колір.
- Натисніть Створити клас.
Ви бачите новий клас. Він уже має всі успадковані атрибути й цілі.
Щоб перенести наявні сутності в новий клас, виберіть їх у Базі даних і скористайтеся Змінити клас…. Див. Зміна класу.
Додавання мітки
- Натисніть + Мітка на бічній панелі або + Нова мітка на сторінці Мітки.
- Введіть Назву й Опис.
- Якщо мітка належить до іншої мітки, виберіть її як Батьківську.
- Виберіть Клас(и), до яких вона застосовується. ⌘ / Ctrl/Ctrl+клацання вибирає кілька. Якщо нічого не вибрано, мітка застосовується до кожного класу.
- Натисніть Створити мітку.
Щоб застосувати мітку, скористайтеся + Мітка в інспекторі або Поданні елемента чи Мітка ▾ на панелі масових дій Бази даних.
Дозвіл нового зв’язку
Зв’язок між двома класами дозволений, лише коли його допускає ціль. Додайте ціль, щоб дозволити його.
- Відкрийте клас-джерело.
- У розділі Відношення натисніть + Відношення.
- Виберіть Відношення.
- Виберіть Інший клас.
- Залиште позначеним Додати обернене відношення й до іншого класу. Тоді зв’язок можна створювати з будь-якого кінця.
- Натисніть Додати відношення.
Якщо інший клас не має оберненого відношення, стовпець Назад до цього класу показує + на <class>: натисніть його, щоб додати обернене відношення там.
Якщо потрібного відношення немає, спершу створіть його:
- Натисніть Новий тип відношення… у діалозі (або + Відношення на бічній панелі).
- Введіть Назву й Назву оберненого та їхні описи.
- Натисніть Створити відношення.
- Виберіть нове відношення на кроці 3 вище.
Визначення робочого процесу статусу
- Натисніть Робочий процес на бічній панелі.
- У Додати клас… виберіть клас.
Ви бачите картку класу. Робочий процес відстежує перший атрибут-перелік класу.
- За потреби виберіть інший атрибут у списку відстежує. Його зміна очищає переходи.
- Натисніть + Додати перехід.
- Задайте для переходу Назву, Від і До. Від — це (Початковий — без значення) або стан.
- Позначте Затвердження, якщо зміна потребує затвердженого запиту на зміну. Щоб блокувати елемент після зміни, відкрийте меню ⋯ рядка (або клацніть рядок правою кнопкою) і виберіть Блокувати елемент після цього переходу; тоді рядок показує Блокує елемент.
- Повторіть кроки 4–6 для кожного дозволеного кроку.
Щоб вибрати, хто затверджує перехід, див. Вибір затверджувачів переходу.
Редактори атрибута тепер пропонують лише дозволені наступні стани з позначкою ⇢ робочий процес.
Додавання чи зміна станів робочого процесу
- На сторінці Робочий процес знайдіть картку класу. Стовпець Елементи рахує елементи в кожному стані; елемент без значення зараховується до типового значення атрибута (тестовий випадок без статусу зараховується як Not Run, як його показує Центр тестування).
- Щоб додати стан, введіть його назву в Новий стан і натисніть + Додати стан.
Стан додається до класу та до варіантів атрибута.
- Щоб упорядкувати стани, натискайте ↑ або ↓. Засоби вибору й стовпці дошки дотримуються цього порядку.
- Щоб перейменувати власний стан, натисніть Перейменувати… і введіть нову назву.
Елементи в цьому стані, переходи й колір значення отримують нову назву. Одне натискання “Відмінити” повертає все назад.
- Щоб вилучити стан, натисніть Вилучити… (власний) або Вивести… (вбудований).
- Стан, якого не має жоден елемент, вилучається.
- Коли елементи мають цей стан, виберіть Перемістити та вилучити зі станом, у який їх перемістити, або Залишити як виведений. Виведений стан залишається на своїх елементах, показує (виведено) і більше не пропонується. Його вихідні переходи залишаються, тож елементи можуть вийти з нього. Відновити знову пропонує його.
Жодна зміна на цій сторінці не очищає значення.
Вибір затверджувачів переходу
- На сторінці Робочий процес позначте Затвердження для переходу.
Поруч з’являється кнопка: Налаштування запитів на зміну ▾.
- Натисніть кнопку.
Відкривається Затверджувачі переходу.
- У Хто затверджує виберіть один варіант:
- Як задано в Запити на зміну → Налаштування: вирішують затверджувачі проєкту (типово).
- Власники або Власники та редактори.
- Названі особи: позначте учасників проєкту, які затверджують. У настільному застосунку введіть їхні імена через кому так, як кожна особа вводить його в Параметри → Ваше ім’я.
- У Потрібно затверджень виберіть, скільки осіб мають затвердити: від 1 до 5 або Кожна названа особа.
- Натисніть Зберегти.
Кнопка показує правило, наприклад Усі 3 названі ▾. Одне натискання “Відмінити” повертає зміну назад.
Запит, що містить кілька змін стану, потребує виконання кожного застосовного правила. Одне відхилення від того, хто може затверджувати, відхиляє його. У хмарному сервісі названі затверджувачі враховуються лише тоді, коли робочий процес востаннє налаштовував власник проєкту; інакше перехід потребує такої самої кількості затверджень власників.
Запит затвердження зміни стану
- В інспекторі або Поданні елемента виберіть стан із позначкою (потребує затвердження). Для вимоги можна також натиснути її перехід на смузі рецензування (він закінчується на …).
Відкривається Запитати затвердження.
- За бажанням введіть Причину, потім натисніть Подати запит.
Створюється й подається запит на зміну зі зміною стану. Діалог називає його затверджувачів: власних затверджувачів переходу або тих, що задані в Запити на зміну → Налаштування. Елемент зберігає свій стан.
Поки запит відкритий, смуга рецензування вимоги показує його з лічильником, наприклад CR-4: 1 із 3 затверджень.
- Затверджувачі затверджують його.
З останнім затвердженням елемент переходить у новий стан, якщо цей затверджувач може редагувати проєкт. Інакше редактор відкриває запит і натискає Застосувати зміни. Історія елемента показує через CR-n, а запис про затвердження вимоги називає кожного затверджувача й запит.
Прямі зміни до такого стану відхиляються з повідомленням “… потребує затвердження. Виберіть “X” в елементі, щоб надіслати запит.”: масові Атрибути…, клітинки сітки, переміщення на дошці та зміни ШІ. Повторний вибір стану, поки запит відкритий, відкриває цей запит.
Спільне використання схеми між проєктами
- У проєкті-джерелі відкрийте Налаштування → Схема на панелі навігації.
- Натисніть Експортувати схему.
Завантажується файл JSON.
- У цільовому проєкті відкрийте Налаштування → Схема на панелі навігації.
- Натисніть Більше ▾ → Імпортувати схему… і виберіть файл.
- Виберіть Режим:
- Об’єднати (додати класи, атрибути, відношення й мітки, яких цей проєкт не має, зіставлені за назвою) або
- Замінити схему цього проєкту.
- Натисніть Імпортувати.
Приклад: CubeSat EO-1
Цей приклад додає рівень технологічної готовності (TRL) до активів, спеціалізує клас і додає робочий процес рецензування. Створіть демопроєкт через Керування проєктами → Файли проєктів ▾ → Новий демопроєкт, потім відкрийте Налаштування → Схема на панелі навігації.
Перегляньте модель.
- Прочитайте сторінку Використання.
Таблиця Класи перелічує найуживаніші класи першими, з їхніми елементами, атрибутами й відношеннями. Ще не використовується перелічує класи, мітки й відношення, яких демопроєкт не використовує.
Додайте TRL до активів.
- Натисніть Asset, потім + Атрибут.
- Введіть назву
TRLі виберіть тип Один зі списку. - Введіть варіанти від
1до9у Дозволені значення, по одному в рядку. - Введіть опис
Technology readiness level. - Натисніть Додати атрибут.
Заповніть його.
- Відкрийте Архітектура → Активи.
- Виберіть 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 тепер пропонує лише Draft і In Review.
Відмініть або збережіть.
- Натисніть ⌘Z / Ctrl+Z по одному разу на кожну зміну, щоб відмінити експеримент. Або збережіть зміни й натисніть Експортувати схему, щоб використати їх у наступному проєкті CubeSat.
Поради та добрі практики
- Віддавайте перевагу підкласам і міткам, а не новим класам верхнього рівня. Підклас зберігає всі відношення LML, діаграми й перевірки свого батьківського класу. Мітка взагалі нічого не змінює в структурі.
- Приховуйте замість видаляти. Приховування класу, атрибута чи мітки зберігає наявні дані без змін, і його можна скасувати.
- Налаштуйте схему перед імпортом. Зіставлення імпорту пропонує наявні атрибути. Стовпці, зіставлені з Новий атрибут, створюються автоматично з вгаданим типом. Див. Імпорт і експорт.
- Зберігайте вбудовані доповнення. Приховайте вбудоване розширення, яке вам не потрібне. Не перейменовуйте й не видаляйте його: відсутнє розширення додається знову, з порожнім значенням, під час наступного відкриття проєкту.
- Документуйте кожен власний елемент у його Описі. Він з’являється як підказка в редакторах і в таблицях схеми в Довідці.
- Перевірки атрибута “менше ніж” також відповідають сутностям без значення. Наприклад,
Asset:"TRL<6"включає активи без TRL. Поєднуйте таку перевірку з позитивною або використовуйте>=для доповнення.
Типові помилки
- Зміна типу атрибута очищає його значення. Holarch попереджає: “N сутностей мають значення “X”. Зміна типу з A на B очищає ці значення.” Якщо старі значення потрібні, спершу експортуйте звіт CSV. Одне натискання “Відмінити” повертає назад і зміну типу, і очищені значення; у проєктах із понад 5,000 таких значень під час очищення показується картка поступу.
- Видалення відношення видаляє його зв’язки. Підтвердження показує їх кількість. Відміна відновлює їх.
- Вилучення цілі залишає зв’язки, яких схема більше не дозволяє. Наявні зв’язки залишаються; Перевірки моделі перелічують їх за правилом Global.9 (Relationships the schema does not allow). Вилучіть їх або змініть їхнє відношення до чи після вилучення цілі; підтвердження показує їх кількість.
- Клас не можна видалити, поки він має сутності. Спершу змініть їхній клас або видаліть їх чи приховайте клас.
- Звичайні переходи лише спрямовують редактори. Масові Атрибути…, імпорт і зміни ШІ однаково можуть задати будь-який стан, що не потребує затвердження. Позначте перехід як Затвердження, коли зміна не повинна обходити рецензування.
- Перейменувати вбудований стан неможливо. На них спираються затвердження, контроль конфігурації та верифікація. Натомість додайте новий стан або виведіть вбудований.
Як це пов’язано з іншими функціями
- База даних, інспектор і Подання елемента показують і редагують атрибути. Вони пропонують відношення, які дозволяє схема. Запити посилаються на класи, атрибути, мітки й відношення за назвою. Див. Модель і база даних.
- Діаграми: типи діаграм, які може мати сутність, залежать від її класу й класів над ним. Власні підкласи успадковують їх.
- Функції Вимоги (якість, затвердження, 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, а також Підкласи.
- Картка Атрибути: + Атрибут і таблиця з такими стовпцями:
- Елементи керування порядком власних атрибутів класу: перетягніть рядок або скористайтеся ↑ / ↓ (кожне переміщення повертає назад одне натискання “Відмінити”).
- Назва, Тип (назва типу; наведіть на неї вказівник, щоб побачити збережений ідентифікатор).
- Подробиці: варіанти й типове значення.
- Визначено в: “цей клас” або клас-предок.
- Опис.
- Дії для атрибутів, визначених у цьому класі: ✎ (Редагувати атрибут), ⊘ / 👁 (Приховати атрибут / Показати атрибут) і × (Вилучити атрибут).
- Картка Відношення: + Відношення і таблиця з обома напрямками: Відношення, Інші класи, Назад до цього класу (назва оберненого та + на <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 на ньому), щоб змінити. Без переходів картка показує “Немає переходів: кожен стан може слідувати за будь-яким іншим.”
У хмарному сервісі робочі процеси змінюють лише власники проєкту; інші бачать сторінку лише для читання з повідомленням “Лише власники проєкту змінюють робочі процеси.”
Як зміни схеми впливають на наявні дані
Перегляньте цю таблицю, перш ніж змінювати елемент схеми, який уже має дані.
| Зміна | Вплив на сутності й зв’язки |
|---|---|
| Перейменувати клас, атрибут, відношення чи мітку | Дані зберігаються, бо все зберігається за ідентифікатором. Збережені запити, текст пошуку й заголовки стовпців, що використовують стару назву, перестають збігатися. Оновіть їх. |
| Змінити батьківський клас класу | У редакторах клас отримує атрибути й цілі нового батьківського класу й втрачає атрибути й цілі старого. Збережені значення залишаються. Не дозволено для вбудованого класу, що має сутності. |
| Позначити клас абстрактним чи прихованим | Наявні сутності залишаються. Клас більше не пропонується для нових сутностей чи «Змінити клас». |
| Видалити клас | Дозволено, лише коли клас не має підкласів і сутностей. Його власні атрибути й цілі вилучаються. Мітки вилучають його зі свого списку класів. |
| Додати атрибут | Наявні сутності не мають значення. Нові сутності отримують Типове значення. |
| Змінити тип атрибута | Кожне значення цього атрибута очищається після підтвердження. |
| Вилучити варіант | Сутності зберігають старе значення. Редактор більше його не пропонує. |
| Приховати атрибут | Значення зберігаються, але не показуються, не шукаються й не експортуються, доки атрибут знову не показано. |
| Вилучити атрибут | Його значення очищається в кожній сутності й кожному зв’язку після підтвердження. |
| Додати ціль | Відношення стає доступним між цими класами (і їхніми підкласами). |
| Вилучити ціль | Наявні зв’язки залишаються, хоча схема їх більше не дозволяє. Правило Global.9 Перевірок моделі перелічує їх. |
| Видалити відношення | Пара відношень, її цілі й кожен зв’язок, що її використовує, вилучаються. |
| Видалити мітку | Її знімають з кожної сутності. Її дочірні мітки переходять до її батьківської. |
| Імпортувати схему (Об’єднати) | Додає класи, відношення, цілі, атрибути й мітки, яких бракує за назвою. Нічого наявного не змінюється й не вилучається. |
| Додати нові вбудовані | Додає класи, відношення, атрибути й мітки типової схеми, яких бракує за назвою, з їхніми типовими ідентифікаторами. Цілі додаються для доданих класів і відношень, а також цілі LML 2.0 між наявними класами; значення Decision Status з LML 2.0 дописуються в кінець. Нічого наявного не змінюється й не вилучається. |
| Імпортувати схему (Замінити) або Скинути до типової | Схема замінюється. Дані сутностей залишаються, але значення атрибутів, яких більше немає, не показуються. Вбудовані розширення додаються знову під час наступного відкриття проєкту. |
Кожна зміна відміняється одним натисканням “Відмінити”, і ⌘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 |
| Risk | Owner, Handling Strategy (Accept, Avoid, Transfer, Mitigate, Watch), Residual Probability, Residual Consequence, Need-by Date, Trigger, Closure Rationale; Status отримує варіанти Mitigating і Watch |
| Test Case | Tested By, Test Date, Configuration, Test Article, Test Evidence (файл) |
| Завдання | Board Column (перелік), додається, коли створюється або перетворюється дошка Kanban із власними назвами стовпців. Його значення — назви стовпців. |
| Input/Output | Data Rate, Data Rate Units, Protocol/Format, Message/Data Definition |
| Conduit | Connector/Pins, Medium, 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, Current Estimate |
| Рішення | Status (Open, In Analysis, Decided, Deferred, Superseded), Decision Date, Decided By |
| Характеристика | Units |
| Asset | Quantity |
Додані мітки: 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 сутностей.” |
| Вилучити мітку з елементів | “Вилучити “X” з N сутностей?” |
| Скинути схему | “Власні класи, атрибути, відношення й мітки буде вилучено зі схеми (дані сутностей лишаються; доступна відміна).” |
Обмеження
- Назви класів і міток: 100 символів.
- Назви атрибутів, створених імпортом: 80 символів.
- Один відстежуваний атрибут на клас.
- Звичайні переходи застосовують редактори атрибутів, клітинки сітки й дошка Kanban. Переходи із затвердженням також відхиляють прямі й масові зміни. Нові елементи можна створювати в будь-якому стані.
- Заблокувати застосовується до елементів LML. Елементи SysML v2 не блокуються.
- Назви станів: 100 символів.
- Об’єднати не додає нових варіантів до атрибута, який уже існує; додайте їх у діалозі атрибута.
- Додати нові вбудовані… з’являється лише після повторного відкриття сторінки, коли схема стала власною.
Пов’язане
- Модель і база даних: сутності, редактори атрибутів, запити й масові зміни.
- Вимоги: атрибути вимог, перевірки якості й затвердження.
- Простежуваність: як відношення живлять матрицю й перевірки покриття.
- Імпорт і експорт: зіставлення атрибутів і схема у файлах обміну.
- Довідка: Схема, Основи LML.