Реализация поддержки пользователей средствами JIRA или как мы избавились от OTRS

0. О чем это все

История началась с того, что в компании, в которой я работал, была старая и, субъективно, несколько неудобная система обработки заявок (OTRS), с которой работала техническая поддержка. Разработка использовала JIRA, а отсутствие интеграции между JIRA и OTRS мешало толком формализовать процесс взаимодействия отделов. Кроме этого, в OTRS было несколько существенных недостатков, например письмо, взятое в работу одним сотрудником поддержки, не мог видеть другой. Эти проблемы надо было как-то решать и в процессе раздумий все свелось к двум вариантам:

1. Обновление OTRS и настройка ее интеграции с JIRA
2. Полный перенос работы техподдержки в JIRA и отключение OTRS

Делать решили второй вариант: это позволяло унифицировать рабочие инструменты, перестать поддерживать лишний сервис (который админы поддерживали по принципу «работает — не трожь», что не позволяло его оптимизировать и развивать), реализовать автоматическую сборку статистики по работе технической поддержки и использовать различные плюшки JIRA: канбан-доски, создание шаблонного бага на разработку одной кнопкой, гибкий поиск, автоматическую рассылку писем при исправлении ошибки и прочее.

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

Для реализации минимально рабочего проекта, о котором пойдет речь в этой статье, нам понадобятся:

1. JIRA на своем сервере. Облачная JIRA не поддерживает необходимые плагины,
2. JETI (можно и JEMH, но дорого и не в данном мануале) — плагин, добавляющий инструментарий для корректной работы с входящими и исходящими письмами,
3. Права администратора и руки средней кривизны ;-)
4. Пользователь, которым мы будем создавать задачи и комментарии (назовем его support),
5. Отдельный проект JIRA для работы с ящиком техподдержки (в статье это будет support@example.com), настроенный по вашему вкусу. В нем один тип задач (в моем случае — Ticket)

1. Допиливаем поля и роли проекта

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

1. Создаем поле типа «Text Field (single line)» и привязываем его к экранам редактирования и просмотра задач. В нем плагин будет хранить почту пользователя. Назовем его «Customer Email».
2. В роль Developers проекта записываем людей, которые будут осуществлять поддержку пользователей. Все возможные изменения тасков запрещаем для всех, кроме данной роли, с помощью Permission Scheme, так как в нашем случае «написал комментарий в задаче» = «отправил письмо пользователю».

2. Настраиваем шаблоны автоответа и комментариев в JETI

У нас будет два типа писем:

1. Автоответ — подтверждение для пользователя о создании задачи. Позволяет избавить поддержку от лишней работы, а пользователей — от лишней траты нервов на написание второго письма.
2. Обычное письмо — основной способ коммуникации поддержки с пользователем, будет отсылаться при комментировании задачи.

*В шаблонах можно сделать клевую верстку и прочее, но не в рамках данной статьи, поэтому примеры будут некрасивые, но рабочие. Для всего остального на форме есть Field picker (позволяет вытаскивать значения полей из JIRA) и HTML-теги ;-)

Пожалуй, начнем. Для этого:

1. Идем в Administration > Add-ons > JIRA Email This Issue (Configuration) > Templates > Add
2. В открывшейся форме вводим название шаблона (В моем случае «Comment template»), жмем «Add»
3. Заполняем поля Subject template (Тема письма) и HTML Body Template (Тело письма), пример: тут
   Скриншот

   

4. Повторяем шаги 1-3 для шаблона автответа (В моем случае «Auto-reply template»), пример: тут
   Скриншот

   

   Теперь «Comment template» нужно привязать к конкретному проекту и событию с помощью Notification template. Для «Auto-reply template» этого делать не надо — мы привяжем его к созданию задачи из письма, а не к событию в JIRA.

5. Идем в Administration > Add-ons > JIRA Email This Issue (Configuration) > Notifications > Add
6. В открывшейся форме вводим название шаблона уведомлений: «Comment notification template» и жмем «Add»
7. Снова жмем «Add» в правом верхнем углу экрана
8. Заполняем форму:
   Event Type: «Issue Commented» — письмо высылается как реакция на событие в JIRA. В данном случае выбираем событие, которое высылается JIRA при комментировании любой задачи.
   Template: «Comment template»
9. Опять жмем «Add»
10. В открывшейся форме заполняем поля:
    Recipients (To): «Customer Email» из пункта 1.1
    Add attachments to email: Newest — в письме пользователю будем высылають только последние вложения.
11. Жмем «Save».

3. Конфигурируем JIRA для работы со входящей почтой

Теперь настроим создание задач и комментариев к ним через почту. Это можно сделать и без использования плагина JETI, заменив в 4-м пункте «Email this Issue Mail Handler» на «Create a new issue or add a comment to an existing issue».

1. Идем по пути: Administration > System > Incoming Mail > Add POP > IMAP Mail Servers
2. Подключаемся к почте поддержки «support@example.com» — абсолютно аналогично любому почтовому клиенту. Обратите внимание на полезную кнопочку «Test connection».
   Пример заполнения

   

3. После успешного заведения ящика жмем по кнопке «Add Incoming Mail Handler» чуть ниже, чтобы добавить обработчик нашей почты.
4. В открывшемся окне заполняем:
   «Server» — Почта, созданная чуть выше;
   «Handler» — «Email this Issue Mail Handler»
5. Заполнив, жмем «Next»
6. На следующей странице заполняем форму следующим образом:
   Project: Ваш проект
   Issue Type: Ticket
   Default Reporter: support
   Notify user: Убираем галочку
   Так же есть кнопка «Test».
   Пример заполнения

   

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

7. Идем в Administration > Add-ons > JIRA Email This Issue (Configuration) > Mail Handlers > Add
8. Заполняем форму:
   Project: Ваш проект
   Issue Type: Ticket
   Acknowledge new issues: «Auto-reply template» — указываем шаблон автоответа
   *Acknowledge new comments — сюда можно запилить еще один шаблон автоответа на последующие письма от пользователя. Лично я не использую, но можно.
   Sender field: «Customer Email» — выбираем поле, куда будем сохранять почту пользователя.
   Пример заполнения

   
9. Нажимаем «Save»

4. Настраиваем исходящую почту в JETI

Так как шаблоны мы уже создали, нам осталось только указать контекст их применения:

1. Идем в Administration > Add-ons > JIRA Email This Issue (Configuration) > Contexts > Add
2. В открывшейся форме заполняем:
   Project: Ваш проект
   Issue Type: Ticket
   Notification Template: «Comment notification template»
   From Address: «support@example.com» — вводим почту, которую будем использовать для переписки с пользователями.
   Пример заполнения

   

3. Снова «Save»

5. Проверяем

Теперь посмотрим на результаты наших трудов:

1. Высылаем письмо на адрес поддержки — в течение пяти минут должна быть заведена задача и должен прийти автоответ. В поле Customer Email созданной задачи должен быть адрес отправителя письма, если в JIRA нет такого пользователя. На почту должен прийти автоответ о получении письма.
2. Высылаем еще одно письмо с той же темой и с того же адреса — задача должна быть откомментирована.
3. Комментируем задачу — пользователю должно прийти письмо с комментарием.

Вид со стороны Jira

Вид со стороны почты пользователя

6. Резюме

На этом этапе мы создали минимально работоспособный проект для обработки запросов пользователей на основе JIRA и JETI.

Плюсы:

1. Сбор технической информации о пользователе сайта с помощью сборщиков запросов (разрешение, браузер, страница — в теории вообще всё, что может вытащить js),
2. Интеграция с другими плагинами: канбан-доска для проекта, автоматическая рассылка писем при релизе, рассылка напоминаний о незаконченных задачах etc,
3. Единый рабочий инструмент для разработки и поддержки,
4. Реализация аналитики любого уровня сложности по работе технической поддержки пользователей.

Минусы:

1. Автором JETI до сих пор не выполнен запрос на отсылку кастомных событий при обработке писем. Поэтому не удалось настроить переоткрытие задач при получении повторного письма от пользователя после того, как первое было обработано техподдержкой. Сейчас приходится фильтрами ловить в нотификациях от JIRA, но обещают исправить в следующем релизе: cсылка
2. Невозможность отправки конкретных аттачей пользователю: отправляется несколько последних по некому хитрому алгоритму.
3. Зависимость от общих настроек исходящей почты JIRA (префикс письма, текстовый адрес) — не нашел, как исправить, и буду рад идеям, если найдутся.
   Отсутствие защиты от спама — решили фильтрами через интерфейс самой почты, но клево было бы подобные вещи делать через JIRA.
4. Нельзя просто взять и выслать письмо от поддержки на какой-то левый ящик. Редкий, но иногда нужный кейс.

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

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

Автор: Keramblock

Источник