Интеграция с JIRA Service Desk

Добро пожаловать в JIRA Service Desk Server! В этом обзоре мы рассмотрим все, что вам нужно знать, чтобы интегрироваться с JIRA Service Desk Server. Это включает в себя фреймворк P2 для создания надстроек, а также функции и сервисы JIRA Service Desk, которые можно использовать при интеграции с JIRA Service Desk.

Привет мир

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

Что такое JIRA Service Desk?

Служба JIRA Service Desk в основном используется в качестве сервисного решения, от управления активами до DevOps. В разнообразных ИТ-командах используется JIRA Service Desk, включая группы поддержки, оперативные группы и многое другое. С более чем 15 000 из этих команд, использующих JIRA Service Desk, есть много возможностей для его расширения. Входите и начинайте!

Если вы ранее не использовали JIRA Service Desk, ознакомьтесь с обзором продукта для получения дополнительной информации.

Создание надстроек для JIRA Service Desk Server

Если вы хотите создать надстройку для JIRA Service Desk Server, вы должны использовать платформу разработки Atlassian, которая включает фрейворк Plugins2. Надстройки используются для расширения функциональности JIRA Service Desk, которая может быть интеграцией с другим существующим сервисом, новыми функциями для JIRA Service Desk или даже новым продуктом, который работает в JIRA Service Desk.

Основной поток разработки для создания надстройки JIRA Service Desk с использованием Atlassian SDK:

Создайте свой дополнительный проект, как и любое другое дополнение JIRA, например, с помощью команды SDK atlas-create-jira-plugin. Эта команда создает дополнительные файлы проекта и скелетный код.

Когда вы готовы к созданию и тестированию своего дополнения, запустите команду atlas-package из корневого каталога проекта. Эта команда создает пакетный JAR-файл, который вы можете установить в JIRA (в подкаталог target)

Настройте AMPS для запуска JIRA с установленной службой JIRA Service Desk. Если вы еще этого не делали, см. раздел Настройка AMPS для запуска JIRA Core с установленными дополнительными приложениями.
Запустите JIRA. Для ранней разработки и тестирования вы можете использовать экземпляр разработки, который SDK предоставляет вам при запуске следующей команды (установите версию до 7.0.0 или новее): atlas-run-standalone --product jira -version 7.0.0.

Войдите в JIRA в качестве администратора, используя комбинацию имени пользователя и пароля по умолчанию admin / admin.

Установите надстройку, созданную на шаге 2, с помощью команды atlas-package. Вы можете сделать это двумя способами:
1. Перейдите в Консоль администрирования и откройте страницу «Управление надстройками». На странице нажмите Загрузить надстройку и выберите файл JAR, созданный для вас командой atlas-package. Вы найдете JAR-файл в целевом каталоге вашего дома проекта после запуска atlas-package.
2. Используя инструменты командной строки SDK: используя терминал, перейдите в домашний каталог проекта и просто запустите плагин atlas-install-plugin (после того, как он упаковал ваш дополнительный JAR с помощью команды SDK atlas-package). Эта команда просто загрузит ваше дополнение в UPM (и может значительно сократить ваш поток разработки).
Теперь вы должны увидеть свою надстройку на странице JIRA «Управление надстройками» в качестве установленного плагина. Каждый раз, когда вы меняете свой код надстройки или ресурсы, перезагрузите вашу надстройку повторяя шаг # 6 выше.

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

Разработка с помощью плагинов2

Если вы создаете надстройку с помощью Plugins2, вам также нужно будет понять ряд ключевых процессов разработки:

Внедрение безопасности: внедрение безопасности является важной частью интеграции с JIRA. Подробнее об аутентификации и авторизации для JIRA Server см. в Обзор безопасности.
Перечисление вашей надстройки на Atlassian Marketplace и внедрение лицензирования: список вашей надстройки на Atlassian Marketplaces и лицензирование необходимы, если вы хотите сделать свою надстройку доступной для общественности. Дополнительную информацию см. в Документация Marketplace.
Проектирование вашей надстройки: поскольку надстройки Plugins2 могут вставлять контент непосредственно в приложение Atlassian host, крайне важно, чтобы надстройки были визуально совместимы с дизайном приложения Atlassian. Наши дизайнеры и разработчики создали ряд ресурсов, которые помогут вам в этом:
- Atlassian Design Guidelines - наши руководящие принципы проектирования определяют основные взаимодействия с приложениями Atlassian.
- Atlassian User Interface (AUI) - AUI - это библиотека многократно используемых внешних компонентов интерфейса.

Создание блоков для интеграции с сервером Service Desk JIRA

Три основных компонента интеграции с JIRA Service Desk - это API, веб-узлы и модули.

API-интерфейс JIRA Service Desk Server

API-интерфейсы JIRA Service Desk Server позволяют вашей интеграции взаимодействовать с JIRA Service Desk Server. Например, используя REST API, вы можете получить запросы очереди для отображения в своем надстройке или создавать запросы из телефонных звонков. Для большинства других интеграций вы должны использовать REST API. API Java следует использовать только в том случае, если вы создаете надстройку Plugins2.

API-интерфейс REST API-службы JIRA Service Desk (последняя версия)
JIRA Service Desk Server Java API (последняя версия)

Примечание. Служба JIRA Service Desk построена на платформе JIRA, поэтому вы можете использовать API-интерфейс REST API JIRA и API-интерфейс Java-платформы JIRA для взаимодействия с JIRA Service Desk Server.

Webhooks и правила автоматизации

Надстройки и приложения могут реагировать на условия / события в JIRA Service Desk с помощью правил автоматизации. Вы можете реализовать «действие автоматизации», которое выполняет действия в удаленной системе как часть правила автоматизации. Также можно настроить правило автоматизации для запуска веб-узлов, которые уведомляют ваше дополнение или приложение. Для получения дополнительной информации см. Веб-ссылки JIRA Service Desk.

Модули JIRA Service Desk

Модуль - это просто элемент пользовательского интерфейса, например вкладка или меню. Модули пользовательского интерфейса Service Desk JIRA позволяют надстройкам взаимодействовать с пользовательским интерфейсом JIRA Service Desk. Например, ваш надстройку может использовать модуль пользовательского интерфейса JIRA Service Desk для добавления панели в верхнюю часть клиентских порталов. Дополнительные сведения см. в разделе О модулях JIRA.

Сервер JIRA Service Desk и платформа JIRA

JIRA Service Desk - это приложение, созданное на платформе JIRA. Платформа JIRA предоставляет набор базовых функциональных возможностей, которые распределяются между всеми приложениями JIRA, такими как задачи, рабочие процессы, поиск, электронная почта и т. д. Приложение JIRA является расширением платформы JIRA, которая обеспечивает определенную функциональность. Например, JIRA Service Desk добавляет порталы запросов клиентов, очереди поддержки, SLA, базу знаний и автоматизацию.

Это означает, что, когда вы разрабатываете JIRA Service Desk, вы фактически интегрируетесь с приложением JIRA Service Desk, а также с платформой JIRA. Приложение JIRA Service Desk и платформа JIRA имеют свои собственные API REST, события веб-хостинга и веб-фрагменты.

Прочтите документацию на платформе JIRA Server для получения дополнительной информации.

Ищете вдохновение?

Если вы ищете идеи по созданию следующей интеграции JIRA Service Desk Server, это могут привести к следующим примерам использования и примерам.

Вот несколько распространенных случаев использования JIRA Service Desk:

Support helpdesk: простой способ предоставить поддержку любому в организации с ИТ-запросами, такими как запросы на оборудование (ноутбук) или программное обеспечение.
ITSM / ITIL: более продвинутые ИТ-команды хотят использовать сервисное решение для поддержки процессов ITSM и ITIL, включая управление инцидентами, проблемами и изменениями.
Управление активами: ИТ-команды хотят открывать, контролировать, отслеживать и отслеживать ключевые ИТ-активы, такие как оборудование и серверы.
DevOps: разработчики, операторы и ИТ-команды могут использовать JIRA Service Desk для совместной работы и решения проблем быстрее.
Бизнес-команды: финансовые и HR-команды могут использовать JIRA Service Desk для сбора запросов от любого лица в организации.

Вот несколько примеров того, что можно построить поверх JIRA Service Desk:

Настройка клиентского портала: JIRA Service Desk предоставляет интуитивно понятный клиентский портал, который позволяет нетехническим конечным пользователям взаимодействовать с сервисными группами, такими как ИТ и поддержка. Расширяя это, вы можете создать полностью адаптированный интерфейс для портала клиента, который соответствует брендингу вашей компании.
Собирайте запросы за пределами службы поддержки JIRA: создавайте функциональные возможности для создания запросов от имени клиентов различными способами. Например, интегрируйте его в раздел поддержки вашего веб-сайта или получите меню помощи в мобильном приложении или подключите оповещения к инструменту системного мониторинга для создания инцидентов в JIRA Service Desk.
Интеграция SLA: JIRA Service Desk вводит понятие соглашений об уровне обслуживания (SLA), позволяя командам точно измерять и устанавливать цели на основе временных показателей, например. время для назначения, время ответа, время до разрешения. С помощью REST API JIRA Service Desk вы можете получить подробную информацию об SLA и создать свои собственные отчеты.
Интеграция телефонии: создание запросов на основе входящих голосовых вызовов путем интеграции вашей телефонной системы с JIRA Service Desk через API REST.
Информация о дополнительном запросе: добавьте информацию об активах, клиенте или другой соответствующей информации в запросы, чтобы облегчить агентам решение проблем и закрытие запросов.

Больше информации

jira-servicedesk-development tag на форуме Atlassian Answers - Присоединяйтесь к обсуждению разработки JIRA Service Desk.

По материалам Atlassian JIRA Server Developer Integrating with JIRA Service Desk