Slack & RocketChat Notification

10,000.00

Уведомления из OTRS с неограниченным кол-вом каналов в Slack и RocketChat.

Уведомления настраиваются на очереди. Для каждой очереди можно настроить неограниченное количество каналов Slack или RocketChat.

Доступны уведомления по событиям:

  • Добавление заметки в заявку
  • Истекло время первого ответа
  • Ответ клиента
  • Изменен владелец заявки
  • Наступило время ожидания
  • Истекло время решения заявки
  • Смена статуса заявки
  • Новая заявка

По каждому из событий в канал Slaсk или RocketChat отправляется уведомление, их текст приведен в таблице:

Название события Текст уведомления Комментарий
AddNote @login, новая заметка @login —
@Логин владельца заявки
PeTime @login, время откладывания наступило @login — @Логин владельца заявки
FirstResponseEscalation Требует срочной типизации Уведомление отправляется через 70% (значение может регулироваться в настройках администратором системы) времени от SLA (Например, SLA=100 минут, уведомление отправится через 70 минут)
FollowUp Ответ клиента
OwnerUpdate @login, вы назначены владельцем заявки @login — @Логин владельца заявки
PendingTime @login, время ожидания наступило @login — @Логин владельца заявки
SolutionEscalation До решения заявки осталось времени меньше Уведомление отправляется через 70% (значение может регулироваться в настройках администратором системы) времени от SLA (Например, SLA=100 минут, уведомление отправится через 70 минут)
StateUpdate Смена статуса
TicketCreate Новая заявка

Кроме текста, указанного в поле “Текст уведомления”, в каждом уведомлении содержится следующая информация:

  • (от): имя и e-mail отправителя
  • Subject (тема): тема заметки
  • More (подробнее): ссылка на заявку в OTRS

Пример внешнего вида уведомления (Рисунки 2.1, 2.2.):

Рисунок 2.1. Внешний вид уведомления в Slack

 

Рисунок 2.2. Внешний вид уведомления в Rocket.chat

Инструкция пользователя

Для получения уведомлений агенту необходимо состоять в канале Slack или RocketChat, для которого настроена отправка уведомлений из OTRS.

Установка пакета

Установка модуля осуществляется с помощью пакета RS4OTRS Advanced Escalation через стандартный функционал OTRS. Шаги установки пакета описаны в официальной инструкции OTRS 6 для Администратора на русском и английском языках.

Настройка OTRS

Настройка модуля в конфигурации системы производится в разделе TicketSlackNotification → Core.  Внешний вид окна настроек приведен на рисунке 5.1.

Рисунок 5.1. Настройки

В настройках модуля содержится 7 элементов:

  • SlackNotification::QueueRecipients
  • SlackNotification::SlackLink
  • SlackNotification::SlackCalendar
  • SlackNotification::EventFormat
  • SlackNotification::StateUpdate::StateIDs
  • SlackNotification::TicketCreate::SenderTypes
  • SlackNotification::Subject

Далее приведено описание каждого элемента.

5.1.1. SlackNotification::QueueRecipients

Эта настройка определяет соответствие очередей и каналов Slack, в которые будут отправляться сообщения о событиях из указанных очередей. Для одной очереди может быть настроено несколько каналов.

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

Поле Описание
Ключ Название очереди в OTRS
Содержание Webhook канала Slack, в который будут отправляться сообщения о событиях из указанной очереди. При необходимость может быть задано несколько каналов, для этого необходимо указать их webhook в данном поле с разделителем “|”

 

5.1.2. SlackNotification::SlackLink

Эта настройка определяет ссылку на API канала в Slack.

Поле Описание
Webhook очереди Slack, в которую будут отправляться сообщения о событиях из указанной очереди.

 

 

5.1.3. SlackNotification::SlackCalendar

Эта настройка определяет, используется ли календарь (для отправки уведомлений только в  рабочее время, указанное в календаре)

Поле Описание
Набор значений: “”да, “нет”.

По умолчанию “да”.

При выборе опции “да” уведомления в Slack отправляются только в рабочее время, которое задано в календаре.

При выборе опции “нет” уведомления в Slack отправляются в любое время.

 

5.1.4. SlackNotification::EventFormat

Эта настройка определяет формат текста уведомлений для каждого события.

Поле Описание
Ключ Название события
Содержание Текст уведомления

 

По каждому из событий в канал Slaсk отправляется уведомление, их текст приведен в таблице:

Название события Текст уведомления Комментарий
AddNote @$login, новая заметка @$login —
@Логин владельца заявки
DelayingTime @$login, время откладывания наступило|hold @$login — @Логин владельца заявки
|hold — состояние, которое отслеживается (hold)
FirstResponseEscalation Требует срочной типизации|70% |70% — % времени от SLA, при котором будет отправлено уведомление по данному событию
FollowUp Ответ клиента
OwnerUpdate @$login, вы назначены владельцем заявки @$login — @Логин владельца заявки
PendingTime @$login, время ожидания наступило|pending client @$login — @Логин владельца заявки

|pending client — состояние, которое отслеживается (pending client)

 

SolutionEscalation До решения заявки осталось времени меньше|70% |70% — % времени от SLA, при котором будет отправлено уведомление по данному событию
StateUpdate Смена статуса
TicketCreate Новая заявка

Кроме текста, указанного в поле “Текст уведомления”, по каждой заявке пользователю отправляется следующая информация:

  • From (от): имя и e-mail отправителя
  • Subject (тема): тема заметки
  • More (подробнее): ссылка на заявку в OTRS

Пример внешнего вида уведомления (Рисунки 5.2, 5.3):

Рисунок 5.2. Внешний вид уведомления в Slack

 

Рисунок 5.3. Внешний вид уведомления в RocketChat

 

5.1.5. SlackNotification::StateUpdate::StateIDs

Эта настройка определяет список ID состояний, для которых будут отправляться уведомления по событию StateUpdate (Смена статуса).

5.1.6. SlackNotification::TicketCreate::SenderTypes

Эта настройка определяет типы заметок, по которым будут отправляться уведомления по событию TicketCreate.

Поле Описание
Возможные типы заметок: system, customer, agent

 

5.1.7. SlackNotification::Subject

Эта настройка определяет, что будет отображаться в теме уведомления (тема артикла или заголовок тикета)

Поле Описание
Возможные значения: article subject (тема артикла), ticket title (заголовок тикета)

 

5.3. Дополнительная настройка

После выполнения настроек в конфигурации системы для запуска отправки уведомлений необходимо в Cron (или ином планировщике задач) запустить скрипт:

*/1 * * * * $HOME/bin/RS.TicketSlackNotification.pl >> /dev/null

 

Настройка Slack

Для получения агентом уведомлений по событиям из OTRS в каналы Slack в настройках модуля RS4OTRS_TicketSlackNotification для каждого канала, в который будут поступать уведомления, необходимо указать webhook. Для получения webhook канала Slack необходимо выполнить следующие действия:

Перейти на сайт https://api.slack.com/

Нажать кнопку “Start building” (Рисунок 1)

Рисунок 1. Сайт https://api.slack.com/

 

На открывшейся странице необходимо заполнить форму (Рисунок 2):

  • App Name — имя приложения, в Slack будет отображаться как имя пользователя, от которого поступают уведомления. При этом пользователь будет помечен ярлыком “app” (Рисунок 4)
  • Development Slack Workplase — необходимо нажать на данный пункт, в открывшемся списке выбора выбрать пункт “Sign in to another workspace” (Рисунок 3).

Рисунок 2. Создание приложения Slack

 

Рисунок 3.Создание приложения Slack

 

Рисунок 4. Вид пользователя Slack, от которого будут поступать уведомления о событиях в OTRS

 

На открывшейся странице необходимо ввести название Slack, в котором содержатся каналы для получения уведомлений и нажать кнопку “Continue” (Рисунок 5.)

Рисунок 5. Авторизация в Slack

 

На открывшейся странице необходимо авторизоваться в Slack под пользователем, который является администратором Slack. После ввода данных необходимо нажать кнопку “Sign in” (Рисунок 6).

Рисунок 6. Авторизация в Slack

 

Далее на форме, описание которой приведено в п.3, в списке выбора Development Slack Workplase необходимо выбрать Slack, в котором авторизовался администратор (на шагах 4,5). После заполнения данных необходимо нажать кнопку Create App (Рисунок 7).

Рисунок 7. Создание приложения Slack

 

После успешного создания приложения откроется страница с информацией о нем (Рисунок 8).

Рисунок 8. Информация о приложении Slack

 

На данной странице необходимо выбрать пункт меню “Incoming webhooks” (Рисунок 9).

Рисунок  9. Создание webhook

 

На открывшейся странице необходимо перевести свич “Activate Incoming Webhooks” из положения “Off” в положение “On” (Рисунок 10).

Рисунок 10. Создание webhook

 

На открывшейся форме необходимо нажать кнопку “Add new Webhook to your Workplace” (Рисунок 11).

Рисунок  11. Создание webhook

 

В открывшейся форме в списке выбора “Post to” необходимо выбрать канал, Webhook которого нужно получить, затем нажать кнопку “Authorize” (Рисунок 12).

Рисунок  12. Создание webhook.Выбор канала.

 

После добавления webhook канала, информация о нем отображается в пункте меню “Incoming webhooks” (Рисунок 13). Для настройки уведомлений в выбранный канал url webhookа необходимо скопировать (с помощью кнопки “Copy”) и предоставить Администратору OTRS.

При необходимости webhook может быть добавлен для нескольких каналов (пункты 7-12).

Рисунок 13. Webhook канала

Настройка RocketChat

Для получения агентом уведомлений по событиям из OTRS в каналы RocketChat в настройках модуля RS4OTRS_TicketSlackNotification для каждого канала, в который будут поступать уведомления, необходимо указать webhook. Для получения webhook канала RocketChat необходимо выполнить следующие действия:

Открыть страницу https://домен.rocket.chat/home, авторизоваться в RocketChat под администратором — ввести логин и пароль, после чего нажать кнопку “Авторизация” (Рисунок 14).

Рисунок 14. Авторизация в RocketChat

 

В панели инструментов нажать кнопку “…”, выбрать пункт “Администрирование” (Рисунок 15).

Рисунок 15. RocketChat. Открытие панели администратора

 

На открывшейся странице необходимо выбрать пункт меню “Интеграции” (Рисунок 15).

Рисунок 15. Панель администратора

 

На открывшейся странице необходимо нажать кнопку “Новая интеграция” (Рисунок 16).

Рисунок 16. Создание интеграции

 

Далее необходимо выбрать пункт “Входящий webhook” (Рисунок 16).

Рисунок 16. Создание интеграции

 

На открывшейся странице (Рисунок 17) необходимо заполнить поля формы, описание полей приведено в таблице ниже. После заполнения полей необходимо нажать кнопку “Применить” (Рисунок 18), при этом в правом верхнем углу страницы отобразится статус создания интеграции (Рисунок 19).

Поле Описание
Включено “Да” или “Нет”, регулирует включен webhook или выключен. Необходимо установить значение “Да”
Имя (Опционально) Название интеграции
Опубликовать на канале Имя канала, на который будут приходить уведомления. Для канала необходимо начать с символа #, с @ для пользователя
Отправить от имени Имя пользователя, от которого будут приходить уведомления. Должен быть указан существующий пользователь
Псевдоним (Опционально) Псевдоним, который появится перед логином в сообщениях
URL-адрес Аватара (Опционально) URL-адрес изображения для замены стандартного изображения в интеграции
Эмодзи (Опционально) Эмодзи для замены аватара
Использовать скрипт “Да” или “Нет”, регулирует включен скрипт для интеграции или выключен. Скрипт используется для дополнительных настроек интеграции. Для получения webhook заполнение не обязательно.
Скрипт Поле для ввода скрипта, который запускается при установленном параметре “Использовать скрипт” = “Да”

 

Рисунок 17. Создание интеграции

 

Рисунок 18. Создание интеграции

 

Рисунок 19. Интеграция создана

 

После того, как интеграция создана, она отображается в разделе “Интеграции” панели администратора (Рисунок 20). Необходимо нажать на название созданной интеграции для просмотра webhook.

Рисунок 20. Созданная интеграция

 

На открывшейся странице отобразятся сведения, которые были заполнены при создании интеграции, а также два новых поля — “Webhook URL” и “Token”. Информация о webhook отображается в поле “Webhook URL” (Рисунок 21). Для настройки уведомлений в выбранный канал url webhookа необходимо скопировать и предоставить Администратору OTRS.

При необходимости webhook может быть добавлен для нескольких каналов (пункты 4-8).

Рисунок 21. Webhook канала

Системные требования

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

  • Процессор 3 GHz Xeon или сопоставимый
  • ОЗУ 8 GB RAM
  • Дисковое пространство 256 GB

Требования к программному обеспечению:

  • OTRS 6 Community Edition
  • OTRS ITSM 6 (опционально)

Отзывы

Отзывов пока нет.

Будьте первым, кто оставил отзыв на “Slack & RocketChat Notification”

Ваш e-mail не будет опубликован. Обязательные поля помечены *