¶ Интеграция с OTRS системой
В данном разделе описана интеграция только в части процессов управления инцидентами.
Основные функциональные возможности:
- Для каждого События платформы можно оформить ПОДПИСКУ на отправку уведомления в OTRS. В платформе в Справочнике Внешних систем заводится пользователь OTRS, для которого настраивается подписка событий.
- В OTRS при заведении INC по событию платформы отправляется информация об INC, в котором есть номер события IoT и статус. Этот INC записывается как атрибут события и доступен в представлении Журнала событий в Основном Приложении.
- Платформа при отправке события должна учитывать корреляцию событий. Для первого события в цепочке событий передает событие как НОВЫЙ INC, для закрывающего события передает как РЕШЕНО INC, для промежуточных событий как ВЫПОЛНЯЕТСЯ INC.
- При внесении в Журнал работ OTRS комментария о ходе работ, если в INC есть номер события платформы, отсылается по RESTAPI платформы данные о комментарии и они вносятся в журнал комментов события. В Журнале событий платформы появится признак в Событии о наличии комментария по INC.
Схема поцесса показана ниже:
¶ Настройка интеграции в платформе
- В разделе Справочники->Справочник внешних систем загрузить форму и создать внешнюю систему (например OTRS-ISS). Пользователь должен обладать правами root, SA, IM (см. управление пользователями).
- Внести сведения о внешней системы. Имя будет отображаться в Журнале при просмотре инцидента. URL - указать url, который будет использоваться для клика на номер инциента в платформе и перехода в систему OTRS на список инцидентов.
- Создать группу с ролью Менеджер Инцидентов. Создать пользователя и включить его в группу Incident Managment. В область видимости пользователя по рубрикам дать те объекты, по которым необходимо создавать инциденты в OTRS.
- В справочнике Событий выбрать те события, по которм необходимо создавать инцидент , в атрибутах События установить флажок
Экспорт. - Кликнуть на кнопку Выбрать внешние события и указать ту систему, которую вносили в справочнике Внешних систем.
На этом настройки в платформе завершены. Можно переходить к настройке модуля интеграции otrs-gate.
¶ Модуль интеграции
¶ Установка модуля
Создать директорию /opt/otrs-gate и поместить в нее otrs-gate.jar, application.yml
mkdir /opt/otrs-gate
cp otrs-gate.jar /opt/otrs-gate
cp application.yml /opt/otrs-gate
Создать директорию для логов:
mkdir -p /var/log/otrs-gate
Настроить к ней путь в конфиге application.yml:
logging:
path: /var/log/otrs-gate
Создать символьную ссылку в директории /etc/init.d
cd /etc/init.d
chmod +x /opt/otrs-gate/otrs-gate.jar
ln -s /opt/otrs-gate/otrs-gate.jar otrs-gate
Перечитать списко сервисов linux
systemctl daemon-reload
Запуск и остановку сервиса можно осуществлять стандартными командами, т.е.
service otrs-gate start
service otrs-gate status
service otrs-gate stop
¶ Настройка модуля
Настройка модуля проводится в файле appication.yml
- Настройка секции логина OTRS (пример ниже)
# Параметры настройки на OTRS
otrs:
rest:
# url api работы с заявкой
url: http://10.10.2.68:8089/otrs/nph-genericinterface.pl/Webservice/Ticket/
# параметры логина
user: otrs_user
password: otrs_password
- Настройка секции с платформой (пример ниже). В секции artemis указываем параметры подключения к брокеру JMS для подписки на очередь EventExport.
# Параметры настройки на Semnext
sem-next:
rest:
# пользователь минимум должен обладать ролью INCIDENT_MANAGER
# и иметь в видимости объекты на которых создаются экспортные события
url: http://10.3.2.103/sem-restservices/
user: otrs_im
password: otrs_user
artemis:
broker-url: tcp://10.10.2.73:61616
user: artemis_user
password: artemis_password
event-export-topic: jms.topic.EventExport
- Настройка параметров интеграции
Эти настройки тесно связаны с атрибутами карточки инцидента OTRS и предполагают интеграционное соглашение между двумя системами.
- Ключ deviceClassifier: DeviceClassifier указывает, что в поле карточки OTRS deviceClassifier передается имя классификатора устройства, по которому произошло событие
- state-xxx: <статусы> - статусы для заявок, по которым идут события
Остальные поля понятны и откомментрованы
# параметры интеграции
integration:
# идентификатор справочника внешних систем в платформе которые должен обрабатвать модуль
ext-system: OTRS-ISS
# имя атрибута в заявке OTRS в который маппировать DeviceClassifier.name
deviceClassifier: DeviceClassifier
# константы OTRS которых нельзя получить из Semnext, и которые являются обязательными для api OTRS
# для заявки
ticket:
# очередь заявок
queue: Raw
# блокировка
lock: unlock
# тип заявки
type: Incident
# статус для новой заявки
state-new: new
# статус заявки для событий внутри одного инцидента и комментариев к событию
state-progress: open
# статус для закрытия заявки
state-close: closed successful
# приоритет
priority: 3 normal
# логин в OTRS владельца
owner: otrs_user
# логин в OTRS клиента
customer-user: otrs_im
# для журнала по заявке
article:
# канал
communication-channel: Email
# тип контента
content-type: text/plain; charset=utf8
# тема для комментария из Semnext для передачи в OTRS
comment-title: Пользователь внес информацию по событию