CRM metodologist manual

.gitattributes

@@ -11,6 +11,7 @@ crm/methodologist-manual/resources/img/eventChooser.png -text
 crm/methodologist-manual/resources/img/funnel_1.png -text
 crm/methodologist-manual/resources/img/funnel_2.png -text
 crm/methodologist-manual/resources/img/funnel_3.png -text
+crm/methodologist-manual/resources/img/notifications.png -text
 crm/methodologist-manual/src/crm_about.md -text
 crm/methodologist-manual/src/crm_consist/buildin_objects.md -text
 crm/methodologist-manual/src/crm_consist/dictionaries.md -text
@@ -23,6 +24,9 @@ crm/methodologist-manual/src/crm_consist/marketing_pipeline.md -text
 crm/methodologist-manual/src/crm_consist/marketing_sidePannel.md -text
 crm/methodologist-manual/src/crm_consist/registries.md -text
 crm/methodologist-manual/src/crm_consist/user_components.md -text
+crm/methodologist-manual/src/crm_consist/user_components_button.md -text
+crm/methodologist-manual/src/crm_consist/user_components_registryChooser.md -text svneol=unset#text/plain
+crm/methodologist-manual/src/crm_consist/user_components_reminder.md -text
 crm/methodologist-manual/src/crm_install.md -text
 crm/methodologist-manual/src/index.md -text
 crm/spec/Makefile -text

crm/methodologist-manual/src/crm_consist/dictionaries.md

@@ -9,6 +9,7 @@
 *   [Адрес](#dictionaryAddress)
 *   [Почта](#dictionaryEmail)
 *   [Социальные сети](#dictionarySocialNetworks)
+*   [Действия](#dictionaryRemindActions)
 
 #### Статусы лида {#dictionaryLeadStatus}
 
@@ -68,27 +69,27 @@
 Если некоторые параметры не были указаны, то им присваиваются значения
 по умолчанию:
 
-*   не указан crm_dict_leadStatus_quality:
-    *   crm_dict_leadStatus_quality=1
-    *   crm_dict_leadStatus_end=0
+*   не указан `crm_dict_leadStatus_quality`:
+    *   `crm_dict_leadStatus_quality=1`
+    *   `crm_dict_leadStatus_end=0`
 
-*   не указан crm_dict_leadStatus_end:
+*   не указан `crm_dict_leadStatus_end`:
     *   crm_dict_leadStatus_end=0
 
-*   не указаны crm_dict_leadStatus_quality и crm_dict_leadStatus_end:
-    *   crm_dict_leadStatus_quality=1
-    *   crm_dict_leadStatus_end=0
+*   не указаны `crm_dict_leadStatus_quality` и `crm_dict_leadStatus_end`:
+    *   `crm_dict_leadStatus_quality=1`
+    *   `crm_dict_leadStatus_end=0`
 
-*   не указан crm_dict_leadStatus_color:
-    *   crm_dict_leadStatus_color=#f3c02d
+*   не указан `crm_dict_leadStatus_color`:
+    *   `crm_dict_leadStatus_color=#f3c02d`
 
-Запись с данными crm_dict_leadStatus_quality=1, crm_dict_leadStatus_end=1
+Запись с данными `crm_dict_leadStatus_quality=1`, `crm_dict_leadStatus_end=1`
 должна быть одна. Если таких записей несколько, то данные значения
-применяются только для первой. Остальным записям из списка присваивается
-значение crm_dict_leadStatus_end=0.
+применяются только для первой созданной записи. Остальным записям из списка
+присваивается значение `crm_dict_leadStatus_end=0`.
 
-Список статусов лида, для которых crm_dict_leadStatus_value=0 либо не
-указан вовсе, сортируются по параметру crm_dict_leadStatus_name в локали С
+Список статусов лида, для которых `crm_dict_leadStatus_value=0` либо не
+указан вовсе, сортируются по параметру `crm_dict_leadStatus_name` в локали С
 в алфавитном порядке.
 
 #### Статусы сделки {#dictionaryDealStatus}
@@ -341,4 +342,10 @@
 | Другой                         | 7                              |
 +--------------------------------+--------------------------------+
 
+#### Действия {#dictionaryRemindActions}
+
+Код справочника: crm_dict_remindActions
+
+Поля справочника:
+
 

crm/methodologist-manual/src/crm_consist/marketing_cost_comission.md

@@ -11,13 +11,13 @@
     реестра [% комиссии](#registryComission).
 
 1.  Значение поля "% комиссии" для каждого отдельного лида идет в расчет
-    при совпадении:
+    согласно значению `crm_dict_leadStatus_end` записи справочника
+    [`crm_dict_leadStatus`](#dictionaryLeadStatus):
 
-    *   указанного периода действия данного процента в записи реестра
-        [% комиссии](#registryComission);
+	*   `crm_dict_leadStatus_end=1` - % комиссии на момент сохранения 
+этого статуса;
 
-    *   даты смены значения в поле "Статус" соответствующей записи реестра
-        [Лид](#registryLead).
+	*   остальные - % комиссии на конец [рассматриваемого периода](#marketing.filters).
 
 1.  Если в записи реестра [% комиссии](#registryComission) указано
     несколько записей с одинаковыми датами начала, то в расчет идет

crm/methodologist-manual/src/crm_consist/user_components.md

 ### Пользовательские компоненты {#user_components}
 
-#### Модифицированный компонент выбора записи реестра {#user_components.registryChooser}
+Конфигурация Synergy CRM содержит предустановленные пользовательские 
+компоненты:
 
-Пользовательский компонент на основе компонента "Ссылка на реестр". Компонент 
-имеет возможность сопоставления (в качестве источника и приемника). Список 
-доступных действий:
+-	[Модифицированный компонент выбора записи реестра](#user_components.registryChooser)
 
-- "Выбрать из реестра"
+-	[Кнопка создания новой записи реестра "Сделка"](#user_components.button)
 
-- "Создать"
+-	[Напоминания](#user_components.reminder)
 
-- "Удалить"
+<#include "crm_consist/user_components_registryChooser.md">
+<#include "crm_consist/user_components_button.md">
+<#include "crm_consist/user_components_reminder.md">
 
-![Модифицированный компонент выбора записи реестра]()
-
-**Проигрыватель формы в режиме редактирования**
-
-*Выбор существующей записи реестра:*
-
-Выбор записи осуществляется по нажатию на лейбл *"Выбрать из реестра"* 
-(доступен всегда). По нажатию на лейбл откроется диалоговое окно, которое 
-содержит таблицу со всеми записями данного реестра. Столбцы таблицы 
-представляют собой отображаемые поля реестра.
-
-![Диалог выбора существующей записи реестра]()
-
-Доступна возможность ручного ввода и подбора результатов среди имеющихся 
-записей реестра. При этом поиск производится по всем отображаемым полям реестра.
-
-Значения в выпадающем списке составлены из полей диалога (т.е. отображаемых 
-полей реестра), разделенных тире.
-
-*Создание новой записи реестра из текущей формы:*
-
-Создание новой записи доступно по нажатию на лейбл *"+ Создать"* (доступен всегда). 
-По нажатию на лейбл открывается диалоговое окно проигрывателя формы в режиме 
-редактирования.
-
-![Диалог создания новой записи реестра]()
-
-*Удаление текущего выбранного значения компонента:*
-
-Удаление текущего значения компонента доступно по нажатию на лейбл *"х Удалить"*, 
-который доступен только после выбора какого-либо значения.
-
-По нажатию на лейбл "х Удалить" компонент принимает вид пустого поля ввода.
-
-**Проигрыватель формы в режиме чтения**
-
-Выбранная запись реестра отображается в виде подчеркнутого лейбла, составленного 
-из значащего содержимого этого реестра. По нажатию на лейбл выбранной записи 
-откроется диалоговое окно проигрывателя формы, который отображает эту запись 
-из реестра в режиме просмотра.
-
-![Компонент выбора записи реестра в режиме чтения]()
-
-#### Кнопка создания новой записи реестра "Сделка" {#user_components.button}
-
-Пользовательский компонент в виде кнопки. Названием кнопки является значение 
-поля `crm_dict_leadStatus_buttonName` записи справочника 
-[`crm_dict_leadStatus`](#dictionaryLeadStatus) 
-со значением параметра `crm_dict_leadStatus_end`=1.
-
-Кнопка в проигрывателе формы активна как в режиме чтения, так и в режиме 
-редактирования.
-
-![Кнопка создания новой записи реестра "Сделка"]()
-
-По нажатию на кнопку:
-
-*   выпадающий список "Статус" принимает значение записи справочника 
-[`crm_dict_leadStatus`](#dictionaryLeadStatus) со значением параметра 
-`crm_dict_leadStatus_end`=1 и становится неактивным;
-
-*   документ пересохраняется с новым значением выпадающего списка "Статус";
-
-*   создается новая запись реестра [Сделка](#registryDeal), в которой 
-сопоставлены поля:
-
-	*   `crm_form_deal_main1_lead` заполняется ссылкой на данную 
-запись [Лида](#registryLead);
-
-	*   `crm_form_deal_main2_theme` заполняется значением из 
-`crm_form_lead_deals_theme`.
-
-*Выпадающий список "Статус"*:
-
-При выборе пункта со значением параметра `crm_dict_leadStatus_end`=1 в 
-справочнике [`crm_dict_leadStatus`](#dictionaryLeadStatus) выполняются 
-те же действия, что и по нажатию на кнопку.
 
 

crm/methodologist-manual/src/crm_consist/user_components_button.md

+#### Кнопка создания новой записи реестра "Сделка" {#user_components.button}
+
+Пользовательский компонент в виде кнопки. Названием кнопки является значение 
+поля `crm_dict_leadStatus_buttonName` записи справочника 
+[`crm_dict_leadStatus`](#dictionaryLeadStatus) 
+со значением параметра `crm_dict_leadStatus_end`=1.
+
+Кнопка в проигрывателе формы активна как в режиме чтения, так и в режиме 
+редактирования.
+
+![Кнопка создания новой записи реестра "Сделка"]()
+
+По нажатию на кнопку:
+
+*   выпадающий список "Статус" принимает значение записи справочника 
+[`crm_dict_leadStatus`](#dictionaryLeadStatus) со значением параметра 
+`crm_dict_leadStatus_end`=1 и становится неактивным;
+
+*   документ пересохраняется с новым значением выпадающего списка "Статус";
+
+*   создается новая запись реестра [Сделка](#registryDeal), в которой 
+сопоставлены поля:
+
+	*   `crm_form_deal_main1_lead` заполняется ссылкой на данную 
+запись [Лида](#registryLead);
+
+	*   `crm_form_deal_main2_theme` заполняется значением из 
+`crm_form_lead_deals_theme`.
+
+*Выпадающий список "Статус"*:
+
+При выборе пункта со значением параметра `crm_dict_leadStatus_end`=1 в 
+справочнике [`crm_dict_leadStatus`](#dictionaryLeadStatus) выполняются 
+те же действия, что и по нажатию на кнопку.
+
+

crm/methodologist-manual/src/crm_consist/user_components_registryChooser.md

+#### Модифицированный компонент выбора записи реестра {#user_components.registryChooser}
+
+Пользовательский компонент на основе компонента "Ссылка на реестр". Компонент 
+имеет возможность сопоставления (в качестве источника и приемника). Список 
+доступных действий:
+
+- "Выбрать из реестра"
+
+- "Создать"
+
+- "Удалить"
+
+![Модифицированный компонент выбора записи реестра]()
+
+**Проигрыватель формы в режиме редактирования**
+
+*Выбор существующей записи реестра:*
+
+Выбор записи осуществляется по нажатию на лейбл *"Выбрать из реестра"* 
+(доступен всегда). По нажатию на лейбл откроется диалоговое окно, которое 
+содержит таблицу со всеми записями данного реестра. Столбцы таблицы 
+представляют собой отображаемые поля реестра.
+
+![Диалог выбора существующей записи реестра]()
+
+Доступна возможность ручного ввода и подбора результатов среди имеющихся 
+записей реестра. При этом поиск производится по всем отображаемым полям реестра.
+
+Значения в выпадающем списке составлены из полей диалога (т.е. отображаемых 
+полей реестра), разделенных тире.
+
+*Создание новой записи реестра из текущей формы:*
+
+Создание новой записи доступно по нажатию на лейбл *"+ Создать"* (доступен всегда). 
+По нажатию на лейбл открывается диалоговое окно проигрывателя формы в режиме 
+редактирования.
+
+![Диалог создания новой записи реестра]()
+
+*Удаление текущего выбранного значения компонента:*
+
+Удаление текущего значения компонента доступно по нажатию на лейбл *"х Удалить"*, 
+который доступен только после выбора какого-либо значения.
+
+По нажатию на лейбл "х Удалить" компонент принимает вид пустого поля ввода.
+
+**Проигрыватель формы в режиме чтения**
+
+Выбранная запись реестра отображается в виде подчеркнутого лейбла, составленного 
+из значащего содержимого этого реестра. По нажатию на лейбл выбранной записи 
+откроется диалоговое окно проигрывателя формы, который отображает эту запись 
+из реестра в режиме просмотра.
+
+![Компонент выбора записи реестра в режиме чтения]()
+
+##### Сопоставление полей реестров {#user_components.matching}
+
+**Лиды**
+
+При сохранении изменений связанные поля заполнятся ссылкой на текущую запись в 
+следующих реестрах:
+
+*   [Аккаунт](#registryAccount) - `crm_form_account_lead_lead`
+
+*   [Контакт](#registryContact) - `crm_form_contact_lead_lead`
+
+*   [Активность](#registryLeadActivity) - `crm_form_leadActivity_main_lead`
+
+При выборе существующей записи реестра [Аккаунт](#registryAccount) в 
+динамической таблице (`crm_form_account_lead`) этой записи добавится 
+строка, которая будет содержать ссылку на текущую запись реестра 
+[Лид](#registryLead) в поле `crm_form_account_lead_lead`.
+
+При выборе существующей записи реестра [Контакт](#registryContact) в 
+динамической таблице (`crm_form_contact_lead`) этой записи добавится 
+строка, которая будет содержать ссылку на текущую запись реестра 
+[Лид](#registryLead) в поле `crm_form_contact_lead_lead`.
+
+**Сделки**
+
+При сохранении изменений связанные поля заполнятся ссылкой на текущую 
+запись в реестре [Активность сделки](#registryDealActivity) - 
+`crm_form_dealActivity_main_deal`.
+
+**Аккаунты**
+
+При сохранении изменений связанные поля заполнятся ссылкой на текущую 
+запись в следующих реестрах:
+
+*   [Лид](#registryLead) - `crm_form_lead_main_account`
+
+*   [Аккаунт](#registryAccount), который указан в поле "Материнский 
+аккаунт" текущей записи - `crm_form_account_childAccount_account`
+
+*   [Аккаунт](#registryAccount), который указан в поле "Дочерний аккаунт" 
+текущей записи - `crm_form_account_parentAccount_parentAccount`
+
+**Контакты**
+
+При сохранении изменений связанные поля заполнятся ссылкой на текущую 
+запись в реестре [Лид](#registryLead) - `crm_form_lead_main_contact`.
+
+**Активности лидов**
+
+При сохранении изменений связанные поля заполнятся ссылкой на текущую 
+запись в реестре [Лид](#registryLead) - `crm_form_lead_activity_activity`.
+
+**Активности сделок**
+
+При сохранении изменений связанные поля заполнятся ссылкой на текущую 
+запись в реестре [Сделка](#registryDeal) - `crm_form_deal_activity_activity`.
+
+

crm/methodologist-manual/src/crm_consist/user_components_reminder.md

+#### Напоминания {#user_components.reminder}
+
+Всплывающие по таймеру записи реестра [Напоминания]({#registryReminders), 
+отображаемые поверх любого активного модуля ARTA Synergy. 
+
+*Отображение напоминания при наступлении указанного времени*:
+
+При наступлении указанных даты и времени в нижнем правом углу основного 
+приложения вне зависимости от активного модуля отобразится панель напоминания.
+
+Панель напоминания содержит:
+
+- ссылку на запись реестра указанного [Лида](#registryLead)
+
+- значение поля "Действие"
+
+- кнопки:
+
+    - "Отложить"
+
+    - "Закрыть"
+
+По нажатию на кнопку "Отложить" панель скроется и снова отобразится по 
+истечении 15 минут от текущего времени на сервере.
+По нажатию на кнопку "Закрыть" панель более не будет отображаться.
+
+Напоминание будет отображаться до тех пор, пока не будет нажата одна 
+из указанных кнопок.
+
+Каждое новое напоминание добавляется выше остальных. Одновременно 
+отображаются последние три напоминания. Если имеется более трех 
+напоминаний, добавляется панель счетчика очереди, которая всегда 
+отображается последней (ниже остальных).
+
+![Напоминания](resources/img/notifications.png) 
+
+Счетчик очереди содержит текст с количеством напоминаний, которые 
+не отображаются на странице.
+
+*Отображение напоминаний в модуле "Ежедневник"*:
+
+Все сохраненные напоминания отображаются в модуле "Ежедневник" в 
+виде заметок. Такие заметки содержат:
+
+- лейбл "Напоминание!"
+
+- дата - значение, указанное в поле "Дата и время" при создании 
+напоминания
+
+- время начала заметки - время на момент создания запоминания
+
+- время завершения заметки - время, указанное в поле "Дата и время" при создании напоминания
+
+- ссылка на указанную запись реестра [Лид](#registryLead)
+
+- значение поля "Комментарий", указанноое при создании напоминания.
+
+

crm/methodologist-manual/src/crm_install.md

 Установка конфигурации {#sec.crm_install}
 =============================================
 
-Кейс CRM устанавливается отдельным пакетом. Возможные варианты установки:
+Synergy CRM устанавливается отдельным пакетом. Возможные варианты установки:
 
-1.  Установка голой базы с преднастроенным CRM без данных  
-2.  Установка базы с CRM с демо-данными  
-3.  Установка поверх имеющейся базы  
+1.  Установка конфигурации CRM без данных  
+2.  Установка конфигурации CRM с демо-данными  
+3.  Установка поверх имеющейся конфигурации Synergy  
 
 Для *варианта 1* необходимо загрузить схемы с предварительно загруженной 
 конфигурацией и орг.структурой вида:
@@ -37,8 +37,5 @@
 -   включить отображение внешнего модуля "Маркетинг" в какой-либо ветке 
     орг.структуры
 
-> **Примечание**
->
-> Для тех объектов, импорт/экспорт которых еще отсутствует (группы и 
-> внешние модули), в варианте 3 нужно создавать самостоятельно.
+