c-m v1.0

custom_manual/First_configuration.rst

@@ -3,31 +3,55 @@
 
 В подсистеме администрирования:
     * обновить БД и процессы
-    * завести пользователей и орг.структуру, в которой будут:
+    * завести пользователей и орг.структуру (Либо настроить синхронизацию с AD), в которой будут:
         * клиенты (которые будут инициировать создание заявок)
         * специалисты сервиса (оператор и исполнитель для инцидентов, оператор/руководитель и исполнитель для проблем, исполнитель для изменений, сервисные команды)
-        * Системный пользователь (упоминался выше, обязательно должен быть назначен на должность)
+        * Системный пользователь (создается до установки прилоежния Synergy ITSM, обязательно должен быть назначен на должность)
     * раздать права на внешние модули (в простом случае - всем специалистам сервиса, не клиентам)
 
 
 
 В Конфигураторе:
+
+1. В справочник Форм завершения добавить новую форму завершения следующим образом:
+
+.. figure:: _static/Configurator_wcf.png
+
+        Рис. 
+        
+2. На формах:
     * в форме “Обращение” вставить значения оператора, исполнителя, системного пользователя по умолчанию
     * в форме “Проблема” вставить значения ответственного менеджера, руководителя, системного пользователя по умолчанию
     * в форме “Изменение” вставить значение ответственного менеджера по умолчанию
-    * раздать права на реестры (в простом случае - всем права на всё, кроме удаления, а группе «Admin» - полные права)
-    * раздать права на пункт меню создания “2. Создать обращение” (в простом случае - всей организации и группе «Admin»)
-    * заменить во внешних модулях “Аналитика по инцидентам” и “Аналитика по проблемам” адрес приложения актуальной ссылкой на дашборды Kibana (достаточно изменить только IP-адрес и при необходимости порт)
-    * сбросить значения счетчиков, либо при необходимости создать свои шаблоны номеров для идентификаторов и применить их в соответствующих формах
-    * проверить, что во всех маршрутах реестра и шаблонах маршрута выбрана форма завершения “Без подтверждения” (упоминалась в начале инструкции)
+3. Раздать права на реестры (в простом случае - всем права на всё, кроме удаления, а группе «Admin» - полные права)
+
+4. Сбросить значения счетчиков, либо при необходимости создать свои шаблоны номеров для идентификаторов и применить их в соответствующих формах
 
 В клиентской части:
+1. 
     * создать и заполнить одну запись в реестре “Настройки уведомлений” и после этого для всех групп закрыть доступ на создание и удаление в этом реестре (необходимо для корректной отправки уведомлений на почту)
-    * создать хотя бы по одной тестовой записи в реестрах “Обращения” и “Проблемы” (необходимо для создания шаблонов индекса в Kibana)
+    * создать и заполнить одну запись в реестре "Настройки интеграции с почтой" и после этого для всех групп закрыть доступ на создание и удаление в этом реестре (необходимо для корректной отправки уведомлений на почту)
+
+
+2. Для работоспосбоности уведомлений и интеграции с почтой:
+    * Для созданных пользователей в реестре "Контакты" должны быть записи с заполненными email
+
+3. Создать записи в реестре "Сервисы"
+
+
+
+
+4. Для работоспособности дашбордов:
+
+В интерфейсе Synergy:
+    * создать хотя бы по одной тестовой записи в реестрах “Обращения” и “Проблемы”
     
 В подсистеме администрирования:
     * проиндексировать данные форм
     
+В конфигураторе:  
+    * заменить во внешних модулях “Аналитика по инцидентам” и “Аналитика по проблемам” адрес приложения актуальной ссылкой на дашборды Kibana (достаточно изменить только IP-адрес и при необходимости порт)
+
 В Kibana:
     * создать 2 шаблона индекса: ``r-itsm_registry_incidents`` и ``r-itsm_registry_problems``
     * импортировать в Kibana (Management -> Saved Objects -> Import) конфигурацию их 2-х дашбордов из файла .../configuration/arta/apps/sm_dashboards.json

custom_manual/Incident_structure.rst

@@ -176,47 +176,6 @@
 
         Рис. 
   
-Поле Приоритет ``itsm_form_incident_priority`` не доступно пользователю на редактирование и вычисляется исходя из значений 
-полей Срочность ``itsm_form_incident_urgency`` и Воздействие ``itsm_form_incident_influence`` в основном скрипте scipt.js формы обращения:
-
-:: 
-
-    //  вычисление приоритета
-    (function calculatePriority() {
-    var CRITICAL_INCIDENT = 1;
-
-    var itsm_form_incident_urgency = "itsm_form_incident_urgency";
-    var itsm_form_incident_influence = "itsm_form_incident_influence";
-    var itsm_form_incident_major = "itsm_form_incident_major";
-    var itsm_form_incident_status = "itsm_form_incident_status";
-    var itsm_form_incident_priority = "itsm_form_incident_priority";
-
-    var urgencyModel = playerModel.getModelWithId(itsm_form_incident_urgency);
-    var influenceModel = playerModel.getModelWithId(itsm_form_incident_influence);
-    var majorModel = playerModel.getModelWithId(itsm_form_incident_major);
-    var priorityModel = playerModel.getModelWithId(itsm_form_incident_priority);
-
-    function calcPriority(){
-        var urgencyValue = parseInt(urgencyModel.getValue()[0]);
-        var influenceValue = parseInt(influenceModel.getValue()[0]);
-        var isMajor = majorModel.getValue() !== null && majorModel.getValue().length > 0 && majorModel.getValue()[0] == '1';
-
-        var priorityValue = urgencyValue + influenceValue - 1;
-
-        if(isMajor) {
-            priorityValue = CRITICAL_INCIDENT;
-        }
-        priorityModel.setValue(priorityValue+"");
-    }
-
-    on(urgencyModel, "valueChange", "calcPriority", calcPriority);
-
-    on(influenceModel, "valueChange", "calcPriority", calcPriority);
-
-    on(majorModel, "valueChange", "calcPriority", calcPriority);
-    }());
-
-
 
 
 7. Связанные сущности
@@ -269,10 +228,6 @@
         Рис. 
 
 
-Маршрут обращения
-------------------------------------
-
-
 Список блокирующих процессов
 ------------------------------------
 
@@ -285,7 +240,7 @@ event.blocking.interpreter.completion
 1. Получает ход выполнения по обращению
 2. Определяет последнюю завершенную работу
 3. Определяет файл по форме завершения в папке Прочие для этой работы
-4. Копирует данные с найденного файла формы завершения на форму обращения
+4. Копирует данные с найденного файла формы завершения на форму обращения (меняет статус и записывает значения группы полей статуса)
 
 event.blocking.interpreter.email
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -339,18 +294,14 @@ event.blocking.incident.calc.status.1
 Операции над фильтрами
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
+Для всех обращений в указанном преднастроенном фильтре:
 
-Операции над выборкой
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+1. Завершает текущую работу с формой завершения с заполненными полями статус и группа полей статуса
 
 
-Общие настройки
-------------------------------------
-
-
-Настройки интеграции с почтой
+Операции над выборкой
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
+Для всех обращений произвольной выборки:
 
-Настройки уведломлений
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+1. Завершает текущую работу с формой завершения с заполненными полями статус и группа полей статуса
\ No newline at end of file

custom_manual/Install_manual.rst

@@ -8,7 +8,7 @@
 
 
 
-**Шаг1** При необходимости, установить Arta Synergy 4.0 (hamming) и выше (.. _Инструкция: http://tdd.lan.arta.kz/docs/synergy/trunk/admin-manual/html/install-and-setup.html )
+**Шаг1** При необходимости, установить Arta Synergy (trunk.4.0-r1~190301.195857 (hamming)) и выше (.. _Инструкция: http://tdd.lan.arta.kz/docs/synergy/trunk/admin-manual/html/install-and-setup.html )
 
 **Шаг2** Для использования Дашбордов установить Elasticsearch и Kibana (.. _Инструкция: http://tdd.lan.arta.kz/docs/synergy/trunk/admin-manual/html/appendix.dashboards.html )
 

custom_manual/index.rst

@@ -12,7 +12,9 @@
    :numbered:
 
    goals
-   Steps
+   Install_manual
+   First_configuration
+   mail-integration
    Product_structure
    Incident_structure
    Portal

custom_manual/mail-integration.rst

+Настройка интеграции с почтой
+====================================
+
+Уведомления
+-----------------------------
+
+1. Для отправки уведомлений и получения, обрабротки обращений должен быть заведен специальный общий адрес электронной почты.
+
+2. В приложении SynergyAdmin открыть вкладку "Настройки уведомлений" ввести парамтеры почты-отправителя уведомлений.
+
+.. figure:: _static/MI_notification.png
+
+        Рис. 
+        
+3. Для всех пользователей в структуре должны быть указаны email адрес в профиле пользователя.
+
+.. figure:: _static/MI_notification_1.png
+
+        Рис. 
+        
+4. В реестре контактов на каждого пользователя должна быть заведена запись с указанным email в таблице Контактная информация
+
+.. figure:: _static/MI_notification_2.png
+
+        Рис. 
+        
+.. note::
+
+    В случае, если пользователь, email которого найден в профилях оргструктуры, направляет обращение через почту и при этом, его email
+    не найден в реестре "Контакты", - запись будет создана автоматически. 
+    
+.. note::
+
+    В последующих версиях это требование будет исключено.
+
+5. В реестре "Настройки уведомлений" создать запись и внести необходимые настройки текстов уведомлений
+
+.. figure:: _static/MI_notification_3.png
+
+        Рис. 
+        
+.. note::
+
+    В уведомлении, кроме текста, может присутствовать значение любого поля на форме (исключая файлы и динамические таблицы).
+    Для добавления такого значения в текст уведомления необходимо указать имя компонента на форме в формате: ``${itsm_form_incident_author}``.
+
+Перечень настроек:
+
+* **Уведомление по-умолчанию** - уведомление приходит при срабатывании блокирующего процесса ``itsm_notification`` в маршруте реестра обращений для всех статусов, для которых не настроены специфичные уведомления ниже.
+* **Кастомные уведомления** - специфичный текст уведомления для указанного статуса (Рекомендуется указывать специфичные тексты для уведомления по статусам, требующим действий инициатора: "ожидает ответа пользователя", "ожидает оценки пользователя")
+* **Уведомления при не найденном email в списке пользователей** - данное уведомление получит отправитель, при попытка отправить письмо на служебный почтовый ящик, в случае,если его email не указан ни в каком из профилей 
+* **Уведомления о просроченности времени реакции обращения**
+* **Уведомления о просроченности времени решения обращения**
+* **Уведомления о просроченности времени решения проблемы**
+* **Уведомление о невозможности изменения информации** - данное уведомление будет получено инициатором, при попытке ответить на полученное уведомление (или при отправке нового письма содержащего номер обращения в фигурных скобках, например: ``{1234}``) для обращения статус которого отличается от допустимых (настраиватся в реестре "Настройки интеграции с почтой")
+
+Прием и обработка обращений
+------------------------------
+
+1. В реестре "Настройки интеграции с почтой" создать запись и внести значения полей:
+
+.. figure:: _static/MI_int_1.png
+
+        Рис. 
+        
+.. figure:: _static/MI_int_2.png
+
+        Рис. 
+