Шаблоны сообщений

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

При нажатии Создать открывается экран Шаблон сообщения. Он содержит вкладки Детали шаблона и Параметры.

Детали шаблона

Вкладка Детали шаблона содержит панель атрибутов шаблона и HTML-редактор для макета и содержимого.

template body

Атрибуты шаблона

Чтобы определить шаблон, задайте следующие атрибуты:

  • Название: понятное название шаблона. Обязательный атрибут.

  • Код: уникальный идентификатор шаблона. Обязательный атрибут.

  • Тип: Текст или HTML.

  • Группа (необязательно): группа шаблона. Группы настраиваются в экране Группы шаблонов.

Создание шаблона

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

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

Подробнее о редакторе см. в документации GrapesJS.

Плейсхолдеры

Плейсхолдеры - это переменные в шаблоне сообщения, которые заменяются фактическими значениями во время выполнения. Они используют синтаксис интерполяции FreeMarker, например ${variableName}.

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

FreeMarker также предоставляет встроенные функции для форматирования и обработки значений. Например, ${date?string["MM/dd/yyyy"]} форматирует дату как MM/dd/yyyy.

Подробнее см. в документации FreeMarker.

Инструменты редактора шаблонов

Панель кнопок в верхней части HTML-редактора содержит следующие инструменты:

  • Импорт HTML: загрузить существующий HTML в шаблон.

  • Экспорт HTML: скачать текущее содержимое шаблона как HTML-файл.

  • Просмотр исходного кода: показать HTML-код для редактирования или просмотра.

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

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

Параметры

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

Детали параметра

На вкладке Детали параметра настройте для каждого параметра следующие свойства:

  • Имя: имя параметра, отображаемое в форме ввода.

  • Алиас: уникальный идентификатор, используемый в шаблоне и в коде.

  • Тип: Тип данных параметра. Поддерживаются следующие типы: простые (Строка, Число, Логический), типы времени (Дата, Время, Дата и время), а также сложные типы, такие как Перечисление, Сущность или Список сущностей.

  • Скрытый: флаг, который скрывает параметр в форме ввода.

  • Обязательный: флаг, делает параметр обязательным.

  • Значение по умолчанию: значение, которое используется, если другое значение не задано.

Типы параметров и дополнительные поля

Для некоторых типов параметров требуются дополнительные поля:

  • Сущность или Список сущностей:

    • Сущность: сущность, используемая в параметре. Обязательна для Entity и List of Entities.

  • Перечисление:

    • Перечисление: перечисление, используемое в параметре. Обязательно для Enumeration.

  • Дата, Время или Дата и время:

    • Текущая дата/время по умолчанию: использует текущую дату, время или дату и время по умолчанию.

Локализация

На вкладке Локализация можно задать имена параметров для разных языков пользователя.