⌘ K

ServiceDesk Plus · Для администраторов

Пользовательский виджет JIRA

Скачайте соответствующий ZIP-архив виджета для своей сборки ServiceDesk Plus.

Для сборок до 15200 нажмите здесь. 

Для сборок 15200 и выше нажмите здесь.

 

Виджет JIRA интегрирует управление задачами JIRA с управлением заявками ServiceDesk Plus. Пользователи могут создавать задачи JIRA и связывать их с соответствующими заявками ServiceDesk Plus.

После создания связи виджет при каждом открытии из заявки ServiceDesk Plus показывает актуальные сведения о связанной задаче JIRA.

Основные возможности

  • Создание задач: Создание новой задачи JIRA из ServiceDesk Plus.
  • Отслеживание задач: Просмотр и отслеживание задач JIRA, связанных с заявками ServiceDesk Plus.
  • Двусторонняя синхронизация: Синхронизация сведений между JIRA и ServiceDesk Plus.
  • Динамические поля: Автоматическая загрузка полей и типов задач выбранного проекта.
  • Просмотр истории: Отслеживание изменений сведений о задачах JIRA и связанных заявках ServiceDesk Plus.

Установка виджета JIRA 

Шаг 1. Создание токена API JIRA 

  • Откройте страницу токенов API JIRA , чтобы создать новый токен для виджета. При наличии можно использовать существующий токен.

Иллюстрация 1: Пользовательский виджет JIRA

  • Нажмите Create API token without scopes. 
  • Задайте дату истечения и создайте токен. 
  • Скопируйте созданный токен.

Шаг 2. Создание сервиса и соединения 

  • Войдите в ServiceDesk Plus.
  • Перейдите в Admin > Developer Space > Connections > Custom Services.
  • Нажмите Create Service.
  • Укажите имя сервиса jira. Ссылка сервиса заполняется автоматически и доступна для изменения.
Имя сервиса должно быть в нижнем регистре или формате snake case.
  • Установите Authentication Type в значение Basic Authentication.
  • Нажмите Create Service.

Иллюстрация 2: Пользовательский виджет JIRA

  • Нажмите Create Connection. 
  • Укажите имя соединения, аналогичное имени сервиса. Ссылка соединения заполняется автоматически и доступна для изменения.
  • Нажмите Create And Connect. Появится запрос учётных данных JIRA.
 Имя пользователя — имя для входа в JIRA, обычно адрес электронной почты; пароль — созданный токен API. 
  • Нажмите Connect , чтобы авторизовать соединение.
  • Скопируйте метаданные JSON на странице сведений о соединении.

Иллюстрация 3: Пользовательский виджет JIRA

Шаг 3. Скачивание и настройка ZIP-архива виджета 

  • Нажмите здесь , чтобы скачать ZIP-архив виджета JIRA. 
  • Распакуйте архив и откройте plugin-manifest.json. 
  • Вставьте скопированные метаданные JSON в массив connections, как показано ниже:

Иллюстрация 4: Пользовательский виджет JIRA

  • Добавьте домен экземпляра JIRA в массив white_list.

Иллюстрация 5: Пользовательский виджет JIRA

 

  • Откройте config.json , чтобы настроить поведение и возможности виджета. В файле доступны следующие атрибуты:
    • jiraType: укажите, является ли экземпляр JIRA облачным или локальным. Допустимые значения: cloud и jiraop.
    • domain: укажите домен экземпляра JIRA. Например, если он размещён на https://sdptest.atlassian.com, задайте значение домена sdptest.atlassian.com.
    • protocol: Укажите протокол домена: http или https.
    • apiVersion: укажите используемую версию API JIRA. Это важно, поскольку у разных версий могут отличаться конечные точки или возможности. По умолчанию apiVersion установлен в 3.
    • apiBasePath: Укажите путь запросов API. Для облачных экземпляров JIRA используется /rest/api, а для локальных обычно /jira/rest/api.
    • fieldMapping: укажите поля для синхронизации JIRA и ServiceDesk Plus.
    "fieldMapping": [ 
      { 
        "field": "summary", 
        "displayName": "Summary", 
        "defaultValue": "${{request.subject}}", 
        "view": true, 
        "sync": true, 
        "values": { 
          "sourceValue": "jiraValue" 
        } 
      } 
  ] 

Описание кода

Ключ

Значение

"field": "summary"

Целевой атрибут поля JIRA, с которым сопоставляются данные; в данном случае поле summary.

"displayName": "Summary"

Понятное пользователю имя поля для отображения в виджете.

"defaultValue": "${{request.subject}}"

Задаёт значение поля по умолчанию из request.subject в ServiceDesk Plus. При синхронизации этот шаблон динамически заменяется значением.

"view": true

Указывает, что поле должно быть видно в виджете.

"sync": true

Указывает двустороннюю синхронизацию между JIRA и ServiceDesk Plus.

Если sync установлен в true, последнее значение поля summary синхронизируется в обоих приложениях.

"values": { "sourceValue": "jiraValue" }

Сопоставляет значения полей приложений. В этом примере sourceValue в ServiceDesk Plus сопоставляется с jiraValue в JIRA.

 

  • После настройки необходимых параметров снова упакуйте все файлы виджета в ZIP-архив.
 Не архивируйте родительскую папку. Выберите все файлы по отдельности и создайте архив.  

Шаг 4. Загрузка пользовательского виджета JIRA 

В ServiceDesk Plus:

  • Перейдите в Admin > Developer Space > Custom Widgets. 
  • Добавьте новый виджет и загрузите ZIP-архив.
  • Нажмите Save. 

Теперь полностью работающий виджет JIRA должен быть доступен.

 Открытие виджета JIRA 

  • Откройте страницу сведений существующей заявки. 
  • Перейдите во вкладку JIRA на странице сведений, чтобы открыть виджет.

Иллюстрация 6: Пользовательский виджет JIRA

 Создание задачи JIRA в виджете 

  • В виджете нажмите Create an issue , чтобы создать задачу JIRA и связать её с заявкой ServiceDesk Plus.
  • Выберите проект и тип задачи. Виджет автоматически заполнит поля, относящиеся к выбранным проекту и типу.
  • После заполнения сведений нажмите Create Issue. 

Иллюстрация 7: Пользовательский виджет JIRA

  • Созданная задача JIRA автоматически связывается с заявкой ServiceDesk Plus. При открытии виджета из заявки отображаются сведения о связанной задаче, как показано ниже:

Иллюстрация 8: Пользовательский виджет JIRA

Примечание: 

На странице связанной задачи используйте следующие действия синхронизации; автоматическая синхронизация в виджете пока не поддерживается:

  • Нажмите Update JIRA with Request Change , чтобы обновить соответствующую задачу JIRA актуальными сведениями заявки ServiceDesk Plus.
  • Нажмите Update Request with JIRA Changes , чтобы обновить соответствующую заявку ServiceDesk Plus актуальными сведениями задачи JIRA.