Настройка шаблонов рассылок

Шаблоны рассылок предназначены для формирования по ним писем при использовании почтовых рассылок в бизнес-процессах, при отправке отчетов и в сообщений на вкладке "Обсуждения" в документах заявок.

Примечание:

Подробнее о работе с отчетами в веб-интерфейсе пользователя Avanpost IDM см. статью "5.2.10. Отчёты" руководства по администрированию.

Подробнее о настройке бизнес-процессов см. статью "5.1.9. Настройка бизнес-процессов" руководства по администрированию

Управление шаблонами рассылок осуществляется в разделе "Настройка процессов" → "Шаблоны рассылок" веб-интерфейса администратора Avanpost IDM.
В данном разделе шаблоны сгруппированы по назначению в три каталога:

  • "Заявки" – для рассылок в бизнес-процессах;
  • "Отчеты" – для рассылок по отчетам;
  • "Уведомления чата" – для сообщений в чате на вкладке "Обсуждения" документа заявки в веб-интерфейсе пользователя.

Каждый шаблон рассылок состоит из двух hbs файлов:

  • Заголовок – содержит шаблон темы письма.
  • Шаблон – содержит шаблон тела письма.

Навигатор по разделу:

1. Интерфейс редактора шаблонов рассылок

Интерфейс редактора шаблонов рассылок состоит из следующих функциональных областей:


Рисунок – Редактор шаблонов рассылок

  • [1] – Проводник с каталогами шаблонов рассылок. Для просмотра содержимого каталога требуется нажать .
  • [2] – Секция "Открытые редакторы". Содержит список открытых для редактирования файлов шаблонов. В секции доступно сохранение шаблонов с помощью кнопки и закрытие шаблонов с помощью кнопки .
  • [3] – Вкладки с открытыми в редакторе шаблонами. Нажимая на них, можно переключаться между открытыми для редактирования шаблонами. Для закрытия вкладки необходимо нажатьсправа от названия.
  • [4] – Рабочая область редактора для составления шаблонов.
  • [5] – Кнопки управления редактором:
    • – Открывает форму поиска по шаблонам рассылок вместо проводника. 
    • – Открывает проводник с открытыми редакторами [2] и каталогами с шаблонами рассылок [1]. (Проводник открыт по умолчанию)
    • – Проверка настроенного шаблона на выбранном документе.
    • – Экспорт открытого в редакторе шаблона рассылок на локальный компьютер в формате JSON.
    • – Импорт шаблона рассылок в формате JSON с локального компьютера.

2. Добавление шаблонов рассылок

Для добавления нового шаблона рассылок необходимо:

  1. Нажать в строке соответствующего каталога.
  2. Указать название для шаблона в появившемся поле.
  3. Нажать справа от названия. Шаблон рассылок сохранится в выбранном каталоге и в редакторе откроются его файлы: Заголовок и Шаблон.
  4. Составить шаблон темы письма в файле заголовка.
  5. Составить шаблон тела письма в файле шаблона.

    Внимание:

    При составлении шаблонов можно пользоваться HTML для оформления письма и языком шаблонов Handlebars для получения значений из полей и атрибутов документа и настройки логики. 

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

  6. Нажать  в секции "Открытые редакторы" в строках обоих файлов.
  7. Нажать на панели с кнопками в левой части редактора для проверки составленного шаблона.
  8. В открывшемся окне отметить в списке документ(заявку), данные из которого будут использованы для проверки. Нажать .
  9. Отметить в списке получателя письма, данные которого будут использованы для проверки. Нажать .
  10. Проверить сформированное письмо и нажать .


Рисунок – Добавление шаблона рассылок

3. Составление шаблонов рассылок 

При составлении шаблонов рассылок можно использовать:

  1. Простой текст;
  2. HTML разметку для оформления письма;
  3. Язык Handlebars для получения значений из полей и атрибутов документа и настройки логики.

3.1. Handlebars

Примечание:

Документация по Handlebars: https://handlebarsjs.com/guide/

Доступные для использования функции, поля и атрибуты документа представлены в окне "Подсказки". Чтобы открыть это окно необходимо нажать в левом нижнем углу редактора.

Можно вставить код из окна "Подсказки" в редактор, нажав напротив нужной подсказки.


Рисунок – Добавление кода из подсказки в редактор


Таблица – Доступные для использования функции, поля и атрибуты документа в окне "Подсказки"

Атрибуты документа (заявки)

АтрибутКод в редактореНазначение
Author

{{Author}}

Подставляет ФИО автора заявки
Tasks

{{Tasks}}

Подставляет задачи по заявке
UserActions

{{UserActions}}

Подставляет действия исполнителя заявки
Subject

{{Subject}}

Подставляет ФИО субъекта заявки
UserName

{{UserName}}

Подставляет ФИО исполнителя заявки
DocumentId

{{DocumentId}}

Подставляет идентификатор документа
DocumentNumber

{{DocumentNumber}}

Подставляет номер документа
DocumentType

{{DocumentType}}

Подставляет тип документа
DocumentForm

{{DocumentForm}}

Подставляет тип компонента документа
DocumentCreated

{{DocumentCreated}}

Подставляет дату подачи документа
Status

{{Status}}

Подставляет текущий статус заявки
Fields

{{Fields}}

Подставляет поля документа в виде словаря

Поля документа (заявки)

ПолеКод в редактореНазначение
Список ролей

{{#getFieldValues 'Role'}} <p>{{Name}}</p> {{/getFieldValues}}

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

{{#getFieldValue 'DateFrom'}} {{#formatDate Value 'dd.MM.yyyy'}} {{/formatDate}} {{/getFieldValue}}

Подставляет дату создания документа
Дата окончания

{{#getFieldValue 'DateTo'}} {{#formatDate Value 'dd.MM.yyyy'}} {{/formatDate}} {{/getFieldValue}}

Подставляет дату окончания документа
Получить список значений поля

{{#getFieldValues 'FieldName'}} <p>{{Value}}</p> {{/getFieldValues}}  

Подставляет список значений поля документа. Вместо FieldName необходимо подставить название целевого поля документа
Получить значение поля

{{#getFieldValue 'FieldName'}} <p>{{Value}}</p> {{/getFieldValue}}

Подставляет значение поля документа. Вместо FieldName необходимо подставить название целевого поля документа

Функции

ФункцияКод в редактореНазначение
if

{{#if}} body {{/if}}

Условный оператор. Определяет по указанному условию, выполнять ли блок "body".
Подробнее: https://handlebarsjs.com/guide/builtin-helpers.html#if
each

{{#each}} body {{/each}}

Итератор. Выполняет блок "body" для всех значений входного параметра.
Подробнее: https://handlebarsjs.com/guide/builtin-helpers.html#each

with

{{#with}} body {{/with}}

Обозначает поля объекта в виде блока Handlebars.
Подробнее: https://handlebarsjs.com/guide/builtin-helpers.html#with
ifEquals

{{#ifEquals 'value1' 'value2'}} body1 {{else}} body2 {{/ifEquals}}

Сравнивает значения "value1" и "value2". Если значения равны, то выполняется блок "body1", иначе выполняется блок "body2"
encryptObject

{{#encryptObject str}} {{/encryptObject}}

Шифрует объект "str".
formatDate

{{#formatDate Created 'dd.MM.yyyy' '+01:01'}} {{/formatDate}}

Форматирует вывод даты и времени
getFieldValue

{{#getFieldValue 'FieldName'}} {{Value}} {{/getFieldValue}}

Возвращает значение поля документа. Вместо FieldName необходимо подставить название целевого поля документа
getFieldValues

{{#getFieldValues 'FieldName'}} {{_index}}: {{Name}} {{/getFieldValues}}

Возвращает список значений поля документа. Вместо FieldName необходимо подставить название целевого поля документа
ifFieldExistsAndHaveValue

{{#ifFieldExistsAndHaveValue 'DateTo'}} body1 {{else}} body2 {{/ifFieldExistsAndHaveValue}}

Проверяет, существует ли поле и задано ли для него значение. Если да, выполняется блок "body1", если нет — блок "body2"

4. Изменение шаблонов рассылок

4.1. Изменение названий шаблонов рассылок

Для переименования шаблона рассылок необходимо:

  1. Нажать  в строке требуемого шаблона в проводнике.
  2. Изменить имя шаблона.
  3. Нажать .


Рисунок – Изменение имени шаблона рассылок

4.2. Изменение содержимого шаблонов рассылок

Для изменения шаблона рассылок необходимо:

  1. Нажать в строке требуемого шаблона в списке в проводнике. В проводнике откроется список с двумя файлами шаблона.
  2. Для изменения шаблона темы письма нажать на "Заголовок". Для изменения шаблона тела письма нажать на "Шаблон". Выбранный файл откроется в рабочей области редактора.
  3. Изменить текст шаблона в выбранном файле.
  4. Нажать в секции "Открытые редакторы" в строке измененного файла.
  5. Нажать на панели с кнопками в левой части редактора для проверки составленного шаблона.
  6. В открывшемся окне отметить в списке документ(заявку), данные из которого будут использованы для проверки. Нажать .
  7. Отметить в списке получателя письма, данные которого будут использованы для проверки. Нажать .
  8. Проверить сформированное письмо и нажать .


Рисунок – Изменение шаблона рассылок

5. Удаление шаблонов рассылок

Для удаления шаблона рассылок необходимо:

  1. Нажать в строке требуемого шаблона в списке в проводнике.
  2. Подтвердить удаление во всплывающем окне.


Рисунок – Удаление шаблона рассылок

Обсуждение