Задача отправки уведомления

Начиная с Jmix 3.1

Обзор

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

Это собственная задача Jmix, а не стандартная задача BPMN. Чтобы добавить ее, нажмите значок Change type change type icon задачи и выберите Send Notification Task.

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

Графическая нотация

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

notification task
XML-представление

Задача отправки уведомления — это сервисная задача с типом jmix-send-notification. Ее уведомления — элементы расширения jmix:notification.

<serviceTask id="notify-manager" name="Notify manager" flowable:type="jmix-send-notification">
  <extensionElements>
    <jmix:notification recipientType="expression" recipientExpression="${order.manager}"
                       channels="in-app,email" contentType="plain">
      <jmix:subject>New order ${order.number}</jmix:subject>
      <jmix:body>Order ${order.number} is waiting for your approval.</jmix:body>
    </jmix:notification>
  </extensionElements>
</serviceTask>

Свойства

В моделере BPMN можно задать следующие свойства задачи отправки уведомления:

Свойство

Описание

Id

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

Name

Имя задачи, не более 255 символов. Обычно задачи называют по схеме «глагол + объект», например «Согласовать заказ» или «Отправить счет».

Notifications

Уведомления, которые отправляет задача. См. Уведомления.

Execution listeners

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

Asynchronous execution

  • Asynchronous

  • Exclusive

  • Asynchronous leave

  • Asynchronous leave exclusive

Documentation

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

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

Уведомления

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

Другие дополнения расширяют эти возможности:

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

Свойства уведомления

Раздел Notifications показывает список уведомлений. Для управления ими используйте кнопки Create, Edit и Remove. У уведомления есть следующие свойства:

Свойство

Описание

Subject

Тема уведомления. Обязательное свойство. Может содержать выражения.

Type

Необязательный тип уведомления. Задает значок уведомления в UI. Список показывает зарегистрированные типы; также можно ввести имя типа.

Recipient

Кто получает уведомление. Обязательное свойство. См. Получатели уведомлений.

Recipient expression

Выражение, которое возвращает получателей. Показывается, если Recipient имеет значение Expression.

Channels

In-app, Email или оба. Нужен хотя бы один канал. По умолчанию выбран In-app. Email доступен, если установлено дополнение Email Sending.

Use message template, Message template

Шаблон, по которому формируется текст. Доступно, если установлено дополнение Message Templates. См. Шаблоны сообщений в уведомлениях.

Content type

Plain text или HTML. Для HTML текст редактируется в редакторе форматированного текста. Если переключиться с HTML на обычный текст, моделер запрашивает подтверждение и очищает текст. Скрыто, если используется шаблон сообщения.

Body

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

В XML каждое уведомление — это элемент расширения jmix:notification. Его атрибуты: recipientType, recipientExpression, channels, type, contentType и templateCode; дочерние элементы: jmix:subject и jmix:body.

Получатели уведомлений

Recipient Значение в XML Описание

Process initiator

initiator

Пользователь, сохраненный в переменной процесса initiator.

Expression

expression

Результат Recipient expression. Выражение может возвращать имя пользователя, пользователя или их коллекцию, например ${order.manager} или ${reviewers}.

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

Выражения в уведомлениях

Тема и текст — это выражения Flowable, например ${order.number} или ${context.recipientUser.username}. Значения вставляются с помощью toString(), поэтому для форматирования вызывайте методы, например ${order.date.getYear()}.

У объекта context есть следующие свойства:

Свойство Описание

recipientUser

Пользователь, который получает это уведомление.

processId

Id экземпляра процесса.

processDefinitionId, processDefinitionName

Id и имя определения процесса.

executionId

Id исполнения.

variables

Map переменных процесса, например ${context.variables.orderNumber}.

В теме и тексте context всегда означает контекст уведомления, даже если у процесса есть переменная с таким именем.

Шаблоны сообщений в уведомлениях

Если уведомление использует шаблон сообщения, шаблон формирует только текст. Тема по-прежнему берется из свойства Subject и использует выражения Flowable, а шаблон использует синтаксис FreeMarker.

Параметры шаблона заполняются из переменных процесса: алиас каждого параметра должен совпадать с именем переменной процесса. Например, если у процесса есть переменная order, добавьте параметр order и используйте ${order.number} в шаблоне. Объект context, описанный в разделе Выражения в уведомлениях, тоже доступен. Значения параметров по умолчанию не используются. Если шаблон ссылается на отсутствующую переменную, уведомление не отправляется, а ошибка записывается в лог.

Ошибки в уведомлениях

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

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