Конструктор диаграмм PlantUML

Когда возникает необходимость наглядно отобразить структуру или процесс, в качестве альтернативы графическим редакторам можно использовать PlantUML. Это оpen source платформа, позволяющая описывать диаграммы с помощью простого и понятного текстового языка. Подробнее с возможностями PlantUML можно ознакомиться на сайте plantuml.com.

Конструктор диаграмм PlantUML переведет ваш опыт работы с диаграммами на новый уровень.

Предназначение инструмента

Каждая информационная база «1С:Предприятие» содержит свой уникальный набор объектов: справочники, документы, их реквизиты и т. д. Применительно к проектам на 1С диаграммы обычно строятся с использованием наименований объектов метаданных для узлов и связей.

Цель создания инструмента: упростить процесс создания диаграмм. Конструктор диаграмм PlantUML позволяет выбирать узлы из списка объектов базы 1С или добавлять новые, указывать связи между ними. Это реализовано так же удобно, как при работе в конструкторе запросов 1С. Преимущество инструмента «1С‑Рарус» в том, что в результате формируется текстовое описание диаграммы, которое затем используется open source сервисом PlantUML для создания ее графического представления.

Основные возможности инструмента «Конструктор диаграмм Plant UML»:

• Автоматическая генерация диаграмм на основе списка объектов и связей или текстового описания.
• Изменение визуального оформления объектов диаграмм.
• Графическое отображение структуры и связей таблиц информационной базы 1С, в которой непосредственно работает инструмент.
• Выбор и изменение типа диаграмм для получения различных вариантов анализа одного и того же процесса или структуры данных.
• Сохранение результатов построения диаграмм.

Инструмент распространяется в виде внешней обработки для платформы «1С:Предприятие 8.3». Рекомендуется использовать с версией 1С 8.3.24 и выше. Поддерживает работу в режиме тонкого, толстого и веб‑клиента.

Как работает инструмент

Интерфейс конструктора максимально прост. Сразу после запуска внешней обработки пользователь может приступить к составлению списка объектов для будущей схемы, добавляя новые или выбирая необходимые метаданные из текущей базы 1С (справочники, документы, регистры).

Также предусмотрена возможность отображения и редактирования текста в формате PlantUML. Такой подход добавляет новые возможности редактирования диаграмм и упрощает переносимость: диаграмму, описанную текстом, легко перемещать, делиться ею, хранить и использовать на разных устройствах. Чтобы получить текстовое описание диаграммы, необходимо на панели инструментов открыть меню «Файл» и выбрать пункт «Текст PlantUML».

Визуализация диаграммы в правой части экрана осуществляется автоматически с добавлением в список каждого нового элемента или связи. Это значительно упрощает процесс редактирования, исключая необходимость ручного перемещения элементов, — достаточно внести изменения в состав объектов и их взаимосвязи, после чего диаграмма будет автоматически перестроена.

Элементы диаграммы отображаются в виде дерева, где «узел» является группой, а «связь» — подчиненным элементом. Для более наглядного и логичного отображения объекты, имеющие общий смысл (например, справочники), могут быть объединены в группы.

3 типа диаграмм, которые поддерживает Конструктор PlantUML

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

1. Диаграмма классов:

• Используется для отображения структуры данных, показывая классы, их атрибуты, методы и взаимосвязи между ними (в контексте «1С:Предприятие» классами чаще всего являются объекты метаданных конфигурации).
• Позволяет разработчикам увидеть, как классы взаимодействуют друг с другом, их зависимости и иерархию классов.
• Полезна на этапе проектирования для определения архитектуры системы и для документирования кода.

2. Диаграмма деятельности:

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

3. Диаграмма последовательностей:

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

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

Настройка свойств объектов

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

Настройка общих свойств

Кроме настроек отдельных элементов, можно изменять общие свойства диаграммы: задать стиль, выделить важные детали, выбрать формат изображения для сохранения диаграммы.

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

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

Реализована возможность сохранения диаграммы в виде изображения, выбор формата производится на форме настроек общих свойств диаграммы (доступны PNG или SVG). Эти файлы можно использовать в документации, презентациях или технических заданиях.

Для целей дальнейшего редактирования и совместной работы полученные результаты визуализации можно сохранить в формате текстового файла PlantUML, либо в формате, который содержит все данные и параметры диаграммы и может быть использован другими пользователями в инструменте «Конструктор PlantUML».

Ограничения

Визуализация PlantUML — это бесплатный open source проект, копия которого развернута на сервере «1С‑Рарус» для обеспечения постоянной доступности пользователям. При желании в параметрах инструмента можно задать другой адрес сервиса, развернутого на собственном или любом другом общедоступном сервере. Подробная информация, как развернуть собственный сервер PlantUML: plantuml.com.

Для работы с инструментом требуется наличие интернет‑соединения. Сервис по адресу plantuml.rarus.ru является частью данного инструмента и его использование попадает под лицензионное соглашение в рамках которого распространяется Конструктор диаграмм PlantUML.

Компания «1С‑Рарус» прилагает все усилия для обеспечения круглосуточной доступности сервиса, однако оставляет за собой право на приостановку или внесение изменений в его работу без предварительного уведомления.

Условия использования инструментов «1С‑Рарус»

Команда разработки «1С‑Рарус» приглашает к обсуждению инструментов и пожеланий к их развитию на форум «1С‑Рарус». Все желающие могут принять участие в развитии и сопровождении инструментов: github.com/rarus/dataeditor/blob/main/CONTRIBUTING.md.

Следите за публикациями новых инструментов.