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) по стандартным идентификаторам. Импорт читает их как те же библиотечные элементы, поэтому единицы и типы остаются разрешёнными. - Текст сохраняет идентификаторы, если вы об этом просите. Установите флажок Включить ID элементов при экспорте текста
.sysml. Тогда каждое именованное определение, использование и пакет несёт свой идентификатор первой строкой тела,@HolarchMetadata::ElementId { id = "…"; }. При повторном импорте этого текста каждый элемент с идентификатором сопоставляется с элементом с тем же идентификатором, даже если он был переименован, перемещён к другому владельцу или в другой пакет верхнего уровня либо переупорядочен. Его положения на диаграммах, комментарии, трассировки и связи сохраняются. - Текст без идентификаторов сопоставляется по имени. Holarch сопоставляет пакеты верхнего уровня по имени, а элементы внутри них — по именам и положению. Идентификаторы сохраняются там, где элементы совпадают. Переименованный элемент по-прежнему сопоставляется, если сохраняет своё место; элемент, который одновременно переименован и перемещён, становится новым элементом.
Под элементами управления экспорта об этом сказано: «Идентификаторы элементов сохраняются в JSON. В тексте .sysml установите флажок “Включить ID элементов”, чтобы сохранить их: тогда элементы сохраняют положения на диаграммах, комментарии и трассировки при повторном импорте отредактированного текста, даже после переименования или перемещения. Без идентификаторов элементы сопоставляются по имени.»
Идентификаторы элементов в тексте
@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 с модели, написанной в другом месте.
- Подключить пакет, который ведёт другая команда, например библиотеку компонентов, и обновлять его, когда они присылают новую версию.
- Передать пакет поставщику или инструменту, который читает текст SysML v2 или JSON.
- Хранить файлы
.sysmlв собственной системе контроля версий рядом с проектом Holarch.
Импортировать файлы в этот проект
- Откройте Модель → Импорт и экспорт.
- В разделе Импорт выберите В этот проект.
- Перетащите файлы в зону сброса или щёлкните её и выберите файлы.
Вы увидите «Чтение файлов…», затем предпросмотр: число пакетов верхнего уровня и файлов, проблемы и таблицу со столбцами Импорт, Пакет, Элементы и Результат.
- Прочитайте список проблем, если он есть. В нём указаны каждый файл и строка, которые не разбираются, и каждый пропущенный файл.
- Снимите отметку с каждого пакета, который не нужно импортировать. Чтобы заменить пакет, конфликтующий по имени, отметьте его.
На тарифе с ограничением числа элементов предпросмотр подсчитывает элементы, которые будут в проекте после импорта (связи не учитываются). Если это больше ограничения, он сообщает об этом, например “Этот импорт доведёт проект до 1804 элементов; тариф Free допускает 1000.”, и кнопка Импортировать: N пакетов остаётся недоступной, пока вы не снимете отметку с достаточного числа пакетов. Ничего не применяется и не отправляется на сервер. Импорт в новый проект так же проверяется по ограничению вашего тарифа на один проект.
- Нажмите Импортировать: N пакетов.
Уведомление сообщает “Импортировано: N пакетов.”. На странице написано “Импортировано: N пакетов (M элементов). Отмена откатывает импорт за один шаг.”. Нажмите Открыть текст, чтобы их увидеть.
Импортировать файлы в новый проект
- Откройте Модель → Импорт и экспорт и выберите В новый проект SysML v2.
- Перетащите или выберите файлы.
Предпросмотр перечисляет элементы верхнего уровня, все отмечены.
- Снимите отметку с ненужных и измените Название проекта. По умолчанию это имя единственного файла или первого пакета.
- Нажмите Создать проект.
Новый проект открывается в Редакторе.
На странице Управление проектами команда Файлы проектов ▾ → Импортировать файлы SysML v2… делает то же самое за один шаг. Если части файлов не удаётся прочитать, сначала появляется вопрос: “Найдено проблем: N. Части файлов пропущены. Создать проект из остального? Чтобы сначала посмотреть проблемы, откройте проект SysML v2 и используйте «Импорт и экспорт».”. Нажмите Создать проект, чтобы продолжить.
Обновить пакет из новой версии
- Экспортируйте или получите новую версию в виде файлов
.sysmlили JSON. - Импортируйте её В этот проект.
У пакета отображается Изменено с числом добавленных, изменённых и удалённых элементов.
- Нажмите Импортировать: 1 пакет.
Совпадающие элементы сохраняют свои ID, поэтому ссылки на них (связи требований, риски, макеты представлений, комментарии) остаются. Элементы, которых больше нет в файле, перемещаются в Корзину.
Переименовывать и перемещать элементы в тексте с сохранением идентификаторов
- Экспортируйте пакеты как Текст SysML v2 с отмеченным флажком Включить ID элементов.
- Отредактируйте файлы: переименуйте элементы, переместите их к другим владельцам или в файл другого пакета, измените их порядок. Оставляйте каждую строку
@HolarchMetadata::ElementIdвнутри тела её элемента. - Импортируйте отредактированные файлы В этот проект.
У пакетов отображается Изменено. Переименованные и перемещённые элементы считаются изменёнными, а не добавленными и удалёнными.
- Нажмите Импортировать: N пакетов.
Элементы сохраняют свои ID: их положения на диаграммах, комментарии, трассировки и ссылки остаются. Элементы, перемещённые в другой пакет, покидают пакет, в котором были.
Большие импорты в размещённом сервисе
В размещённом сервисе импорт 5000 элементов и более применяет сервер, а не ваш браузер. Когда каждый отмеченный пакет имеет статус Новый или заменяет пакет со статусом Конфликт, сервер читает файлы сам (шаги ниже). Когда отмеченный пакет имеет статус Изменено, ваш браузер, как обычно, вычисляет объединение и один раз загружает изменения; затем сервер записывает их за один шаг, с той же карточкой хода выполнения и теми же командами «Отменить импорт» (остановка до применения и откат после него).
- Выберите файлы и проверьте предпросмотр, как при любом импорте.
- Нажмите Import N Packages (или Создать проект).
Файлы загружаются один раз. Сервер читает их с теми же проверками и теми же ID элементов, что и в предпросмотре, и записывает результат за один шаг.
- Следите за карточкой хода выполнения внизу окна: она показывает этап (загрузка, чтение, проверка, применение, обновление индекса проекта) и оставшееся время.
Можно уйти со страницы или закрыть вкладку. Импорт продолжается на сервере, и когда вы снова откроете проект, его результат будет там. Каждая открытая копия проекта перезагружается, когда импорт применён; неотправленные правки отправляются снова после перезагрузки.
- Другие участники видят “Name импортирует file…” в той же карточке и на странице «Импорт и экспорт».
- Один импорт за раз: второй большой импорт в тот же проект ждёт, пока не завершится первый.
- Отменить импорт на карточке хода выполнения (доступно тому, кто начал импорт, или владельцу) останавливает импорт до его применения. Ничего не меняется.
- Откат импорта: ⌘Z / Ctrl+Z в браузере не отменяет серверный импорт. Нажмите Отменить импорт на странице “Импорт и экспорт”, чтобы вернуть проект в состояние до последнего импорта. Состояние перед откатом сохраняется в разделе История, поэтому правки, сделанные после импорта, можно восстановить оттуда.
- Активность проекта и История показывают импорт одной записью от имени того, кто его начал.
Экспортировать модель или пакет
- Откройте Модель → Импорт и экспорт.
- В разделе Экспорт выберите, что экспортировать: Вся модель или пакет по его полному имени.
- Выберите формат: Текст SysML v2 (.sysml; .zip для нескольких пакетов) или JSON SysML v2 (.json).
- Для текста, который вы будете редактировать и снова импортировать, отметьте Включить ID элементов.
- Нажмите Экспорт.
Скачивается один файл или zip-архив, если экспорт содержит несколько файлов. Уведомление сообщает “Экспортировано: <file>.” или “Экспортировано файлов в zip: N.”.
Чтобы быстро экспортировать один пакет, используйте Браузер: в меню строки пакета есть Экспортировать как .sysml и Экспортировать как JSON.
Импортировать и экспортировать требования ReqIF
ReqIF — формат обмена инструментов управления требованиями. Файл ReqIF импортируется как один пакет требований SysML v2, а требования экспортируются обратно в ReqIF, поэтому инструмент управления требованиями и проект SysML v2 могут обмениваться одними и теми же требованиями в обоих направлениях.
Импорт файла ReqIF:
- Откройте Модель → Импорт и экспорт (или нажмите Импортировать… на странице «Требования», или выберите Импортировать ReqIF… в ⌘K / Ctrl+K).
- Перетащите файл
.reqifили.reqifzв поле или щёлкните поле, чтобы выбрать его. Один файл ReqIF за один импорт. - Панель ReqIF показывает число требований, глав и отношений, сколько из них преобразовано, приближено или пропущено, и проходит ли проверку текст SysML v2 без проблем.
- В разделе Краткие имена из выберите Внешний ID (номер, который люди видят в исходном инструменте, например
SRS-12) или Идентификатор ReqIF (внутренний ID инструмента). Требования без внешнего ID получают идентификатор. - В разделе Типы отношений выберите, чем станет каждый тип отношения: Вывести, Уточнить, Зависимость или Пропустить. Предпросмотр вычисляется заново, а выбор сохраняется для следующего импорта того же файла.
- Нажмите Импортировать: 1 пакет. Одно нажатие “Отменить” отменяет весь импорт. Уведомление сообщает “Импортировано из <title>: N требований.”
Что создаёт импорт:
| ReqIF | SysML v2 |
|---|---|
| Требование (spec object) | requirement с внешним ID или идентификатором в качестве краткого имени, именем и текстом в виде doc |
| Тип требования | requirement def с одним атрибутом на каждый атрибут ReqIF |
| Перечислимый тип данных | enum def |
| Атрибут статуса (Draft, Proposed, Approved и т. д.) | Статус требования в Holarch |
| Заголовок главы | package с номером главы в качестве краткого имени |
| Вложенное требование | Вложенный requirement |
| Отношение derived from | Соединение вывода (derivation) |
| Отношение refines | Зависимость с аннотацией Refinement |
| satisfies, verified by и другие отношения | Зависимость (отчёт объясняет почему) |
| Спецификация | package внутри пакета файла |
Таблицы становятся строками текста с | между ячейками, списки — строками, начинающимися с тире, а у форматирования и ссылок остаётся только текст; такие требования помечаются как Приближено. Изображения и встроенные объекты не импортируются; требование, которое содержало такой объект, указывается с причиной, чтобы вы могли прикрепить к нему файл. Скачать отчёт сохраняет каждое требование и отношение с результатом в CSV; Скачать текст SysML v2 сохраняет текст.
Импорт более новой копии файла: импортируйте её в тот же проект. Holarch находит пакет предыдущего импорта и сравнивает требование за требованием:
- Требования сохраняют свои ID элементов, поэтому диаграммы, ссылки satisfy и verify, рецензирования и История остаются привязанными. Переименованные и перемещённые требования обновляются на месте.
- Требования, которых нет в новом файле, сохраняются. Отметьте Убрать отсутствующие в этом файле: N требований, чтобы переместить их в Корзину.
- Части, случаи верификации и ссылки, добавленные вами в Holarch, сохраняются.
- Требование, изменённое только в Holarch, сохраняет ваше изменение. Требование, изменённое и здесь, и в файле, получает текст из файла; прежний текст остаётся в Истории. Предпросмотр перечисляет такие требования в разделе Изменено здесь и в файле.
Экспорт в ReqIF:
- В разделе Экспорт выберите пакет или Вся модель, а также ReqIF (.reqif) или Архив ReqIF (.reqifz).
- Нажмите Экспорт. Уведомление сообщает “Экспортировано требований как <file>: N.”.
Экспортировать… → Требования (ReqIF) в базе данных или на странице «Требования» так же экспортирует показанные (или выбранные) требования.
Файл содержит краткое имя каждого требования (как ReqIF.ForeignID), имя, doc (как XHTML), статус и значения атрибутов, иерархию пакетов как спецификацию, а также связи derive, refine и зависимости. Требования, импортированные из ReqIF, сохраняют исходные идентификаторы, типы и типы отношений, поэтому исходный инструмент обновляет свои требования, а не добавляет копии; повторный экспорт и импорт файла показывает каждый пакет как Без изменений. Вычисляемые значения атрибутов записываются как текст. Ссылки satisfy и verify остаются в Holarch: в ReqIF нет частей и случаев верификации.
Получать из репозитория и отправлять в него
Подключите проект к одной ветви репозитория моделей SysML v2, чтобы читать её последний коммит и отправлять свои изменения обратно.
- Откройте Модель → Импорт и экспорт и найдите раздел Репозиторий.
- Введите Адрес репозитория (https-адрес его Systems Modeling API) и, если репозиторию он нужен, Токен доступа.
- Нажмите Загрузить проекты, затем выберите Проект и Ветвь. Чтобы вместо этого начать новый проект репозитория из этой модели, нажмите Новый проект репозитория.
- Нажмите Получить…. Holarch читает последний коммит ветви и перечисляет каждое различие: Новый, Изменено, Удалено или Конфликт. Если получать нечего, вы увидите “Актуально: в репозитории нет изменений.”.
- Снимите отметку с ненужных различий, затем нажмите Применить pull. Одно нажатие “Отменить” отменяет всё получение.
- После изменения модели нажмите Отправить. Ваши изменения с последнего синхронизированного коммита уходят в ветвь одним новым коммитом. Вы увидите, например, “3 изменения отправлено как коммит 1a2b3c4d.”.
Конфликт — элемент, изменённый и здесь, и в репозитории после последней синхронизации. Конфликт без отметки сохраняет версию этого проекта.
Примечание: отправка отклоняется, если в ветви есть коммиты, которые этот проект не получил: “В ветви репозитория есть коммиты, которые этот проект не получил. Сначала получите изменения, затем отправьте снова.”
Разобранный пример: демо-проект 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, когда важны ID, например если другой инструмент хранит ссылки по ID. Используйте текст, когда люди читают или рецензируют файлы; отметьте Включить ID элементов, если текст после редактирования вернётся в Holarch.
- Не включайте ID в текст, который вы передаёте людям только для чтения: они добавляют по строке на каждый элемент.
- Держите один пакет верхнего уровня на файл. Экспорт записывает файлы именно так, и последующий импорт сопоставляет их пакет за пакетом.
- Импортируйте пакет от другой команды в его собственный пакет верхнего уровня. Тогда обновления затрагивают только этот пакет.
- Перед импортом проверьте список проблем. Члены, которые не разбираются, пропускаются.
Типичные ошибки
- У пакета отображается «Конфликт»: “Существует пакет с именем X и другими ID.” В проекте есть пакет с таким именем, который не был импортирован из этого JSON. Отметьте строку, чтобы заменить его (старый пакет перемещается в Корзину), или импортируйте в новый проект.
- “В импорте есть два пакета верхнего уровня с именем X; импортируется только первый.” Два файла объявляют один и тот же пакет верхнего уровня. Объедините их в один файл или переименуйте один из них.
- Переименованный элемент импортирован как новый. В тексте не было ID элементов, а элемент был одновременно переименован и перемещён (или изменились и его вид, и имя). Экспортируйте с Включить ID элементов, внесите изменение и импортируйте снова.
- После импорта не хватает элементов. Член, который не разбирается, пропускается: “Этот член не разбирается и пропускается.” Исправьте строку, указанную в списке проблем, затем импортируйте снова.
- Импорт JSON отклонён. Импортируйте по одному файлу JSON SysML v2 за раз, без файлов
.sysml.
Связь с другими функциями
- Редактор: импортированные пакеты открываются в нём; экспортированные файлы — это текст, который вы видите там.
- Отмена и Корзина: одно нажатие “Отменить” отменяет весь импорт в этот проект; удаляемые или заменяемые им элементы попадают в Корзину.
- Управление изменениями: значения и документация, изменённые при импорте, помечают связи требований для рецензирования, как и любая другая правка.
- Файлы проектов Holarch: Экспортировать этот проект… на странице «Управление проектами» сохраняет весь проект Holarch с рисками, документами и другими данными Holarch.
.sysmlи JSON содержат только модель. - Преобразование: чтобы перенести модель между LML и SysML v2, создайте преобразованную копию (см. Преобразование между LML и SysML v2).
Страница «Импорт и экспорт»
Импорт
| Элемент управления | Использование |
|---|---|
| В этот проект | Объединить файлы с открытым проектом. Недоступно тем, кто может только просматривать проект; для них импорт создаёт новый проект. |
| В новый проект SysML v2 | Создать новый проект из файлов. |
| Зона перетаскивания | “Перетащите файлы сюда или щёлкните, чтобы выбрать их”. Принимает файлы .sysml, архив .zip с файлами .sysml или один файл JSON SysML v2. |
| Таблица предпросмотра | Импорт (флажок), Пакет (имя и вид), Элементы (количество), Результат (Новый, Изменено, Без изменений или Конфликт, с подробностями). |
| Имя проекта | (Только для нового проекта) Имя нового проекта, до 200 символов. |
| Импортировать: N пакетов / Создать проект | Применить импорт. |
| Отмена | Закрыть предпросмотр без импорта. |
Элементы вне каких-либо пакетов в тексте .sysml перечисляются вместе в одной строке — Вне пакетов.
Если модель меняется, пока открыт предпросмотр (другая вкладка, соавтор или отмена), предпросмотр вычисляется заново.
Экспорт
| Элемент управления | Использование |
|---|---|
| Экспорт (область) | Вся модель или любой пакет по полному имени. |
| как (формат) | Текст SysML v2 (.sysml; .zip для нескольких пакетов) или JSON SysML v2 (.json). |
| Включить ID элементов | (Только текст; по умолчанию выключено) Записывать ID каждого именованного элемента в текст как @HolarchMetadata::ElementId { id = "…"; }, чтобы отредактированная копия при повторном импорте сохраняла ID при переименованиях и перемещениях. |
| Экспорт | Скачать файл. |
Текстовый экспорт записывает по одному файлу на каждый пакет верхнего уровня, названному по нему (Vehicles.sysml). Элементы вне пакетов попадают в Outside packages.sysml. Экспорт JSON записывает один файл, названный по проекту или пакету.
Репозиторий
Раздел Репозиторий связывает проект с одной ветвью репозитория, который предоставляет Systems Modeling API.
- Адрес репозитория: https-адрес API репозитория. Holarch подключается только к https-адресам на публичных хостах; администраторы сайта могут ограничить хосты и порты.
- Токен доступа: хранится в зашифрованном виде для вашей учётной записи и этого проекта и отправляется только на этот адрес. Он больше никогда не показывается; оставьте поле пустым, чтобы сохранить сохранённый токен.
- Загрузить проекты, Проект и Ветвь: выбор места синхронизации. Новый проект репозитория создаёт в репозитории проект для этой модели.
- Получить…, Применить pull: прочитать последний коммит, просмотреть различия и применить их; одно нажатие “Отменить” возвращает всё назад. Holarch сравнивает с коммитом, синхронизированным последним, поэтому может отличить ваши изменения от изменений репозитория.
- Отправить: отправить изменения с последнего синхронизированного коммита одним коммитом. “Нечего отправлять: модель совпадает с последним синхронизированным коммитом.” означает, что нового нет.
- Настройки… изменяет подключение. Отключить удаляет сохранённый токен и состояние синхронизации; модель остаётся.
- Операции с репозиторием требуют роли редактора. Читатели не могут получать и отправлять изменения.
- Отправка отклоняется для проектов с грифами регулируемых данных.
Как читаются файлы
- Файлы проверяются до того, как что-либо будет прочитано: их размеры, количество, вложенность и длина текста.
- В zip-архиве скрытые файлы и папки
__MACOSXигнорируются. Ссылки, файлы, отличные от.sysml, и вторая копия того же пути пропускаются, а список проблем объясняет почему. - Текст должен быть в кодировке UTF-8. Метка порядка байтов допускается.
- Каждый импортируемый элемент проверяется перед записью. Отклонённый элемент забирает с собой свои члены; список проблем их подсчитывает.
- В JSON элементы видов, которые Holarch не интерпретирует, сохраняются такими, какими были импортированы: см. Элементы, которые Holarch не интерпретирует.
Элементы, которые Holarch не интерпретирует
JSON SysML v2 может содержать виды элементов, которые Holarch не моделирует, например поведения, шаги или взаимодействия KerML. Holarch сохраняет их, а не пропускает:
- Каждый такой элемент остаётся в модели со своим ID, именем, владельцем и исходным JSON, включая его связи (типизации, специализации и другие) и то, чем они владеют. Его члены сохраняют его как владельца.
- Браузер показывает его исходный вид с меткой Не интерпретируется; наведите указатель на метку, чтобы увидеть пояснение. Инспектор показывает его вид, его ID в файле и то, на что указывают его связи.
- Его нельзя переименовать или изменить в Holarch. Измените его в инструменте, из которого он пришёл, и импортируйте снова. Его можно переместить или удалить.
- У него нет текста SysML. Редактор исключает его и всё, чем он владеет, из текста, а примечание над текстом сообщает, сколько элементов не показано. Редактирование текста никогда их не удаляет. Экспорт
.sysmlтоже их не включает. - Экспорт JSON записывает его обратно без изменений. Корректируется только то, что изменилось в модели: удалённый или добавленный вами член, переименованный член или новый владелец.
- Предпросмотр импорта перечисляет каждый сохранённый вид один раз в виде примечания, например 2 элемента Behavior сохранены как импортированные. Примечания не являются проблемами.
Не сохраняются: безымянное корневое пространство имён, в которое некоторые инструменты оборачивают весь экспорт (его члены становятся элементами верхнего уровня), и неподдерживаемые элементы внутри значения, которые указываются как проблемы. Элемент, JSON которого больше 256 КБ, сохраняет только свой вид и ID.
Сообщения
| Сообщение | Значение и исправление |
|---|---|
| Выберите файлы .sysml, архив .zip с файлами .sysml или файл JSON SysML v2. | Файлы не выбраны. |
| Файлы .sysml не найдены. Выберите файлы .sysml, архив .zip с файлами .sysml или файл JSON SysML v2. | Архив или выбор не содержит файлов .sysml. |
| Импортируйте по одному файлу JSON SysML v2 за раз, без файлов .sysml. | Выбрано несколько файлов JSON или JSON вместе с текстом. |
| <file> не является файлом ReqIF (…). Экспортируйте его из исходного инструмента в формате ReqIF 1.0 или новее и импортируйте снова. | Файл не является XML ReqIF или содержит DOCTYPE, который Holarch не читает. |
| <file> не содержит требований (нет элементов SPEC-OBJECT). Экспортируйте спецификации вместе с их объектами и импортируйте файл снова. | В файле ReqIF есть типы, но нет требований. |
| В <title> требований: N — больше, чем принимает один импорт (около M). Экспортируйте спецификации отдельными файлами ReqIF. | Текст SysML v2 превысил бы ограничение 8 МБ. Импортируйте спецификации по одному файлу. |
| <file> не является текстом UTF-8. Сохраните его в UTF-8 и импортируйте снова. | Преобразуйте кодировку файла. |
| <file> не является допустимым ZIP-архивом. Создайте архив заново. | Архив повреждён. |
| <file> содержит зашифрованные файлы. Создайте архив без пароля. | Архивы, защищённые паролем, не читаются. |
| <path> сжат более чем в 200 раз, что типично для zip-бомбы. Создайте архив заново. | Архив отклонён по соображениям безопасности. |
| Архив использует неподдерживаемый метод сжатия. Создайте его со стандартным сжатием ZIP. | Используйте стандартное сжатие (deflate). |
| Файлы KerML пока не импортируются. | Файлы .kerml пропускаются. |
| Из архива импортируются только файлы .sysml. | Другие файлы в zip-архиве пропускаются. |
| Ссылки не импортируются. | Символические ссылки в zip-архиве пропускаются. |
| Архив содержит этот файл дважды; импортируется первая копия. | Две записи имеют одинаковый путь. |
| <file> не является допустимым JSON. Экспортируйте модель снова. | Файл JSON повреждён. |
| <file> не является JSON SysML v2 (списком элементов с @id и @type). Выберите экспорт JSON SysML v2. | JSON в каком-то другом формате. |
| Строка N файла <file> длиннее 64 КБ. Разбейте строку, затем импортируйте файл снова. | Очень длинные строки отклоняются. |
| Этот член не разбирается и пропускается. | Исправьте строку, указанную в списке проблем. |
| Элемент с этим ID находится внутри <element> в этом проекте. Сначала переместите его на верхний уровень или импортируйте в новый проект. | (Конфликт) Пакет верхнего уровня из JSON уже существует глубже в модели. |
| N его ID элементов используются в другом месте этого проекта. Вместо этого импортируйте в новый проект. | (Конфликт) JSON повторно использует ID других элементов. |
| Текст пакета не разбирается после вывода. Импортируйте его в новый проект. | (Конфликт) Пакет не удалось объединить. |
| N элементов вида <kind> сохранены как импортированные (не интерпретируются): … | (Примечание) Элементы вида, который Holarch не интерпретирует, сохраняются без изменений. См. Элементы, которые Holarch не интерпретирует. |
| Элемент вида <kind> внутри значения не поддерживается и пропускается. | Значение (выражение) содержит элемент, который Holarch не может прочитать. Остальная часть значения сохраняется как текст. |
| Элемент вида <kind> слишком велик, чтобы сохранить его полностью; сохраняются только его вид и ID. | Его JSON больше 256 КБ. |
| Импорт не применён: … Ничего не изменено. | Импорт не удался; проект не изменён. |
| Модель пуста. Добавьте пакет, затем экспортируйте снова. | Экспортировать нечего. |
| Пакета для экспорта больше нет. Выберите другой. | Пакет был удалён, пока страница была открыта. |
Ограничения
| Ограничение | Значение |
|---|---|
| Файлов за один импорт | 2,000 |
Текст .sysml за один импорт (после распаковки) | 8 МБ |
| Zip-архив | 16 МБ, 10 000 записей |
| Вложенность папок в zip-архиве | 32 папки |
| Элементов за один импорт (текст или JSON) | 100,000 |
| Файл JSON | 24 МБ, вложенность 64 уровня |
| JSON одного элемента, который Holarch не интерпретирует | 256 КБ, вложенность 12 уровней |
| Длина строки | 64 КБ |
Файл ReqIF (.reqif или .reqif внутри .reqifz) | 64 МБ; создаваемый из него текст SysML v2 должен укладываться в ограничение текста 8 МБ (примерно от 8000 до 20 000 требований) |
- Ответы репозитория ограничены 64 МБ на всё получение, и каждая операция с репозиторием останавливается через 120 секунд.
- Каждая учётная запись может выполнять не более 300 операций с репозиторием в час.
- Файлы KerML (
.kerml) пока не импортируются. - В размещённом приложении сервер читает импорт объёмом до 1,5 МБ текста
.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. в США и других странах.