Merge branch 'v3.1' into 'master'

V3.1

See merge request !1

install_guide/conf.py

@@ -43,17 +43,17 @@ source_suffix = '.rst'
 master_doc = 'index'
 
 # General information about the project.
-project = u'Инструкция по установке Synergy Sales'
-copyright = u'2018, ARTA Software'
+project = u'Инструкция по установке Synergy Customers'
+copyright = u'2022, 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 = '1.5'
+version = '3.0'
 # The full version, including alpha/beta/rc tags.
-release = '1.5'
+release = '3.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

install_guide/index.rst

@@ -3,109 +3,13 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Инструкция по установке приложения Arta Synergy Sales
-==========================================================
+Инструкция по установке приложения Synergy Customers
+======================================================
 
-Общие сведения
----------------------
+.. toctree::
+   :maxdepth: 2
+   :glob:
+   :numbered:
 
-Synergy Sales устанавливается отдельным пакетом. Возможны следующие варианты установки.
-
-1. ``Clean`` - полная установка приложения без демо-данных ("чистая" установка с загрузкой конфигурации и преднастроенных БД, хранилища, индексов Elasticsearch и Kibana, дашбордов).
-
-    .. hint:: Вариант установки ``Clean`` удаляет все текущие данные в системе!
-
-2. ``Install/Upgrade Configuration`` - установка приложения, загрузка его конфигурации, индексов и дашбордов (соответственно, без БД и хранилища).
-
-    .. hint:: Данный вариант установки отличается от других тем, что загружается конфигурация через Synergy API, не удаляя при этом информацию пользователя.
-
-3. ``Manual`` - установка только приложения без автоматической загрузки конфигурации, дашбордов и всего остального.
-
-Предварительные требования
-------------------------------
-
-Важно! Для работы данного приложения требуется:
-
-* установить Arta Synergy 4.0 hamming (`инструкция по установке <http://tdd.lan.arta.kz/docs/synergy/tags/hamming/admin-manual/html/install-and-setup.html#install-and-setup.install>`_)
-* установить и запустить Elasticsearch и Kibana (`инструкция по установке <http://tdd.lan.arta.kz/docs/synergy/tags/hamming/admin-manual/html/appendix.dashboards.html>`_)
-* в подсистеме администрирования обновить базу данных и процессы
-* для варианта установки ``Install/Upgrade Configuration`` предварительно завести Системного пользователя (с произвольными логином/паролем, с доступом в систему, с ролью "Разработчик Synergy" и "Администратор", а также назначенного на произвольную должность)
-
-Установка приложения
---------------------------
-
-Установочный пакет находится в репозитории *unstable*. В файле ``/etc/apt/sources.list`` необходимо добавить либо раскомментировать следующую строку:
-
-``deb http://deb.arta.kz/tengri unstable main contrib non-free``
-
-    .. note:: Для предотвращения дальнейшей нечаянной установки нестабильных версий пакетов из репозитория *unstable*, после установки ``arta-synergy-apps-sales`` рекомендуется его закомментировать в том же файле ``/etc/apt/sources.list``.
-
-Для установки приложения необходимо выполнить команду:
-
-    .. code-block:: html 
-
-	# apt-get update
-	# apt-get install arta-synergy-apps-sales
-
-Особенности установки Clean
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-В ходе установки необходимо выполнить следующее:
-
-* Выбрать тип установки из предложенного списка
-
-    .. figure:: resources/img/sales_clean_1.png
-
-        Рис. Тип установки
-
-* Указать URL до Synergy, на котором производится работа (например: http://192.168.2.164:8080/Synergy)
-
-    .. figure:: resources/img/sales_2.png
-
-        Рис. Ввод synergy URL
-
-* Ввести пароль mysql
-
-    .. figure:: resources/img/sales_clean_3.png
-
-        Рис. Ввод пароля mysql
-
-    .. attention:: В случае, если после установки приложения вариантом ``Clean`` имеются проблемы с авторизацией пользователей (ошибка ``loginservlet``), то выполните в терминале команду ``dpkg-reconfigure arta-synergy-synergy`` и следуйте `мастеру установки <http://tdd.lan.arta.kz/docs/synergy/tags/hamming/admin-manual/html/install-and-setup.html#install-and-setup.install>`_.
-
-Особенности установки Install/Upgrade Configuration и Manual
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-В ходе установки необходимо выполнить следующее:
-
-* Выбрать тип установки из предложенного списка
-
-    .. figure:: resources/img/sales_install_1.png
-
-        Рис. Тип установки
-
-* Указать URL до Synergy, на котором производится работа (например: http://192.168.2.164:8080/Synergy)
-
-    .. figure:: resources/img/sales_2.png
-
-        Рис. Ввод synergy URL
-
-* Ввести последовательно логин и пароль Системного пользователя
-
-    .. figure:: resources/img/sales_install_3.png
-
-        Рис. Ввод логина
-
-    .. figure:: resources/img/sales_install_4.png
-
-        Рис. Ввод пароля
-
-* Ввести пароль mysql
-
-    .. figure:: resources/img/sales_clean_3.png
-
-        Рис. Ввод пароля mysql
-
-После установки
--------------------
-
-После установки приложения обязательно выполнить пункты `инструкции по внедрению <http://rtd.lan.arta.kz/docs/sales-introduction-guide/ru/v1.5/>`_.
+   install
+   update

install_guide/install.rst

+Установка приложения
+----------------------
+
+Предварительные шаги
+~~~~~~~~~~~~~~~~~~~~~~
+
+#. Установить самую актуальную версию платформы Arta Synergy, 
+   не менее версии `4.1 minsky`_.
+
+#. Установить самую актуальную версию `Конструктора приложений`_
+
+#. Установить и запустить Elasticsearch `(инструкция по установке)`_
+
+#. В подсистеме администрирования обновить базу данных и процессы.
+
+#. Завести Системного пользователя:
+
+   * с произвольными логином/паролем;
+   * с доступом в систему;
+   * с ролью "Разработчик Synergy", "Разработчик web-клиента" и 
+     "Администратор";
+   * назначенный на произвольную должность.
+
+.. _`4.1 minsky`: http://tdd.lan.arta.kz/docs/synergy/tags/minsky/admin-manual/html/install-and-setup.html#install-and-setup.install
+
+.. _`Конструктора приложений`: http://rtd.lan.arta.kz/docs/synergy-constructor/ru/latest/
+
+.. _`(инструкция по установке)`: http://tdd.lan.arta.kz/docs/synergy/tags/minsky/admin-manual/html/appendix.dashboards.html
+
+Процесс установки
+~~~~~~~~~~~~~~~~~~~
+
+Synergy Customers устанавливается отдельным пакетом. Возможны следующие 
+варианты установки:
+
+#. ``Install/Upgrade Configuration`` - установка приложений Customers и 
+   импорта, загрузка конфигураций (Synergy и конструктора), без БД и 
+   хранилища. Соответственно, имеющиеся в Системе данные не удаляются.
+
+#. ``Manual`` - установка только приложения для импорта. 
+
+Установочный пакет находится в репозитории *product-stable*. В файле 
+``/etc/apt/sources.list`` необходимо добавить либо раскомментировать 
+следующие строки:
+
+    .. code-block:: html 
+
+	deb http://deb.arta.kz/tengri product-stable main contrib non-free
+    
+    .. code-block:: html 
+
+	deb http://deb.arta.kz/tengri extensions main contrib non-free
+
+
+Для установки приложения необходимо выполнить команду:
+
+    .. code-block:: html 
+
+	# apt-get update
+	# apt-get install arta-synergy-apps-customers
+
+В ходе установки необходимо выполнить следующее:
+
+* Выбрать тип установки ``Install/Upgrade Configuration`` из предложенного 
+  списка:
+
+    .. figure:: resources/img/customers_install.png
+
+        Рис. Тип установки
+
+* Указать URL до Synergy, на котором производится работа (например: 
+  http://192.168.4.80:8080/Synergy):
+
+    .. figure:: resources/img/customers_1.png
+
+        Рис. Ввод synergy URL
+
+* Ввести последовательно логин и пароль Системного пользователя:
+
+    .. figure:: resources/img/customers_2.png
+
+        Рис. Ввод логина
+
+    .. figure:: resources/img/customers_3.png
+
+        Рис. Ввод пароля
+
+После установки
+~~~~~~~~~~~~~~~~~
+
+Во-первых, в подсистеме конфигурирования необходимо добавить Системного 
+пользователя в группу "Все права" (с кодом ``customers_groups_access_all``).
+
+Во-вторых, в подсистеме конфигурирования необходимо проверить 
+логин и пароль Системного пользователя в следующих блокирующих процессах:
+
+* ``event.blocking.interpreter.changeDealStage``
+* ``event.blocking.interpreter.createActivity``
+* ``event.blocking.interpreter.createUserPlansForSales``
+* ``event.blocking.interpreter.getEndDealStatus``
+* ``event.blocking.interpreter.add_deal_status``
+* ``event.blocking.interpreter.add_deal_status_on_change``
+* ``event.blocking.interpreter.calculate_deal_status_duration_summary``
+* ``event.blocking.interpreter.change_deal_status``
+* ``event.blocking.interpreter.sum_deal_expired_days``
+* ``event.blocking.interpreter.sum_expired_days``
+* ``event.blocking.interpreter.transaction_check``
+* ``event.blocking.interpreter.transaction_check2``
+* ``event.blocking.interpreter.contracts_activity``
+* ``event.blocking.interpreter.leads_activity``
+* ``event.blocking.interpreter.lidschange``
+* ``event.blocking.interpreter.activity_status``
+
+В-третьих, в конструкторе для приложения customers в свойствах приложения указать актульный логин и пароль пользователя по умолчанию (администратора с доступом к справочникам и настройкам системы).
+
+
+В-четвёртых, необходимо проверить доступность приложения Customers по 
+адресу ``http://адрес_сервера:порт/customers`` (например: 
+http://192.168.4.80:8080/customers).
+
+Ожидаемое поведение:
+
+1. Откроется страница авторизации.
+2. Авторизация Системным пользователем произойдет успешно.
+3. Откроется главная страница модуля (с поиском и кнопками создания).
+4. При выполнении произвольного запроса в поиске приложение отвечает не 
+   ошибкой сервера, а отсутствием данных.
+
+Если фактическое поведение отличается от ожидаемого, то необходимо:
+
+* в подсистеме администрирования проверить актуальность базы данных и 
+  процессов и, при необходимости, их обновить;
+
+* проверить конфигурационный файл ``/etc/nginx/sites-enabled/synergy-base`` 
+  на наличие следующих настроек:
+
+    .. code-block:: xml 
+
+        location /constructor {
+               allow                   all;
+               proxy_pass              http://127.0.0.1:8080;
+               proxy_set_header        Host       $host;
+               proxy_set_header        X-Real-IP  $remote_addr;
+               }
+
+        location /customers {
+               proxy_pass http://127.0.0.1:8080/customers;
+               }
+
+        location /import {
+               allow                   all;
+               proxy_pass              http://127.0.0.1:8080/import;
+               proxy_set_header        Host       $host;
+               proxy_set_header        X-Real-IP  $remote_addr;
+               }
+        
+        location /salesplan{
+               proxy_pass              http://127.0.0.1:8080/salesplan;
+               }
+
+* открыть Конструктор приложений по адресу ``http://адрес_сервера:порт/constructor`` 
+  (например: http://192.168.4.80:8080/constructor), авторизоваться под Системным 
+  пользователем, открыть приложение с кодом ``customers`` и задеплоить его через 
+  меню "Клиент" -> "Деплой".
+

install_guide/update.rst

+Обновление приложения
+-----------------------
+
+Предварительные шаги
+~~~~~~~~~~~~~~~~~~~~~~
+
+#. Установить самую актуальную версию платформы Arta Synergy, 
+   не менее версии `4.1 minsky`_.
+
+#. Установить самую актуальную версию актуальную версию `Конструктора приложений`_
+   
+#. Установить и запустить Elasticsearch `(инструкция по установке)`_  
+
+#. В подсистеме администрирования обновить базу данных и процессы.
+
+#. Завести Системного пользователя:
+
+   * с произвольными логином/паролем;
+   * с доступом в систему;
+   * с ролью "Разработчик Synergy", "Разработчик web-клиента" и 
+     "Администратор";
+   * назначенный на произвольную должность.
+
+.. _`4.1 minsky`: http://tdd.lan.arta.kz/docs/synergy/tags/minsky/admin-manual/html/install-and-setup.html#install-and-setup.install
+
+.. _`Конструктора приложений`: http://rtd.lan.arta.kz/docs/synergy-constructor/ru/latest/
+
+.. _`(инструкция по установке)`: http://tdd.lan.arta.kz/docs/synergy/tags/minsky/admin-manual/html/appendix.dashboards.html
+
+Процесс обновления
+~~~~~~~~~~~~~~~~~~~~
+
+Synergy Customers обновляется из пакета. Все действия аналогичны процессу 
+установки, используйте вариант установки ``Install/Upgrade Configuration``:
+
+#. ``Install/Upgrade Configuration`` - установка приложений Customers и 
+   импорта, загрузка конфигураций (Synergy и конструктора), без БД и 
+   хранилища. Соответственно, имеющиеся в Системе данные не удаляются.
+
+#. ``Manual`` - установка только приложения для импорта. 
+
+Установочный пакет находится в репозитории *product-stable*. В файле 
+``/etc/apt/sources.list`` необходимо добавить либо раскомментировать 
+следующую строку:
+
+    .. code-block:: html 
+
+	deb http://deb.arta.kz/tengri product-stable main contrib non-free
+
+Для установки приложения необходимо выполнить команду:
+
+    .. code-block:: html 
+
+	# apt-get update
+	# apt-get install arta-synergy-apps-customers
+
+В ходе установки необходимо выполнить следующее:
+
+* Выбрать тип установки ``Install/Upgrade Configuration`` из предложенного 
+  списка:
+
+    .. figure:: resources/img/customers_install.png
+
+        Рис. Тип установки
+
+* Указать URL до Synergy, на котором производится работа (например: 
+  http://192.168.4.80:8080/Synergy):
+
+    .. figure:: resources/img/customers_1.png
+
+        Рис. Ввод synergy URL
+
+* Ввести последовательно логин и пароль Системного пользователя:
+
+    .. figure:: resources/img/customers_2.png
+
+        Рис. Ввод логина
+
+    .. figure:: resources/img/customers_3.png
+
+        Рис. Ввод пароля
+
+.. attention:: В случае, если платформа Arta Synergy была обновлена с версии 
+               **4.0 hamming** до **4.1 minsky**, требуется переустановка 
+               приложения для импорта. 
+
+Для этого необходимо переустановить пакет Customers командой:
+
+    .. code-block:: html 
+
+	# aptitude reinstall arta-synergy-apps-customers
+
+И в ходе обновления необходимо выбрать тип установки ``Manual`` из 
+предложенного списка:
+
+    .. figure:: resources/img/customers_manual.png
+
+        Рис. Тип установки
+
+После обновления
+~~~~~~~~~~~~~~~~~~
+
+Во-первых, в подсистеме конфигурирования необходимо проверить логин 
+и пароль Системного пользователя в следующих блокирующих процессах:
+
+* ``event.blocking.interpreter.changeDealStage``
+* ``event.blocking.interpreter.createActivity``
+* ``event.blocking.interpreter.createUserPlansForSales``
+* ``event.blocking.interpreter.getEndDealStatus``
+* ``event.blocking.interpreter.add_deal_status``
+* ``event.blocking.interpreter.add_deal_status_on_change``
+* ``event.blocking.interpreter.calculate_deal_status_duration_summary``
+* ``event.blocking.interpreter.change_deal_status``
+* ``event.blocking.interpreter.sum_deal_expired_days``
+* ``event.blocking.interpreter.sum_expired_days``
+* ``event.blocking.interpreter.transaction_check``
+* ``event.blocking.interpreter.transaction_check2``
+* ``event.blocking.interpreter.contracts_activity``
+* ``event.blocking.interpreter.leads_activity``
+* ``event.blocking.interpreter.lidschange``
+* ``event.blocking.interpreter.activity_status``
+
+Из-за особенностей загрузки конфигурации в Конструкторе приложений 
+после обновления будет 2 приложения: старое и новое. При этом по 
+умолчанию активным будет именно старое приложение. Поэтому все 
+следующие действия сводятся к трем шагам:
+
+1. В старом приложении освободить дефолтные код и URL.
+
+2. В новом приложении настроить дефолтные код и URL.
+
+3. Передеплоить приложение со стороны сервера.
+
+Во-вторых, настроить обновленное приложение в Конструкторе:
+
+* Открыть Конструктор приложений по адресу ``http://адрес_сервера:порт/constructor`` 
+  (например: http://192.168.4.80:8080/constructor) и авторизоваться под Системным 
+  пользователем.
+
+* Открыть старое приложение с кодом и URL ``customers`` и выполнить следующие 
+  действия в нем:
+
+    * выбрать меню "Клиент" -> "Свойства";
+    * изменить название на любое значение, отличное от исходного (для примера 
+      подойдет ``Customers Old 1``);
+    * изменить код и URL на любое значение, отличное от исходного ``customers`` 
+      (для примера подойдет ``customers1``);
+    * сохранить изменения.
+
+* Открыть новое приложение с названием ``Customers 3.0_IMPORTED`` и выполнить 
+  следующие действия в нем:
+
+    * выбрать меню "Клиент" -> "Свойства";
+    * изменить название на любое значение, отличное от исходного 
+      ``Customers 3.0_IMPORTED`` (для примера подойдет название по умолчанию 
+      ``Customers 3.0``);
+    * изменить код и URL строго на значение ``customers``;
+    * сохранить изменения;
+    * выбрать меню "Клиент" -> "Деплой".
+
+
+В-третьих, в конструкторе для приложения customers в свойствах приложения проверить актульный логин и пароль пользователя по умолчанию (администратора с доступом к справочникам и настройкам системы).
+
+Во-четвёртых, передеплоить приложение со стороны сервера:
+
+* Перейти в папку ``deployments``:
+
+    .. code-block:: html 
+
+	# cd /opt/synergy/jboss/standalone/deployments
+
+* Выполнить команду:
+
+    .. code-block:: html 
+
+	# touch customers.war.dodeploy
+
+Готово, можно проверять.

introduction_guide/conf.py

@@ -43,17 +43,17 @@ source_suffix = '.rst'
 master_doc = 'index'
 
 # General information about the project.
-project = u'Инструкция по внедрению Synergy Sales'
-copyright = u'2018, ARTA Software'
+project = u'Инструкция по настройке и использованию Synergy Customers'
+copyright = u'2022, 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 = '1.5'
+version = '3.0'
 # The full version, including alpha/beta/rc tags.
-release = '1.5'
+release = '3.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -232,7 +232,7 @@ latex_documents = [
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    ('index', 'readthedocstemplate', u'Спецификация требований Synergy Showcase',
+    ('index', 'readthedocstemplate', u'Инструкция по настройке и использованию Synergy Customers',
      [u'Read the Docs'], 1)
 ]
 

introduction_guide/faq.rst

+Настройка и кастомизация Synergy Customers
+============================================
+
+Можно ли изменить дизайн продукта?
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+*Теги: изменить дизайн, изменить интерфейс.*
+
+*Уровень: разработчик.*
+
+Продукт реализован на платформе Arta Synergy и конструкторе 
+приложений в частности. Данный конструктор приложений 
+обеспечивает дизайн "по умолчанию", используется встроенный 
+framework `UIKit <https://getuikit.com/docs/introduction>`_.
+
+При этом конструктор приложений позволяет менять дизайн продукта. 
+Для этого необходимо:
+
+* подключить разработчика со знаниями HTML/CSS и JavaScript;
+* в приложении конструктора ``Customers`` переопределить стили 
+  в ресурсах и свойствах всех используемых компонентов:
+
+  * "CSS Класс" и "Стили" - у стандартных компонентов;
+  * "HTML" и "Стили" - у пользовательских компонентов.
+
+.. tip:: Изменить цвета витрины продаж можно без разработчика 
+         штатными средствами, см. подробнее здесь_.
+
+.. _здесь: #id5
+
+Как изменить URL-адрес приложения?
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+*Теги: адрес приложения, URL, /customers.*
+
+*Уровень: системный администратор.*
+
+В качестве примера изменим URL с ``customers`` на ``sales``.
+
+#. Авторизоваться в Конструкторе приложений и перейти в 
+   актуальную версию приложения "Customers 3.0" (с кодом 
+   ``customers``).
+
+#. Открыть свойства приложения и поменять значение поля URL 
+   с дефолтного ``customers`` на новое ``sales``.
+
+#. Передеплоить приложение.
+
+   *Вариант 1.* В Конструкторе приложений использовать меню 
+   Клиент -> Деплой.
+
+   *Вариант 2.* Передеплоить приложение со стороны сервера:
+
+   * Перейти в папку ``deployments``:
+
+       .. code-block:: html 
+
+	   # cd /opt/synergy/jboss/standalone/deployments
+
+   * Выполнить команду:
+
+       .. code-block:: html 
+
+	   # touch sales.war.dodeploy
+
+#. Со стороны сервера перейти в конфигурационный файл nginx:
+
+    .. code-block:: html 
+
+	# nano /etc/nginx/sites-enabled/synergy-base
+
+   и поменять дефолтный контекст ``/customers`` на новый 
+   ``/sales``.
+
+   *Было customers:*
+
+    .. code-block:: xml 
+
+        location /customers {
+                proxy_pass http://127.0.0.1:8080/customers;
+        }
+
+   *Стало sales:*
+
+    .. code-block:: xml 
+
+        location /sales {
+                proxy_pass http://127.0.0.1:8080/sales;
+        }
+
+#. Проверить корректность настроек nginx:
+
+    .. code-block:: html 
+
+	# nginx -t
+
+   При необходимости исправить ошибки.
+
+#. Если проверка прошла успешно, перезагрузить настройки nginx:
+
+    .. code-block:: html 
+
+	# nginx -s reload
+
+
+
+Как изменить поля в карточках?
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+*Теги: добавить новое поле, изменить заголовок поля, изменить 
+порядок следования полей.*
+
+*Уровень: аналитик.*
+
+Продукт реализован на платформе Arta Synergy и редактора 
+форм в частности. Данный редактор форм обеспечивает гибкую 
+настройку состава полей любых карточек.
+
+#. Авторизоваться в Конфигураторе приложений и перейти в 
+   приложение "Customers" (с кодом ``customers``).
+
+#. Найти и открыть нужную форму.
+
+#. Изменить состав полей и их свойства согласно рекомендаций_.
+
+.. _рекомендаций: description.html#id1
+
+Как изменить стадии сделки?
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+*Теги: сделка, изменить название стадии, переименовать стадию, 
+изменить порядок следования стадий, изменить описание стадии, 
+добавить новую стадию, удалить стадию.*
+
+*Уровень: аналитик.*
+
+**Решение:** отредактировать элементы справочника "Стадии сделки".
+
+#. Авторизоваться в Конфигураторе приложений и перейти в 
+   приложение "Customers" (с кодом ``customers``).
+
+#. Найти и открыть справочник "Стадии сделки" (с кодом 
+   ``customers_dict_dealStatus``).
+
+#. Нажать на кнопку "Элементы". Откроется таблица со списком 
+   стадий сделок. Для удобства отсортируйте таблицу по столбцу 
+   "Порядковый номер".
+
+#. Изменить элементы согласно описания справочника `стадий сделок`_.
+
+.. _`стадий сделок`: description.html#c
+
+Как изменить стадии договора?
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+*Теги: договор, изменить название стадии, переименовать стадию, 
+изменить порядок следования стадий, изменить описание стадии, 
+изменить цвет стадии, добавить новую стадию, удалить стадию.*
+
+*Уровень: аналитик.*
+
+**Решение:** отредактировать элементы справочника "Стадии договора".
+
+#. Авторизоваться в Конфигураторе приложений и перейти в 
+   приложение "Customers" (с кодом ``customers``).
+
+#. Найти и открыть справочник "Стадии договора" (с кодом 
+   ``customers_dict_contractStatus``).
+
+#. Нажать на кнопку "Элементы". Откроется таблица со списком 
+   стадий договора. Для удобства отсортируйте таблицу по столбцу 
+   "Порядковый номер".
+
+#. Изменить элементы согласно описания справочника `стадий договора`_.
+
+.. _`стадий договора`: description.html#id5
+
+Как изменить стадии лида?
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+*Теги: лид, изменить название стадии, переименовать стадию, 
+изменить порядок следования стадий, добавить новую стадию, удалить стадию.*
+
+*Уровень: аналитик.*
+
+**Решение:** отредактировать элементы справочника "Стадии лида".
+
+#. Авторизоваться в Конфигураторе приложений и перейти в 
+   приложение "Customers" (с кодом ``customers``).
+
+#. Найти и открыть справочник "Стадии лида" (с кодом 
+   ``customers_dict_leadStatus``).
+
+#. Нажать на кнопку "Элементы". Откроется таблица со списком 
+   стадий лида. Для удобства отсортируйте таблицу по столбцу 
+   "Порядковый номер".
+
+#. Изменить элементы согласно описания справочника стадий лида.
+

introduction_guide/guide.rst

+Описание Synergy Customers
+========================================
+
+Главная страница
+~~~~~~~~~~~~~~~~~~~
+
+На главной странице Synergy Customers расположен одиз из основных элементов продукта - **Канбан-доска**. Канбан-доска позволяет наглядно представить элементы Customers в разбивке по статусам. Элементы доски содержат необходимую информацию - сумму, ФИО ответственного менеджера, ссылки на контакт и организацию.
+
+В заголовке столбца содержится информация о количестве элементов и сумма по столбцу.
+
+На левой панели расположены разделы Synergy Customers:
+
+* Сделки (Канбан-доска)
+* Лиды (Канбан-доска)
+* Организации (список)
+* Контакты (список)
+* Договоры (список)
+* Активности (список)
+
+При необходимости боковую панель можно свернуть/развернуть.
+
+
+.. figure:: img/Customers_3.0_-_deals.png
+
+        Рис. 1
+        
+ 
+ 
+Фильтры
+~~~~~~~~~~~~~~~~~~~   
+
+При наличии в выбранном разделе доступных пользователю фильтров соответствующего реестра - выбор фильтров будет отображаться слева от поисковой строки.
+
+По умолчанию отображается верхний доступный фильтр.
+
+.. figure:: img/3.1.regFilters.png
+
+        Рис. 2
+        
+
+
+Расширенный поиск
+~~~~~~~~~~~~~~~~~~~   
+
+Расширенный поиск с выбором условий доступен по нажатию на пиктограмму справа от поисковой строки.
+
+На открывшейся панели есть возможность добавить/удалить условия фильтрации по тем полям формы (например, с кодом поля *field*), для которых есть соотвествующее поле с типом неизменяемый текст и с кодом поля *fieldLabel*.
+
+
+.. figure:: img/3.1.extraFilters.png
+
+        Рис. 3
+        
+
+Создание контакта
+~~~~~~~~~~~~~~~~~~~
+
+Создать новую карточку контакта в Synergy Customers можно несколькими 
+способами:
+
+
+#. из раздела "Контакты" по нажатию на кнопку ``+ Создать``;
+#. из действующей карточки Сделки по нажатию на кнопку ``+ Создать`` 
+   в поле "Контакт".
+#. из карточки Лид по нажатию на кнопку ``+ Создать`` в поле "Контакт".
+
+Система отобразит список совпадений по ФИО и/или ИИН контакта, при 
+наличии. Наличие совпадений не ограничивает создание карточки.
+
+Создание организации
+~~~~~~~~~~~~~~~~~~~
+
+Создать новую карточку организации в Synergy Customers можно несколькими 
+способами:
+
+
+#. из раздела "Организации" по нажатию на кнопку ``+ Создать``;
+#. из действующей карточки Контакта по нажатию на кнопку ``+ Создать`` 
+   в поле "Организация";
+#. из действующей карточки Сделки по нажатию на кнопку ``+ Создать`` 
+   в поле "Организация".
+#. из карточки Лид по нажатию на кнопку ``+ Создать`` 
+   в поле "Организация".
+
+Система отобразит список совпадений по наименованию и/или БИН организации, 
+при наличии. Наличие совпадений не ограничивает создание карточки.
+
+Создание сделки
+~~~~~~~~~~~~~~~~~
+
+Создать новую карточку сделки в Synergy Customers можно несколькими 
+способами:
+
+
+#. из раздела "Сделки" по нажатию на кнопку 
+   ``+ Создать``;
+#. из действующей карточки Организации по нажатию на кнопку ``Создать`` 
+   в блоке "Сделки" - с автоматической привязкой данной организации;
+#. из действующей карточки Контакта по нажатию на кнопку ``Создать`` 
+   в блоке "Сделки" - с автоматической привязкой данного контакта и 
+   связанной с ним Организации.
+
+Смена стадии сделки
+~~~~~~~~~~~~~~~~~~~~~
+
+Сменить стадию сделки в Synergy Customers можно несколькими способами:
+
+#. из карточки Сделки, выбрав нужную стадию в поле "Стадия";
+#. в разделе Сделки перемещением плашки Сделки из стадии А в стадию Б;
+
+
+Создание лида
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Создать карточку лида можно в разделе Лид, 
+нажав на кнопку ``+ Создать``
+
+
+.. figure:: img/Customers_3.0_-_leads.png
+
+        Рис. 4
+
+
+
+

introduction_guide/index.rst

@@ -3,14 +3,14 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Инструкция по внедрению Synergy Sales
-=========================================
+Инструкции по настройке Synergy Customers
+===========================================
 
 .. toctree::
    :maxdepth: 2
    :glob:
    :numbered:
 
-   src/install_type
-   src/kibana
-   src/troubleshooting
+   guide
+   description
+   faq

introduction_guide/src/clean.rst

-Вариант установки "Clean": настройки системы
------------------------------------------------
-
-Проверить, что в файле ``/opt/synergy/jboss/standalone/configuration/arta/apps/crm/crm.properties`` прописаны корректные URL до Synergy и логин/пароль Системного Пользователя:
-
-.. code-block:: js
-
-    # Адрес Synergy для доступа к REST API
-    synergy.address=http://192.168.4.210:8080/Synergy
-    # Логин пользователя от имени которого будет выполняться запрос к REST API Synergy
-    user.login=sales_login
-    # Пароль пользователя от имени которого будет выполняться запрос к REST API Synergy
-    user.password=sales_password
-
-.. important:: Точные логин/пароль Системного Пользователя в варианте установки ``Clean`` указаны ниже.
-
-Настройки, автоматически установленные в подсистеме администрирования
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Во-первых, созданы следующие пользователи:
-
-* Пользователь1 - Абдрешен Леонид
-* Пользователь2 - Балтиев Руслан
-* Пользователь3 - Бобров Степан
-* Пользователь4 - Васильева Людмила
-* Пользователь5 - Васнецов Игорь
-* Пользователь6 - Габдуллин Данияр
-* Пользователь7 - Жуматаев Ерик
-* Пользователь8 - Калиев Ербол
-* Пользователь9 - Муканова Камила
-* Пользователь10 - Саматов Ергали
-* Пользователь11 - Султангазина Айнур
-
-.. note:: Всем разрешен доступ в систему, прочими свойствами не обладают. Логин и пароль пользователей совпадает с фамилией.
-
-* Администратор (с ролями "Администратор" и "Разработчик Synergy", логин/пароль: 1/1)
-* Системный Пользователь (с ролями "Администратор" и "Разработчик Synergy", логин/пароль: system/system)
-
-.. figure:: ../resources/img/users.png
-
-        Рис. Управление пользователями
-
-Во-вторых, заведена следующая орг.структура:
-
-* Организация (подразделение, руководитель Пользователь1)
-	* Администрация (подразделение, руководитель отсутствует)
-		* Администратор (должность, назначен Администратор)
-		* Системный пользователь (должность, назначен Системный Пользователь)
-	* Отдел маркетинга (подразделение, руководитель Пользователь7)
-		* Отдел маркетинга Алматы (подразделение, руководитель Пользователь2)
-			* Маркетолог (должность, назначен Пользователь4)
-		* Отдел маркетинга Астана (подразделение, руководитель Пользователь3)
-			* Маркетолог (должность, назначен Пользователь6)
-	* Отдел продаж (подразделение, руководитель Пользователь11)
-		* Отдел продаж Алматы (подразделение, руководитель Пользователь10)
-			* Специалист по продажам (должность, назначен Пользователь8)
-		* Отдел продаж Астана (подразделение, руководитель Пользователь5)
-			* Специалист по продажам (должность, назначен Пользователь9)
-
-.. figure:: ../resources/img/structure.png
-
-        Рис. Организационная структура
-
-В третьих, на подразделение "Отдел маркетинга" настроено отображение следующих модулей:
-
-* Ежедневник
-* Хранилище -> Реестры
-* Проекты
-* Управление маркетингом
-
-.. figure:: ../resources/img/modules.png
-
-        Рис. Управление модулями - Отдел маркетинга
-
-На корневое подразделение "Отдел продаж" настроено отображение следующих модулей:
-
-* Ежедневник
-* Хранилище -> Реестры
-* Проекты
-* Управление продажами
-
-.. figure:: ../resources/img/modules2.png
-
-        Рис. Управление модулями - Отдел продаж
-
-На все прочие дочерние подразделения "Отдел продаж" настроено отображение следующих модулей:
-
-* Ежедневник
-* Хранилище -> Реестры
-* Проекты
-* Управление продажами (ОП)
-
-.. figure:: ../resources/img/modules3.png
-
-        Рис. Управление модулями - Отдел продаж (дочерние структуры)
-
-Настройки, автоматически установленные в конфигураторе
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Во-первых, импортировано приложение `Sales`.
-
-Во-вторых, созданы следующие группы пользователей:
-
-* Все маркетологи
-	* Маркетологи-менеджеры
-		* Маркетологи-менеджеры по Алматы (Пользователь2 и Системный Пользователь)
-		* Маркетологи-менеджеры по Астане (Пользователь3)
-	* Маркетологи-специалисты
-		* Маркетологи-специалисты по Алматы (Пользователь4 и Системный Пользователь)
-		* Маркетологи-специалисты по Астане (Пользователь6)
-	* Руководитель отдела маркетинга (Пользователь7 и Системный Пользователь)
-* Все специалисты по продажам
-	* Менеджеры по продажам
-		* Менеджеры по продажам по Алматы (Пользователь 10 и Системный Пользователь)
-		* Менеджеры по продажам по Астане (Пользователь5)
-	* Руководитель отдела продаж (Пользователь11 и Системный Пользователь)
-	* Специалисты по продажам
-		* Специалисты по продажам по Алматы (Пользователь8 и Системный Пользователь)
-		* Специалисты по продажам по Астане (Пользователь9)
-* Центральный аппарат (Абдрешен и Системный Пользователь)
-
-.. note:: Дополнительно в каждой перечисленной группе имеется Администратор.
-
-В-третьих, настроены прочие опции, значения которых отличаются от дефолтных:
-
-* форма завершения "Комментарий": "Требовать подтверждения результата" - нет
-* "Отображать полное ФИО пользователя" - да
-* "Отображать ФИО и должность пользователя на момент подписи в листе подписей" - да
-* "Отображать в ходе исполнения будущие этапы" - да
-* "Требовать ввода комментария при согласовании/утверждении" - да
-* "Требовать ввода комментария при отказе в согласовании/утверждении" - да
-* "Форма завершения по-умолчанию" - Комментарий
-* "Переназначение работ" - везде переназначить работы на непосредственного руководителя
-* "Название системы" - ARTA Synergy Sales
-* "Интеграция с почтой" - да
-
-.. note:: «Интеграция с почтой» предназначена для отправки уведомлений, шаблонов документов (коммерческое предложение, акт приема-передачи, договора) заказчикам на почту. Подробнее о настройке электронной почты см. `здесь <http://tdd.lan.arta.kz/docs/cases/crm/user-manual/html/sec.appendix.html#user_settings>`_.
-
-В-четвертых, необходимо проверить корректность URL до Synergy в настройках следующих внешних модулей:
-	* ``crm_ext1Lead``
-	* ``crm_ext2Deal``
-	* ``crm_ext3DealOS``
-
-А также проверить корректность URL до Synergy в ссылке на дашборд в настройке ``template.html`` следующих пользовательских компонентов:
-	* ``crm_component_leads_dashboard``
-	* ``crm_component_deals_dashboard``
-	* ``crm_component_deals_productivity``
-	* ``crm_component_deals_os_productivity``
-

introduction_guide/src/install_type.rst

-Настройки системы
-==========================
-
-.. toctree::
-   :maxdepth: 2
-   :numbered:
-
-   clean
-   install_upgrade
-   manual

introduction_guide/src/install_upgrade.rst

-Вариант установки "Install/Upgrade Configuration": настройки системы
-----------------------------------------------------------------------
-
-Проверить, что в файле ``/opt/synergy/jboss/standalone/configuration/arta/apps/crm/crm.properties`` прописаны корректные URL до Synergy и логин/пароль Системного Пользователя:
-
-.. code-block:: js
-
-    # Адрес Synergy для доступа к REST API
-    synergy.address=http://192.168.4.210:8080/Synergy
-    # Логин пользователя от имени которого будет выполняться запрос к REST API Synergy
-    user.login=sales_login
-    # Пароль пользователя от имени которого будет выполняться запрос к REST API Synergy
-    user.password=sales_password
-
-Настройки, которые необходимо выполнить в подсистеме администрирования
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-#. Настроить права на внешние модули в организационной структуре.
-
-Настройки, которые необходимо выполнить в конфигураторе
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-#. Проверить корректность URL до Synergy в настройках следующих внешних модулей:
-	* ``crm_ext1Lead``
-	* ``crm_ext2Deal``
-	* ``crm_ext3DealOS``
-
-#. Проверить корректность URL до Synergy в ссылке на дашборд в настройке ``template.html`` следующих пользовательских компонентов:
-	* ``crm_component_leads_dashboard``
-	* ``crm_component_deals_dashboard``
-	* ``crm_component_deals_productivity``
-	* ``crm_component_deals_os_productivity``
-
-#. Распределить пользователей по группам маркетологов и менеджеров по продаже, по категории руководитель / менеджер / специалист.
-
-#. Добавить во все группы Системного пользователя.

introduction_guide/src/kibana.rst

-Настройка Kibana для визуализации данных
-==================================================
-
-В конфигурационном файле Kibana ``/etc/kibana/kibana.yml`` необходимо изменить параметр ``server.host``, указав для него IP-адрес сервера Kibana и раскомментировать соответствующую строку:
-
-.. code-block:: xml
-
-    # Kibana is served by a back end server. This setting specifies the port to use.
-    #server.port: 5601
-
-    # Specifies the address to which the Kibana server will bind. IP addresses and host names are both valid values.
-    # The default is 'localhost', which usually means remote machines will not be able to connect.
-    # To allow connections from remote users, set this parameter to a non-loopback address.
-    server.host: "192.168.2.164"
-
-    # Enables you to specify a path to mount Kibana at if you are running behind a proxy. This only affects
-    # the URLs generated by Kibana, your proxy is expected to remove the basePath value before forwarding requests
-    # to Kibana. This setting cannot end in a slash.
-    #server.basePath: ""
-
-    # The maximum payload size in bytes for incoming server requests.
-    #server.maxPayloadBytes: 1048576
-
-    # The Kibana server's name.  This is used for display purposes.
-    #server.name: "your-hostname"
-
-    # The URL of the Elasticsearch instance to use for all your queries.
-    #elasticsearch.url: "http://localhost:9200"
-
-    # When this setting’s value is true Kibana uses the hostname specified in the server.host
-    # setting. When the value of this setting is false, Kibana uses the hostname of the host
-    # that connects to this Kibana instance.
-    #elasticsearch.preserveHost: true
-
-Запуск Kibana осуществляется командой:
-
-    .. code-block:: html 
-
-	# /etc/init.d/kibana start
-
-По умолчанию Kibana запускается по адресу ``localhost:5601``.
-
-Дополнительные подробности доступны в подробной документации о `Kibana <http://rtd.lan.arta.kz/docs/guide/ru/hamming/dashboards.html>`_.
-
-Индексация данных форм
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Загрузка данных в Elasticsearch осуществляется с помощью процесса индексации данных форм в разделе подсистеме администрирования "Обслуживание системы" -> "Управление индексом форм".
-
-**Проиндексировать все данные форм** (это может занять время, зависит от количества записей в системе)
-
-В это время для каждой формы и каждого компонента этой формы в Synergy создается несколько индексов. Каждый из этих индексов будет отображен в Kibana со своим кодом, как используемое поле.
-
-    .. figure:: ../resources/img/indexes.png
-
-        Рис. Управление индексом данных форм
-
-Для проверки установки Kibana, необходимо в основном приложении Synergy перейти в модуль "Управление маркетингом" либо "Управление продажами", вкладка "Аналитика". Если все настроено правильно, то должны иметь следующее:
-
-    .. figure:: ../resources/img/analytics.png
-
-        Рис. Аналитика
-

introduction_guide/src/manual.rst

-Вариант установки "Manual": настройки системы
----------------------------------------------------
-
-Проверить, что в файле ``/opt/synergy/jboss/standalone/configuration/arta/apps/crm/crm.properties`` прописаны корректные URL до Synergy и логин/пароль Системного Пользователя:
-
-.. code-block:: js
-
-    # Адрес Synergy для доступа к REST API
-    synergy.address=http://192.168.4.210:8080/Synergy
-    # Логин пользователя от имени которого будет выполняться запрос к REST API Synergy
-    user.login=sales_login
-    # Пароль пользователя от имени которого будет выполняться запрос к REST API Synergy
-    user.password=sales_password
-
-Настройки, которые необходимо выполнить в подсистеме администрирования
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-#. Настроить права на внешние модули в организационной структуре.
-
-Настройки, которые необходимо выполнить в конфигураторе
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-#. Импортировать приложение Sales из архива ``/opt/synergy/apps/crm/app-sales.7zip``. 
-
-.. hint:: 
-
-        #. При импорте приложения рекомендуем руководствоваться `документацией`_.
-        #. Если на сервере уже был установлен продукт, следует сверить номера версий приложения в архиве и на сервере, при необходимости нужно увеличить номер версии в архиве.
-
-#. Заменить URL до Synergy в настройках следующих внешних модулей:
-	* ``crm_ext1Lead``
-	* ``crm_ext2Deal``
-	* ``crm_ext3DealOS``
-
-.. figure:: ../resources/img/module.png
-
-        Рис. Настройки внешнего модуля
-
-#. Заменить URL до Synergy в ссылке на дашборд в настройке ``template.html`` следующих пользовательских компонентов:
-	* ``crm_component_leads_dashboard``
-	* ``crm_component_deals_dashboard``
-	* ``crm_component_deals_productivity``
-	* ``crm_component_deals_os_productivity``
-
-#. Распределить пользователей по группам маркетологов и менеджеров по продаже, по категории руководитель / менеджер / специалист.
-
-#. Добавить во все группы Системного пользователя.
-
-.. _`документацией`: http://tdd.lan.arta.kz/docs/synergy/tags/hamming/release-notes/html/app_export_import.html#app_import
-
-Настройки, которые необходимо выполнить в Kibana
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-#. Создать следующие шаблоны индексов:
-	* ``r-crm_registry_deals``
-	* ``deals_status_history``
-	* ``r-crm_registry_accounts``
-	* ``r-crm_registry_deals*``
-	* ``r-crm_registry_deals_plans_custom``
-	* ``r-crm_registry_events``
-	* ``r-crm_registry_invoices``
-	* ``r-crm_registry_lead``
-
-#. Импортировать визуализации из файла ``/opt/synergy/apps/crm/sales_visualizations.json``.
-
-#. Импортировать дашборды из файла ``/opt/synergy/apps/crm/sales_dashboards.json``.
-
-.. hint:: Дополнительные подробности доступны в подробной документации о `Kibana <http://rtd.lan.arta.kz/docs/guide/ru/hamming/dashboards.html>`_.

introduction_guide/src/troubleshooting.rst

-Устранение неполадок
-============================
-
-Проблема: во внешних модулях ничего не отображается
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-**Возможная причина:** при установке неправильно указан URL для Synergy.
-
-**Пути устранения:**
-
-#. В терминале необходимо выполнить команду:
-
-    .. code-block:: html 
-
-	# dpkg-reconfigure arta-synergy-apps-sales
-
-   и следовать `мастеру установки <http://tdd.lan.arta.kz/docs/synergy/tags/hamming/admin-manual/html/install-and-setup.html#install-and-setup.install>`_.
-
-#. Проверить корректность URL до Synergy в настройках следующих внешних модулей:
-	* ``crm_ext1Lead``
-	* ``crm_ext2Deal``
-	* ``crm_ext3DealOS``
-
-#. Проверить корректность URL до Synergy в ссылке на дашборд в настройке ``template.html`` следующих пользовательских компонентов:
-	* ``crm_component_leads_dashboard``
-	* ``crm_component_deals_dashboard``
-	* ``crm_component_deals_productivity``
-	* ``crm_component_deals_os_productivity``
-
-Проблема: нет реестров у пользователя
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-**Возможная причина:** не настроены права для реестров.
-
-**Пути устранения:** в Конфигураторе необходимо настроить права пользователю на реестры, добавив его в одну из типовых групп пользователей.
-
-Проблема: не отображаются Лиды или не работают сопоставления реестров
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-**Возможная причина:** неправильно прописаны очереди в файле.
-
-**Пути устранения:**
-
-#. Прописать очередь в файле ``/opt/synergy/jboss/standalone/configuration/arta/api-observation-configuration.xml``
-
-    .. code-block:: xml
-
-        <listener>
-            <queue>java:jboss/queues/Synergy/FormDataChange</queue>
-            <event>event.form.formdata.change</event>
-        </listener>
-        <listener>
-            <queue>java:jboss/queues/Synergy/LeadDelete</queue>
-            <event>crm.lead.delete</event>
-        </listener>
-
-#. В файл ``/opt/synergy/jboss/standalone/configuration/standalone-onesynergy.xml`` в секцию ``<jms-destinations/>`` добавить очередь:
-
-    .. code-block:: xml
-
-        <jms-queue name="FormDataChange">
-            <entry name="queue/FormDataChange"/>
-            <entry name="java:jboss/queues/Synergy/FormDataChange"/>
-            <durable>true</durable>
-        </jms-queue>
-        <jms-queue name="LeadDelete">
-            <entry name="queue/LeadDelete"/>
-            <entry name="java:jboss/queues/Synergy/LeadDelete"/>
-            <durable>true</durable>
-        </jms-queue>
-
-Проблема: при переходе во внешние модули в рабочей области отображается ошибка страницы
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-**Возможная причина:** не зедеплоилось приложение.
-
-**Пути устранения:** в ``/opt/synergy/jboss/standalone/deployments`` удалить файл ``crm.war.undeployed`` либо ``crm.war.deployed``.
-
-Проблема: при переходе в аналитику отображается ошибка "Попытка соединения не удалась"
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-**Возможная причина:** не запущена Kibana.
-
-**Пути устранения:** запустить Kibana
-
-    .. code-block:: html 
-
-	# /etc/init.d/kibana start
-
-Проблема: при переходе в аналитику отображается ошибка
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-    .. figure:: ../resources/img/error.png
-
-        Рис. Ошибка
-
-**Возможная причина:** в пользовательских компонентах дашбордов не прописались ссылки.
-
-**Пути устранения:** проверить корректность URL до Synergy в ссылке на дашборд в настройке ``template.html`` следующих пользовательских компонентов:
-	* ``crm_component_leads_dashboard``
-	* ``crm_component_deals_dashboard``
-	* ``crm_component_deals_productivity``
-	* ``crm_component_deals_os_productivity``
-
-Проблема: после установки Sales на дашбордах все кириллические символы стали отображаться как ??????????
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-**Возможная причина:** проблема с локалью.
-
-**Пути устранения:**
-
-#. Остановить все сервисы в указанном порядке:
-
-	#. synergy
-	#. kibana
-	#. elasticsearch
-	#. mysql
-
-#. Установить локаль по умолчанию en_US.UTF-8, для этого выполнить команду:
-
-    .. code-block:: html 
-
-	# dpkg-reconfigure locales
-
-   В открывшемся окне можно выбрать все локали:
-
-    .. figure:: ../resources/img/locales.png
-
-        Рис. Локали
-
-   Затем указать локаль по умолчанию: выбрать из списка ``en_US.UTF-8``
-
-    .. figure:: ../resources/img/locale.png
-
-        Рис. Локаль по умолчанию
-
-#. Запустить все остановленные сервисы в указанном порядке:
-
-	#. mysql
-	#. elasticsearch
-	#. kibana
-	#. synergy
-
-#. В разделе "Управление индексом форм" подсистемы администрирования запустить переиндексацию данных форм.
-

req_spec/conf.py

@@ -43,17 +43,17 @@ source_suffix = '.rst'
 master_doc = 'index'
 
 # General information about the project.
-project = u'Спецификация требований Synergy Sales'
-copyright = u'2019, ARTA Software'
+project = u'Спецификация требований Synergy Customers'
+copyright = u'2020, 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 = '1.5'
+version = '2.1'
 # The full version, including alpha/beta/rc tags.
-release = '1.5'
+release = '2.1'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

req_spec/glossary.rst

@@ -6,7 +6,7 @@
 
 * **ОС** - операционная система.
 * **ИС** - информационная система.
-* **Система** - ИС «Synergy Sales».
+* **Система** - ИС «Synergy Customers».
 * **СУБД** - система управления базами данных.
 * **Справочник** - перечень заранее определенных значений параметров 
   объектов системы.
@@ -17,23 +17,12 @@
   отображения структурированных данных.
 * **Реестр** - способ представления данных по Форме в табличном виде.
 * **Запись** - Документ на основе Формы в Реестре.
-* **Маркетинговое мероприятие** - Документ (в терминах системы), 
-  позволяющий хранить структурированные данные (меры по привлечению 
-  клиентов и повышению объемов продаж) по утвержденной Форме.
-* **Лид** - Документ (в терминах системы), позволяющий хранить 
-  структурированные данные о потребительском интересе, который через 
-  выполнение задач можно конвертировать в Сделку, по утвержденной 
-  Форме.
-* **Отклик маркетингового мероприятия** - проявление интереса и 
-  регистрация Лида в Системе в результате воздействия на потребителя 
-  маркетингового мероприятия. Отклик может быть целевым (задается 
-  вручную) и текущим (рассчитывается Системой автоматически из 
-  количества Лидов, связанных с Маркетинговым мероприятием).
-* **Эффективность маркетингового мероприятия** - отношение текущего и 
-  целевого откликов маркетингового мероприятия.
 * **Сделка** - Документ (в терминах системы), позволяющий хранить 
   структурированные данные о сотрудничестве с Контактом и Аккаунтом, 
-  которое через выполнение задач можно конвертировать в продажу, по 
+  которое через выполнение задач можно конвертировать в Договор, по 
+  утвержденной Форме.
+* **Договор** - Документ (в терминах системы), позволяющий хранить 
+  структурированные данные о продаже с Контактом и Аккаунтом, по 
   утвержденной Форме.
 * **Аккаунт** - Документ (в терминах системы), позволяющий хранить 
   структурированные данные об организации или подразделении организации, 
@@ -42,11 +31,10 @@
   структурированные данные о человеке, работающем в Аккаунте, с которым 
   происходят взаимодействия для заключения Сделок, по утвержденной Форме.
 * **Активность** - регистрация любого действия с Контактом и Аккаунтом 
-  в карточках Лидов и Сделок.
-* **Дашборд** - информационная панель, отображающая данные в реальном 
-  времени, содержащая Визуализации в различных представлениях и разрезах, 
-  а также предназначенная для упрощения работы по оценке и обработке 
-  данных, прогнозированию дальнейшего состояния и принятию решений.
-* **Визуализация** - элемент Дашборда в виде числовой метрики, таблицы 
-  или различных диаграмм.
+  в карточках Сделок и Договоров.
+* **Мероприятие** - Документ (в терминах системы), позволяющий хранить 
+  структурированные данные о маркетинговом мероприятии.
+* **Лид** - Документ (в терминах системы), позволяющий хранить 
+  структурированные данные о человеке, либо организации, с которыми 
+  происходят взаимодействия для заключения Сделок, по утвержденной Форме.  
 

req_spec/goals.rst

-Цели создания
-=================
+Цели и задачи Synergy Customers
+===================================
 
-Целью создания Synergy Sales является автоматизация процессов 
-маркетинга и продаж. Основные точки прироста эффективности от 
-внедрения системы Synergy Sales:
+Основная бизнес-цель Synergy Customers - это своевременное исполнение 
+плана продаж компании за счет набора инструментов для его контроля:
 
-* ``Управление маркетингом`` - снижение расходов на привлечение 
-  одного клиента за счет качественной сегментации целевой аудитории, 
-  возможности подготовки точных ценностных предложений, планирования 
-  маркетинговых кампаний и процессного подхода по подготовке 
-  потенциальных клиентов для продаж (генерации и взращивания лидов).
+* обеспечение актуальности и полноты базы клиентов;
+* фиксирование всей истории взаимодействий с клиентами;
+* деление клиентов на однородные сегменты и назначение списков для 
+  отработки;
+* обеспечение своевременного исполнения активностей с клиентами;
+* формирование планов продаж компании;
+* фиксирование фактов и отклонений по отношению к плану продаж;
+* понимание текущего объема продаж;
+* возможность отслеживания статусов сделок;
+* выявление "бутылочного горлышка" в процессе продаж.
 
-* ``Управление продажами`` - повышение уровня конвертации (доли 
-  лидов, ставших покупателями) и сокращение расходов на цикл продаж 
-  на основе процессного подхода к заключению сделки и контроля 
-  нормативов выполнения операций.
 

req_spec/index.rst

@@ -11,6 +11,7 @@
    :glob:
    :numbered:
 
-   goals
    glossary
+   goals
+   processes
    requirements

req_spec/processes.rst

+Основные процессы, которые покрывает Synergy Customers
+=========================================================
+
+1. Сегментирование рынка  
+
+.. csv-table::
+    :widths: 5, 15, 30
+
+    "**Код процесса**", "**Наименование процесса**", "**Ценность**"
+    "SG01", "Импорт/актуализация данных по ассортименту товаров/услуг", "Быстрый доступ к информации по ассортименту."
+    "SG02", "Импорт данных о клиентах и договорах из файлов в карточки клиентов", "Исключение необходимости ручного ввода данных о клиентах и сделках."
+    "SG03", "Формирование списка клиентов (сегмента) из базы клиентов", "Возможность сделать подходящее предложение для однородного сегмента клиентов."
+    "SG04", "Формирование аналитики по клиенту из списка", "Понимание поведения и истории отношений с отдельным клиентом."
+    "SG05", "Формирование отчета о структуре и объеме продаж: сегмент, ассортимент, подразделение, время", "Понимание структуры фактического спроса по фактическим сделкам."
+    "SG06", "Выгрузка списка клиентов (сегмента) в файл", "Возможность передать списки исполнителям"
+
+2. Управление продажами 
+
+.. csv-table::
+    :widths: 5, 15, 30
+
+    "**Код процесса**", "**Наименование процесса**", "**Ценность**"
+    "SL01", "Формирование плана продаж", "Определение отвественных за выполнение плана."
+    "SL02", "Назначение списка клиентов исполнителям активных продаж", "Целевой список будет проработан активными продажами."
+    "SL03", "Поиск карточки клиента со всей известной информацией о нем", "Целевой список будет проработан активными продажами."
+    "SL04", "Добавление/актуализация карточки клиента", "Актуальная база клиентов."
+    "SL06", "Планирование и напоминание сотруднику о задачах по сделкам (активности)", "Выполнение обещаний и плановых задач."
+    "SL07", "Подготовка индивидуального предложения ", "Дать индивидуальное предложение."
+    "SL08", "Регистрация изменения по сделке: статуса, параметров, документов", "Актуальная информация по всем сделкам."
+    "SL09", "Оформление договора/заказа", "Быстрое формирование договора/заказа"
+    "SL10", "Формирование персонального отчета по продажам (план/факт, анализ воронки)", "Понимание исполнения плана продаж исполнителя."
+    "SL11", "Формирование отчета по продажам подразделения (план/факт, анализ воронки, по исполнителям, ассортименту)", "Понимание исполнения плана продаж подразделения, востребованности ассортимента, структура и причин отказов."
+
+3. Управление маркетингом
+
+.. csv-table::
+    :widths: 5, 15, 30
+    
+    "**Код процесса**", "**Наименование процесса**", "**Ценность**"
+    "LG01", "Формирование маркетингового плана с целевыми показателями", "Фокусирование усилий по привлечению потенциальных клиентов"
+    "LG02", "Регистрация фактических показателей по мероприятиям", "Накопление данных о фактических результатов мероприятий"
+    "LG03", "Формирование аналитического отчета об эффективности исполнения маркетингового плана и каналов лидов", "Аналитика для корректировки маркетингового плана"
+    "LG04", "Регистрация лидов", "Не пропустить ни одного обращения"
+
+Synergy Customers предоставляет 29 вариантов условий для сегментации клиентов:
+
+.. list-table:: Условия фильтров
+   :widths: 30 30
+   :header-rows: 1
+
+   * - Контакты
+     - Аккаунты
+   * - полное имя
+     - наименование компании
+   * - ИИН
+     - БИН / ИИН
+   * - роль в компании
+     - организационно-правовая форма
+   * - телефон
+     - телефон
+   * - e-mail
+     - e-mail
+   * - город
+     - город
+   * - адрес
+     - адрес
+   * - примечание
+     - примечание
+   * - фамилия
+     - выручка
+   * - имя
+     - численность штата
+   * - отчество
+     - статус
+   * - дата рождения
+     - менеджер
+   * - возраст
+     - 
+   * - пол
+     - 
+   * - статус
+     - 
+   * - менеджер
+     - 
+
+Synergy Customers предоставляет следующие этапы продаж:
+
+.. list-table:: Этапы продаж
+   :widths: 30 30
+   :header-rows: 1
+
+   * - Сделки
+     - Договоры
+   * - Новая
+     - Проект договора
+   * - Уточнение потребности
+     - Согласование
+   * - Подготовка предложения
+     - Подписанн
+   * - Защита предложения
+     - Счет
+   * - В договор - успешное завершение сделки
+     - Оплата
+   * - Отказ - неуспешное завершение сделки
+     - Акт
+   * - 
+     - Закрытие - успешное завершение договора
+   * - 
+     - Нереализованно - неуспешное завершение договора
+    
+   
+