.. Read the Docs Template documentation master file, created by
   sphinx-quickstart on Tue Aug 26 14:19:49 2014.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Инструкция по установке приложения Arta Synergy SM
===================================================

Важно! Для работы данного приложения требуется:

* установить Arta Synergy 3.15 wilkes и выше (инструкция по установке)
* установить Elasticsearch и Kibana (инструкция по установке)
* в подсистеме администрирования обновить БД и процессы, завести Системного пользователя (код пользователя - itsm_service_user) с ролями “Администратор” и “Методолог” (“Разработчик Synergy”)
* в разделе конфигуратора “Специальные справочники” в wilkes / “Формы завершения” в hamming создать новую форму завершения: тип - “Без результата”, код - “no_result”, название - “Без подтверждения”, галочка “Требовать подтверждения результата” выключена

Arta Synergy SM устанавливается отдельным пакетом. Возможные варианты установки:

* Clean - полная установка приложения без демо-данных (“чистая” установка с загрузкой конфигурации и преднастроенных БД, хранилища, индексов Elasticsearch и Kibana, дашбордов)
* Install/Upgrade Configuration - установка приложения и загрузка его конфигурации (соответственно, без БД, хранилища, индексов и дашбордов)
* Manual - установка только приложения без автоматической загрузки конфигурации, дашбордов и всего остального

Подключение репозиториев
----------------------------------------------------------------------

Установочный пакет находится в репозитории *unstable*. В файле */etc/apt/sources.list* необходимо добавить либо раскомментировать следующую строку:

* *deb http://deb.arta.kz/tengri unstable main contrib non-free*

Установка приложения
----------------------------------------------------------------------

Для установки приложения необходимо выполнить команду:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

* *# apt-get update*
* *# apt-get install arta-synergy-apps-itsm*

В ходе установки необходимо выполнить следующее:
   
* Выбрать тип установки из предложенного списка
* Указать URL до Synergy, на котором производится работа (*например: http://192.168.1.172:8080/Synergy*)
* Ввести последовательно логин и пароль Системного пользователя

.. note::

Для предотвращения дальнейшей нечаянной установки нестабильных версий пакетов из репозитория *unstable*, 
после установки *arta-synergy-apps-itsm* рекомендуется его закомментировать в том же файле */etc/apt/sources.list*.

Для работоспособности личного кабинета необходимо
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

1. В файле */etc/nginx/sites-enabled/synergy-base* добавить следующее:

:: 

    location /itsm {

    allow			all;

    proxy_pass		http://127.0.0.1:8080/itsm;

    proxy_set_header	Host       $host;

    proxy_set_header	X-Real-IP  $remote_addr;
    
    }


2. Проверить наличие очередей и их слушателей для ITSM в двух файлах:


**/opt/synergy/jboss/standalone/configuration/standalone-onesynergy.xml**

:: 

    <jms-queue name="ItsmFormChangeQueue">
        <entry name="java:jboss/queues/Integration/ItsmFormChangeQueue"/>
        
        <durable>true</durable>
    </jms-queue>
    
    <jms-queue name="ItsmBlockingQueue">
        <entry name="java:jboss/queues/Integration/ItsmBlockingQueue"/>
        
        <durable>true</durable>
    </jms-queue>
    
    <jms-queue name="ItsmCallback_1">
        <entry name="java:jboss/queues/Integration/ItsmCallback_1"/>
        
        <durable>true</durable>
    </jms-queue>

**/opt/synergy/jboss/standalone/configuration/arta/api-observation-configuration.xml**

:: 

    <listener>
        <queue>java:jboss/queues/Integration/ItsmBlockingQueue</queue>
        
        <event>event.blocking.itsm.*</event>
    </listener>
    
    <listener>
        <queue>java:jboss/queues/Integration/ItsmBlockingQueue</queue>
        
        <event>event.blocking.incident.*</event>
    </listener>
    
    <listener>
        <queue>java:jboss/queues/Integration/ItsmBlockingQueue</queue>
        
        <event>event.blocking.problem.*</event>
    </listener>

3. Кроме того, удостоверьтесь, что конфигурационный файл */opt/synergy/jboss/standalone/configuration/itsm.properties* содержит следующие строки (только с Вашими данными):

    login=1

    password=1

    address=http://127.0.0.1:8080/Synergy

    public_address=http://192.168.1.172:8080/Synergy


После установки вариантом “Clean”
----------------------------------------------------------------------

В Kibana:
    * проверить, что всё загрузилось, в дашбордах отсутствуют визуализации, помеченные «!»

В Конфигураторе:
    * проверить во внешних модулях “Аналитика по инцидентам” и “Аналитика по проблемам” адрес приложения: должна быть актуальная ссылка на дашборды Kibana (в результате установки она может быть не полностью корректная)

В клиентской части:
    * проверить работоспособность обоих дашбордов
    * для работоспособности уведомлений на почту клиентам при их создании в реестре “Контакты” необходимо заполнить и поле e-mail
    * для работоспособности уведомлений о просрочке времени SLA необходимо заполнить поле e-mail в настройках каждого специалиста сервиса

После установки вариантом “Install/Upgrade Configuration”
----------------------------------------------------------------------

Если версия Synergy 4.0 hamming и выше, то предварительно импортировать приложение /opt/synergy/apps/itsm/itsm_application.7zip

В подсистеме администрирования:
    * обновить БД и процессы
    * завести пользователей и орг.структуру, в которой будут:
    * клиенты (которые будут инициировать создание заявок)
    * специалисты сервиса (оператор и исполнитель для инцидентов, оператор/руководитель и исполнитель для проблем, исполнитель для изменений, сервисные команды)
    * Системный пользователь (упоминался выше, обязательно должен быть назначен на должность)
    * раздать права на внешние модули (в простом случае - всем специалистам сервиса, не клиентам)



В Конфигураторе:
    * в форме “Инцидент” вставить значения оператора, исполнителя, системного пользователя по умолчанию
    * в форме “Проблема” вставить значения ответственного менеджера, руководителя, системного пользователя по умолчанию
    * в форме “Изменение” вставить значение ответственного менеджера по умолчанию
    * раздать права на реестры (в простом случае - всем права на всё, кроме удаления, а группе «Admin» - полные права)
    * раздать права на пункт меню создания “2. Создать инцидент” (в простом случае - всей организации и группе «Admin»)
    * заменить во внешних модулях “Аналитика по инцидентам” и “Аналитика по проблемам” адрес приложения актуальной ссылкой на дашборды Kibana (достаточно изменить только IP-адрес и при необходимости порт)
    * сбросить значения счетчиков, либо при необходимости создать свои шаблоны номеров для идентификаторов и применить их в соответствующих формах
    * проверить, что во всех маршрутах реестра и шаблонах маршрута выбрана форма завершения “Без подтверждения” (упоминалась в начале инструкции)

В клиентской части:
    * создать и заполнить одну запись в реестре “Настройки уведомлений” и после этого для всех групп закрыть доступ на создание и удаление в этом реестре (необходимо для корректной отправки уведомлений на почту)
    * создать хотя бы по одной тестовой записи в реестрах “Инциденты” и “Проблемы” (необходимо для создания шаблонов индекса в Kibana)

В подсистеме администрирования:
    * проиндексировать данные форм

В Kibana:
    * создать 2 шаблона индекса: «r-itsm_registry_incidents» и «r-itsm_registry_problems»
    * импортировать в Kibana (Management -> Saved Objects -> Import) конфигурацию их 2-х дашбордов из файла .../configuration/arta/apps/sm_dashboards.json
    * импортировать в Kibana (Management -> Saved Objects -> Import) конфигурацию из 27-и визуализаций из файла .../configuration/arta/apps/sm_visualizations.json
    * проверить, что всё загрузилось, в дашбордах отсутствуют визуализации, помеченные «!» (при этом возможно наличие визуализаций со значениями “0”, “?”, “No results found”, и это всё не является ошибкой)

В клиентской части:
    * проверить работоспособность обоих дашбордов
    * для работоспособности уведомлений на почту клиентам при их создании в реестре “Контакты” необходимо заполнить и поле e-mail
    * для работоспособности уведомлений о просрочке времени SLA необходимо заполнить поле e-mail в настройках каждого специалиста сервиса

