ITSM системы

23 января 2025 г.Около 4 минGateITSM

Общее описнаие процесса интеграции с ITSM системами

Основной задачей интеграции Inspark c ITSM системами является передача данных о событиях регистрируемых в Inspark в
эти системы, для их отработки и контроля службой service desk использующих ITSM систему для организации своих процессов.

Общие функции интеграции:

создание на основании события Inspark заявки (инцидента) в интегрируемой системе;
передача данных об обработке (комментарии) событий из Inspark в ITSM системы;
передача изменения состояния события в Inspark в ITSM систему;
возможность получить информацию в Inspark об отработке заявки по событию в ITSM системе.

Настройка взаимодействия в Inspark

Настройка Внешней системы

Каждая интегрируемая система ITSM должна быть зарегистрирована в справочнике "Внешних систем"

Инфо

ID (идентификатор внешней системы) используется для настройки интеграционных моделей
URL обеспечивает доступ к заявкам созданным из Inspark в ITSM системе из ЛК

Настройка интегрируемых событий

Для того чтобы событие Inspark передавалось во внешние системы событие должно иметь тип "Экспорт" и в спике внешних
систем для экспорта должна быть указана система котораяможет получать данное событие

Список сиситем для которых экспортируется событие

Параметры события и связанных сущностей Inspark для экспорта

 * Идентификатор записи в журнале событий (EventLog.Id).
 * Идентификатор типа события.
 * Название события.
 * Время события.
 * Текст сообщения.
 * Идентификатор критичности.
 * Название критичности.
 * Значение связанного с событием параметра.
 * Идентификатор контроллера.
 * Название объекта.
 * Полное наименование объекта.
 * Идентификатор статуса объекта.
 * Название статуса объекта.
 * Идентификатор типового измеряемого параметра (если таковой связан с событием).
 * Идентификатор типового вычисляемого параметра (если таковой связан с событием).
 * Название параметра.
 * Теги параметра, через табуляцию.
 * Название зоны.
 * Название классификатора устройства.
 * Название схемы подключения.
 * Код параметра.
 * Идентификатор инцидента (цепочка событий).
 * Признак закрытия инцидента.
 * Код инцидента во внешней системе (для интеграций).
 * Идентификаторы внешних систем через запятую.
 * Комментарий, который оставил пользователь в журнале активностей.
 * Время комментария в журнале активностей.
 * Пользователь, оставивший комментарий в журнале активностей.

Настройки платформы Inspark для выгрузки экспортных событий

Все события, для которых установлен признак экспортное выгружаются в jms топик (очередь) Artemis. Все подписчики данной очереди получат сообщение представляющее экспортное событие с параметрами как описано выше. Настраивается данная
очередь в sem-engine

artemis: 
  ...
  # настройки очередей
  queue:    
    ...
    eventexport:
      destination: jms.topic.EventExport
      concurrency: 1-8

Модуль интеграции ExploIt

Explo-IT обеспечивает информационно-аналитическую поддержку организационно-технологических процессов эксплуатации объектов (зданий).
Задачи модуля передача событий регистрируемых в Inspark в Explo-It.

API интеграции с Explo-It

Протокол обмена

Основа работы Explo-It создание заявок на обслуживание оборудования. Т.е. при создании заявки необходимо обязательно
указать связанное оборудование. Планируется при реализации следующих шагов интеграции систем, связь между оборудованием
Explo-It и устройствами Inspark перенести в MDM (Система мастер данных). В текущей интеграции связь с оборудованием
в Explo_It осуществляется через альтернативный код параметров на контроллере, в который заносится идентификатор
оборудования Explo-It, и при создании событий связанных с такими параметрами, связь устанавливается по данному
идентификатору.

Инфо

Дополнительно реализовано требование, если событие настроено на передачу в ExploIt, но для связанного события не > установлена связь с оборудованием, то такое событие передается как связанное с оборудованием по умолчанию, которое задается в конфигурации модуля интеграции.
Дополнительно реализовано требование, если событие настроено на передачу в ExploIt и оно связано с параметром на контроллере имеющим тип значения IMAGE (изображение, хранящееся на медиа-сервере), то такое событие передается в Explo-It вместе со ссылкой на изображение хранящееся в Inspark.

Алгоритм работы модуля:

при старте и периодически в соответствии с настройками осуществляется вычитывание из инстанса Inspark всех параметров
из доступных объектов у которых установлен атрибут "альтернативный код" или тип значения IMAGE
(изображение, хранящееся на медиа-сервере), данные сохраняются в оперативном кэше;
при старте модуль подписывается на jms очередь экспортных событий;
при получении сообщения в очередь экспортных событий модуль распарсивает событие;
если событие настроено для передачи в Explo-It, переход к следующему шагу, если нет завершение обработки;
подготовка данных для api Explo-It

Параметр	Обозначение	Правило заполнения
Уникальный идентификатор связанного оборудования	equipmentId	Заполняется из поля "Cобытие"."Код параметра"
Уникальный идентификатор связанного положения	locationId	Не используется
Текстовое описание события	description	"Cобытие"."Текст сообщения"
Приоритет события	priority	Маппинг "Cобытие"."Идентификатор критичности" по правилу: 1 — ggid-priority-critical, 2 — ggid-priority-high, 3 — ggid-priority-medium, 4 — ggid-priority-low
Класс Заявки	requestClass	Не используется
Уникальный идентификатор события в BMS системе	bmsEventId	"Cобытие"."Идентификатор инцидента (цепочка событий)"
Код события	eventCode	"Cобытие"."Идентификатор типа события"
Дата сообщения	eventDate	"Cобытие"."Время события" (Дата-время в формате ISO)
Статус события в BMS	eventStatus	Заполняется по правилу: - новое событие и для него еще не создана заявка в Explo-It - new_event; событие из цепочки событий по которому уже есть заявка в Explo-It – new_event_condition, событие содержит комментарий пользователя к событию которое уже создано в Explo-IT - event_acknowledged, если событие содержит ссылку на заявку в Explo-It, проверяется, является событие закрывающим инцидент Inspark - event_resolved
Ссылка на скачивание файлов, связанных с событием	fileLinks	Если с событием связан параметр с типом значения IMAGE заполняется "Cобытие"."Значение связанного с событием параметра" (содержится только файл картинки, полный путь к изображению достраивает Explo-It)

вызов метода api c передачей подготовленных данных выше;
логирование результатов взаимодействия;
разбор ответа от Explo-It, если ответ содержит идентификатор созданной заявки, сохранение идентификатора в Inspark;
завершение обработки.

Настройка связи параметров c оборудованием Explo-It

Для параметра связанного с оборудованием Explo-It задать в поле "Альтернативный код" equipmentId

Настройка в модуле exploit-gate

# подключение к рест-сервисам inspark (должен заканчиваться слэшем)
rest:
  url: http://localhost:8080/sem-restservices/
  user: root
  password: ******

# параметры подключения к артемис inspark
artemis:
  url: tcp://10.10.2.54:61616
  user: artemis
  password: ******
  # настройки очереди экспортных событий
  queue:
    eventexport:
      destination: jms.topic.EventExport

Настройка на Explo-It

# Параметры настройки на exploit
exploit:
  rest:
    # url api работы с заявкой
    url: https://test.explo-it.ru/api/newBmsMessage/
    # параметры логина
    user: inspark
    password: ******

# параметры интеграции
integration:
  # идентификатор справочника внешних систем в Semnext которые должен обрабатывать модуль
  ext-system: EXPLOIT-SUITCASE
  # идентификатор оборудования в Explo-It для создания инцидента, если идентификатор оборудования не зарегистрирован
  # в Inspark
  default-equipment-id: ggid537d-434d-449f-bf2c-55b7a2c30fa6
  # крон для запуска синхронизации мета данных из Inspark (коды параметров определяющие идентификаторы оборудования
  # Explo-It, измеряемые параметры, в которых мы можем вернуть картинки)
  cron: 0 0,15,30,45 * * * ?

Модуль интеграции Naumen

Интеграция между IoT и Naumen в части управления заявками (Incident).

Протокол обмена Naumen

Алгоритм работы модуля:

при старте модуль подписывается на jms очередь экспортных событий;
при получении сообщения в очередь экспортных событий модуль распарсивает событие;
если событие настроено для передачи в Naumen, переход к следующему шагу, если нет завершение обработки;
если сообщение представляет новое событие и для него еще не создана заявка в Naumen, вызов метода api создания заявки,
в случаи спешного создания заявки ее идентификатор и статус сохраняются в Inspark для инцидента связанного с событием;
если событие содержит ссылку на заявку в Naumen, проверяется, является событие закрывающим инцидент Inspark,
если да вызов метода api для обновления заявки с передачей времени закрытия заявки, если метод обновления выполняется
успешно, в инциденте Inspark обновляется статус внешней заявки;
если событие содержит комментарий к соьытию вызывается метод создания комментария в Naumen по заявке;
завершение обработки.

Настройка в модуле naumen-gate

# подключение к рест-сервисам inspark (должен заканчиваться слэшем)
rest:
  url: http://localhost:8080/sem-restservices/
  user: root
  password: masterkey

# параметры подключения к артемис inspark
artemis:
  url: tcp://10.10.2.54:61616
  user: artemis
  password: SuperHot
  # настройки очереди экспортных событий
  queue:
    eventexport:
      destination: jms.topic.EventExport

Настройка на Naumen

# Параметры настройки на Naumen
naumen:
  rest:
    # url api работы с заявкой
    url: http://192.168.246.29:8080
    # ключ доступа
    access-key: 00000000-0000-0000-000-000000000000

# параметры интеграции
integration:
  # идентификатор справочника внешних систем в Inspark которые должен обрабатывать модуль
  ext-system: NAUMEN