README.md

engine-list-view.png

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

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.

Содержание

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

Вы можете запустить 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.

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

Для работы 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, чтобы сохранить подключение.

engine-list-view.png

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

engine-state.png

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

engine-detail-view.png

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

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

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

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

process-list-view.png

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

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

new-process-deployment-view.png

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

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

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

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

start-process-dialog.png

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

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

process-instance-list-view.png

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

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

process-instance-detail-view.png

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

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

user-task-list-view.png

Инциденты

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

incident-list-view.png

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

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

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

  1. Войдите в OpenBPM Control Community с admin/admin.
  2. Перейдите Security → Users и нажмите Create.

    user-list-view.png

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

  4. Нажмите OK.

    user-detail-view.png

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

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

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

    role-assignments-view_1.png

    role-assignments-view_2.png

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

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

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

  1. Docker

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

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

.\gradlew test

По умолчанию тесты выполняются на 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

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

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

Лицензия

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

Конвейеры
0 успешных
0 с ошибкой