Категории

Jira

Содержание


Jira — программа для планирования и контроля проектов. Благодаря интеграции работать с задачами Jira можно напрямую из Юздеска: создавать их прямо из карточки запроса, отслеживать последние изменения, привязывать к запросам уже существующие задачи.


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

1. Создайте дополнительное поле с типом «Текст». Откройте раздел «Настройки» ⟶ «Дополнительные поля», выберите «Текст» и нажмите «Создать».


Укажите заголовок поля «Jira», снимите галочки с чекбоксов «Присваивать тег» и «Создать как фильтр» и поставьте галочку в чекбоксе «Нельзя редактировать». Затем нажмите «Сохранить».


2. Создайте динамический блок. Откройте раздел «Настройки» ⟶ «Блоки», нажмите «Добавить динамический блок»:

  • Имя – Jira;
  • Заголовок – Jira;
  • Содержание блока — оставьте поле пустым;
  • URL – заполните поле значением https://jiranew-integrations.usedesk.ru/api;
  • Включен – выберите чекбокс для активации блока;
  • Параметры (POST) – нажмите «Добавить параметр» и переходите к п. 3.


3. Добавьте параметры (POST):

Важно! Для корректной работы интеграции у указываемого в параметрах пользователя Jira должны быть следующие права:

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


Если у вас коробочная версия:

  • jira_username – логин пользователя в Jira (рекомендуем сделать отдельного суперадмина с логином «UsedeskBot»);
  • jira_secret – пароль аккаунта Jira, имя пользователя которого вы указали в поле jira_username (обязательный параметр);
  • usedesk_token – API токен. Как создать API канал и найти его токен написали тут;
  • jira_domain – домен Jira. Писать с https:// (обязательный параметр);
  • usedesk_field_id – ID дополнительного поля из п. 1 (обязательный параметр);
  • usedesk_url — URL API Юздеска. Указывается, если вы используете коробочную версию Юздеска на собственном сервере. В таком случае уточните значение у поддержки — support@usedesk.ru (необязательный параметр);
  • project — если указать key проектов, задачи можно будет создавать только в них. Например: «MAIN», «SALES», «SUPP» Если параметр не используется, задачи можно будет создать в любом проекте.


Если у вас облачная версия:

  • jira_username – e-mail пользователя в Jira (рекомендуем сделать отдельного суперадмина с логином «UsedeskBot»);
  • jira_secret – токен Jira. О том, как его получить, читайте здесь;
  • usedesk_token – API токен. Как создать API канал и найти его токен написали тут;
  • jira_domain – домен Jira. Писать с https:// (обязательный параметр);
  • usedesk_field_id – ID дополнительного поля из п. 1 (обязательный параметр);
  • usedesk_url — URL API Юздеска. Указывается, если вы используете коробочную версию Юздеска на собственном сервере. В таком случае уточните значение у поддержки — support@usedesk.ru (необязательный параметр);
  • project — если указать key проектов, задачи можно будет создавать только в них. Например: «MAIN», «SALES», «SUPP» Если параметр не используется, задачи можно будет создать в любом проекте.


После внесения всех изменений нажмите «Сохранить».


Передача статусов задач из Jira

В Юздеске можно настроить правила, которые будут срабатывать, когда задача в Jira перейдет в определённый статус. Например, можно перевести запросы с прикреплённой задачей в открытый статус, чтобы оповестить клиентов о решении проблемы или о новой функции, или даже настроить автоматическое оповещение.

Для передачи статуса в дополнительное поле Юздеска нужно настроить вебхуки в Jira.

Важно: мы сможем передавать статус в Юздеск только в том случае, если к запросу прикреплена только одна задача.


Создайте дополнительное поле для статуса задачи

Создайте дополнительное поле с типом «Текст». Откройте раздел «Настройки» → «Дополнительные поля», выберите «Текст» и нажмите «Создать».


Укажите заголовок поля «Статус в Jira», снимите галочки с чекбоксов «Присваивать тег» и «Создать как фильтр» и поставьте галочку в чекбоксе «Нельзя редактировать». Затем нажмите «Сохранить».



Получите адрес вебхука

Перейдите на страницу получения адреса: https://jirasettings-integrations.usedesk.ru


В поле «Usedesk токен» укажите токен API-канала. О том, как его получить, рассказываем тут.

В поле «Usedesk host» нужно указать адрес API Юздеска. Если вы пользуетесь облачным Юздеском, менять ничего не нужно. Если вы используете коробочную версию Юздеска на собственном сервере, уточните URL для работы с API у поддержки.

Заполните дополнительные данные для взаимодействия Jira и Юздеска:



  • Дополнительное поле — дополнительное поле в Юздеске, в котором содержится идентификатор задачи. Вы создали его в пункте 1 настройки интеграции с Jira.
  • Дополнительное поле для статуса в Jira — дополнительное поле с типом «текст», в которое будет передаваться статус задачи из Jira.
  • Переоткрытие задачи в Usedesk в Jira — параметр, который регулирует переоткрытие задач в Юздеске при событии в Jira:
    • Никогда не обновлять — мы не будем переоткрывать задачу;
    • Только комментарии — мы будем переоткрывать запрос при новом комментарии в Jira;
    • Только изменения — мы будем переоткрывать запрос при изменении задачи в Jira;
    • Всегда — мы будем переоткрывать запрос и при изменении задачи, и при новых комментариях в Jira.

Установите имя статуса в Jira, при котором мы будем добавлять тег «закрыто_jira» и переоткрывать задачу в этом случае. Если в этом нет необходимости, поле можно заполнить как «нет».


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


Настройте Jira

Внимание: настройки могут меняться в зависимости от версии Jira. Ниже приведена инструкция для облачной Jira.

Перейдите в настройки Jira:



В левой панели выберите пункт «WebHooks» в разделе «Advanced»:



В правой панели нажмите на «Create a WebHook»:


Заполните данные:

  • Name — удобное для вас имя, чтобы идентифицировать его в дальнейшем;
  • Status — Enabled;
  • URL — адрес для вебхука, полученный выше;
  • Issue related events — отметить галочками «Comment: created» и «Issue: updated».


Не забудьте сохранить настройки нажатием на кнопку «Create» внизу страницы.


Принцип интеграции

В карточке запроса дополнительный блок расположен в правой части страницы под карточкой клиента и другими дополнительными блоками (при наличии).



Создание задачи в карточке запроса

Создавать задачи Jira можно напрямую из карточки запроса. Для этого нажмите кнопку «Создать», заполните появившиеся поля и снова нажмите на «Создать».


Важные нюансы:

  • в зависимости от параметра project в настройках дополнительного блока мы покажем либо все проекты в вашем аккаунте Jira, либо только указанные;
  • список исполнителей подтягивается из Jira;
  • к задаче можно прикрепить одно или несколько вложений.

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

К карточке запроса вы можете привязать одну и более задач Jira. Связь будет отображаться в дополнительном поле из п. 1. Привязать = видеть информацию по конкретной задаче (задачам) в карточке запроса. Для этого нажмите «Связать» и заполните поле «Номер», вписав ключ задачи Jira. Например, MARKETING-777.


Блок Jira в карточке запроса: общая информация

Дополнительный блок карточки запроса Jira включает в себя следующее:

1. Кнопки «Создать», «Связать», «Отвязать» — кнопки для создания, прикрепления и удаления задачи в карточке запроса.

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


Если вы привязали несколько задач к карточке запроса, в блоке будет отображаться список задач. Ключ задачи в общем списке – ссылка для перехода из Юздеска в Jira (в примере – DEMO-125). Для перехода в карточку конкретной задачи кликните на её название (в примере — 211212). Чтобы отвязать задачу – перейдите в карточку задачи и нажмите кнопку «Отвязать».


Все логи по созданию, прикреплению и удалению задач Jira отображаются в карточке запроса в виде внутренних комментариев:


2. Кнопка «Назад к списку» – для возврата в общий список задач Jira, привязанных к карточке запроса (отображается, если привязано более одной задачи).


3. Ключ задачи – ссылка для перехода из Юздеска в Jira, открывается в новом окне.


4. Дополнительные поля – дополнительная информация из Jira, которую вы сами можете настроить для отображения в карточке задачи. Для этого нажмите на шестерёнку и выберите поля, которые будут отображаться в карточке задачи. Порядок расположения полей можно менять перетаскиванием.


5. Изменения – история изменений в задаче. Для удобства можно использовать сортировку: отображать сначала либо последние, либо старые изменения.


6. Раздел «Комментарии» отображает все комментарии к задаче. Для удобства комментарии можно сортировать по дате создания: отображать первыми либо старые, либо новые.


7. Кнопка «Написать комментарий» – функция, с помощью которой вы можете оставить комментарий в задаче, не переходя при этом в Jira.


В журнале карточки запроса запишется соответствующий лог.