Настройка интеграции на стороне Jira

Описание

В Jira для интеграции используются типы объектов класса "Задача" (issue). Для характеристик объекта в Jira предназначены поля, которые равнозначны атрибутам в SMP.

Данные из Jira приходят в систему через обратный вызов через HTTP (вебхук). Данные представлены в виде Post-запросов. Каждый запрос содержит описание события, пользователя, выполнившего действие, и все параметры объекта, с которым выполняется действие.

События Jira (webhookEvent), поддерживаемые интеграцией c SMP:

  • создана (issue_created);

  • обновлена (issue_updated):

    • обновлены поля (issue_updated);
    • изменен статус (issue_generic);
    • установлен ответственный (issue_assigned);
  • добавлен комментарий (comment_created для Jira Cloud и issue_commented для Jira Server);
  • добавлен файл (attachment_created).

Выполнение настройки

Генерация API-токена для Jira Cloud

Сгенерируйте API-токен для служебного сотрудника. API-токен используется при настройке интеграции с Jira Cloud в качестве пароля от учетной записи и предоставляет сотруднику доступ к Jira Cloud.

Подробное описание генерации API-токена, см. документацию Jira.

Jira Server не поддерживает API-токены. Для получения доступа к Jira Server используйте пароль от учетной записи служебного сотрудника в Jira.

Настройка вебхуков

Настройка доступна администратору проекта в Jira.

В верхнем меню выберите "Настройки" → "Система". На панели слева в разделе "Дополнительно" выберите "Веб-хуки".

Укажите URL событий в формате:

<URL приложения>/services/rest/exec-post?func=modules.jiraToNaumen.processWebhook&accessKey=<Access Key сотрудника>&params=requestContent

где:

  • <URL приложения> — адрес приложения SMP в формате yourapplication.ru/sd;
  • <Access Key сотрудника> — ключ доступа служебного сотрудника для интеграции.

Выберите события для интеграции. При настройке вебхуков для выбора доступны все события Jira, участвовать в интеграции будут только события, поддерживаемые интеграцией с SMP.

При настройке вебхуков не устанавливайте флажок в параметре "Исключить основу".

Настройка карточки объекта

Настройка доступна администратору проекта в Jira.

Для перехода к настройке в верхнем меню выберите "Проекты" и название вашего проекта. На панели слева выберите "Настройки проекта" → "Типы задач".

Добавьте на карточку типа, объекты которого будут участвовать в интеграции, все поля, значения которых должны передаваться в SMP при интеграции.

Обязательность полей в Jira должна совпадать с обязательностью атрибутов в SMP.

Настройка жизненного цикла объекта

Настройка доступна администратору проекта в Jira.

На карточке типа, объекты которого будут участвовать в интеграции, нажмите кнопку "Изменить рабочий процесс". Настройте статусы и переходы в соответствии с настройкой жизненного цикла объекта интеграции в SMP.

Настройка статусов и переходов в Jira должна совпадать с настройкой жизненного цикла объекта интеграции в SMP.

Настройка доступа служебного сотрудника к проекту

Настройка доступна администратору проекта в Jira.

Для перехода к настройке в верхнем меню выберите "Проекты" и название вашего проекта. На панели слева выберите "Настройки проекта" → "Доступ".

Укажите проект, для которого настраивается интеграция, и роль служебного сотрудника в нем.

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