First_configuration.rst 18.2 KB
Newer Older
1 2 3
Первичные настройки
=================================

4 5 6
Для общей работоспособности
---------------------------------

Elizaveta Kakhovskaya's avatar
Elizaveta Kakhovskaya committed
7
В подсистеме администрирования:
8
    * обновить БД
9
    * завести пользователей и орг.структуру (Либо настроить синхронизацию с AD), в которой будут:
10 11 12 13 14 15 16 17 18
        * Системный пользователь (создается до установки Synergy ITSM, должен быть назначен на должность)
        * Инициаторы обращений
        * Операторы Первой линии
        * Исполнители Второй линии (Количество уровней исполнения можно увеличить).
    * Добавить пользователей в группы:
        * Первая линия - всех операторов первой линии
        * Вторая линия - всех исполнителей второй линии
        * itsm_group_reassign_access - Пользователи, которым предоставляется доступ к Переназначению обращений, находящихся на исполнении.
        * itsm_group_admin - Администраторы и системный пользователь.
Elizaveta Kakhovskaya's avatar
Elizaveta Kakhovskaya committed
19

20

21
*Примечание*. Обязательно необходимо добавить системного пользователя в группу itsm_group_admin. 
Elizaveta Kakhovskaya's avatar
Elizaveta Kakhovskaya committed
22 23

В Конфигураторе:
24

25
1. В справочник Форм завершения добавить новые формы завершения для обращения, проблемы, запроса на изменение и изменения следующим образом:
26

27
.. figure:: _static/Configurator_wcf.png
28 29

        Рис. 
30 31 32 33 34


.. figure:: _static/Configurator_wcf_problem.png

        Рис. 
35 36 37 38 39 40 41 42

.. figure:: _static/Configurator_wcf_rfc.png

        Рис. 

.. figure:: _static/Configurator_wcf_change.png

        Рис. 
43
        
44 45 46
2. Для формы завершения "Комментарий" активировать чек-бокс "Не требует подтверждения".

3. На формах:
47
    * в форме “Обращение” вставить значения оператора, исполнителя, системного пользователя по умолчанию
48 49 50
    * в форме “Проблема” вставить значения ответственного менеджера, исполнителя, системного пользователя по умолчанию
    * в форме “Изменение” вставить значение ответственного за координацию изменений в ИТ/администратора системы, владельца БП, ответственного за релиз, бизнес-аналитика, разработчика, тестировщика, системного пользователя по умолчанию
    * в форме "Запрос на изменение RFC" вставить значение ответственного за координацию изменений в ИТ/администратора системы, CAB, системного пользователя по умолчанию
51
    
52 53 54
4. Проверить/уточнить права на реестры 

5. Сбросить значения счетчиков, либо при необходимости создать свои шаблоны номеров для идентификаторов и применить их в соответствующих формах
55

56
6. Прописать логин/пароль системного пользователя для всех скриптов Блокирующих процессов 
Elizaveta Kakhovskaya's avatar
Elizaveta Kakhovskaya committed
57

58 59 60
7. Для реестра "Заявка на права доступа" в маршруте активации для работы "Прошу назначить права доступа" указать требуемого ответственного.

8. Для реестра "База знаний" в маршруте активации для согласования "Прошу согласовать" указать требуемого ответственного.
61

62

63

64
В пользовательской части:
65

66
1. Создать и заполнить одну запись в реестре “Настройки портала” и после этого для всех групп закрыть доступ на создание и удаление в этом реестре (необходимо для корректной работы портала):
67

68 69
.. figure:: _static/portal_settings.png

70
2. Создать и заполнить хотя бы одну запись реестра "Сервисы" для возможности запуска обращения по маршруту.
71

72 73
**Примечание:** Для отправки уведомлений из системы настроить в системе администрирования "Настройки уведомлений", это описано в следующей главе "Настройка интеграции с почтой".

74 75
Для работоспособности дашбордов:
-----------------------------------------
76

77 78 79 80

В интерфейсе Synergy:
    * создать хотя бы по одной тестовой записи в реестрах “Обращения” и “Проблемы”
    
Elizaveta Kakhovskaya's avatar
Elizaveta Kakhovskaya committed
81 82
В подсистеме администрирования:
    * проиндексировать данные форм
83 84 85
    
В конфигураторе:  
    * заменить во внешних модулях “Аналитика по инцидентам” и “Аналитика по проблемам” адрес приложения актуальной ссылкой на дашборды Kibana (достаточно изменить только IP-адрес и при необходимости порт)
Elizaveta Kakhovskaya's avatar
Elizaveta Kakhovskaya committed
86 87

В Kibana:
88
    * создать 2 шаблона индекса: ``r-itsm_registry_incidents`` и ``r-itsm_registry_problems``
Elizaveta Kakhovskaya's avatar
Elizaveta Kakhovskaya committed
89 90 91 92 93 94 95 96
    * импортировать в 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 в настройках каждого специалиста сервиса
97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128
    

    
Для реализации дашборда "Облако тегов"
-----------------------------------------

Данный дашборд отображает самые часто встречающиеся слова в поле "Тема"/"Описание" обращения, частота соответствует размеру текста. Чем чаще встречается то или иное слово, тем больше его шрифт. Таким образом, можно определить с чем чаще всего возникают проблемы.

Для того чтобы исключить слова, которые повторяются, но не несут важности для пользователя, создан "Реестр исключений". Примеры слов: доброе, утро, не, работает и т.д.

.. figure:: _static/exceptions.jpg

        Рис. Реестр исключений

Так как одно слово может быть использовано с разными окончаниями, для группирования создан "Реестр синонимов". Например, в обращении могут использоваться слова: принтер, принтеру, принтера. Чтобы все эти слова воспринимались на визуализации как "принтер", необходимо заполнить его в Реестре синонимов.

.. figure:: _static/synonyms.jpg

        Рис. Реестр синонимов

1. Заполнить по возможности Реестр синонимов и Реестр исключений.

**Примечание:** изменения в синонимах и исключениях после первичной индексации не будут применяться. Для этого требуется использование отдельного скрипта. В связи с этим необходимо на первом этапе заполнить реестры синонимов и исключений всеми необходимыми словами.

2. Создать хотя бы одну запись реестра Обращений, заполнить тему, описание, запустить по маршруту активации.

3. Создать индекс ``itsm_incident_tagcloud`` в Kibana->Management->Index Patterns->Add new

.. figure:: _static/index.jpg

        Рис. Создание индекса

129
4. Загрузить  дашборд "Облако тегов и 2 визуализации "Облако тегов по теме", "Облако тегов по описанию". Архив можно скачать здесь_.
130

131 132 133 134 135 136 137
.. _здесь: _static/TagCloud.7z

Для загрузки его необходимо перейти в Kibana->Management->Saved Objects и загрузить нажав на Import. Загружать необхрдимо json файлы, а не архив.

5. После импорта можно перейти на дашборд и ознакомиться с результатами.

6. При необходимости создать внешний модуль в SynergyIDE и добавить ссылку на этот дашборд, дать права группам пользователей.
138 139 140 141 142 143 144


Для настройки уведомления о том, что у пользователя открыт документ
-----------------------------------------

Реализовано уведомление для записей реестра Обращения в статусе "Зарегистрировано", которое отображается когда один пользователь открывает обращение, которое открыто у другого пользователя. Таким образом можно исключить одновременную работу над одним документом при распределении обращений.

145 146
Также бывают ситуации, когда пользователь закрывает сразу же страницу браузера и тем самым документ не закрывается. В базе данных документ остается открытым под данным пользователем. Реализовано несколько API методов для работы с открытыми документами:

147
1. GET `/itsm/rest/document/isopen?documentID={documentID}` - возвращает информацию по документу если он открыт, пример ответа:
148 149


150 151 152 153 154 155 156 157 158 159
{
    "errorCode": 0,
    "errorMessage": "OK",
    "data": {
        "userID": "1",
        "documentID": "bba1e996-c745-4d4f-b933-47aeef158ab2",
        "dataUUID": "63857",
        "date": "1577244327226"
    }
}
160

161 162

2. GET `/itsm/rest/document/list` - получает весь список открытых документов, пример ответа:
163

164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181
{
    "errorCode": 0,
    "errorMessage": "OK",
    "data": [
        {
            "userID": "f7abd6d9-7b92-4da4-a183-d53feaee2296",
            "documentID": "1b5f6d64-0d61-4f4c-b6a4-8fc80e6be177",
            "dataUUID": "63828",
            "date": "1577244489896"
        },
        {
            "userID": "1",
            "documentID": "bba1e996-c745-4d4f-b933-47aeef158ab2",
            "dataUUID": "63857",
            "date": "1577244327226"
        }
    ]
}
182 183


184
3. POST `/itsm/rest/document/remove/{documentID}` - удаляет из списка один документ, в ответ приходит 1 если был удален или 0 если в базе не найден данный документ, пример ответа:
185

186 187 188 189 190
{
    "errorCode": 0,
    "errorMessage": "OK",
    "data": 1
}
191

192

193
4. POST `/itsm/rest/document/removeAll` - удаляет из списка все документы, в ответ приходит количество удаленных записей, пример ответа:
194

195 196 197
{
    "errorCode": 0,
    "errorMessage": "OK",
198 199
    "data": 4
}
200

201 202

В случае если при выполнении любого из вышеперечисленных методов возникает ошибка, в ответ возвращается json:
203

204 205 206
{
    "errorCode": 13,
    "errorMessage": "сообщение, характеризующее ошибку"
207
}
208

209
Также для удобства реализован скрипт `closeOpenDocument.sh`, который проверяет и удаляет из базы открытые документы. Данный скрипт можно поставить в крон для автоматического удаления зависших документов (*для случаев когда событие закрытия документа из UI Synergy не может быть вызвано*). Скрипт содержит настройки, которые по необходимости изменить под потребности:
210
Скрипт находится в папке `/opt/synergy/apps/itsm/scripts`.
211 212 213 214 215

# кол-во часов, прошедших с даты открытия документа, по истечению которых нужно удалить документ из базы  

HOURS=5  
  
216 217 218 219
# mySQL настройки 

mysqlUser="root"   

220
mysqlPass="root"  
221

222
mysqlDB="synergy"  
223

224
mysqlHost="localhost"
225

226 227 228 229 230 231 232

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

1. Подключиться по ssh и в терминале ввести команду 

`$ crontab -e`

233
2. Добавить текст
234

235
0 22 * * * /opt/synergy/apps/itsm/scripts/closeOpenDocument.sh
236

237
В данном случае скрипт будет запускаться каждый день в 22.00. При необходимости можно поменять сроки исполнения.
238 239 240

3. Сделать скрипт исполняемым:

241
$ chmod a+x /opt/synergy/apps/itsm/scripts/closeOpenDocument.sh
242

243 244 245 246 247


Для  закрытия обращений, которые ожидают доработки со стороны инициатора
-----------------------------------------

248
Бывают ситуации, когда пользователь обратился с обращением, и после отправки обращения на доработку пользователь не отвечает (возможно обращение уже не актуально). Обращения так и находится в статусе "Ожидает ответа пользователя". И так может собираться большое количество обращений. Для того чтобы их закрывать реализован скрипт `close_incident.sh`, который позволит закрыть данные заявки, если с момента отправления на доработку прошло 16 рабочих часов. Для того чтобы этот скрипт исполнялся его необходимо поставить в крон.
249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266
Скрипт находится в папке `/opt/synergy/apps/itsm/scripts`. В скрипте имеются следующие настройки:

1. файл откуда берутся настройки соединения с synergy: source /opt/synergy/jboss/standalone/configuration/arta/apps/itsm/itsm.properties

2. подключение к базе mysql(при необходимости заменить в скрипте логин и пароль)

mysqlUser="User"
mysqlPass="Pass"
mysqlHost="127.0.0.1"

3. расположение лог файла, код реестра инцидентов и комментарий по умолчанию:

logFile="/var/log/synergy/scripts.log"
...
registryCode="itsm_registry_incidents"
comment="Закрыто по истечению времени на ожидание ответа пользователя"

Для того чтобы его поставить в крон необходимо:
267 268 269 270 271 272 273 274 275 276 277 278 279 280

1. Подключиться по ssh и в терминале ввести команду 

`$ crontab -e`

2. Добавить текст

0 23 * * * /opt/synergy/apps/itsm/scripts/close_incident.sh

В данном случае скрипт будет запускаться каждый день в 23.00. При необходимости можно поменять сроки исполнения.

3. Сделать скрипт исполняемым:

$ chmod a+x /opt/synergy/apps/itsm/scripts/close_incident.sh
281 282 283