События

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

Типы элементов событий

У события есть позиция в процессе и триггер. По позиции событие может быть одним из следующих:

  • Начальное событие запускает экземпляр процесса или подпроцесс. В событийном подпроцессе его триггер запускает событийный подпроцесс.

  • Промежуточное событие находится на потоке операций между двумя элементами.

  • Граничное событие прикреплено к действию: задаче, подпроцессу или вызову процесса. Оно реагирует на свой триггер, пока действие выполняется. Исключение — граничное событие компенсации: оно становится активным, когда действие завершается. Чтобы прикрепить событие на экране Modeler, перетащите промежуточное событие из палитры на границу действия.

  • Конечное событие завершает путь.

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

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

Промежуточное перехватывающее событие — это состояние ожидания: процесс останавливается на нем, движок фиксирует транзакцию и сохраняет состояние процесса, а когда приходит триггер, процесс продолжается. Сообщения и сигналы движок ждет через подписки на события, а таймеры — через задания таймеров.

Граничные события и начальные события событийных подпроцессов могут быть прерывающими или непрерывающими. События ошибки и отмены всегда прерывающие.

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

  • Прерывающее начальное событие событийного подпроцесса отменяет все остальное в своей области. Когда событийный подпроцесс завершается, завершается и область.

  • Непрерывающее событие запускает свой путь параллельно, а действие или область продолжает выполняться.

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

В следующей таблице показаны события по триггеру и позиции:

Триггер Начальное Промежуточное перехватывающее Промежуточное генерирующее Граничное Конечное

Пустое

none start

none intermediate throwing

none end

Сообщение

message start

message intermediate catching

message boundary

Таймер

timer start

timer intermediate catching

timer boundary

Ошибка

error start

error boundary

error end

Эскалация

escalation start

escalation intermediate throwing

escalation boundary

escalation end

Отмена

cancel end

Компенсация

compensation intermediate throwing

compensation boundary

Сигнал

signal none

signal intermediate catching

signal intermediate throwing

signal boundary

Завершение

terminate end

Jmix BPM поддерживает не все события BPMN 2.0. См. Поддержка событий BPMN.

Выбор события

Задача Событие

Запустить процесс с экрана Start process или из кода

Пустое начальное событие

Запускать процесс по расписанию

Начальное событие таймера

Приостановить процесс на время или до определенной даты

Промежуточное перехватывающее событие таймера

Напомнить исполнителю или предпринять дальнейшие действия, если задача выполняется слишком долго

Граничное событие таймера: непрерывающее, чтобы сохранить задачу; прерывающее, чтобы отменить ее

Запустить процесс, когда код отправляет именованное сообщение

Начальное событие сообщения

Ждать, пока код сообщит что-то об одном экземпляре процесса, например о полученном платеже

Промежуточное перехватывающее событие сообщения или граничное событие сообщения

Уведомить сразу много экземпляров процессов, например об изменении прайс-листа

События сигнала

Уйти с обычного пути из-за бизнес-сбоя, например отклоненного платежа

События ошибки

Сообщить о ситуации охватывающей области, с остановкой работы или без нее

События эскалации

Отменить результаты завершенных шагов

События компенсации

Отменить транзакционный подпроцесс и отменить результаты его завершенных шагов

События отмены

Остановить все параллельные пути, когда завершается один путь

Завершить конечное событие

Отметить промежуточный этап

Пустое промежуточное генерирующее событие

Некоторые события легко перепутать:

  • Сообщение или сигнал. Сообщение приходит одному исполнению, которое выбирает ваш код, или запускает один процесс. Сигнал приходит каждому событию, которое его ждет. Используйте сигнал, только если должны отреагировать все ожидающие экземпляры процессов.

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

  • Пустое конечное событие или элемент «Завершить конечное событие». Пустое конечное событие завершает только свой путь, а параллельные пути продолжаются. Элемент «Завершить конечное событие» завершает все пути в своей области.

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

Подписки на события

Подписка на событие — это запись, которая сообщает движку процессов, что процесс ждет сообщение или сигнал. Через подписки ждут только события сообщения и сигнала. Таймеры используют задания таймеров, см. События таймера. Событиям ошибки и эскалации не нужно ни то, ни другое: движок ищет перехватывающее событие, когда генерируется ошибка или эскалация.

Движок создает подписки так:

  • Начальные события — начальное событие сообщения или сигнала процесса получает подписку при развертывании определения процесса. Когда приходит сообщение или сигнал, запускается новый экземпляр процесса.

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

Движок хранит подписки в таблице базы данных ACT_RU_EVENT_SUBSCR.

API подписок на события

Запрос подписок на события

Можно запросить существующие подписки на события, чтобы увидеть, какие процессы ждут определенных событий. Например:

List<EventSubscription> messageSubscriptions = runtimeService.createEventSubscriptionQuery()
    .eventType("message")
    .list();

Получение подписок на события

Список подписок можно получить через API RuntimeService. Например, подписки на сигналы:

// Query for all signal event subscriptions
List<EventSubscription> signalSubscriptions = runtimeService.createEventSubscriptionQuery()
    .eventType("signal")
    .list();

Для подписок на сообщения используйте "message". Движок также хранит подписки "compensate" для завершенных действий, у которых есть обработчик компенсации.

Для таймеров используйте ManagementService:

List<Job> timerJobs = managementService.createTimerJobQuery().list();

Срабатывание подписок на события

Подписку на событие можно активировать, когда происходит соответствующее событие. Например, чтобы активировать событие сообщения:

runtimeService.messageEventReceived("orderPlaced", executionId, processVariables);

Обработка событий слушателями

См. раздел Event Listeners.

Пустые события

У пустого события нет триггера. Большинство процессов начинаются с пустого начального события и заканчиваются пустыми конечными событиями. См. None Start Event и Intermediate Throwing None Event в документации Flowable.

Событие Использование

Пустое начальное событие

Запускает экземпляр процесса, когда пользователь запускает процесс на экране Start process или код вызывает runtimeService.startProcessInstanceByKey() с id процесса. На уровне процесса может быть только одно пустое начальное событие. Со вторым процесс не развертывается и возникает ошибка Multiple none start events are not supported. Начальное событие встроенного подпроцесса всегда пустое.

Пустое промежуточное генерирующее событие

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

Пустое конечное событие

Завершает текущий путь. Экземпляр процесса завершается, когда не остается активных путей.

Свойства пустых событий

На экране Modeler можно задать следующие свойства пустых событий:

Свойство

Описание

Id

Идентификатор элемента. Он генерируется автоматически, но его можно заменить на более понятный, чтобы логи было проще читать.

Name

Имя элемента.

Form

Пользовательский интерфейс, который показывается при запуске процесса вручную. См. Процессные формы.

Process variables

Параметры для запуска процесса через API. Доступны, если форма не задана.

Execution listeners

См. Слушатели выполнения.

Asynchronous execution

  • Asynchronous

  • Exclusive

  • Asynchronous leave

  • Asynchronous leave exclusive

Начиная с Jmix 3.1

Documentation

Описание и дополнительные сведения об элементе.

У пустого начального события есть все эти свойства. В подпроцессе у него нет свойства Form. У пустого конечного события есть Id, Name, Asynchronous, Exclusive и Documentation. У пустого промежуточного генерирующего события есть только Id и Name.

Пример

В этом примере пустое промежуточное генерирующее событие Address validated отмечает, что задача Validate address завершена. Процесс проходит событие и переходит к задаче Send parcel.

none intermediate event example

XML этого примера:

<process id="parcel-delivery" isExecutable="true">
  <startEvent id="start" /> (1)
  . . .
  <serviceTask id="validate-address" name="Validate address" ... />
  . . .
  <intermediateThrowEvent id="address-validated" name="Address validated" /> (2)
  . . .
  <endEvent id="end" /> (3)
</process>
1 У пустого начального события нет определения события.
2 Пустое промежуточное генерирующее событие.
3 Пустое конечное событие.

События таймера

Событие таймера срабатывает в заданную дату, по истечении длительности или в повторяющемся цикле. Используйте таймеры, чтобы запускать процессы по расписанию, приостанавливать процесс, а также задавать сроки и напоминания для задач. Таймеры выполняет исполнитель заданий. См. Timer Event Definitions в документации Flowable.

Чтобы добавить событие таймера на экране Modeler, нажмите значок Change type change type icon начального, промежуточного или граничного события и выберите вариант с таймером.

Событие Использование

Начальное событие таймера

Запускает экземпляр процесса, когда срабатывает таймер. Циклический таймер запускает экземпляр при каждом срабатывании. Движок создает таймер при развертывании процесса, а развертывание новой версии процесса заменяет его. У процесса, запущенного таймером, нет переменной initiator, потому что его не запускает пользователь.

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

Промежуточное перехватывающее событие таймера

Процесс ждет на событии, пока не сработает таймер. Событие — это состояние ожидания.

Граничное событие таймера

Срабатывает по таймеру, если действие, к которому оно прикреплено, еще активно. Может быть прерывающим или непрерывающим.

Значения таймера

Свойство Timer type определяет, как движок читает значение таймера:

Timer type Значение Примеры

Duration

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

PT8H: 8 часов.

P5D: 5 дней.

Date

Дата и время в формате ISO 8601. Если дата уже прошла, таймер срабатывает сразу.

2035-06-17T09:00:00

Cycle

Повторяющийся интервал в формате ISO 8601 или cron-выражение. Первое поле cron-выражения — секунды.

R3/PT10H: 3 раза, каждые 10 часов.

0 0 9 ? * MON: каждый понедельник в 9:00.

Значением может быть выражение, которое возвращает такую строку, например ${reviewPeriod}. Используйте cron-выражения только с типом Cycle. С другими типами движок не может создать таймер и выбрасывает исключение couldn’t resolve duedate.

Свойства событий таймера

На экране Modeler можно задать следующие свойства событий таймера:

Свойство

Описание

Id

Идентификатор элемента. Он генерируется автоматически, но его можно заменить на более понятный, чтобы логи было проще читать.

Name

Имя элемента.

Timer type

Duration, Date или Cycle. См. Значения таймера.

Duration, Date, Cycle

Значение таймера для выбранного типа.

Business calendar

Бизнес-календарь, по которому рассчитывается таймер. Доступно, если установлено дополнение Business Calendars.

Execution listeners

См. Слушатели выполнения.

Asynchronous execution

  • Asynchronous

  • Exclusive

  • Asynchronous leave

  • Asynchronous leave exclusive

Начиная с Jmix 3.1

Documentation

Описание и дополнительные сведения об элементе.

У промежуточных и граничных событий таймера нет свойств Execution listeners и Documentation. У начального события таймера также есть раздел Process variables, как и у пустого начального события.

Пример

В этом примере процесс запускается каждый понедельник в 9:00. У пользовательской задачи Write report два граничных события таймера. Через час непрерывающее событие 1 hour создает задачу Remind performer, а Write report остается активной. Через пять дней прерывающее событие 5 days отменяет Write report и создает задачу Escalate issue. Когда отчет написан, событие Next day задерживает процесс на день перед задачей Check report.

timer events example

XML этого примера:

<process id="weekly-report" isExecutable="true">
  <startEvent id="every-week" name="Every week">
    <timerEventDefinition>
      <timeCycle>0 0 9 ? * MON</timeCycle> (1)
    </timerEventDefinition>
  </startEvent>
  . . .
  <userTask id="write-report" name="Write report" />
  <boundaryEvent id="one-hour" name="1 hour" attachedToRef="write-report"
      cancelActivity="false"> (2)
    <timerEventDefinition>
      <timeDuration>PT1H</timeDuration>
    </timerEventDefinition>
  </boundaryEvent>
  <boundaryEvent id="five-days" name="5 days" attachedToRef="write-report"> (3)
    <timerEventDefinition>
      <timeDuration>P5D</timeDuration>
    </timerEventDefinition>
  </boundaryEvent>
  . . .
  <intermediateCatchEvent id="next-day" name="Next day">
    <timerEventDefinition>
      <timeDuration>P1D</timeDuration>
    </timerEventDefinition>
  </intermediateCatchEvent>
  . . .
</process>
1 Cron-выражение: каждый понедельник в 9:00.
2 Непрерывающее граничное событие.
3 Прерывающее граничное событие. Отсутствие cancelActivity равносильно значению true.

События сообщения

Событие сообщения ждет сообщение, которое ваш код отправляет экземпляру процесса, или запускает экземпляр процесса, когда приходит сообщение. Используйте его, когда другая система или ваше приложение должны известить один конкретный экземпляр процесса о чем-то, например о поступлении платежа. См. Message Event Definitions в документации Flowable.

Чтобы добавить событие сообщения на экране Modeler, нажмите значок Change type change type icon начального, промежуточного или граничного события и выберите вариант с сообщением.

Событие Использование

Начальное событие сообщения

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

Промежуточное перехватывающее событие сообщения

Процесс ждет на событии, пока не получит сообщение. Событие — это состояние ожидания.

Граничное событие сообщения

Перехватывает сообщение, пока действие, к которому оно прикреплено, активно. Может быть прерывающим или непрерывающим.

Jmix BPM не поддерживает промежуточные генерирующие события сообщения и конечные события сообщения. См. Генерирующее событие сообщения.

Отправка сообщений

События сообщения ссылаются на определения сообщений процесса. У определения есть id и имя. Определениями можно управлять в свойствах процесса или добавить определение из события, выбрав Create new…​ в его поле Message.

Ваш код отправляет сообщения через RuntimeService и передает имя сообщения, а не id:

  • startProcessInstanceByMessage(messageName) запускает экземпляр процесса на начальном событии сообщения. Если ни у одного развернутого процесса нет начального события для этого сообщения, вызов завершается ошибкой no subscription to message with name …​ found. Сообщение может запускать только один процесс: развертывание другого процесса с начальным событием для того же сообщения завершается ошибкой there already is a message event subscription for the message with name …​.

  • messageEventReceived(messageName, executionId) доставляет сообщение исполнению, которое его ждет. Если исполнение не ждет этого сообщения, вызов завершается ошибкой does not have a subscription to a message event with name …​. Найдите исполнение по имени сообщения:

    Execution execution = runtimeService.createExecutionQuery()
            .processInstanceId(processInstanceId)
            .messageEventSubscriptionName("Payment received")
            .singleResult();
    runtimeService.messageEventReceived("Payment received", execution.getId());

У обоих методов есть варианты, которые также передают переменные процесса. После сообщения процесс выполняется в транзакции вызова до следующего состояния ожидания. Если следующий шаг выбрасывает исключение, вызов завершается ошибкой, а процесс остается на событии. См. Throwing a Message Event в документации Flowable.

Свойства событий сообщения

На экране Modeler можно задать следующие свойства событий сообщения:

Свойство

Описание

Id

Идентификатор элемента. Он генерируется автоматически, но его можно заменить на более понятный, чтобы логи было проще читать.

Name

Имя элемента.

Message

Определение сообщения, на которое ссылается событие. Если оно не задано, процесс не развертывается и возникает ошибка attribute 'messageRef' or 'messageExpression' is required.

Execution listeners

См. Слушатели выполнения.

Asynchronous execution

  • Asynchronous

  • Exclusive

  • Asynchronous leave

  • Asynchronous leave exclusive

Начиная с Jmix 3.1

Documentation

Описание и дополнительные сведения об элементе.

У промежуточных и граничных событий сообщения нет свойств Execution listeners и Documentation. У начального события сообщения также есть раздел Process variables, как и у пустого начального события.

Пример

В этом примере процесс ждет на промежуточном перехватывающем событии сообщения после Activity 1. Когда ваш код доставляет сообщение Payment received ожидающему исполнению, как показано в разделе Отправка сообщений, процесс переходит к Activity 2.

message intermediate example

XML этого примера:

<definitions ...>
  <message id="payment-received" name="Payment received" /> (1)

  <process id="order-processing" isExecutable="true">
    . . .
    <intermediateCatchEvent id="payment-received-catch">
      <messageEventDefinition messageRef="payment-received" /> (2)
    </intermediateCatchEvent>
    . . .
  </process>
</definitions>
1 Определение сообщения. Код обращается к сообщению по имени.
2 Перехватывающее событие ссылается на определение по id.

События сигнала

Событие сигнала генерирует сигнал или перехватывает его. Сгенерированный сигнал доходит до каждого события, которое его ждет: во всех экземплярах процессов или, если у сигнала область Process instance, только в том же экземпляре процесса. Используйте сигналы, чтобы сразу известить многие экземпляры процессов о чем-то, например о закрытии магазина. См. Signal Event Definitions в документации Flowable.

Чтобы добавить событие сигнала на экране Modeler, нажмите значок Change type change type icon начального, промежуточного или граничного события и выберите вариант с сигналом.

Событие Использование

Начальное событие сигнала

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

Промежуточное перехватывающее событие сигнала

Процесс ждет на событии, пока не будет сгенерирован сигнал. Событие — это состояние ожидания.

Граничное событие сигнала

Перехватывает сигнал, пока действие, к которому оно прикреплено, активно. Может быть прерывающим или непрерывающим.

Промежуточное генерирующее событие сигнала

Генерирует сигнал. Затем процесс продолжается по исходящему потоку операций.

Jmix BPM не поддерживает конечные события сигнала. См. Генерирующее конечное событие сигнала.

Генерация сигналов

События сигнала ссылаются на определения сигналов процесса. У определения есть id, имя и область. Определениями можно управлять в свойствах процесса или добавить определение из события, выбрав Create new…​ в его поле Signal.

Ваш код генерирует сигнал через RuntimeService и передает имя сигнала, а не id:

runtimeService.signalEventReceived("Shop closed");

Движок доставляет сигнал в транзакции кода или экземпляра процесса, который его генерирует. Если перехватывающий экземпляр процесса завершается исключением, генерирующая сторона тоже завершается ошибкой и ее транзакция откатывается. Чтобы доставлять сигнал асинхронно, задайте flowable:async="true" в элементе signalEventDefinition генерирующего события в XML. Свойство Asynchronous делает асинхронным только само событие. См. Throwing a Signal Event в документации Flowable.

Свойства событий сигнала

На экране Modeler можно задать следующие свойства событий сигнала:

Свойство

Описание

Id

Идентификатор элемента. Он генерируется автоматически, но его можно заменить на более понятный, чтобы логи было проще читать.

Name

Имя элемента.

Signal

Определение сигнала, на которое ссылается событие. Если оно не задано, процесс не развертывается и возникает ошибка signalEventDefinition does not have a 'signalRef' or a 'signalExpression'.

Execution listeners

См. Слушатели выполнения.

Asynchronous execution

  • Asynchronous

  • Exclusive

  • Asynchronous leave

  • Asynchronous leave exclusive

Начиная с Jmix 3.1

Documentation

Описание и дополнительные сведения об элементе.

У промежуточных и граничных событий сигнала нет свойств Execution listeners и Documentation. У начального события сигнала также есть раздел Process variables, как и у пустого начального события.

Пример

В этом примере граничное событие сигнала Shop closed прерывает задачу Prepare order и процесс переходит к задаче Cancel order. У сигнала глобальная область, поэтому один вызов signalEventReceived("Shop closed") отменяет заказы во всех экземплярах процессов, которые ждут на Prepare order.

signal example

XML этого примера:

<definitions ...>
  <signal id="shop-closed" name="Shop closed" flowable:scope="global" /> (1)

  <process id="order-processing" isExecutable="true">
    . . .
    <userTask id="prepare-order" name="Prepare order" />
    <boundaryEvent id="shop-closed-catch" name="Shop closed"
        attachedToRef="prepare-order">
      <signalEventDefinition signalRef="shop-closed" /> (2)
    </boundaryEvent>
    . . .
  </process>
</definitions>
1 Определение сигнала с глобальной областью.
2 Граничное событие ссылается на определение по id.

События ошибки

Событие ошибки генерирует или перехватывает ошибку BPMN: бизнес-ошибку, которую процесс обрабатывает на альтернативном пути, например отклоненный платеж. Перехватывающие события ошибки всегда прерывающие. Java-код генерирует ошибку BPMN как BpmnError. События ошибки не перехватывают другие исключения: такие исключения откатывают транзакцию до последнего состояния ожидания. См. Error Event Definitions в документации Flowable и Обработка ошибок.

Чтобы добавить событие ошибки на экране Modeler, нажмите значок Change type change type icon конечного события, граничного события или начального события внутри событийного подпроцесса и выберите вариант с ошибкой.

Событие Использование

Начальное событие ошибки

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

Граничное событие ошибки

Перехватывает ошибки, сгенерированные внутри действия, к которому оно прикреплено: событием завершения ошибки в подпроцессе или Java-кодом, который вызывает сервисная задача. Отменяет действие, и процесс продолжается по исходящему потоку операций события.

Событие завершения ошибки

Генерирует ошибку и завершает текущий путь.

Сопоставление ошибок

События ошибки ссылаются на определения ошибок процесса. У определения есть id, имя и необязательный код ошибки. Определениями можно управлять в свойствах процесса или добавить определение из события, выбрав Create new…​ в его поле Error.

Движок сопоставляет генерирующие и перехватывающие события по коду ошибки:

  • Событие без заданной ошибки или с определением ошибки без кода перехватывает любую ошибку.

  • Генерирующее событие с определением ошибки без кода соответствует любому перехватывающему событию, поэтому задавайте код для ошибок, которые генерируете.

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

  • Событие завершения ошибки должно ссылаться на определение ошибки. Иначе процесс завершается ошибкой, когда доходит до события: Error Code must not be null.

  • Ошибки, которые генерирует Java-код, например new BpmnError("PAYMENT_FAILED"), сопоставляются по коду так же.

  • Если ошибку не перехватывает ни одно событие, движок выбрасывает исключение No catching boundary event found for error with errorCode …​.

Свойства событий ошибки

На экране Modeler можно задать следующие свойства событий ошибки:

Свойство

Описание

Id

Идентификатор элемента. Он генерируется автоматически, но его можно заменить на более понятный, чтобы логи было проще читать.

Name

Имя элемента.

Error

Определение ошибки, которую событие генерирует или перехватывает. Оставьте его пустым у перехватывающего события, чтобы перехватывать любую ошибку.

Execution listeners

См. Слушатели выполнения.

Asynchronous execution

  • Asynchronous

  • Exclusive

  • Asynchronous leave

  • Asynchronous leave exclusive

Начиная с Jmix 3.1

Documentation

Описание и дополнительные сведения об элементе.

У начального события ошибки также есть раздел Process variables, как и у пустого начального события. У событий завершения ошибки нет свойств Asynchronous leave и Asynchronous leave exclusive.

Пример

В этом примере событие завершения ошибки подпроцесса генерирует ошибку Failure после задачи Do something. Граничное событие ошибки отменяет подпроцесс, и процесс переходит к задаче Handle error.

error end event in subprocess

XML этого примера:

<definitions ...>
  <error id="failure" name="Failure" errorCode="FAILURE" /> (1)

  <process id="error-handling" isExecutable="true">
    <subProcess id="subprocess">
      . . .
      <endEvent id="error-end">
        <errorEventDefinition errorRef="failure" /> (2)
      </endEvent>
    </subProcess>
    <boundaryEvent id="error-catch" attachedToRef="subprocess">
      <errorEventDefinition errorRef="failure" /> (3)
    </boundaryEvent>
    . . .
  </process>
</definitions>
1 Определение ошибки.
2 Событие завершения ошибки ссылается на определение.
3 Граничное событие перехватывает ошибки с кодом FAILURE.

События эскалации

Начиная с Jmix 3.1

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

На экране Modeler можно создавать события эскалации, задавать их свойства и управлять определениями эскалаций. Чтобы добавить событие эскалации, нажмите значок Change type change type icon промежуточного, конечного или граничного события либо начального события внутри событийного подпроцесса и выберите вариант с эскалацией.

Событие Использование

Начальное событие эскалации

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

Граничное событие эскалации

Перехватывает эскалации, сгенерированные внутри действия, к которому оно прикреплено, например встроенного подпроцесса. Может быть прерывающим или непрерывающим.

Промежуточное генерирующее событие эскалации

Генерирует эскалацию. Затем процесс продолжается по исходящему потоку операций, если только прерывающее событие не перехватило эскалацию и не отменило охватывающую область.

Конечное событие эскалации

Генерирует эскалацию и завершает текущий путь.

Сопоставление эскалаций

События эскалации ссылаются на определения эскалаций процесса. У определения есть id, имя и необязательный код эскалации. Определениями можно управлять в свойствах процесса или добавить определение из события, выбрав Create new…​ в его поле Escalation.

Движок сопоставляет генерирующие и перехватывающие события по коду эскалации:

  • Сначала он ищет перехватывающее событие в области генерирующего события, а затем в охватывающих областях.

  • Событие без заданной эскалации или с определением эскалации без кода соответствует любой эскалации.

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

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

Свойства событий эскалации

На экране Modeler можно задать следующие свойства событий эскалации:

Свойство

Описание

Id

Идентификатор элемента. Он генерируется автоматически, но его можно заменить на более понятный, чтобы логи было проще читать.

Name

Имя элемента.

Escalation

Определение эскалации, которую событие генерирует или перехватывает. Оставьте его пустым у перехватывающего события, чтобы перехватывать любую эскалацию.

Execution listeners

См. Слушатели выполнения.

Asynchronous execution

  • Asynchronous

  • Exclusive

  • Asynchronous leave

  • Asynchronous leave exclusive

Documentation

Описание и дополнительные сведения об элементе.

У начального события эскалации также есть раздел Process variables, как и у других начальных событий. У конечных событий эскалации нет свойств Asynchronous leave и Asynchronous leave exclusive.

Пример

В этом примере подпроцесс Process order генерирует эскалацию Low stock после задачи Reserve items. Непрерывающее граничное событие перехватывает эскалацию и создает задачу Reorder items. В это же время подпроцесс переходит к задаче Ship order.

escalation example

XML этого примера:

<definitions ...>
  <escalation id="low-stock" name="Low stock" escalationCode="LOW_STOCK" /> (1)

  <process id="order-processing" isExecutable="true">
    <subProcess id="process-order" name="Process order">
      . . .
      <intermediateThrowEvent id="low-stock-throw" name="Low stock">
        <escalationEventDefinition escalationRef="low-stock" /> (2)
      </intermediateThrowEvent>
      . . .
    </subProcess>
    <boundaryEvent id="low-stock-catch" name="Low stock"
        attachedToRef="process-order" cancelActivity="false"> (3)
      <escalationEventDefinition escalationRef="low-stock" />
    </boundaryEvent>
    . . .
  </process>
</definitions>
1 Определение эскалации.
2 Генерирующее событие ссылается на определение.
3 Непрерывающее граничное событие. Для прерывающего события не указывайте cancelActivity или задайте true. У непрерывающего начального события эскалации есть атрибут isInterrupting="false".

События компенсации

Компенсация отменяет результаты завершенных действий, например отменяет бронирование отеля, если платеж не прошел. Генерирующее событие компенсации запускает обработчики компенсации этих действий. См. Compensation Intermediate Throwing Event и Compensation Boundary Event в документации Flowable.

Чтобы добавить событие компенсации на экране Modeler, нажмите значок Change type change type icon промежуточного или граничного события и выберите Compensation intermediate throw event или Compensation boundary event. Чтобы получить граничное событие, перетащите промежуточное событие из палитры на границу действия.

Событие Использование

Граничное событие компенсации

Прикрепляет обработчик компенсации к действию. Чтобы добавить обработчик, нажмите Append compensation activity в контекстной панели события. Экран Modeler добавляет задачу, отмеченную как обработчик компенсации, и соединяет ее с событием ассоциацией. При необходимости измените тип задачи, например на сервисную задачу.

Событие становится активным, когда действие завершается, и обработчик выполняется один раз для каждого завершения, например для каждого экземпляра действия с множественным экземпляром. Flowable не поддерживает граничные события компенсации на встроенных подпроцессах: их обработчики не выполняются.

Промежуточное генерирующее событие компенсации

Запускает обработчики компенсации завершенных действий в своей области: экземпляре процесса или подпроцессе, который содержит событие. Действия внутри подпроцесса компенсируются, только если подпроцесс завершен. Обработчики выполняются в порядке, обратном порядку завершения; действия, завершенные в одной транзакции, могут компенсироваться в любом порядке. Затем процесс продолжается по исходящему потоку операций. Чтобы компенсировать только одно действие, задайте атрибут activityRef элемента compensateEventDefinition в XML.

Начальное событие компенсации

Экран Modeler предлагает этот вариант для начальных событий внутри событийного подпроцесса, но Flowable его не поддерживает: процесс с таким событием не развертывается, и возникает ошибка start event of event subprocess must be of type 'error', 'timer', 'message' or 'signal'.

На экране Modeler у событий компенсации есть только свойства Id и Name.

Пример

В этом примере у задачи Book hotel с множественным экземпляром в подпроцессе есть граничное событие компенсации с обработчиком Cancel hotel booking. Если задача Charge credit card генерирует ошибку, ее граничное событие ошибки ведет к генерирующему событию компенсации Cancel booking, которое компенсирует завершенные действия процесса:

  • Если подпроцесс завершен, Cancel hotel booking выполняется один раз для каждого завершенного экземпляра Book hotel.

  • Если подпроцесс еще активен, например находится на задаче Review booking, компенсация не затрагивает действия внутри него и Cancel hotel booking не выполняется.

compensation example

XML этого примера:

<process id="booking" isExecutable="true">
  . . .
  <subProcess id="booking-subprocess">
    . . .
    <serviceTask id="book-hotel" name="Book hotel" ...>
      <multiInstanceLoopCharacteristics ... />
    </serviceTask>
    <boundaryEvent id="book-hotel-compensation" attachedToRef="book-hotel">
      <compensateEventDefinition /> (1)
    </boundaryEvent>
    <serviceTask id="cancel-hotel-booking" name="Cancel hotel booking"
        isForCompensation="true" ... /> (2)
    . . .
    <association id="compensation-association" associationDirection="One"
        sourceRef="book-hotel-compensation" targetRef="cancel-hotel-booking" /> (3)
  </subProcess>
  . . .
  <intermediateThrowEvent id="cancel-booking" name="Cancel booking">
    <compensateEventDefinition /> (4)
  </intermediateThrowEvent>
  . . .
</process>
1 Граничное событие компенсации.
2 Обработчик компенсации.
3 Ассоциация, которая соединяет событие и обработчик.
4 Генерирующее событие компенсации. Оно компенсирует все завершенные действия в своей области, то есть в процессе.

События отмены

События отмены отменяют транзакционный подпроцесс. См. Cancel End Event и Cancel Boundary Event в документации Flowable.

Чтобы добавить событие отмены на экране Modeler, нажмите значок Change type change type icon конечного события внутри транзакционного подпроцесса или граничного события на нем и выберите вариант с отменой.

Событие Использование

Конечное событие отмены

Отменяет транзакционный подпроцесс, который содержит событие. Вне транзакционного подпроцесса, например в модели из другого инструмента, процесс не развертывается и возникает ошибка end event with cancelEventDefinition only supported inside transaction subprocess.

Граничное событие отмены

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

Пример см. в разделе Возможные исходы транзакции.

Свойства событий отмены

На экране Modeler можно задать следующие свойства конечного события отмены:

Свойство

Описание

Id

Идентификатор элемента. Он генерируется автоматически, но его можно заменить на более понятный, чтобы логи было проще читать.

Name

Имя элемента.

Asynchronous execution

  • Asynchronous

  • Exclusive

Начиная с Jmix 3.1

Documentation

Описание и дополнительные сведения об элементе.

У граничного события отмены есть только свойства Id и Name.

Завершить конечное событие

Элемент «Завершить конечное событие» завершает все пути в своей области: в экземпляре процесса, а внутри подпроцесса — в этом подпроцессе. Используйте его, когда один путь определяет результат, а остальные пути нужно остановить, например когда заказ отменяется, пока другие задачи еще открыты. См. Terminate End Event в документации Flowable.

Чтобы добавить элемент «Завершить конечное событие» на экране Modeler, нажмите значок Change type change type icon конечного события и выберите Terminate end event.

Свойства элемента «Завершить конечное событие»

На экране Modeler можно задать следующие свойства элемента «Завершить конечное событие»:

Свойство

Описание

Id

Идентификатор элемента. Он генерируется автоматически, но его можно заменить на более понятный, чтобы логи было проще читать.

Name

Имя элемента.

Terminate all

Если выбрано, событие завершает весь экземпляр процесса, даже если событие находится внутри подпроцесса. По умолчанию не выбрано.

Execution listeners

См. Слушатели выполнения.

Asynchronous execution

  • Asynchronous

  • Exclusive

Начиная с Jmix 3.1

Documentation

Описание и дополнительные сведения об элементе.

Пример

В этом примере, когда Task 2 завершается, элемент «Завершить конечное событие» завершает подпроцесс: Task 1 отменяется, а процесс переходит к Task 3. Task 0 остается активной. Если выбрано Terminate all, событие завершает весь экземпляр процесса, включая Task 0.

terminate end event example 2

XML этого примера:

<subProcess id="subprocess">
  . . .
  <endEvent id="terminate-end" name="Terminate end event">
    <terminateEventDefinition /> (1)
  </endEvent>
</subProcess>
1 Если выбрано Terminate all, у элемента есть атрибут flowable:terminateAll="true".

Поддержка событий BPMN

Jmix BPM поддерживает не все события BPMN 2.0. На диаграмме ниже неподдерживаемые события отмечены розовым.

jmix events

Не поддерживаются следующие события:

  • условные события всех типов;

  • события-ссылки;

  • промежуточные генерирующие события сообщения и конечные события сообщения;

  • конечные события сигнала;

  • начальные и конечные события компенсации.

Экран Modeler не предлагает эти события. Исключение — начальные события компенсации: экран предлагает их внутри событийных подпроцессов, хотя процесс с таким событием не развертывается. Условные события реализованы в движке Flowable, но не поддерживаются в Jmix BPM. Остальные события не реализованы и во Flowable. Способы смоделировать похожую логику см. в разделе Обходные решения для неподдерживаемых событий.

Модель BPMN, созданная в другом инструменте, может содержать неподдерживаемые события. Экран Modeler показывает их на диаграмме, но некоторые из них работают не так, как определяет спецификация BPMN:

  • Процесс с событием-ссылкой или промежуточным генерирующим событием сообщения не развертывается.

  • Конечные события сообщения, сигнала и компенсации работают как пустые конечные события: они завершают путь, но не отправляют сообщение или сигнал и не запускают компенсацию.

Обходные решения для неподдерживаемых событий

В этом разделе описано, как реализовать нужную логику процесса для элементов, которые не поддерживаются в Jmix BPM.

Генерирующее событие сообщения

Во-первых, везде, где возможно, используйте сигналы вместо сообщений. В большинстве случаев эти типы событий взаимозаменяемы.

signal instead of message

Во-вторых, используйте сервисную задачу с вызовом API.

throw message workaround 1

Сервисную задачу можно реализовать как бин Spring, например:

@Component(value = "smpl_MyService")
public class MyService {

    @Autowired
    private RuntimeService runtimeService;

    public void sendMessage(String messageName, String executionId) {
        runtimeService.messageEventReceived(messageName, executionId);
    }
}

Генерирующее конечное событие сигнала

Используйте сочетание промежуточного генерирующего события сигнала и пустого конечного события:

workaround signal end event

Конечное событие компенсации

compensation end event workaround

Условные события

Условное событие определяет событие, которое срабатывает, если заданное условие принимает значение true. Его можно использовать как начальное событие событийного подпроцесса, как промежуточное событие и как граничное событие. Начальное и граничное события могут быть прерывающими и непрерывающими.

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

workaround conditional events

Не используйте события-ссылки.

События-ссылки могут появиться на диаграмме при импорте XML-файла из сторонних инструментов, например Camunda Modeler.