Веб-сайт | Документация | Новостной канал | Чат поддержки

OpenBPM Control Community - это веб-приложение, предоставляющее административные функции для внешних BPM движков.

Основные возможности

• Connection Management: Простая настройка подключений к различным BPM движкам и переключение между ними при необходимости.
• Process Browsing: Навигация по процессам, развернутым в движке.
• Process Deployment: Развертывание новой версии бизнес-процесса с удобным предпросмотром диаграммы.
• Instance Management: Управление экземплярами процессов, запущенных в BPM движке.
• User Task Management: Просмотр пользовательских задач с возможностью их переназначения.

[!NOTE] В настоящее время поддерживается только Camunda 7.

OpenBPM Control Community создан с использованием open-source фреймворка Jmix.

Содержание

• Запуск приложения
  • Docker Image
  • Исходный код
• Использование
  • Подключение к BPM Engines
  • Работа с процессами
    • Развертывание процесса
    • Запуск процесса
  • Управление экземплярами процессов
  • Пользовательские задачи
  • Инциденты
  • Настройка пользователей
• Запуск тестов
  • Запуск интеграционных тестов
  • Запуск UI тестов
• Лицензия

Запуск приложения

Вы можете запустить OpenBPM Control Community с использованием Docker image или из исходного кода.

Docker Image

Этот способ позволяет запустить OpenBPM Control Community с использованием заранее собранного Docker image.

Необходимые условия:

Установите следующие компоненты:

1. Docker
2. Docker Compose

Инструкции можно найти здесь.

Исходный код

Этот способ позволяет собрать и запустить OpenBPM Control Community локально с помощью Gradle.

Необходимые условия:

Установите следующие компоненты:

1. Git
2. Java 21 (JDK и JRE)
3. PostgreSQL

Инструкция:

1. Клонируйте репозиторий: shell git clone https://gitflic.ru/project/openbpm/openbpm-control-community.git

2. Настройте базу данных PostgreSQL. OpenBPM Control Community хранит данные, такие как подключения к BPM движкам, в базе данных. По умолчанию используется база PostgreSQL:

   • Имя: openbpm-control
   • Username для подключения: root
   • Password для подключения: root

3. Перейдите в каталог склонированного проекта и откройте терминал.

4. Выполните команду:

    .\gradlew bootRun
   

   Приложение будет доступно в браузере по адресу http://localhost:8081.

Примечание: bootRun активирует профиль Spring dev, который для удобства предзаполняет форму входа учётными данными по умолчанию admin/admin. Production-сборки (bootJar) не активируют этот профиль, поэтому форма входа остаётся пустой. При запуске приложения напрямую из IDE (запуск главного класса Application вместо bootRun) добавьте dev в активные профили конфигурации запуска, чтобы получить такое же поведение.

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

OpenBPM Control Community требует аутентифицированного доступа. Изначально предоставляется административный пользователь с учётными данными admin/admin. Чтобы добавить больше пользователей, см. раздел Настройка пользователей.

Подключение к BPM Engines

Чтобы добавить подключение к работающему BPM движку, выполните шаги:

1. Перейдите в BPM engines в меню приложения.
2. Нажмите Create.
3. В New BPM engine заполните:
   • Name: краткое имя сервера, где запущен BPM движок (например, Dev stand).
   • Base URL.
4. Если целевой BPM движок требует аутентификацию, установите флажок Enabled в группе Authentication и настройте учетные данные.
5. Нажмите OK, чтобы сохранить подключение.

Вы можете настроить любое количество подключений. В правом верхнем углу отображается, к какому движку сейчас подключен OpenBPM Control Community.

Чтобы переключиться на другой движок, нажмите Edit рядом со статусом подключения.

Работа с процессами

Чтобы просмотреть бизнес-процессы, развернутые в выбранном BPM движке, выберите Processes в меню приложения. В Processes можно фильтровать и сортировать процессы. По умолчанию отображаются только последние версии.

Доступные действия:

• Refresh: обновить список процессов.
• Deploy: загрузить BPMN 2.0 XML в BPM движок.
• Remove: удалить выбранные процессы и связанные экземпляры.
• Activate: активировать приостановленные процессы.
• Suspend: приостановить активные процессы.
• View: просмотреть детали развернутого процесса (диаграмму, XML и т. д.).

Развертывание процесса

Нажмите Deploy в Processes, чтобы загрузить новый процесс или новую версию. Откроется New process deployment.

Загрузите BPMN 2.0 файл кнопкой Upload, просмотрите диаграмму и нажмите OK.

Запуск процесса

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

1. Нажмите View.
2. Добавьте переменные в Start process.
3. Нажмите Start.

Управление экземплярами процессов

Выберите Process instances в меню. В представлении можно фильтровать и сортировать экземпляры (по умолчанию отображаются только активные).

При выборе конкретного экземпляра откроются его данные (история, переменные, активности).

Доступные действия: просмотр, приостановка, активация.

Пользовательские задачи

В User tasks отображаются активные задачи пользователей. Их можно фильтровать, завершать или переназначать.

Инциденты

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

Настройка пользователей

Пользователи хранятся в таблице USER_.

Добавление пользователей

1. Войдите в OpenBPM Control Community с admin/admin.

2. Перейдите Security → Users и нажмите Create.

   

3. Заполните поля (Username, Password).

4. Нажмите OK.

   

Права пользователей

По умолчанию у новых пользователей нет прав. Чтобы выдать права:

1. Выберите пользователя → Role assignments.
2. Добавьте роль Full Access.

3. Сохраните.

   

   

Теперь пользователь может войти и работать с системой.

Запуск тестов

Запуск интеграционных тестов

Необходимые условия:

1. Docker

Тесты используют Testcontainers, поэтому ничего заранее поднимать не нужно.

Запуск всех тестов:

.\gradlew test -PintergationTests

По умолчанию тесты выполняются на Camunda Run 7.22 без аутентификации. Можно запускать с профилем test-engine, указывая параметры:

• openbpm.control.testing.engine.type - тип движка (поддерживается только camunda_7).
• openbpm.control.testing.engine.docker-image - docker image движка.
• openbpm.control.testing.engine.auth-type - тип аутентификации (например, Basic).

Пример запуска с переменными окружения:

SPRING_PROFILES_INCLUDE=test-engine;OPENBPM_CONTROL_TESTING_ENGINE_DOCKER_IMAGE=camunda/camunda-bpm-platform:run-7.21.0 .\gradlew test -PintergationTests

Пример запуска с параметрами Gradle:

.\gradlew test -PintergationTests -Dspring.profiles.include=test-engine -Dcontrol.testing.engine.docker-image=camunda/camunda-bpm-platform:run-7.21.0

Запуск UI тестов

Предварительные требования:

Убедитесь, что запущены следующие компоненты:

1. Внешний экземпляр OpenBPM Control:
   • Запущен с Spring-профилем ui-test
   • Подключен к базе данных, поддерживающей множественные соединения (например, PostgreSQL)
2. Внешний запущенный экземпляр BPM-движка (например, Camunda 7)

Пример: Запуск OpenBPM Control из исходных кодов для UI тестов

MacOS и Linux:

./gradlew bootRun -Dspring.profiles.active=ui-test

Windows:

.\gradlew bootRun "-Dspring.profiles.active=ui-test"

Пример: Запуск тестов для Camunda 7 без аутентификации, запущенного локально на порту 8088

MacOS и Linux:

./gradlew test -PuiTests -Dopenbpm.control.testing.ui.engine.rest-base-url=http://localhost:8088/engine-rest

Windows:

.\gradlew test -PuiTests "-Dopenbpm.control.testing.ui.engine.rest-base-url=http://localhost:8088/engine-rest"

Полный список доступных свойств можно найти в файле application-ui-test.properties.

Лицензия

OpenBPM Control Community - open-source проект, распространяемый под лицензией Apache 2.0.