Добавление пользовательского события

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

Некоторые события запускаются JIRA внутренне - например, событие «Обновление задачи» (Issue Updated) или «Перемещение задачи» (Issue Moved). Другие события запускаются из-за пост-функций перехода рабочего процесса - например, событие, «Разрешение задачи» (Issue Resolved), или «Пользовательское событие» (Custom Event), (см. ниже).

На этой странице:

Обзор

В JIRA есть два типа событий:

  • Системные (System) —  события используются повсеместно в JIRA и не могут быть добавлены или удалены. Однако вы можете сделать их неактивными (см. ниже).
  • Пользовательские (Custom) - эти события используются для генерации уведомления по электронной почте (или вызова пользователя) из постфункции конкретного потока рабочего процесса. Вы можете добавлять / удалять столько настраиваемых событий, сколько вам нужно. Обратите внимание, что удаляются только неактивные пользовательские события.

Событие может быть в любом из следующих состояний:

  • Активно (Active) - событие связано с по меньшей мере с одной из схем уведомления или пост-функцией перехода рабочего процесса.
  • Неактивно (Inactive) - событие не связано с какими-либо схемами уведомлений или пост-функциями перехода рабочего процесса. Обратите внимание, что состояние события не указывает, может ли событие быть запущено. Пользовательское событие (Custom event) будет запущено, только если оно связано с пост-функцией перехода для активного рабочего процесса (см. «Активация рабочего процесса»).

Системные события

Встроенные системные события JIRA:

Задача создана:

Issue Created:

В систему была введена задача.

Задача обновлена:

Issue Updated:

В задаче изменились детали.

Задача связана:

Issue Assigned:

Задача была назначена новому пользователю.

Задача разрешена:

Issue Resolved:

Задача была решена (обычно после обработки и исправления).

Задача закрыта:

Issue Closed:

Задача закрыта. (Обратите внимание, что задача может быть закрыта без разрешения, см. «Статусы).

Задача прокомментирована:

Issue Commented:

В задаче добавлен комментарий.

Комментарий задачи изменен:

Issue Comment Edited:

Комментарий задачи был изменен.

Задача переоткрыта:

Issue Reopened:

Задача была вновь открыта.

Задача удалена:

Issue Deleted:

Задача была удалена.

Задача перемещена

Issue Moved:

В этот проект была перемещена задача.

Изменение рабочего журнала задачи

Work Logged On Issue:

Событие добавления трудозатрат в рабочий журнал задачи (протоколирование трудозатрат).

Начало работы над задачей

Work Started On Issue:

Представитель начал работу над задачей.

Работа прекращена по задаче:

Work Stopped On Issue:

Представитель остановил работу над задачей.

Обновление журнала задач:

Issue Worklog Updated:

Изменена запись в рабочем журнале задачи.

Рабочий журнал по задаче удален

Issue Worklog Deleted:

Запись в рабочем журнале задачи была удалена.

Общее событие:

Generic Event:

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

 

Пользовательские события

Вы можете запустить пользовательское событие (Custom event) из настраиваемой пост-функции перехода в пользовательский рабочий процесс. Соответствующие пользователи будут предупреждены о пользовательском переходе путем иницироивания этого события. Например, связанная схема уведомлений может быть сконфигурирована так, чтобы уведомлять пользователей о переходе рабочего процесса на основе иницирования этого  пользовательского события.

Настройка уведомлений для пользовательского события

Пользовательские события чаще всего используются для генерации уведомлений для пользовательских переходов рабочего процесса. Например, вашей организации может понадобиться изменить рабочий процесс по умолчанию, добавив шаг рабочего процесса под названием «QA_Inspection» (например, между «Разрешение задачи» (Resolve Issue) и «Закрытие задачи» (Close Issue)). Обычно вам также нужно будет генерировать уведомление по электронной почте команде QA всякий раз, когда задача переходит к шагу «QA_Inspection» рабочего процесса».

Для этого есть три общих шага:

  1. Добавьте пользовательское событие в систему (например, «Задача ожидающая QA» (Issue Awaiting QA)).
  2. Настройте схему уведомления для отправки электронной почты при запуске настраиваемого события.
  3. Настройте пост-функцию перехода рабочего процесса, чтобы запустить пользовательское событие.

Для того чтобы добавить пользовательское событие,необходимо выполнить следующие шаги:

  1. Войдите в систему как пользователь с глобальным разрешением администраторов JIRA.
  2. Выберите Система»  (System). Выберите «Дополнительно» (Advanced)> «События» (Events), чтобы открыть страницу «Просмотр событий» (View Events).

комбинация клавиш: g + g + начало ввода событий

  1. В форме «Добавить новое событие» (Add New Event) внизу страницы добавьте имя (Name) и описание (Description) для настраиваемого события.
  2. В поле «Шаблон» (Template) выберите шаблон электронной почты по умолчанию, который будет связан с событием.
  3. Нажмите кнопку «Добавить» (Add).

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

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

Для настройки схемы уведомления для отправки почты, выполните следующие шаги:

  1. Войдите в систему как пользователь с глобальным разрешением администраторов JIRA.
  2. Выберите > «Задачи» (Issues). Выберите «Схемы уведомлений» (Notifications Schemes), чтобы открыть страницу «Схемы уведомлений».

Комбинация клавиш: g + g + начало ввода схем уведомлений

  1. Выберите схему уведомления для редактирования, щелкнув имя схемы уведомлений или ссылку «Уведомления» (Notifications) (в разделе «Операции» (Operations)).
  2. При необходимости добавьте получателей для пользовательского события. Дополнительную информацию см. в разделе «Создание схемы уведомлений».

Для того чтобы произвести настройку функции post для запуска пользовательского события, выполните следующие шаги:

  1. Войдите в систему как пользователь с глобальным разрешением администраторов JIRA.
  2. Выберите > «Задачи» (Issues). Выберите «Рабочие процессы» (Workflows), чтобы открыть страницу «Рабочие процессы», в которой отображаются все рабочие процессы в вашей системе.

Комбинация клавиш: g + g + начало ввода рабочих процессов

  1. Перейдите к пост-функции экрана перехода рабочего процесса, который нужно отредактировать. Дополнительную информацию см. в разделе «Настройка рабочего процесса и применение пост-функций к переходам».
  2. Обновите функцию post, чтобы запустить пользовательское событие.
  3. Активируйте или свяжите рабочий процесс (и схему) с соответствующим проектом. Дополнительную информацию см. в разделе «Активация рабочего процесса».

 

По материалам Atlassian JIRA Administrator's Guide: Adding a custom event