Перейти к основному содержимому

Экспорт и импорт документации

ArchiVision поддерживает выгрузку материалов из модели и загрузку данных из внешних источников.

Экспорт нужен для передачи, публикации, ревью и архивного хранения. Импорт нужен для переноса данных, загрузки API-документации и работы с BPMN XML.

Экспорт диаграмм​

Диаграммы можно выгружать в форматы:

  • PNG — растровое изображение для быстрых документов и презентаций;
  • SVG — векторное изображение для качественной вставки в документы;
  • PlantUML — текстовое представление диаграммы для технического хранения и последующей обработки;
  • PDF — файл для передачи и печати.

Экспорт выполняется из меню «Диаграмма» в редакторе или из контекстного меню строки в разделе «Диаграммы», если действие доступно.

В редакторе откройте «Диаграмма» → «Экспорт» и выберите нужный формат.

Загрузка изображения...
Экспорт диаграммы из редактора в PNG, SVG, PlantUML или PDF.

В списке диаграмм меню строки позволяет быстро выгрузить SVG или PlantUML, а также сформировать отчёт.

Загрузка изображения...
Быстрый экспорт SVG и PlantUML из списка диаграмм.

Пошаговое описание находится в разделе «Меню диаграммы».

Экспорт спецификаций UseCase-ов​

Документационное представление UseCase-а можно выгрузить в статический HTML.

В экспорт попадают:

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

Альтернативные последовательности, скрытые текущим пользователем, в HTML не включаются. Исключается вся ветка вместе с вложенными шагами, изображениями и свойствами этих шагов. Перед скачиванием проверьте значки глаза в спецификации UseCase-а и оставьте видимыми только нужные для документа ветки.

Это правило относится к персональному HTML-экспорту документации. Скрытие не удаляет шаги из потока и не меняет представление других пользователей.

Загрузка изображения...
Значок перечёркнутого глаза исключает выбранную альтернативную ветвь из персонального HTML-экспорта, не удаляя её из модели.

Как открыть спецификацию, выбрать поток и скачать HTML, описано в разделе «Экспорт UseCase-спецификации».

Наведите указатель на кнопку с пиктограммой файла и выберите «Скачать одним HTML-файлом».

Загрузка изображения...
Команда экспорта находится в правой части верхней панели документационного представления.

В полученный файл встроены диаграммы, изображения и стили. Его можно открыть локально без входа в ArchiVision и передать как согласованный слепок документации.

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

Экспорт отчетов активности​

На вкладке «Обзор» → «Отчеты» → «Активность» можно выгрузить HTML-отчет по активности.

Такой отчет показывает:

  • выбранный период;
  • общее количество действий;
  • активных пользователей;
  • домены с изменениями;
  • направления работы;
  • активность по месяцам;
  • вклад пользователей;
  • вклад доменов.

Используйте отчет активности для регулярных ревью, контроля развития модели и подготовки управленческих материалов.

Загрузка изображения...
Выгруженный отчет сохраняет показатели, таблицы и графики и открывается без доступа к ArchiVision.

Экспорт BPMN​

Для диаграмм типа BPMN_PROCESS доступно копирование BPMN XML через кнопку «Скопировать XML» в BPMN-редакторе.

Загрузка изображения...
Редактор подтверждает копирование полного BPMN XML в буфер обмена.

Используйте XML, если нужно:

  • передать процесс в другой BPMN-инструмент;
  • сохранить процесс вне ArchiVision;
  • сравнить XML до и после изменения;
  • подготовить шаблон для импорта.

Перед передачей XML проверьте, что процесс сохранён кнопкой «Сохранить BPMN», а не остался только в локальном черновике.

Экспорт ландшафта​

Ландшафт можно выгрузить для переноса или резервного хранения. Пошаговая инструкция находится в разделе «Экспорт ландшафта».

Загрузка изображения...
Master включается всегда; дополнительные рабочие ветки выбираются явно перед скачиванием ZIP-архива.

Экспорт используется, когда нужно:

  • перенести модель между окружениями;
  • сохранить состояние архитектуры;
  • передать данные другой команде;
  • подготовить архив перед крупными изменениями.

Перед экспортом проверьте, какая ветка выбрана. Если нужен утвержденный слепок, работайте с master.

Персональные настройки видимости альтернативных последовательностей не входят в файл экспорта ландшафта. Экспортируется полная архитектурная модель со всеми шагами потоков данных.

Импорт ландшафта​

Импорт позволяет загрузить ранее выгруженный ландшафт. Пошаговая инструкция находится в разделе «Импорт ландшафта».

После выбора ZIP-файла ArchiVision сначала сканирует архив и показывает состав модели. Импорт данных запускается отдельной кнопкой.

Загрузка изображения...
Перед импортом показаны версия формата и количество ландшафтов, доменов, диаграмм, элементов, связей, свойств и UseCase-ов.

После завершения появляется сводка фактически импортированных объектов и команда перехода к новому ландшафту.

Загрузка изображения...
Итоговая сводка подтверждает созданные объекты и позволяет открыть импортированный ландшафт.

Перед импортом рекомендуется:

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

Персональные настройки скрытых альтернатив не импортируются. В новом ландшафте все альтернативные последовательности по умолчанию видимы для каждого пользователя.

Импорт API-документации​

Для элементов, предоставляющих интерфейсы, можно импортировать API-документацию. Пошаговая инструкция находится в разделе «Как импортировать API-документацию».

Выберите компонент-владелец, источник «Файл описания API» и JSON-файл спецификации. Операции, которых ещё нет у этого элемента, добавляются в реестр вместе с описаниями запросов и ответов.

Загрузка изображения...
Спецификация загружается для выбранного компонента Order processor в домене Orders.

Повторный импорт добавляет только новые операции. Совпадение определяется элементом-владельцем, HTTP-методом и путём. Для совпавшей операции сохраняются идентификатор, описание, запрос и ответ, даже если в новом файле они изменены. Поэтому повторный импорт не заменяет проверку и редактирование существующих контрактов.

Загрузка изображения...
Добавлена операция истории событий. Прежние строки и ручное описание операции оформления сохранены.

Учебные файлы: первая версия OpenAPI и вторая версия. Во второй версии добавлена операция истории событий, изменено описание оформления заказа и добавлено поле salesChannel в его запрос.

После проверки контракта интерфейсы можно привязать к интеграционным шагам потоков данных.

Импорт BPMN XML​

В BPMN-редакторе используйте кнопку «Вставить XML».

  1. Откройте BPMN-диаграмму.
  2. Нажмите «Вставить XML».
  3. Вставьте полный BPMN XML.
  4. Нажмите «Загрузить XML».
  5. Проверьте процесс на полотне.
  6. Восстановите или уточните привязки к потокам, шагам и объектам модели.
  7. Нажмите «Сохранить BPMN».
Загрузка изображения...
Полный XML процесса вставляется в текстовое поле и загружается в BPMN-редактор.

Если XML некорректен, редактор покажет ошибку импорта. В этом случае проверьте синтаксис XML и совместимость BPMN-элементов.

Share вместо экспорта​

Если нужно дать временный доступ без отправки файла, используйте шаринг диаграмм.

Share-ссылка удобна, когда:

  • получатель должен смотреть актуальное состояние диаграммы;
  • нужны свойства, интерфейсы или потоки;
  • нужно включить документацию;
  • нужно разрешить AI-вопросы по диаграмме;
  • доступ должен истечь автоматически.

Экспорт лучше использовать, когда нужно зафиксировать слепок на конкретный момент.

Краевые случаи​

Экспорт недоступен​

Проверьте:

  • права пользователя;
  • read-only/share режим;
  • настройки Lock;
  • доступность функции в окружении;
  • выбран ли корректный контекст.

HTML не содержит ожидаемых данных​

Проверьте:

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

После импорта BPMN пропали привязки​

Если XML заменяет структуру процесса, идентификаторы BPMN-элементов могут измениться. Проверьте панель привязки и заново свяжите BPMN-элементы с потоками, шагами и объектами модели.

Связанные разделы​

Видеоурок: Импорт и обновление OpenAPI​

Практический сценарий: импорт и обновление openapi.

Видеоурок: Экспорт аналитики​

Практический сценарий: экспорт аналитики.