Skip to content

S
Synergy Sales
Commit d6488c6f authored by Ilya Veselov's avatar Ilya Veselov
Browse files
Options

Merge branch 'v3.1' into 'master' 

V3.1

See merge request !1
parents 471c5dd9 9501bf64
Hide whitespace changes
Inline Side-by-side
Showing with 1181 additions and 768 deletions
install_guide/conf.py
View file @ d6488c6f
......@@ -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
View file @ d6488c6f
......@@ -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 0 → 100644
View file @ d6488c6f
Установка приложения
----------------------
Предварительные шаги
~~~~~~~~~~~~~~~~~~~~~~
#. Установить самую актуальную версию платформы 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 0 → 100644
View file @ d6488c6f
Обновление приложения
-----------------------
Предварительные шаги
~~~~~~~~~~~~~~~~~~~~~~
#. Установить самую актуальную версию платформы 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
View file @ d6488c6f
......@@ -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/description.rst 0 → 100644
View file @ d6488c6f
Описание компонентов Synergy Customers
========================================
Рекомендации по настройке форм
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Общее описание редактора форм, компонентов и их свойств приведено в
`спецификации на платформу <http://tdd.lan.arta.kz/docs/synergy/tags/minsky/spec/html/sec.conf_forms.html>`_.
Ниже приведены правила и рекомендации к настройке формы для
того, чтобы у пользователей был одинаковый опыт их использования
как с экранов мониторов, так и с мобильных устройств.
* Создавайте вертикально-ориентированные формы:
* группируйте поля в таблицы;
* добавляйте не более 2 компонентов на одну строку;
* добавляйте заголовок (подпись) над компонентом.
* Настройте единый вид всей формы, используя:
* единый шрифт и размер текста;
* отступы как от края формы, так и между компонентами:
* относительные (в %) горизонтальные отступы;
* абсолютные (в пикселях) вертикальные отступы;
* Ответственно подойдите к именованию компонентов:
* имя компонента должно явно описывать его суть;
* имя заголовка (подписи) должно содержать в себе имя
связанного с ним компонента + суффикс ``Label``.
.. hint:: Компонент для ввода БИН организации лучше назвать
``crm_form_account_main_bin``, а подпись к такому
компоненту - ``crm_form_account_main_binLabel``.
* **Скройте** ненужные и неиспользуемые компоненты (**не удаляйте**
и перенесите в самый низ формы). Эти компоненты могут
использоваться в различных функциях / скриптах. Таким
образом вы избавитесь от потенциальных проблем и ошибок в
дальнейшем использовании продукта.
Все формы в продукте настроены с учетом приведенных рекомендаций.
Посмотрите, как они сделаны, и изменяйте их в том же ключе.
Возможные вопросы и проблемы:
#. `Как изменить поля в карточках?`_
.. _`Как изменить поля в карточках?`: faq.html#id3
Cправочник "Стадии сделки"
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. csv-table:: Описание справочника "Стадии сделки"
:header: "Столбец", "Описание", "Доп.свойства"
:widths: 10, 20, 20
"Название", "Название стадии", "Переводимое поле"
"Порядковый номер", "Определяет порядок следования стадий"
"Качество", "Определяет, является ли стадия успешной или неуспешной", "Неуспешная должна быть только одна"
"Законченность", "Определяет, является ли стадия конечной или неконечной", "Конечная стадия должна быть только одна; для неуспешной стадии можно не указывать"
"Название кнопки", "В данный момент нигде не используется"
"Цвет", "Цвет стадии, который будет использоваться в заголовке витрины, а также в воронке продаж", "Формат HTML ``#123ABC``"
"Описание", "Описание стадии, которое будет использоваться в заголовке витрины продаж, а также в карточке сделки", "Переводимое поле"
Возможные вопросы и проблемы:
#. `Как изменить стадии сделки?`_
.. _`Как изменить стадии сделки?`: faq.html#id5
Cправочник "Стадии договора"
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. csv-table:: Описание справочника "Стадии договора"
:header: "Столбец", "Описание", "Доп.свойства"
:widths: 10, 20, 20
"Название", "Название стадии", "Переводимое поле"
"Порядковый номер", "Определяет порядок следования стадий"
"Качество", "Определяет, является ли стадия успешной или неуспешной", "Неуспешная должна быть только одна"
"Законченность", "Определяет, является ли стадия конечной или неконечной", "Конечная стадия должна быть только одна; для неуспешной стадии можно не указывать"
"Цвет", "В данный момент нигде не используется", "Формат HTML ``#123ABC``"
"Описание", "Описание стадии, которое будет использоваться в карточке договора", "Переводимое поле"
Возможные вопросы и проблемы:
#. `Как изменить стадии договора?`_
.. _`Как изменить стадии договора?`: faq.html#id7
Cправочник "Стадии лида"
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. csv-table:: Описание справочника "Стадии сделки"
:header: "Столбец", "Описание", "Доп.свойства"
:widths: 10, 20, 20
"Название", "Название стадии", "Переводимое поле"
"Порядковый номер", "Определяет порядок следования стадий"
"Качество", "Определяет, является ли стадия успешной или неуспешной", "Неуспешная должна быть только одна"
"Законченность", "Определяет, является ли стадия конечной или неконечной", "Конечная стадия должна быть только одна; для неуспешной стадии можно не указывать"
"Название кнопки", "В данный момент нигде не используется"
"Цвет", "Цвет стадии, который будет использоваться в заголовке витрины, а также в воронке продаж", "Формат HTML ``#123ABC``"
Импорт данных
~~~~~~~~~~~~~~~
Функция импорта, реализованная в продукте, универсальная и позволяет
загружать данные из Excel в любой реестр Synergy.
Импорт работает со следующими компонентами формы:
* текстовые однострочные и многострочные поля;
* числовые поля;
* дата/время;
* справочники (выпадающий список, выбор вариантов, переключатель
вариантов);
* ссылка на реестр.
Требования к файлу Excel:
#. Формат файла: ``*.xls``.
#. Первая строка файла - заголовки; далее - строки для импорта в
записи реестра.
.. note:: 1 строка в Excel = 1 запись реестра.
#. Столбцы, которые **не нужно** импортировать обозначить заголовком
``no``.
#. Остальные заголовки должны содержать в себе точный код поля
формы (например, ``crm_form_account_main_adress``).
#. Для корректного импорта чисел значение поля в файле должно быть
в числовом формате.
#. Для корректного импорта дат значение поля в файле должно быть
в формате даты.
#. Для корректного импорта справочников значение поля в файле должно
точь-в-точь совпадать с его "наименованием" у справочника.
#. Для корректного импорта нескольких значений в компонент выбора
вариантов (чекбокс) в файле их нужно прописать в одной ячейке
через ``;`` с пробелом.
#. Желательно избегать содержания в файле спец.символов json: ``"``,
``\``, ``\b``, ``\t`` и т.д.
Использование:
#. Заполнить код формы и код реестра, в который будет проводиться
импорт. Коды можно взять в конфигураторе.
#. Заполнить логин и пароль пользоваться, от имени которого будут
выполняться все запросы. Пользователь должен иметь права на все
реестры (куда происходит импорт и если в файле имеются ссылки на
прочие реестры).
#. Если импортируемые записи необходимо запустить по маршруту,
требуется поставить галочку "Активировать импортированные записи".
#. Если присутсвуют ссылки на реестр **обязательно** нужно заполнить
поле для поиска в формате:
``(код компонента на форме, куда производится импорт):(код компонента на форме, на которую указывает компонент ссылки на реестр, по которому должен производится поиск)``
Для каждой ссылки на реестр необходимо через запятую с пробелом
необходимо указать подобные пары.
#. При поиске записей для ссылок на реестр может найтись несколько
записей реестра. Укажите в соотвествующем пункте действия на этот
случай. Если не найдена ни одна запись, значение останется пустым.
#. Выберите заранее подготовленный файл ``*.xls`` и нажмите на кнопку
"Импортировать". Импорт начнет в нескольких потоках обрабатывать
переданные записи. Следить за процессом можно через логи системы
Synergy.
introduction_guide/faq.rst 0 → 100644
View file @ d6488c6f
Настройка и кастомизация 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 0 → 100644
View file @ d6488c6f
Описание 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
View file @ d6488c6f
......@@ -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 deleted 100644 → 0
View file @ 471c5dd9
Вариант установки "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 deleted 100644 → 0
View file @ 471c5dd9
Настройки системы
==========================
.. toctree::
:maxdepth: 2
:numbered:
clean
install_upgrade
manual
introduction_guide/src/install_upgrade.rst deleted 100644 → 0
View file @ 471c5dd9
Вариант установки "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 deleted 100644 → 0
View file @ 471c5dd9
Настройка 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 deleted 100644 → 0
View file @ 471c5dd9
Вариант установки "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 deleted 100644 → 0
View file @ 471c5dd9
Устранение неполадок
============================
Проблема: во внешних модулях ничего не отображается
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Возможная причина:** при установке неправильно указан 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
View file @ d6488c6f
......@@ -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
View file @ d6488c6f
......@@ -6,7 +6,7 @@
* **ОС** - операционная система.
* **ИС** - информационная система.
* **Система** - ИС «Synergy Sales».
* **Система** - ИС «Synergy Customers».
* **СУБД** - система управления базами данных.
* **Справочник** - перечень заранее определенных значений параметров
объектов системы.
......@@ -17,23 +17,12 @@
отображения структурированных данных.
* **Реестр** - способ представления данных по Форме в табличном виде.
* **Запись** - Документ на основе Формы в Реестре.
* **Маркетинговое мероприятие** - Документ (в терминах системы),
позволяющий хранить структурированные данные (меры по привлечению
клиентов и повышению объемов продаж) по утвержденной Форме.
* **Лид** - Документ (в терминах системы), позволяющий хранить
структурированные данные о потребительском интересе, который через
выполнение задач можно конвертировать в Сделку, по утвержденной
Форме.
* **Отклик маркетингового мероприятия** - проявление интереса и
регистрация Лида в Системе в результате воздействия на потребителя
маркетингового мероприятия. Отклик может быть целевым (задается
вручную) и текущим (рассчитывается Системой автоматически из
количества Лидов, связанных с Маркетинговым мероприятием).
* **Эффективность маркетингового мероприятия** - отношение текущего и
целевого откликов маркетингового мероприятия.
* **Сделка** - Документ (в терминах системы), позволяющий хранить
структурированные данные о сотрудничестве с Контактом и Аккаунтом,
которое через выполнение задач можно конвертировать в продажу, по
которое через выполнение задач можно конвертировать в Договор, по
утвержденной Форме.
* **Договор** - Документ (в терминах системы), позволяющий хранить
структурированные данные о продаже с Контактом и Аккаунтом, по
утвержденной Форме.
* **Аккаунт** - Документ (в терминах системы), позволяющий хранить
структурированные данные об организации или подразделении организации,
......@@ -42,11 +31,10 @@
структурированные данные о человеке, работающем в Аккаунте, с которым
происходят взаимодействия для заключения Сделок, по утвержденной Форме.
* **Активность** - регистрация любого действия с Контактом и Аккаунтом
в карточках Лидов и Сделок.
* **Дашборд** - информационная панель, отображающая данные в реальном
времени, содержащая Визуализации в различных представлениях и разрезах,
а также предназначенная для упрощения работы по оценке и обработке
данных, прогнозированию дальнейшего состояния и принятию решений.
* **Визуализация** - элемент Дашборда в виде числовой метрики, таблицы
или различных диаграмм.
в карточках Сделок и Договоров.
* **Мероприятие** - Документ (в терминах системы), позволяющий хранить
структурированные данные о маркетинговом мероприятии.
* **Лид** - Документ (в терминах системы), позволяющий хранить
структурированные данные о человеке, либо организации, с которыми
происходят взаимодействия для заключения Сделок, по утвержденной Форме.
req_spec/goals.rst
View file @ d6488c6f
Цели создания
=================
Цели и задачи Synergy Customers
===================================
Целью создания Synergy Sales является автоматизация процессов
маркетинга и продаж. Основные точки прироста эффективности от
внедрения системы Synergy Sales:
Основная бизнес-цель Synergy Customers - это своевременное исполнение
плана продаж компании за счет набора инструментов для его контроля:
* ``Управление маркетингом`` - снижение расходов на привлечение
одного клиента за счет качественной сегментации целевой аудитории,
возможности подготовки точных ценностных предложений, планирования
маркетинговых кампаний и процессного подхода по подготовке
потенциальных клиентов для продаж (генерации и взращивания лидов).
* обеспечение актуальности и полноты базы клиентов;
* фиксирование всей истории взаимодействий с клиентами;
* деление клиентов на однородные сегменты и назначение списков для
отработки;
* обеспечение своевременного исполнения активностей с клиентами;
* формирование планов продаж компании;
* фиксирование фактов и отклонений по отношению к плану продаж;
* понимание текущего объема продаж;
* возможность отслеживания статусов сделок;
* выявление "бутылочного горлышка" в процессе продаж.
* ``Управление продажами`` - повышение уровня конвертации (доли
лидов, ставших покупателями) и сокращение расходов на цикл продаж
на основе процессного подхода к заключению сделки и контроля
нормативов выполнения операций.
req_spec/index.rst
View file @ d6488c6f
......@@ -11,6 +11,7 @@
:glob:
:numbered:
goals
glossary
goals
processes
requirements
req_spec/processes.rst 0 → 100644
View file @ d6488c6f
Основные процессы, которые покрывает 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
* - Сделки
- Договоры
* - Новая
- Проект договора
* - Уточнение потребности
- Согласование
* - Подготовка предложения
- Подписанн
* - Защита предложения
- Счет
* - В договор - успешное завершение сделки
- Оплата
* - Отказ - неуспешное завершение сделки
- Акт
* -
- Закрытие - успешное завершение договора
* -
- Нереализованно - неуспешное завершение договора
req_spec/requirements.rst
View file @ d6488c6f
Требования к разработке ИС «Synergy Sales»
=============================================
Требования к ИС «Synergy Customers»
=======================================
Общие требования к Системе
----------------------------------
------------------------------
.. csv-table::
:widths: 2, 30
3.1.1, "Система должна поддерживать работу на следующих серверных ОС: Linux, BSD, Solaris (рекомендуется использовать ОС Debian GNU/Linux 6.0 (amd64)."
3.1.2, "Система должна поддерживать работу на реляционных СУБД и на noSQL СУБД."
3.1.3, "Система не должна требовать обязательного приобретения дополнительных компонентов (лицензии на ОС, на СУБД и т.п.)."
3.1.4, "Система должна поддерживать шифрование подключений с помощью протокола SSL (HTTPS)."
3.1.5, "Система должна поддерживать работу с распределённым хранилищем данных."
3.1.6, "Система должна обеспечивать возможность распределенной работы и удаленного доступа к ресурсам и объектам."
3.1.7, "Система должна поддерживать работу в архитектуре Internet/Intrаnet."
3.1.8, "Система должна предоставлять Web-интерфейс, который не требует установки клиентской части. Система должна поддерживать интернет-браузеры Google Chrome, Mozilla Firefox актуальных версий."
3.1.9, "Система должна предоставлять возможность реализовывать пользовательские интерфейсы, используя HTML и/или JavaScript."
3.1.10, "Система должна предоставлять комплект средств разработки (Software Development Kit - SDK), включая:
* REST API;
* способы авторизации: сессионная, по логину и паролю, по ключам;
* события, возникающие в различных точках исполняемого кода при выполнении определённых условий;
* очереди сообщений;
* поддержку плагинов;
* JavaScript интерпретаторы."
3.1.11, "Система должна предоставлять возможность регулирования доступа к объектам в соответствии с правами пользователя."
3.1.12, "Система должна предоставлять возможность создания, редактирования форм в визуальном редакторе форм."
3.1.13, "Система должна предоставлять инструмент управления бизнес-процессами, поддерживающий нотацию BPMN."
3.1.14, "Система должна предоставлять дизайнер бизнес-процессов. Создание и редактирование бизнес-процессов должно выполняться в рабочем пространстве дизайнера бизнес-процессов."
3.1.15, "Система должна поддерживать версионность документов."
1. Система должна поддерживать работу на следующих серверных ОС: Linux, BSD, Solaris (рекомендуется использовать ОС Debian GNU/Linux версий 8.0 - 9.0 (amd64).
2. Система должна поддерживать работу на реляционных СУБД и на noSQL СУБД.
3. Система не должна требовать обязательного приобретения дополнительных компонентов (лицензии на ОС, на СУБД и т.п.).
4. Система должна поддерживать шифрование подключений с помощью протокола SSL (HTTPS).
5. Система должна поддерживать работу с распределённым хранилищем данных.
6. Система должна обеспечивать возможность распределенной работы и удаленного доступа к ресурсам и объектам.
7. Система должна поддерживать работу в архитектуре Internet/Intrаnet.
8. Система должна предоставлять Web-интерфейс, который не требует установки клиентской части. Система должна поддерживать интернет-браузеры Google Chrome, Mozilla Firefox актуальных версий.
9. Система должна предоставлять возможность реализовывать пользовательские интерфейсы, используя HTML и/или JavaScript.
10. Система должна предоставлять комплект средств разработки (Software Development Kit - SDK), включая:
* REST API;
* способы авторизации: сессионная, по логину и паролю, по ключам;
* события, возникающие в различных точках исполняемого кода при выполнении определённых условий;
* очереди сообщений;
* поддержку плагинов;
* JavaScript интерпретаторы.
11. Система должна предоставлять возможность регулирования доступа к объектам в соответствии с правами пользователя.
12. Система должна предоставлять возможность создания, редактирования форм в визуальном редакторе форм.
13. Система должна предоставлять инструмент управления бизнес-процессами, поддерживающий нотацию BPMN.
14. Система должна предоставлять дизайнер бизнес-процессов. Создание и редактирование бизнес-процессов должно выполняться в рабочем пространстве дизайнера бизнес-процессов.
15. Система должна поддерживать версионность документов.
16. Система должна позволять импорт структурированных данных по заданному шаблону из файла формата Excel (.xls) в модули «Контакты», «Аккаунты», «Сделки», «Договоры».
17. Система должна позволять создание/редактирование/удаление тем сотрудничества.
18. Система должна позволять редактирование справочника стадий сделки.
19. Система должна позволять редактирование справочника стадий договора.
Требования к модулям Системы
----------------------------
---------------------------------
1. Система должна предоставлять доступ пользователям к модулю «Контакты».
2. Система должна предоставлять доступ пользователям к модулю «Аккаунты».
3. Система должна предоставлять доступ пользователям к модулю «Сделки».
4. Система должна предоставлять доступ пользователям к модулю «Договоры».
5. Система должна предоставлять доступ пользователям к модулю «Единое рабочее место».
6. Система должна предоставлять доступ пользователям к модулю «План продаж».
7. Система должна предоставлять доступ пользователям к модулю «План продаж».
Требования к модулю «Контакты»
----------------------------------
1. Модуль должен отображать все контакты в виде списка.
2. Модуль должен позволять по нажатию на строку списка просмотр полной карточки контакта.
3. Модуль должен позволять создание и редактирование карточки контакта.
4. Модуль должен позволять в описании контакта указывать: полное имя, ИИН, компанию (аккаунт) и роль в ней, контактные и адресные данные, а также дополнительную информацию.
5. Модуль должен отображать подсказки о наличии совпадения по введенному полному имени либо ИИН контакта.
6. Модуль должен отображать все активности внутри карточки, связанные с контактом.
7. Модуль должен позволять добавление активностей внутри карточки с автоматической привязкой к контакту и связанному аккаунту.
8. Модуль должен отображать все сделки внутри карточки, связанные с контактом.
9. Модуль должен позволять добавление сделок внутри карточки с автоматической привязкой к контакту и связанному аккаунту.
10. Модуль должен позволять просмотр связанных карточек аккаунта, активности, сделки.
11. Модуль должен позволять поиск контактов по списку. Поиск должен производиться по всему содержимому карточки контакта, а результаты поиска должны фильтровать список контактов.
12. Модуль должен позволять фильтрацию списка контактов по заданным условиям. В условия фильтров должны попадать все текстовые и числовые поля, компоненты выбора пользователей, даты и справочники из карточки контакта.
13. Модуль должен позволять формирование произвольной выборки из списка контактов.
14. Модуль должен позволять назначение выборки из списка контактов на произвольного пользователя Системы.
15. Модуль должен позволять удаление выборки из списка контактов в соответствии с правами доступа.
Требования к модулю «Аккаунты»
----------------------------------
1. Модуль должен отображать все аккаунты в виде списка.
2. Модуль должен позволять по нажатию на строку списка просмотр полной карточки аккаунта.
3. Модуль должен позволять создание и редактирование карточки аккаунта.
4. Модуль должен позволять в описании аккаунта указывать: наименование, БИН/ИИН, справочные данные о форме организации и секторе экономики, контактные и адресные данные, а также дополнительную информацию.
5. Модуль должен отображать подсказки о наличии совпадения по введенному наименованию либо БИН/ИИН аккаунта.
6. Модуль должен отображать все активности внутри карточки, связанные с аккаунтом.
7. Модуль должен позволять добавление активностей внутри карточки с автоматической привязкой к аккаунту.
8. Модуль должен отображать все сделки внутри карточки, связанные с аккаунтом.
9. Модуль должен позволять добавление сделок внутри карточки с автоматической привязкой к аккаунту.
10. Модуль должен позволять просмотр связанных карточек активности, сделки.
11. Модуль должен позволять поиск аккаунтов по списку. Поиск должен производиться по всему содержимому карточки аккаунта, а результаты поиска должны фильтровать список аккаунтов.
12. Модуль должен позволять фильтрацию списка аккаунтов по заданным условиям. В условия фильтров должны попадать все текстовые и числовые поля, компоненты выбора пользователей, даты и справочники из карточки аккаунта.
13. Модуль должен позволять формирование произвольной выборки из списка аккаунтов.
14. Модуль должен позволять назначение выборки из списка аккаунтов на произвольного пользователя Системы.
15. Модуль должен позволять удаление выборки из списка аккаунтов в соответствии с правами доступа.
Требования к модулю «Сделки»
--------------------------------
1. Модуль должен предоставлять витрину продаж (в виде канбан-таблицы) в разрезе стадий сделок в соответствии с правами доступа. Руководителю доступны сделки всех подчиненных, подчиненному - только собственные сделки.
2. Модуль должен отображать сделки в виде списка в соответствии с правами доступа.
3. Модуль должен отображать сделку на витрине продаж в виде плашки с детализацией следующих сведений: название, бюджет и менеджер сделки, контакт и аккаунт.
4. Модуль должен позволять по нажатию на заголовок плашки либо строку списка просмотр полной карточки сделки.
5. Модуль должен позволять создание и редактирование карточки сделки.
6. Модуль должен позволять в описании сделки указывать: название, тему сотрудничества и бюджет сделки, связанные карточки контакта и аккаунта, файлы документов, а также дополнительную информацию.
7. Модуль должен предоставлять возможность указания текущей стадии сделки в соответствии с предварительно настроенными значениями справочника.
8. Модуль должен предоставлять возможность автоматической смены стадии сделки при её перемещении между столбцами витрины продаж.
9. Модуль должен предоставлять возможность успешного завершения сделки - конвертацию сделки в договор с сопоставлением общих полей карточек.
10. Модуль должен предоставлять возможность неуспешного завершения сделки - перевод в соответствующую стадию с обязательным указанием причины отказа.
11. Модуль должен отображать все активности внутри карточки, связанные со сделкой.
12. Модуль должен позволять добавление активностей внутри карточки с автоматической привязкой к сделке и связанным контакту, аккаунту.
13. Модуль должен автоматически фиксировать активности о создании сделки, смены её стадии, а также завершения сделки.
14. Модуль должен позволять просмотр связанных карточек контакта, аккаунта, активности, договора.
15. Модуль должен позволять поиск сделок. Поиск должен производиться по всему содержимому карточки сделки, а результаты поиска должны фильтровать витрину и список сделок.
16. Модуль должен позволять фильтрацию витрины и списка сделок по заданным условиям. В условия фильтров должны попадать все текстовые и числовые поля, компоненты выбора пользователей, даты и справочники из карточки сделки.
17. Модуль должен позволять формирование произвольной выборки из витрины продаж и списка сделок.
18. Модуль должен позволять назначение выборки из витрины и списка сделок на произвольного пользователя Системы.
19. Модуль должен позволять удаление выборки из витрины и списка сделок в соответствии с правами доступа.
20. Модуль должен позволять добавление задач и напоминаний с автоматической привязкой к сделке и связанным контакту, аккаунту.
21. Модуль должен предоставлять визуализацию воронки продаж в разрезе стадий сделок в соответствии с правами доступа.
22. Модуль должен предоставлять информацию о количестве сделок в воронке.
23. Модуль должен предоставлять информацию о суммарной стоимости продаж в воронке.
24. Модуль должен позволять формирование шаблона Коммерческого предложения.
Требования к модулю «Договоры»
----------------------------------
1. Модуль должен отображать договоры в виде списка в соответствии с правами доступа.
2. Модуль должен позволять по нажатию на строку списка просмотр полной карточки договора.
3. Модуль должен позволять создание и редактирование карточки договора.
4. Модуль должен позволять в описании договора указывать: предмет, тему сотрудничества, срок и сумму договора, связанные карточки контакта и аккаунта, файлы документов, а также дополнительную информацию.
5. Модуль должен предоставлять возможность указания текущей стадии договора в соответствии с предварительно настроенными значениями справочника.
6. Модуль должен позволять формировать Транзакции для отслеживания фактических денежных поступлений.
7. Модуль должен отображать все активности внутри карточки, связанные с договором.
8. Модуль должен позволять добавление активностей внутри карточки с автоматической привязкой к договору и связанным контакту, аккаунту.
9. Модуль должен автоматически фиксировать связь договора с карточкой сделки, если он был создан конвертацией из сделки.
10. Модуль должен позволять просмотр связанных карточек контакта, аккаунта, активности, сделки.
11. Модуль должен позволять поиск договоров по списку. Поиск должен производиться по всему содержимому карточки договора, а результаты поиска должны фильтровать список договоров.
12. Модуль должен позволять фильтрацию списка договоров по заданным условиям. В условия фильтров должны попадать все текстовые и числовые поля, компоненты выбора пользователей, даты и справочники из карточки договора.
13. Модуль должен позволять формирование произвольной выборки из списка договоров.
14. Модуль должен позволять формирование шаблона Договора.
Требования к модулю «Единое рабочее место»
---------------------------------------------
1. Модуль должен предоставлять возможность в едином рабочем месте выполнять базовые операции, включая:
* единообразный поиск по всем карточкам;
* просмотр подробной информации из карточек;
* фиксирование активностей;
* создание и редактирование карточек;
* ведение расписания задач.
2. Модуль должен предоставлять возможность поиска по всем карточкам Системы (контакт, аккаунт, сделка, договор).
3. Модуль должен группировать результаты поиска по карточкам.
4. Модуль должен отображать в результатах поиска основную информацию из карточки, не открывая её.
5. Модуль должен позволять по нажатию на результат поиска просмотр и редактирование полной карточки с соответствующими возможностями.
6. Модуль должен позволять создание карточек контакта, аккаунта, сделки.
7. Модуль должен отображать расписание задач пользователя в соответствии с правами доступа.
8. Модуль должен позволять добавление новых задач в расписание.
9. Модуль должен позволять в описании задачи указывать: даты и время начала, завершения задачи, тип действия, комментарий, файлы документов, связанные карточки контакта и аккаунта, сделки и договора.
10. Модуль должен напоминать пользователю о наступлении задачи.
11. Модуль должен отображать напоминание поверх любого модуля Системы.
12. Модуль должен предоставлять возможность завершения задачи.
13. Модуль должен автоматически фиксировать новую активность в момент завершения задачи.
.. csv-table::
:widths: 2, 30
Требования к модулю «План продаж»
---------------------------------------------
3.2.1, "Система должна предоставлять модуль «Маркетинг» в рамках процесса «Управление маркетингом»."
3.2.2, "Система должна предоставлять модуль «Продажи» в рамках процесса «Управление продажами»."
3.2.3, "Система должна предоставлять возможность создания напоминаний с указанием даты и времени напоминания, комментария, действия, а также ссылок на лид и/или сделку."
3.2.4, "Система должна отображать напоминание поверх любого активного модуля при наступлении указанного времени."
3.2.5, "Система должна предоставлять возможность закрыть либо отложить напоминание на 15 минут."
3.2.6, "Система должна предоставлять возможность ограниченного доступа к объектам модулей между подразделениями."
1. Модуль должен позволять создание плана продаж в разрезе суммы и количества продаж услуг или продуктов.
2. Модуль должен позволять в описании плана продаж указывать: период, подразделение, сотрудника и руководителя.
3. Модуль должен позволять автоматическое сопоставление целевых и установленных показателей.
4. Модуль должен отображать созданные планы в виде списка.
5. Модуль должен позволять по нажатию на строку списка просмотр карточки плана продаж.
6. Модуль должен позволять редактирование карточки плана продаж.
7. Модуль должен позволять удаление выборки из списка в соответствии с правами доступа.
8. Модуль должен позволять формирование аналитического отчета о структуре и объеме продаж: план/факт, ассортимент, подразделения, исполнители, время.
9. Модуль должен позволять выгрузку аналитического отчета в файл формата Excel (.xlsx).
Требования к модулю «Маркетинг»
--------------------------------------------
.. csv-table::
:widths: 2, 30
3.3.1, "Модуль должен поддерживать исполнение функций следующих ролей в рамках процесса «Управление маркетингом»:
* специалист по маркетингу;
* менеджер по маркетингу."
3.3.2, "Модуль должен позволять пользователю с ролью Менеджер по маркетингу создание/редактирование/удаление каталога услуг."
3.3.3, "Модуль должен позволять пользователю с ролью Менеджер по маркетингу создание/редактирование/удаление тем сотрудничества."
3.3.4, "Модуль должен позволять пользователю с ролью Менеджер по маркетингу настройку процента лидогенерации."
3.3.5, "Модуль должен позволять создание/редактирование/удаление маркетинговых мероприятий в соответствии с правами доступа."
3.3.6, "Модуль должен позволять в описании маркетингового мероприятия указывать: наименование, тип и стоимость меропрития, ссылка на проект мероприятия."
3.3.7, "Модуль должен позволять задавать целевой отклик маркетингового мероприятия."
3.3.8, "Модуль должен автоматически рассчитывать текущий отклик маркетингового мероприятия из количества лидов, связанных с этим мероприятием."
3.3.9, "Модуль должен автоматически рассчитывать эффективность маркетингового мероприятия из количества текущего и целевого откликов."
3.3.10, "Модуль должен позволять создание/редактирование/удаление аккаунтов в соответствии с правами доступа."
3.3.11, "Модуль должен позволять в описании аккаунта указывать: логотип, наименование, описание, статус, контактные данные и дополнительную информацию об аккаунте."
3.3.12, "Модуль должен позволять создание/редактирование/удаление контактов в соответствии с правами доступа."
3.3.13, "Модуль должен позволять в описании контакта указывать: фотографию, полное имя, должность, дату рождения, статус, контактные данные и дополнительную информацию о контакте."
3.3.14, "Модуль должен предоставлять интеграцию с системными приложениями связи из контактных данных аккаунта, контакта:
* Telegram - открытие веб-приложения: чат с выбранным контактом;
* Facebook Messenger - открытие веб-приложения: чат с выбранным контактом;
* Skype - открытие приложения с одной из функций «позвонить» и «написать»;
* E-mail - открытие почтового клиента с автоматическим заполнением поля «Кому» из выбранного почтового адреса;
* Телефон - открытие SIP-клиента с вызовом на выбранный номер."
3.3.15, "Модуль должен позволять создание/редактирование/удаление лидов в соответствии с правами доступа."
3.3.16, "Модуль должен позволять в описании лида указывать: тему сотрудничества, потенциальный бюджет, а также связанные аккаунт, контакт, маркетинговое мероприятие, сделку."
3.3.17, "Модуль должен позволять добавление/редактирование/удаление активностей внутри карточки лида."
3.3.18, "Модуль должен предоставлять возможность указания текущего статуса лида в соответствии с предварительно настроенными значениями справочника."
3.3.19, "Модуль должен предоставлять возможность конвертации лида в сделку с сопоставлением общих полей карточек."
3.3.20, "Модуль должен предоставлять возможность перехода по связанным объектам (аккаунт, контакт, маркетинговое мероприятие, сделка)."
3.3.21, "Модуль должен предоставлять визуализацию воронки лидогенерации в разрезе статусов лидов, количества лидов данного статуса и коэффициента конвертации в соответствии с правами доступа."
3.3.22, "Модуль должен предоставлять информацию о суммарной стоимости лидогенерации в воронке."
3.3.23, "Модуль должен предоставлять информацию о комиссии лидогенерации в воронке, рассчитанной на основе процента лидогенераци."
3.3.24, "Модуль должен предоставлять поток лидогенерации (в виде таблицы) в разрезе статусов лидов с детализацией сведений о лидах в соответствии с правами доступа."
3.3.25, "Модуль должен сортировать лиды в потоке в порядке убывания потенциального бюджета."
3.3.26, "Модуль должен предоставлять возможность автоматической смены статуса лида путем его перемещения между столбцами потока."
3.3.27, "Модуль должен позволять фильтрацию данных в воронке и потоке лидогенерации по следующим критериям:
* по наличию либо отсутствию привязки к маркетинговому мероприятию;
* по ответственному менеджеру лида;
* по периоду времени;
* по статусу."
3.3.28, "Модуль должен предоставлять маркетинговый отчет в виде аналитического дашборда в соответствии с правами доступа."
3.3.29, "Дашборд должен содержать следующие визуализации:
* количество аккаунтов;
* количество лидов;
* средний предполагаемый чек по лидам;
* список маркетинговых мероприятий с рассчитанными показателями текущего отклика и оценкой эффективности."
Требования к модулю «Продажи»
--------------------------------------------
.. csv-table::
:widths: 2, 30
3.4.1, "Система должна поддерживать исполнение функций следующих ролей в рамках процесса «Управление продажами»:
* специалист по продажам;
* менеджер по продажам."
3.4.2, "Модуль должен позволять пользователю с ролью Менеджер по маркетингу формирование плана продаж в разрезе года, месяца, подразделений либо пользователей, а также тем сотрудничества."
3.4.3, "Модуль должен позволять пользователю с ролью Менеджер по маркетингу настройку процента продаж."
3.4.4, "Модуль должен позволять пользователю с ролью Менеджер по маркетингу настройку нормативов продолжительности этапов продаж."
3.4.5, "Модуль должен позволять пользователю с ролью Менеджер по маркетингу назначение ответственного за сделки."
3.4.6, "Модуль должен позволять создание/редактирование/удаление сделок в соответствии с правами доступа."
3.4.7, "Модуль должен позволять в описании сделки указывать: тему сотрудничества, описание, таблицу заказа, бюджет, файлы документов, а также связанные аккаунт, контакт, лид."
3.4.8, "Модуль должен позволять добавление/редактирование/удаление активностей внутри карточки сделки."
3.4.9, "Модуль должен предоставлять возможность указания текущего статуса сделки в соответствии с предварительно настроенными значениями справочника."
3.4.10, "Модуль должен предоставлять возможность перехода по связанным объектам (аккаунт, контакт, лид)."
3.4.11, "Модуль должен предоставлять возможность формирования следующих шаблонов документов в соответствии с правами доступа:
* коммерческое предложение;
* договор поставки;
* акт приема-передачи;
* счет-фактура."
3.4.12, "Модуль должен позволять как ручное, так и автоматическое (из связанной сделки) заполнение шаблонов документов."
3.4.13, "Модуль должен предоставлять визуализацию воронки продаж в разрезе статусов сделок, количества сделок данного статуса и коэффициента конвертации в соответствии с правами доступа."
3.4.14, "Модуль должен предоставлять информацию о суммарной стоимости продаж в воронке."
3.4.15, "Модуль должен предоставлять информацию о комиссии продаж в воронке, рассчитанной на основе процента продаж."
3.4.16, "Модуль должен предоставлять поток продаж (в виде таблицы) в разрезе статусов сделок с детализацией сведений о сделках в соответствии с правами доступа."
3.4.17, "Модуль должен сортировать сделки в потоке в порядке убывания бюджета."
3.4.18, "Модуль должен предоставлять возможность автоматической смены статуса сделки путем его перемещения между столбцами потока."
3.4.19, "Модуль должен визуально выделять сделку, имеющую просроченность согласно норматива продолжительности данного этапа."
3.4.20, "Модуль должен позволять фильтрацию данных в воронке и потоке лидогенерации по следующим критериям:
* по ответственному менеджеру сделки;
* по периоду времени;
* по статусу;
* по стоимости."
3.4.21, "Модуль должен предоставлять следующие отчеты в виде аналитического дашборда в соответствии с правами доступа:
* «Аналитика»;
* «Продуктивность»."
3.4.22, "Дашборд «Аналитика» должен содержать следующие визуализации:
* количество сделок по статусам;
* количество просроченных сделок по статусам;
* количество сделок с отказом;
* среднее время прохождения сделками статусов;
* топ прайс-листа;
* список сделок."
3.4.23, "Дашборд «Продуктивность» должен содержать следующие визуализации:
* план/факт продаж;
* процент исполнения плана продаж;
* исполнение плана по темам сотрудничества;
* исполнение плана по пользователям."
---------------------------------------------
1. Модуль должен позволять создание и редактирование маркетинговых мероприятий.
2. Модуль должен отображать созданные мероприятия в виде списка.
3. Модуль должен отображать созданные мероприятия в виде календаря.
4. Модуль должен позволять фильтрацию мероприятий в календаре по следующим критериям: период, мероприятие, подразделение и услуга.
5. Модуль должен позволять поиск мероприятий по списку.
6. Модуль должен позволять формирование произвольной выборки из списка мероприятий.
7. Модуль должен позволять назначение выборки из списка мероприятий на произвольного пользователя Системы.
8. Модуль должен позволять удаление выборки из списка мероприятий в соответствии с правами доступа.
9. Модуль должен отображать все лиды в виде списка.
10. Модуль должен позволять по нажатию на строку списка просмотр полной карточки лида.
11. Модуль должен позволять создание и редактирование карточки лида.
12. Модуль должен позволять поиск лидов по списку. Поиск должен производиться по всему содержимому карточки контакта, а результаты поиска должны фильтровать список контактов.
13. Модуль должен позволять фильтрацию списка лидов по заданным условиям. В условия фильтров должны попадать все текстовые и числовые поля, компоненты выбора пользователей, даты и справочники из карточки лида.
14. Модуль должен позволять формирование произвольной выборки из списка лидов.
15. Модуль должен позволять назначение выборки из списка лидов на произвольного пользователя Системы.
16. Модуль должен позволять удаление выборки из списка лидов в соответствии с правами доступа.
17. Модуль должен позволять создание маркетинговых списков, состоящих из аккаунтов.
18. Модуль должен позволять выгрузку маркетинговых списков в файл в формате Excel (.xlsx).
19. Модуль должен позволять формирование аналитического отчета о структуре лидов, об эффективности маркетинговых мероприятий и источников лидов.
20. Модуль должен позволять выгрузку аналитического отчета в файл формата Excel (.xlsx).
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment