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. Связанные материалы

Обзор

Схема определяет, что может содержать модель проекта:

  • классы сущностей,
  • атрибуты каждого класса,
  • отношения, которые могут связывать классы,
  • метки, которыми помечаются сущности,
  • необязательные рабочие процессы: состояния атрибута статуса для каждого класса, допустимые переходы между ними и переходы, требующие утверждения.

Каждый проект начинается со схемы Lifecycle Modeling Language (LML) по умолчанию. Редактор схемы меняет её только для одного проекта. Первая правка создаёт собственную копию проекта, поэтому другие проекты не затрагиваются. Каждая правка схемы отменяется одним нажатием “Отменить”.

Holarch также добавляет в каждый проект встроенные расширения, например Приоритет и Владелец у требований и Handling Strategy у рисков. См. Встроенные расширения.

О повседневной работе с сущностями, атрибутами и связями см. Модель и база данных.

Понятия

Схема проекта

  • Схема по умолчанию: классы, отношения, атрибуты и метки LML, поставляемые с Holarch. Разделы встроенной справки LML Classes (schema), LML Relationships (schema) и Labels (schema) показывают их в актуальном виде для открытого проекта.
  • Схема проекта: копия, хранящаяся внутри проекта. Она создаётся при первой правке. Она переносится вместе с проектом при экспорте и доходит до каждого участника, который его открывает.
  • Встроенные расширения: дополнения, необходимые функциям Holarch. Они применяются по имени при каждом открытии проекта. Поэтому у большинства проектов уже есть собственная копия, и страница Использование сообщает “Этот проект использует собственную отредактированную схему.”

Учебные группы

Класс — это вид сущности, например Requirement или Asset. У него есть Имя, Описание, Родитель и Цвет, а также два флага (Абстрактный и Скрытый).

  • Родитель: подкласс наследует атрибуты и цели отношений своего родителя. Он появляется в каждом запросе, фильтре и диаграмме, которые охватывают родителя. Например, пользовательский подкласс Action получает диаграммы действий. Пользовательский подкласс Requirement получает проверки качества и элементы управления утверждением.
  • Абстрактный: класс группирует подклассы, и его нельзя создать напрямую.
  • Скрытый: класс не предлагается при создании сущностей или смене их класса. Он и его подклассы исключаются из фильтра классов базы данных. Существующие сущности остаются.
  • Цвет: цвет значка и образца класса. Без него пользовательский класс получает цвет ближайшего встроенного предка. Значок показывает первые две буквы имени.

Атрибуты

Атрибут — это поле, которое есть у каждой сущности класса, например Priority у требований. Атрибут может также принадлежать отношению.

У атрибута есть Имя, Тип и место в порядке атрибутов класса. У него могут быть Допустимые значения, Значение по умолчанию и Описание. Описание показывается, когда вы наводите указатель на подпись атрибута.

Типы, сгруппированные так, как их перечисляет диалог атрибута (идентификатор хранимого типа указан в скобках; его используют экспорт, импорт и API):

ГруппаТипСодержит
ТекстКороткий текст (TEXT), Длинный текст (BIG_TEXT), Форматированный текст (HTML)Одна строка; несколько строк; форматированный текст
ЧислаNumber (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. Цель, указывающая на класс, разрешает и его подклассы. Подклассы наследуют цели своего родителя.
  • Отношения могут нести атрибуты, например Multiplicity у 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 как Утверждение, чтобы этот переход проходил через утверждающих проекта.
  • Повторное использование в разных проектах: экспортируйте схему из одного проекта и импортируйте её в следующий.

Схема отвечает на вопрос “Что может выразить эта модель?”. Меняйте её обдуманно. Запросы, сохранённые столбцы, отчёты и импорт ссылаются на классы, атрибуты и отношения по имени.

Добавление атрибута к классу

  1. На панели навигации нажмите Настройки → Схема (среди инструментов внизу).
  2. На боковой панели в разделе Классы щёлкните класс, например Asset.
  3. В карточке Атрибуты нажмите + Атрибут.
  4. Введите Имя.
  5. Выберите Тип, например Один из списка в группе «Варианты».
  6. Для Один из списка или Несколько из списка: введите варианты в поле Допустимые значения, по одному в строке.
  7. Необязательно: задайте Значение по умолчанию. Новые сущности класса начинаются с него.
  8. Необязательно: введите Описание.
  9. Нажмите Добавить атрибут.

    Появляется уведомление “Атрибут сохранён”. Атрибут стоит последним в списке класса и появляется для этого класса и его подклассов: в инспекторе, представлении элемента, столбцах и фильтрах базы данных, поиске, отчётах и сопоставлениях импорта.

  10. Чтобы переместить его, перетащите его строку в таблице Атрибуты или используйте ↑ и ↓ в строке. Каждое перемещение отменяется одним нажатием “Отменить”.

Добавление вариантов к существующему атрибуту

  1. Откройте класс, в котором определён атрибут. Его показывает столбец Определено в. Унаследованный атрибут изменяется в классе, который его определяет.
  2. Нажмите ✎ (Изменить атрибут) в строке.
  3. Добавьте новый вариант отдельной строкой в Допустимые значения.
  4. Нажмите Сохранить.

Для типа Один из списка квадрат перед каждым вариантом (под списком) задаёт цвет значения. Доски Kanban, столбцы которых — значения этого атрибута, используют его как цвет столбца.

Чтобы убрать вариант, удалите его строку в том же диалоге. Сущности, у которых уже есть это значение, сохраняют его, но редактор его больше не предлагает. Прежде чем убрать вариант, найдите такие сущности запросом по атрибуту (например, Requirement:"Priority=Urgent") и задайте им текущий вариант.

Создание подкласса

  1. Откройте родительский класс.
  2. Нажмите + Подкласс.

    (Или нажмите + Класс на боковой панели и выберите Родитель.)

  3. Введите Имя и Описание.
  4. При необходимости задайте Абстрактный, Скрытый и Цвет.
  5. Нажмите Создать класс.

    Откроется новый класс. У него уже есть все унаследованные атрибуты и цели.

Чтобы перенести существующие сущности в новый класс, выберите их в базе данных и используйте Изменить класс…. См. Смена класса.

Добавление метки

  1. Нажмите + Метка на боковой панели или + Новая метка на странице Метки.
  2. Введите Имя и Описание.
  3. Если метка относится к другой метке, выберите её в поле Родитель.
  4. Выберите Классы, к которым она применяется. ⌘ / Ctrl/Ctrl+щелчок выбирает несколько. Если ничего не выбрано, метка применяется ко всем классам.
  5. Нажмите Создать метку.

Чтобы назначить метку, используйте + Метка в инспекторе или представлении элемента либо Метка ▾ на панели массовых действий базы данных.

Разрешение новой связи

Связь между двумя классами разрешена, только если её допускает цель. Добавьте цель, чтобы разрешить её.

  1. Откройте исходный класс.
  2. В разделе Связи нажмите + Связь.
  3. Выберите Отношение.
  4. Выберите Другой класс.
  5. Оставьте отмеченным Добавить обратную связь и к другому классу. Тогда связь можно создавать с любого конца.
  6. Нажмите Добавить связь.

Если у другого класса нет обратного отношения, в столбце Назад к этому классу показано + в <класс>: щёлкните его, чтобы добавить обратное отношение туда.

Если нужного отношения нет, сначала создайте его:

  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: 1 из 3 утверждений.

  3. Утверждающие утверждают его.

    С последним утверждением элемент переходит в новое состояние, если этот утверждающий может редактировать проект. Иначе редактор открывает запрос и нажимает Применить изменения. История элемента показывает через CR-n, а запись об утверждении требования называет каждого утверждающего и запрос.

Прямые изменения на такое состояние отклоняются с сообщением “… needs approval. Choose “X” on the item to request it.” (… требует утверждения. Выберите “X” у элемента, чтобы запросить его): массовые Атрибуты…, ячейки таблицы, перемещения на доске и изменения ИИ. Повторный выбор состояния, пока запрос открыт, открывает этот запрос.

Общая схема для нескольких проектов

  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 item will become 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 entities have a “X” value. Changing the type from A to B clears those values.” (У N сущностей есть значение “X”. Смена типа с A на B очищает эти значения.) Если старые значения нужны, сначала экспортируйте отчёт CSV. Одно нажатие “Отменить” отменяет и смену типа, и очистку значений; в проектах, где таких значений больше 5000, во время очистки показывается карточка хода выполнения.
  • Удаление отношения удаляет его связи. Подтверждение показывает их число. Отмена восстанавливает их.
  • Удаление цели оставляет связи, которые схема больше не разрешает. Существующие связи остаются; Проверки модели перечисляют их по правилу Global.9 (связи, которые схема не разрешает). Удалите их или смените их отношение до или после удаления цели; подтверждение показывает их число.
  • Класс нельзя удалить, пока у него есть сущности. Сначала смените их класс или удалите их, либо скройте класс.
  • Простые переходы лишь направляют редакторы. Массовые Атрибуты…, импорт и изменения ИИ по-прежнему могут задать любое состояние, не требующее утверждения. Отметьте у перехода Утверждение, если изменение не должно обходить рецензирование.
  • Переименовать встроенное состояние нельзя. На них опираются утверждения, управление конфигурацией и верификация. Вместо этого добавьте новое состояние или выведите встроенное из употребления.

Связь с другими функциями

  • База данных, инспектор и представление элемента показывают и изменяют атрибуты. Они предлагают отношения, которые разрешает схема. Запросы ссылаются на классы, атрибуты, метки и отношения по имени. См. Модель и база данных.
  • Диаграммы: типы диаграмм, доступные сущности, зависят от её класса и классов выше него. Пользовательские подклассы наследуют их.
  • Функции Требования (качество, утверждения, 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 по умолчанию.
  • Поиск классов, атрибутов, связей, меток… фильтрует дерево классов. Основная область показывает подходящие Классы, Атрибуты, Найденные связи и Найденные метки или сообщение “No class, attribute, relation or label matches. Try another search term.” (Нет подходящих классов, атрибутов, отношений или меток. Попробуйте другой запрос.)
  • Использование.
  • + Класс, + Метка, + Связь.
  • Классы: дерево классов с образцами цвета, пометками “(abstract)” и “(hidden)” и числом сущностей (включая подклассы).
  • Другое: Связи (с числом), Метки (с числом) и Рабочий процесс.

Использование

Первой открывается страница Использование. Её строка состояния гласит “The default LML schema. The first edit makes a copy for this project.” (Схема LML по умолчанию. Первое изменение создаёт копию для этого проекта.) или “This project uses its own edited schema.” (Этот проект использует собственную изменённую схему.)

  • Классы: таблица нескрытых классов, сначала самые используемые: Класс (щёлкните, чтобы открыть), Элементы (с подклассами), Атрибуты (собственные), Связи (разрешённые, включая унаследованные) и Последнее изменение (когда в последний раз изменился один из его элементов).
  • Пока не используются: три раскрываемых списка — Классы, Метки и Связи, которые ничто в проекте не использует, каждый с числом. Скрыть в строке скрывает этот класс, метку или пару отношений (одно нажатие “Отменить” возвращает всё назад); скрытые элементы остаются в схеме и снова показываются на своей странице или в диалоге.

Страница класса

Щёлкните класс на боковой панели, чтобы открыть его страницу. Сверху вниз:

  • Навигационная цепочка родительских классов. Щёлкните любой, чтобы открыть его.
  • Заголовок: значок и имя класса, чипы Абстрактный и Скрытый, ✎ Изменить класс, + Подкласс и Удалить. N сущностей в проекте › открывает базу данных с фильтром по классу.
  • Карточка Описание: описание, чипы Id N, Атрибуты N (с “(k inherited)”, если часть пришла от родителей), Связи N и Сущности N, а также Подклассы.
  • Карточка Атрибуты: + Атрибут и таблица с такими столбцами:
    • Элементы управления порядком собственных атрибутов класса: перетащите строку или используйте ↑ / ↓ (каждое перемещение отменяется одним нажатием “Отменить”).
    • Имя, Тип (имя типа; наведите на него указатель, чтобы увидеть сохранённый ID).
    • Подробности: варианты и значение по умолчанию.
    • Определено в: “this class” (этот класс) или класс-предок.
    • Описание.
    • Действия для атрибутов, определённых в этом классе: ✎ (Изменить атрибут), ⊘ / 👁 (Скрыть атрибут / Показать атрибут) и × (Убрать атрибут).
  • Карточка Связи: + Связь и таблица с обоими направлениями: Отношение, Другие классы, Назад к этому классу (обратное имя и + в <класс> для другого класса без обратного отношения) и Описание. В Другие классы × удаляет отношение, определённое в этом классе. Унаследованные показывают “(inherited from X)” (унаследовано от X).
  • Карточка Метки: метки, доступные классу. * отмечает метки, доступные всем классам.

Диалог «Изменить класс»

Заголовок — Создать новый класс или Изменить класс — X. Поля: Имя, Описание, Родитель ((нет — верхний уровень) или класс), Скрытый, Абстрактный и Цвет. Нажмите Создать класс или Сохранить класс.

У встроенного класса, у которого есть сущности, нельзя сменить родителя: “Entities use this built-in class, so its parent is fixed.” (Сущности используют этот встроенный класс, поэтому его родитель зафиксирован.)

Диалог атрибута

Заголовок — Новый атрибут или Изменить атрибут — X. Для атрибута отношения в заголовок добавляется “(relation “…”)”. Нажмите Добавить атрибут или Сохранить.

  • Имя и Тип (по группам: текст, числа, дата и время, варианты, ссылки, особые). Поля порядка нет: новый атрибут добавляется последним.
  • Допустимые значения (по одному в строке): только для “Один из списка” и “Несколько из списка”. Пустые строки и повторы отбрасываются. Списку нужно не меньше двух значений: “An enumeration needs at least two choices. Add another choice.” (Перечислению нужно не меньше двух вариантов. Добавьте ещё один вариант.) (“A multiselect …” для “Несколько из списка”). Атрибут, у которого уже одно значение, по-прежнему сохраняется, пока его список не изменён. Для “Один из списка” после списка идёт цветной квадрат для каждого значения.
  • Значение по умолчанию: не для FILE, COMPUTABLE, QUALITY, HTML и USER_TEAM.
  • Описание.

Страница «Отношения»

Нажмите Связи на боковой панели, чтобы увидеть все пары отношений. На странице есть + Связь и таблица с такими столбцами:

  • Отношение и Обратная.
  • Источник → цель: все разрешённые пары классов.
  • Атрибуты: ✎ для каждого атрибута и + Атрибут.
  • Используется: число связей.
  • Описание.
  • ✎ (Изменить связь) и × (Удалить связь).

Диалог отношения называется Новая связь или Изменить связь — X. В нём есть Имя, Обратное имя, Описание, Описание обратной связи, Скрытый и Цвет (или Цвет по умолчанию). Диаграммы Spider рисуют отношение этим цветом; диаграмма всё равно может выбрать свой цвет для каждой связи. Столбец Отношение показывает цвет образцом. При изменении диалог также перечисляет атрибуты отношения с кнопкой + Добавить атрибут. Нажмите Создать связь или Сохранить.

Страница «Метки»

Нажмите Метки на боковой панели, чтобы увидеть все метки. На странице есть Добавить метки DoDAF и Добавить метки UAF (метки фреймворков, которых нет в проекте; они также добавляются при первом продукте DoDAF или первом представлении UAF), + Новая метка и таблица в порядке дерева с такими столбцами:

  • Метка.
  • Применяется к: чипы классов или “All classes” (все классы).
  • Сущности: число.
  • Описание.
  • Действия: ✎ (Изменить метку), ⊖ (Снять эту метку со всех сущностей, показывается, когда она используется) и × (Удалить метку). Одно нажатие “Отменить” возвращает метку на все сущности, с которых она была снята; при более чем 5000 сущностях показывается карточка хода выполнения.

Диалог метки называется Создать новую метку или Изменить метку — X. В нём есть Имя, Описание, Родитель ((нет) или метка), Классы (если ничего не выбрано — все классы) и Скрытый. Нажмите Создать метку или Сохранить метку.

Страница «Рабочий процесс»

Нажмите Рабочий процесс на боковой панели. На странице написано “Set which value changes an enumeration attribute (such as Status) allows.” (Задайте, какие смены значения разрешает атрибут-перечисление, например Status.)

На странице написано “Set the states of a class and which changes between them are allowed or need approval.” (Задайте состояния класса и какие переходы между ними разрешены или требуют утверждения.)

Добавить класс… перечисляет классы, у которых есть атрибут-перечисление и ещё нет рабочего процесса. Он отслеживает Status, если такой атрибут у класса есть. У каждого класса с рабочим процессом есть карточка с:

  • Чип класса, отслеживает и отслеживаемый атрибут. Его смена сначала запрашивает подтверждение, если у рабочего процесса есть переходы.
  • Убрать: убирает рабочий процесс класса. Значения элементов остаются.
  • Состояния: таблица со столбцами Состояние (с пометкой встроенный или (выведено)), Элементы (число) и ↑, ↓, Переименовать…, Убрать… или Вывести из употребления… либо Восстановить. Под ней Новое состояние и + Добавить состояние. Подкласс с унаследованным атрибутом показывает “Own states of X; Y is inherited.” (Собственные состояния X; Y унаследован.)
  • Переходы: + Добавить переход добавляет “New Transition” из (Начальное — без значения) в первое состояние. Таблица: Имя, Из, В, Утверждение и меню ⋯ с пунктами Заблокировать элемент после этого перехода и Удалить переход (также правый щелчок по строке или ⇧F10 / Shift+F10 на ней). Имя, “Из” и “В” показаны как текст; щёлкните поле (или нажмите на нём Enter или F2), чтобы изменить его. Без переходов карточка сообщает “No transitions: every state can follow every other.” (Переходов нет: любое состояние может следовать за любым другим.)

В размещённом сервисе рабочие процессы меняют только владельцы проекта; остальные видят страницу только для чтения с сообщением “Only project owners change workflows.” (Рабочие процессы меняют только владельцы проекта.)

Как изменения схемы влияют на существующие данные

Сверьтесь с этой таблицей, прежде чем менять элемент схемы, у которого уже есть данные.

ИзменениеВлияние на сущности и связи
Переименовать класс, атрибут, отношение или меткуДанные сохраняются, так как всё хранится по ID. Сохранённые запросы, текст поиска и заголовки столбцов со старым именем перестают совпадать. Обновите их.
Сменить родителя классаВ редакторах класс получает атрибуты и цели нового родителя и теряет атрибуты и цели старого. Сохранённые значения остаются. Недоступно для встроенного класса, у которого есть сущности.
Сделать класс абстрактным или скрытымСуществующие сущности остаются. Класс больше не предлагается для новых сущностей и для смены класса.
Удалить классВозможно, только если у класса нет подклассов и сущностей. Его собственные атрибуты и цели удаляются. Метки убирают его из своего списка классов.
Добавить атрибутУ существующих сущностей значения нет. Новые сущности получают Значение по умолчанию.
Сменить тип атрибутаВсе значения этого атрибута очищаются после подтверждения.
Убрать вариантСущности сохраняют старое значение. Редактор его больше не предлагает.
Скрыть атрибутЗначения сохраняются, но не показываются, не ищутся и не экспортируются, пока атрибут снова не станет видимым.
Убрать атрибутЕго значение очищается у всех сущностей и связей после подтверждения.
Добавить цельОтношение становится доступным между этими классами (и их подклассами).
Убрать цельСуществующие связи остаются, хотя схема их больше не разрешает. Их перечисляет правило проверок модели Global.9.
Удалить отношениеУдаляются пара отношений, её цели и все связи, которые её используют.
Удалить меткуОна снимается со всех сущностей. Её дочерние метки переходят к её родителю.
Импорт схемы (объединение)Добавляет классы, отношения, цели, атрибуты и метки, которых нет по имени. Ничего существующего не меняется и не удаляется.
Добавить новые встроенныеДобавляет классы, отношения, атрибуты и метки схемы по умолчанию, которых нет по имени, с их ID по умолчанию. Для добавленных классов и отношений добавляются цели, а также цели 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
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 (перечисление) добавляется, когда создаётся или преобразуется доска Kanban с собственными именами столбцов. Его значения — имена столбцов.
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ВездеОтменить / повторить изменение схемы

Параметры и настройки

  • Схема проекта хранится в проекте и доступна каждому участнику, который может его открыть.
  • Участники с ролью читателя не могут её менять (“View only: ask an owner for edit access.” — только просмотр: попросите у владельца доступ на редактирование).
  • Файлы Экспортировать схему используют формат holarch-schema и содержат классы, отношения, атрибуты, метки и рабочий процесс.

Сообщения

СообщениеЗначение и исправление
“Enter a class name.” (Введите имя класса.)Имя класса пустое.
“That class name is too long; shorten it.” (Имя класса слишком длинное; сократите его.)Имена классов и меток ограничены 100 символами.
“Class names cannot contain : " ( ) < or >. Searches give these characters a meaning.” (Имена классов не могут содержать : " ( ) < или >. Поиск придаёт этим символам значение.)Удалите эти символы. Другие буквы, цифры, пробелы и знаки препинания допустимы. Существующие имена классов остаются действительными.
“Another class already uses this name. Choose a different one.” (Это имя уже использует другой класс. Выберите другое.)Имена классов уникальны (без учёта регистра).
““X” is a search keyword (as in x:…). Choose another class name.” (“X” — ключевое слово поиска, как в x:…. Выберите другое имя класса.)Ключи поиска (class, label, name, number, description, is, relationship, in, under, diagram, id, order) и AND, OR, NOT не могут быть именем класса, потому что поиск прочитал бы класс как этот ключ.
“That parent would make this class its own ancestor.” (Такой родитель сделал бы этот класс собственным предком.)Выберите родителя вне поддерева класса.
“This class has subclasses. Delete them or move them to another parent first.” (У этого класса есть подклассы. Сначала удалите их или перенесите к другому родителю.)Класс с подклассами удалить нельзя.
““X” (or a subclass) has N entities. Change their class or delete them first, or hide the class.” (У “X” или подкласса N сущностей. Сначала смените их класс или удалите их либо скройте класс.)Класс с сущностями удалить нельзя.
“Enter an attribute name.” (Введите имя атрибута.)Имя атрибута пустое.
“The attribute name contains characters that are not allowed.” (Имя атрибута содержит недопустимые символы.)Используйте буквы, цифры, пробелы и _ - $ ( ) . , /.
“Name, Number and Description are built in; pick another attribute name.” (Name, Number и Description встроены; выберите другое имя атрибута.)Это поля сущности, а не атрибуты.
“An attribute with this name already exists here.” (Атрибут с таким именем здесь уже есть.)Он уже есть у класса, родителя или подкласса.
“Add at least one choice.” (Добавьте хотя бы один вариант.)ENUMERATION и MULTISELECT требуют вариантов.
“Enter a label name.” / “The label name contains characters that are not allowed.” / “Another label already uses this name.” / “A label cannot be inside itself. Choose another parent.” (Введите имя метки / имя метки содержит недопустимые символы / это имя уже использует другая метка / метка не может находиться внутри себя, выберите другого родителя.)Проверки диалога метки. В метках можно также использовать & и '.
“Enter a relation name and an inverse name.” / “The relation name and the inverse name must be different.” / “A relation named “X” already exists.” (Введите имя отношения и обратное имя / имя отношения и обратное имя должны различаться / отношение с именем “X” уже существует.)Проверки диалога отношения.
“Not a JSON file.” / “This file is not a schema: it needs classes, relations, attributes and labels.” (Это не файл JSON / этот файл не является схемой: в нём нужны классы, отношения, атрибуты и метки.)Импортировать схему… требует файл JSON схемы или проекта.
“Merged schema: N item(s) added” / “Schema replaced” (схема объединена: добавлено N элементов / схема заменена)Импорт завершён.
“No workflow classes. Choose a class with Add a Class… to define its status transitions.” (Нет классов с рабочим процессом. Выберите класс через “Добавить класс…”, чтобы задать его переходы статусов.)Рабочий процесс ещё не задан.

Перед разрушительным изменением подтверждение сообщает о последствиях:

ПодтверждениеТекст
Убрать атрибут“N entities have a value that will be cleared.” (У N сущностей есть значение, которое будет очищено.)
Сменить тип и очистить значения“N entities have a “X” value. Changing the type from A to B clears those values.” (У N сущностей есть значение “X”. Смена типа с A на B очищает эти значения.)
Удалить класс“Delete the class “X” with its attributes and targets?” (Удалить класс “X” с его атрибутами и целями?)
Убрать цель (× в Другие классы)“N existing relationship(s) stay, although the schema no longer allows them.” (N существующих связей остаются, хотя схема их больше не разрешает.)
Удалить связь“N relationship(s) using it are removed too.” (N связей, которые его используют, тоже удаляются.)
Удалить метку“It is removed from N entities.” (Она снимается с N сущностей.)
Снять метку с элементов“Remove “X” from N entities?” (Снять “X” с N сущностей?)
Сбросить схему“Custom classes, attributes, relations and labels are removed from the schema (entity data stays; Undo is available).” (Пользовательские классы, атрибуты, отношения и метки удаляются из схемы; данные сущностей остаются, отмена доступна.)

Ограничения

  • Имена классов и меток: 100 символов.
  • Имена атрибутов, созданных импортом: 80 символов.
  • Один отслеживаемый атрибут на класс.
  • Простые переходы применяют редакторы атрибутов, ячейки таблицы и доска Kanban. Переходы с утверждением также отклоняют прямые и массовые изменения. Новые элементы можно создавать в любом состоянии.
  • Заблокировать относится к элементам LML. Элементы SysML v2 не блокируются.
  • Имена состояний: 100 символов.
  • Объединить не добавляет новые варианты к уже существующему атрибуту; добавьте их в диалоге атрибута.
  • Добавить новые встроенные… появляется только после повторного открытия страницы, когда схема стала пользовательской.