Message Templates

Дополнение Message Templates предоставляет гибкий и удобный способ управлять повторно используемыми шаблонами сообщений в приложении Jmix. Оно позволяет определять шаблоны с плейсхолдерами, которые заполняются данными во время выполнения. Это дополнение упрощает создание персонализированных сообщений, таких как email и уведомления внутри приложения.

Обзор

Это дополнение позволяет создавать и настраивать шаблоны сообщений, которые объединяют статическое содержимое и динамические параметры. Шаблоны можно создавать в визуальном HTML-дизайнере, который предлагает широкий набор HTML-элементов.

template body

Генератор шаблонов сообщений

Процесс генерации сообщений использует широко распространенный шаблонизатор Apache FreeMarker. Система поддерживает шаблоны в формате HTML и Plain Text.

Редактор HTML-шаблонов

Для создания HTML-шаблонов интегрирован мощный веб-компонент GrapesJS, который предоставляет удобный визуальный редактор. Он позволяет собирать шаблоны из библиотеки готовых HTML-блоков простым перетаскиванием элементов из палитры на холст.

Особенности

  • Централизованное управление шаблонами: храните все шаблоны сообщений в одном месте, чтобы их было удобно находить, редактировать и сопровождать.

  • Типы шаблонов: дополнение поддерживает шаблоны HTML и Plain text, что дает гибкость в форматировании сообщений.

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

  • Визуальный редактор HTML-шаблонов: встроенный редактор на базе GrapesJS упрощает создание HTML-шаблонов без ручной верстки.

  • Предварительный просмотр шаблона: проверяйте шаблоны в UI до использования, рендеря их с текущими значениями параметров.

  • Повторное использование: создайте шаблон один раз и используйте его в нескольких частях приложения.

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

Интеграция с другими дополнениями

Дополнение Message Templates интегрируется с другими дополнениями Jmix:

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

  • Email Sending. Установка дополнения Email Sending позволяет отправлять email, созданные на основе шаблонов сообщений.

  • Notifications. Установка дополнения Notifications позволяет использовать готовые шаблоны сообщений при создании уведомлений. Подробности приведены в разделе Интеграция с уведомлениями.

Установка

Для автоматической установки через Jmix Marketplace следуйте инструкциям в разделе Дополнения.

Для ручной установки добавьте следующую зависимость в build.gradle:

implementation 'io.jmix.messagetemplates:jmix-messagetemplates-flowui-starter'
implementation 'io.jmix.messagetemplates:jmix-messagetemplates-starter'
Дополнение Message Templates нельзя использовать с Oracle Database версии ниже 12.2, так как в старых версиях есть ограничения на длину имен объектов базы данных.

Важное примечание для приложений в режиме меню Single mode

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

  1. Откройте Дизайнер меню в Jmix Studio.

  2. Перейдите на вкладку Structure.

  3. Доступные пункты меню отображаются на левой панели.

    add menu items

  4. Чтобы добавить пункты:

    • Выберите нужные пункты и нажмите кнопку > кнопка (Add Selected).

    • Или перетащите их с левой панели в текущую структуру меню справа.

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