CRM install instruction

crm/additional/src/crm_install.md

@@ -22,24 +22,25 @@ Synergy CRM устанавливается отдельным пакетом. В
 
 2. Установка конфигурации CRM с демо-данными
 
-3. Установка конфигурации CRM без потери данных
+3. Установка конфигурации CRM  Install/Upgrade Configuration
 
+4. Установка конфигурации CRM Manual с загрузкой конфигурации  пользователем
 
-# Базовая установка конфигурации CRM {#basic_setting}
+> **Примечание:**
+>
+>Первые  2  варианта удаляют все текущие данные в системе.
 
-В терминале необходимо выполнить следующие команды:
 
-1. Войти под SuperAdmin-ом
 
-2. Установить систему CRM: 
+# Базовая установка конфигурации CRM {#basic_setting}
 
-`aptitude install arta-synergy-apps-crm`
+В терминале необходимо выполнить следующие команды:
 
-3. При выводе окна Mysql ввести пароль - root
+1. Необходимо установить пакет `arta-synergy-apps-crm`:
 
-![Настройки пакета](resources/img/package_configuration.png)
+ `# aptitude install arta-synergy-apps-crm `
 
-4. После этого выйдет окно терминала для выбора вида установки:
+2. После этого выйдет окно терминала для выбора вида установки:
 
 ![Виды установки CRM](resources/img/install_type.png)
 
@@ -50,128 +51,213 @@ Synergy CRM устанавливается отдельным пакетом. В
 
 -   **Demo CRM** - это тоже чистая установка, но также содержит демо-данные.
 
--   **Manual** - руководство не коснется ваших данных, добавляет реестры и очереди, 
-    оставляя старые данные,т.е. без потери данных.
+-  **Install/Upgrade Configuration** - установка, в которой автоматически загружает
+   конфигурация CRM через API, не удаляя при этом информацию.
+
+-   **Manual** - данная установка не удаляет данные, т.е. без потери информации,
+   конфигурация загружается пользователем.
+
+> **Примечание:**
+>
+> Варианты установки Clean CRM и Demo CRM  удалят все данные пользователя
 
 
 # Установка конфигурации CRM без данных {#crm_without_data}
 
-Выбрав 1 вариант Clean crm, необходимо ввести адрес сервера, на котором 
+Выбрав 1 вариант Clean crm, необходимо ввести URL до Synergy, на котором 
 производится работа. Например: http://192.168.1.172:8080/Synergy
 
 ![Настройки пакета CRM](resources/img/package_configuration2.png)
 
-Далее ввести пароль Mysql - root.
+Далее ввести пароль Mysql - `root`.
+
+## Настройка в подсистеме администрирования и Конфигураторе: {#configure}
+
+Для варианта 1 Clean crm необходимо загрузить базу с настроенными:
+
+-   Чистым хранилищем
+
+-   Пользователями:
+
+    - Системный Пользователь Admin (от имени которого будут 
+      выполняться сопоставления)
+
+    - Пользователь1- Жуматаев
+
+    - Пользователь2- Муканова
+
+-   Всем разрешен доступ в систему, сгенерированы логины/пароли, прочими 
+    свойствами не обладают.
+
+-   Орг.структурой:
+
+    - Организация (подразделение, руководитель отсутствует)
+
+    -     - Отдел маркетинга (подразделение, руководитель Пользователь1)
+
+    -     -     - Специалист по маркетингу (должность, на нее назначен Пользователь2)
+
+-   Дополнительно на "Отдел маркетинга" настроено отображение только следующих модулей:
+
+    - Ежедневник
+
+    - Хранилище -> Реестры
+
+    - Маркетинг
+
+-   Группами:
+
+    - Все маркетологи
+
+    - Маркетологи-менеджеры (Пользователь1)
+
+    - Маркетологи-специалисты (Пользователь2 и Системный Пользователь)
+
+-   Внешним модулем:
+
+    - название: "Маркетинг"
+
+    - адрес: `http://localhost/crm`
+
+-   Конфигурацией, описанной выше
+
+-   Внешним модулем-компонентом:
+
+    - Место размещения: onLoad
+
+    - Пользовательский компонент: "Напоминания"
+
+    - Тип вставки: ADD
+
+-   Прочими опциями (их значения отличаются от дефолтных):
+
+    - форма завершения "Комментарий": "Требовать подтверждения результата" - нет
+
+    - "Отображать полное ФИО пользователя" - да
+    - "Отображать ФИО и должность пользователя на момент подписи в листе подписей" - да
+
+    - "Отображать в ходе исполнения будущие этапы" - да
+
+    - "Требовать ввода комментария при согласовании/утверждении" - да
 
-Права на реестры настраиваются в Конфигураторе. Заходим в систему под 
-пользователем с правами на реестры. Например: Жуматаев - руководитель отдела 
+    - "Требовать ввода комментария при отказе в согласовании/утверждении" - да
+
+    - "Форма завершения по-умолчанию" - Комментарий
+
+    - "Переназначение работ" - везде переназначить работы на непосредственного
+       руководителя
+
+    - "Название системы" - ARTA Synergy CRM
+
+    - "Интеграция с почтой" - да (при необходимости, создать произвольные форму и реестр)
+
+
+Права на реестры настраиваются в Конфигураторе, чтобы они отображались. Заходим в систему 
+под пользователем с правами на реестры. Например: Жуматаев - руководитель отдела 
 маркетинга (логин - Жуматаев, пароль - Жуматаев). 
 
 > **Примечание:**
 >
->Необходимо настроить "Интеграцию с почтой" - (при необходимости, создать 
-произвольные форму и реестр).
+>Настроить "Интеграцию с почтой" - отправка уведомлений, шаблоны документов (коммерческое 
+предложение, акт приема-передачи, договора) заказчикам на почту  (при необходимости, создать 
+произвольные форму и реестр). Нужно прописать настройки сервера для отправки и заполнить 
+электронные адреса пользователей.
 
-После обновления системы необходимо зайти в пользовательскую часть и 
-проверить установку. При переходе в модуль “Хранилище” должны отображаться 
-реестры, указанные в следующем рисунке:
+После установки системы необходимо зайти в Основное приложение Synergy и проверить модули. 
+При переходе в модуль “Хранилище” должны отображаться реестры, например как на следующем рисунке:
 
-![Реестры](resources/img/registries.png)
+![Хранилище](resources/img/registries.png)
 
 На рисунке показано как должна выглядеть система, если кликнуть на верхней 
 панели модуля Маркетинг, т.к данных нет, во всех данных нулевые значения. 
-Если отображается серое окно, значит при установке были допущены ошибки.
 
 ![Маркетинг](resources/img/marketing.png)
 
+Если отображается серое окно, значит при установке были допущены ошибки.Подробнее все ошибки 
+рассмотрены в разделе - [`Устранение неполадок`](#Troubleshooting)
+
 
 # Установка конфигурации CRM с демо-данными {#crm_with_demo}
 
 Для варианта 2 (**Demo CRM**), в дополнение к варианту 1, необходимо загрузить 
-схемы и хранилище, которое будет содержать демо-данные. В частности, записи 
-в каждом реестре и соответствующая им воронка и канбан. Данная установка 
-отличается тем, что будут загружены данные, а в чистой установке конфигурации 
-CRM - нулевые значения в модулях.
+схемы и хранилище, которое будет содержать демо-данные, т.е. записи в каждом реестре и 
+соответствующая им воронка и канбан. 
 
 
-# Установка конфигурации CRM без потери данных - Manual {#crm_manual}
+# Установка конфигурации CRM - Install/Upgrade Configuration {#Install_Upgrade}
 
-Чтобы установить CRM систему на сервер без потери данных необходимо выполнить 
-следующие шаги:
+Данный вариант установки Install/Upgrade Configuration отличается от других видов тем, 
+что автоматически загружается конфигурация через API, не удаляя при этом информацию 
+пользователя. 
 
-1. Скопировать `crm.war` в папку `opt/synergy/jboss/standalone/deployments`
+> В терминале выполняются следующие команды:
 
-2. Импортировать конфигурацию в Конфигуратор (Хранилище/Департамент развития 
-технологии/02 - Отделы/06 - Центр технической компетенции/01 - Обучающие 
-материалы/Инструкции/CRM)
+1. Перед установкой проверьте подключенные репозитории, ознакомиться по следующей 
+[`ссылке`](#http://tdd.lan.arta.kz/docs/synergy/trunk/admin-manual/html/install-and-setup.html#install-and-setup.internet.repos)
 
-3. Добавить внешний модуль в Конфигураторе  с адресом `http://host:port/crm`, 
-в нашем случае - `http://192.168.1.124:8080/crm`
 
-![Внешний модуль](resources/img/external_module.png)
+2. Необходимо установить пакет CRM arta-synergy-apps-crm на виртуальный сервер.
+Для этого выполним команду:
 
-Для того, чтобы работали сопоставления нужно:
+   '# aptitude install arta-synergy-apps-crm'
 
-1. Остановить работу системы с помощью команды в терминале:
+3. Выбрать 3 вид установки
 
-   ` /etc/init.d/arta-synergy-jboss stop`
+![Виды установки CRM](resources/img/install_type.png)
 
-2. В файл `/opt/synergy/jboss/standalone/configuration/arta/api-observation-configuration.xml` 
-прописать очередь:
+4. Далее необходимо ввести URL до Synergy, на котором производится работа.
+Например: http://192.168.1.172:8080/Synergy
 
-```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>
-```
+5. Ввести логин и пароль пользователя с доступом на Конфигуратор
 
-3. Создать файл в `/opt/synergy/jboss/standalone/configuration/arta/apps/crm/crm.properties`
-cо следующим содержимым:
 
-```xml
-	synergy.address=http://localhost:8080/Synergy
-	user.login=логин
-	user.password=пароль
-```
+# Установка конфигурации CRM с загрузкой пользователем - Manual {#crm_manual}
+
+Чтобы установить CRM систему на сервер без потери данных необходимо выполнить 
+следующие шаги:
 
-4. В файл `/opt/synergy/jboss/standalone/configuration/standalone-onesynergy.xml`
-добавить очередь:
+1. Загрузить конфигурацию в Конфигуратор (Хранилище/Департамент развития 
+технологии/02 - Отделы/06 - Центр технической компетенции/01 - Обучающие 
+материалы/Инструкции/CRM)
 
-```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>
-```
+2. Добавить внешний модуль в Конфигураторе  с адресом `http://host:port/crm`, 
+в нашем случае - `http://192.168.1.124:8080/crm`
 
-5. Задеплоить crm.war (подробнее 
-http://tdd.lan.arta.kz/docs/synergy/trunk/sdk-doc/html/integration.deploy.html).
+![Внешний модуль](resources/img/external_module.png)
 
-   Задеплоить, т.е. скопировать в директорию ${jboss.home}/standalone/deployments. 
-   Если приложение состоит из нескольких файлов, необходимо создать *.ear приложение.
 
-   Затем необходимо предоставить права с помощью команды в терминале:
+> **Примечание:**
+>
+>Добавить и настроить права пользователям на реестры CRM  в Конфигураторе для их отображения 
+в пользовательской части системы для модуля Хранилище.   Все настройки по правам пользователя 
+указаны в пункте - Настройка в подсистеме администрирования и Конфигураторе.
+Сопоставление полей реестров можно посмотреть [`ссылка:`](#http://tdd.lan.arta.kz/docs/additional/statements/3/html/crm3.html) 
 
-   `chown -R jboss:synergy opt/synergy/jboss/standalone/deployments`
 
-6. Перезапустить jboss:
+# Устранение неполадок {#Troubleshooting}
 
-   `/etc/init.d/arta-synergy-jboss start`
+1. **Проблема:** в модуле "Маркетинг" ничего не отображается
 
-> **Примечание:**
->
->Обязательно нужно добавить права пользователям на реестры для их отображения 
->в пользовательской части системы для модуля Хранилище.
+**Возможная причина:** при установке неправильно указан URL для Synergy
+
+**Пути устранения:** dpkg-reconfigure arta-synergy-apps-crm или исправить настройки в 
+Конфигураторе
+
+2. **Проблема:** нет реестров у пользователя
+
+**Возможная причина:** не настроены права для реестров в Конфигураторе 
+
+**Пути устранения:** необходимо настроить права пользователю на все реестры CRM,
+который будет указан в настройках файла crm.properties, так как от имени данного 
+пользователя происходят сохранение данных в реестрах при сопоставлении и если прав нет, 
+сохранение данных форм реестров не  произойдет. Необходимо проверить  настройки файла,
+находящегося - `/opt/synergy/jboss/standalone/configuration/arta/apps/crm/crm.properties`. 
+Файл должен содержать следующие данные:
+
+```xml
+synergy.address=http://localhost:8080/Synergy
+	user.login=логин
+	user.password=пароль
+```
 
 

crm/additional/src/index.md

 ---
 author:
 - Гульнур Ережеева
+- Гульмира Тургунова
 title: Инструкция по установке CRM
 ...