c-m v1.0

Releases/conf.py

+# -*- coding: utf-8 -*-
+#
+# Read the Docs Template documentation build configuration file, created by
+# sphinx-quickstart on Tue Aug 26 14:19:49 2014.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys
+import os
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#sys.path.insert(0, os.path.abspath('.'))
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as Strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = []
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'Релизы Synergy ITSM'
+copyright = u'2018, ARTA Software'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '0.1'
+# The full version, including alpha/beta/rc tags.
+release = '0.1-alpha'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build']
+
+# The reST default role (used for this markup: `text`) to use for all
+# documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+# If true, keep warnings as "system message" paragraphs in the built documents.
+#keep_warnings = False
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = 'sphinx_rtd_theme'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# Add any extra paths that contain custom files (such as robots.txt or
+# .htaccess) here, relative to this directory. These files are copied
+# directly to the root of the documentation.
+#html_extra_path = []
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'ReadtheDocsTemplatedoc'
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+# The paper size ('letterpaper' or 'a4paper').
+#'papersize': 'letterpaper',
+
+# The font size ('10pt', '11pt' or '12pt').
+#'pointsize': '10pt',
+
+# Additional stuff for the LaTeX preamble.
+#'preamble': '',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+  ('index', 'ReadtheDocsTemplate.tex', u'Read the Docs Template Documentation',
+   u'Read the Docs', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    ('index', 'readthedocstemplate', u'Релизы Synergy ITSM',
+     [u'Read the Docs'], 1)
+]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+  ('index', 'ReadtheDocsTemplate', u'Read the Docs Template Documentation',
+   u'Read the Docs', 'ReadtheDocsTemplate', 'One line description of project.',
+   'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'
+
+# If true, do not generate a @detailmenu in the "Top" node's menu.
+#texinfo_no_detailmenu = False
\ No newline at end of file

Releases/index.rst

+.. 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.
+
+Содержание
+==========
+
+.. toctree::
+   :maxdepth: 2
+   :glob:
+   :numbered:
+
+   release_1_0
+   release_1_0_

Releases/release_1_0.rst

+Релиз Synergy ITSM v1.0
+=======================================
+
+На сегодняшний день общая тенденция цифровизации процессов, как внутренних, так и внешних (инструментов взаимодействия с клиентом),
+существенно повысила значимость стабильной, отказоустойчивой работы всех компонентов внутренней инфраструктуры.
+
+Что для современного человека значит простой или сбой в работе сервисов, таких как мобильный банкинг или приложение для вызова такси,
+когда мы все привыкли к мгновенному доступу к ним с мобильных устройств?
+
+Такие ситуации в высококонкурентной среде могут оказать огромное негативное влияние на репутацию и бизнес, в целом.
+
+Основным инструментом минимизации подобных рисков должна стать система, призванная осуществлять:
+
+1. оперативное реагирование
+2. применение предупреждающих мер 
+
+для обеспечения поддержки непрерывной работы бизнес-критичных сервисов. 
+
+.. figure:: _static/1_0.png
+
+        Рис. 
+
+Центральный офис Arta Software рад представить свою версию системы, направленной на решение подобных задач - Synergy ITSM v.1.0.
+
+
+--------------------------------------------------------------------------------
+
+
+Встраивайтесь во входящий поток обращений
+--------------------------------------------------------------------------------
+
+Регистрация обращений через:
+
+* E-mail;
+* API (Портал, системы мониторинга); 
+* Ручной ввод от авторизованного персонала;
+
+
+.. figure:: _static/Portal_main_1.png
+
+        Рис. 
+
+.. figure:: _static/Portal_main_2.png
+
+        Рис. 
+
+
+
+Упорядочивайте входящий поток обращений для скорейшего их выполнения
+--------------------------------------------------------------------------------
+
+Первичная обработка обращения:
+
+* Определение приоритета и категории обращения;
+* Выбор(подтверждение) услуги;
+* Автоматический расчет сроков исполнения согласно SLA; 
+* Проверка на полноту предоставленной информации (запрос на доработку);
+
+
+
+Определяйте дальнейшее движение обращения исходя из контекста
+--------------------------------------------------------------------------------
+
+* Возможность завершения обращения уже на Первой линии
+* Направление обращения на Вторую линию исходя из специфики, регионального распределения и других характеристик.
+
+
+Структурируйте процесс исполнения обращения
+--------------------------------------------------------------------------------
+
+* Конфигурирование процесса согласно Вашим потребностям:
+* Возможность определения доступных статусов обращений и их характеристик;
+* Настройка специфичных маршрутов обращений  и порядка их исполнения.
+
+
+**Исполнение обращения:**
+
+* Распределение обращения между сотрудниками подразделения с учетом их текущей нагрузки;
+* Возможность приостановить исполнение обращения по причинам, не зависящим от исполнителя  (например, «Ожидает выделения техники»);
+* Завершение обращения с указанием основных параметров завершения, а также прикреплением файлов;
+* Фиксация исторических данных обращения для дальнейшего формирования статистических отчетов.
+
+.. figure:: _static/3_15.png
+
+        Рис. 
+        
+Поддерживайте непрерывную связь с инициатором обращения
+--------------------------------------------------------------------------------
+
+* Оповещение клиента о статусе обращения посредством e-mail-уведомления;
+* Предоставление доступа к списку Моих обращений и их актуальному статусу через портал;
+* Получение дополнительной информации от инициатора по запросу через e-mail или портал;
+* Получение подтверждения завершения или направление инициатором обращения повторно.
+
+.. figure:: _static/4_2.png
+
+        Рис. 
+        
+
+Контролируйте соблюдение регламента и загрузку ресурсов
+--------------------------------------------------------------------------------
+
+* Аналитика по нарушениям регламента в процессе оказания услуг;
+* Аналитика по производительности подразделений и отдельных исполнителей;
+* Аналитика по пиковой загрузке, периодическим и сезонным колебаниям для прогнозирования загрузки ресурсов;
+
+.. figure:: _static/5_15.png
+
+        Рис. 
+
+--------------------------------------------------------------------------------
+
+Полезные ссылки:
+--------------------------------------------------------------------------------
+
+1. Доступ к `демо-стенду`_.
+
+.. _`демо-стенду`: http://itsm.arta.pro/Synergy
+
+Логин: Оператор Пароль: 1
+
+Логин: Исполнитель Пароль: 1
+
+2. Доступ к `демо-порталу`_.
+
+.. _`демо-порталу`: http://itsm.arta.pro/itsm
+
+Логин: Инициатор Пароль: 1
+
+3.  `Руководство пользователя`_.
+
+.. _`Руководство пользователя`: http://rtd.lan.arta.kz/docs/synergy-itsm-user-manual/ru/v1.0/
+
+4.  `Руководство по внедрению`_.
+
+.. _`Руководство по внедрению`: http://rtd.lan.arta.kz/docs/itsm-custom-maual/ru/v1.0/ 
+
+

Releases/release_1_0_.rst

+Уважаемые коллеги!
+
+Для ваших клиентов, важные процессы которых построены вокруг IT-решений, подготовлен продукт Synergy ITSM.
+Продукт позволяет:
+- [ ] контролировать доступность критичных для бизнеса приложений;
+- [ ] контролировать работоспособность инфраструктуры;
+- [ ] планировать работы по обновлению приложений и управлять ими (я за это не уверен :);
+- [ ] группировать большой поток обращений в конкретные проблемы.
+
+Продукт рекомендован для клиентов, имеющих информационные системы приема (web и mobile), регистрации, распределения и исполнения заявок, апробирован на проекте ITSM Казпочта (здесь надо привести статистику нагрузки на Казпочта);
+
+В текущий версии релиза имеет в свое составе функции:
+- [ ] приема и обработки входящего потока обращений из различных источников (e-mail, посредством API, ручная регистрация, личный кабинет);
+- [ ] сортировка обращений и назначение их компетентным исполнителям, автоматический расчет срока исполнения по SLA;
+- [ ] контроль нагрузки на исполнителей и соблюдение регламентных сроков;
+- [ ] оповещение авторов обращения о статусах заявок, личный кабинет с историей оказания услуг.
+
+Детальная информация приведена здесь (ссылка на релиз) 
+
+Доступны для обсуждения применения решения для ваших клиентов, включая экономический эффект.
\ No newline at end of file

custom_manual/First_configuration.rst

@@ -4,29 +4,41 @@
 В подсистеме администрирования:
     * обновить БД и процессы
     * завести пользователей и орг.структуру (Либо настроить синхронизацию с AD), в которой будут:
-        * клиенты (которые будут инициировать создание заявок)
-        * специалисты сервиса (оператор и исполнитель для инцидентов, оператор/руководитель и исполнитель для проблем, исполнитель для изменений, сервисные команды)
-        * Системный пользователь (создается до установки прилоежния Synergy ITSM, обязательно должен быть назначен на должность)
-    * раздать права на внешние модули (в простом случае - всем специалистам сервиса, не клиентам)
-
+        * Системный пользователь (создается до установки Synergy ITSM, должен быть назначен на должность)
+        * Инициаторы обращений
+        * Операторы Первой линии
+        * Исполнители Второй линии (Количество уровней исполнения можно увеличить).
+    * Добавить пользователей в группы:
+        * Первая линия - всех операторов первой линии
+        * Вторая линия - всех исполнителей второй линии
+        * itsm_group_reassign_access - Пользователи, которым предоставляется доступ к Переназначению обращений, находящихся на исполнении.
+        * itsm_group_admin - Администраторы и системный пользователь.
 
 
 В Конфигураторе:
 
-1. В справочник Форм завершения добавить новую форму завершения следующим образом:
+1. В справочник Форм завершения добавить новый формы завершения обращения и проблемы следующим образом:
 
 .. figure:: _static/Configurator_wcf.png
 
         Рис. 
 
+
+.. figure:: _static/Configurator_wcf_problem.png
+
+        Рис. 
+        
 2. На формах:
     * в форме “Обращение” вставить значения оператора, исполнителя, системного пользователя по умолчанию
     * в форме “Проблема” вставить значения ответственного менеджера, руководителя, системного пользователя по умолчанию
     * в форме “Изменение” вставить значение ответственного менеджера по умолчанию
-3. Раздать права на реестры (в простом случае - всем права на всё, кроме удаления, а группе «Admin» - полные права)
+    
+3. Проверить/уточнить права на реестры 
 
 4. Сбросить значения счетчиков, либо при необходимости создать свои шаблоны номеров для идентификаторов и применить их в соответствующих формах
 
+5. Прописать логин/пароль системного пользователя для всех скриптов Блокирующих процессов 
+
 В клиентской части:
 1. 
     * создать и заполнить одну запись в реестре “Настройки уведомлений” и после этого для всех групп закрыть доступ на создание и удаление в этом реестре (необходимо для корректной отправки уведомлений на почту)
@@ -36,7 +48,7 @@
 2. Для работоспосбоности уведомлений и интеграции с почтой:
     * Для созданных пользователей в реестре "Контакты" должны быть записи с заполненными email
 
-3. Создать записи в реестре "Сервисы"
+3. Создать записи в реестре "Сервисы" по услугам, предоставить доступ на сервисы группам пользователей.
 
 
 

custom_manual/Incident_structure.rst

@@ -273,6 +273,8 @@ event.blocking.itsm.send.rate
 event.blocking.incident.calc.status.1
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
+**Что делает процесс?**
+
 1. Получает из формы SLA время решения и время реакции по параметрам данного обращения
 2. Записывает их на форму обращения
 3. Рассчитывает плановую дату завершения с учетом рабочего календаря

custom_manual/Install_manual.rst

@@ -8,6 +8,7 @@
 
 
 
+
 **Шаг1** При необходимости, установить Arta Synergy (trunk.4.0-r1~190301.195857 (hamming)) и выше `Инструкция по установке ARTA SYNERGY`_.
 
 .. _Инструкция по установке ARTA SYNERGY: http://tdd.lan.arta.kz/docs/synergy/trunk/admin-manual/html/install-and-setup.html 
@@ -151,3 +152,9 @@
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 1.Импортировать приложение /opt/synergy/apps/itsm/itsm_application.7zip
+
+
+.. warning::
+
+    Для работоспособности приложения в дальнейшем, необходимо убедиться, что elastic запущен. В противном случае выполнить команду
+    /etc/init.d/elasticsearch start

custom_manual/Portal.rst

@@ -185,13 +185,6 @@
 5. Далее пункты 5-8 сценария "Подача обращения"
 
 
-Что мы можем улучшить
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-
-???
-
-
 Просмотр обращений
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -211,15 +204,16 @@
 Поиск по обращениям
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
+Поиск по обращениям работает по всем полям отображаемым на форме обращения.
  
-Фильтрация по обращениям
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Для того, чтобы воспользоваться поиском по обращениям на странице "Мои обращения", необходимо:
+Ввести поисковой запрос в поле поиска и нажать enter.
 
 
 Предоставление дополнительной информации
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-1. Пользователь открывает страницу "Мои обращения. Ожидают дополнительной информации"
+1. Пользователь открывает страницу "Мои обращения, выбирает вкладку "Ожидают дополнительной информации"
 2. Отображается таблица обращений (если в этом статусе нет ни одного обращения данного автора - таблица пуста)
 3. Пользователь двойным кликом открывает обращение
 4. Открывается окно обращения с полями:
@@ -245,7 +239,7 @@
 Подтверждение завершения
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-1. Пользователь открывает страницу "Мои обращения. Ожидают подтверждения завершения"
+1. Пользователь открывает страницу "Мои обращения, выбирает вкладку "Ожидают подтверждения завершения"
 2. Отображается таблица обращений (если в этом статусе нет ни одного обращения данного автора - таблица пуста)
 3. Пользователь двойным кликом открывает обращение
 4. Открывается окно обращения с полями:
@@ -268,3 +262,16 @@
 
 Просмотр закрытого обращения
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+1. Пользователь открывает страницу "Мои обращения", выбирает вкладку "Закрытые"
+2. Отображается таблица обращений (если в этом статусе нет ни одного обращения данного автора - таблица пуста)
+3. Пользователь двойным кликом открывает обращение
+4. Открывается окно обращения с полями:
+
+    * Номер
+    * Дата
+    * Статус
+    * Услуга
+    * Тема
+    * Время решения
+    * Код решения
\ No newline at end of file

custom_manual/index.rst

@@ -19,4 +19,4 @@
    Incident_structure
    Portal
    Reports
-   FAQ
+