Metodologist manual: + "productivity" dashboard

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

@@ -60,13 +60,15 @@ API.
 
 - `r-crm-registry_lead` - индекс данных реестра ["Лиды"](#registryLead);
 
-- `r-crm_registry_deals_plans` - индекс данных реестра ["План продаж"](#registrySalesCost);
+- `r-crm_registry_deals_plans_custom` - служебный индекс данных реестра ["План продаж"](#registrySalesCost);
 
-- `r-crm_registry_deals*` - индекс данных реестров ["План продаж"](#registrySalesCost)
-и ["Сделки"](#registryDeal).
+- `r-crm_registry_deals*` - шаблон, объединяющий данные реестра ["Сделки"](#registryDeal) 
+и служебный индекс `r-crm_registry_deals_plans_custom`.
 
 Индекс `deals-status-history` создается и рассчитывается автоматически при 
-запусе Synergy, остальные индексы включены в типовую конфигурацию.
+запусе Synergy. Индекс `r-crm_registry_deals_plans_custom` создается при 
+создании записей в реестре ["План продаж"](#registrySalesCost). Остальные 
+индексы включены в типовую конфигурацию.
 
 ### Управление маркетингом {#dashboards_marketing}
 
@@ -612,4 +614,306 @@ API.
 
 >> функция итогового результата: `sum`
 
+### Продуктивность {#dashboards_productivity}
+
+**Общие настройки дашборда:** 
+
+- период обновления: 30 секунд
+
+- источник данных для публикации: `Embedded iframe`
+
+- опубликован в пользовательском компоненте `crm_component_deals_productivity`, 
+где в параметрах размера фрейма указано `100%` для высоты и ширины.
+
+Дашборд "Продуктивность" в модуле "Управление продажами" состоит из диаграмм: 
+
+1. **Отделения**
+
+Отображает список подразделений организации. Диаграмма не содержит подразделений, 
+для которых не было указано ни одного планового показателя стоимости в реестре 
+[План продаж](#registrySalesCost).
+
+> - тип диаграммы: `Data table`
+
+> - шаблон индекса: `r-crm_registry_deals_plans_custom` 
+
+> - условие на отображаемые данные: `deleted:0`
+
+> Параметры агрегации: 
+
+>> Числовые (`metrics`):
+
+>> *Количество:*
+
+>> - тип агрегации: `Average`
+
+>> - поле агрегации: `plan_key_double`
+
+>> - отображаемое название параметра: "Средняя плановая стоимость продаж"
+
+>> Групповые агрегации (поля таблицы, `buckets`):
+
+>>> *Отделение:* 
+
+>>> - тип разделения: `Split Rows`
+
+>>> - тип агрегации: `Terms`
+
+>>> - поле агрегации: `crm_form_deal_sales_pk1_value_sort`
+
+>>> - способ сортировки: `Term`
+
+>>> - направление сортировки: `Descending`
+
+>>> - количество отображаемых результатов: 30
+
+>>> - отображаемое название параметра: "Отделение"
+
+> Опции диаграммы:
+
+>> количество записей на страницу: 5
+
+2. **Месяцы**
+
+Отображает список месяцев согласно справочнику [Месяцы](#dictionaryMonths). 
+Диаграмма не содержит месяцев, в которые ни одна сделка не перешла в 
+положительный конечный статус (`crm_dict_dealStatus_end=1`), согласно 
+записям реестра [Сделки](#registryDeal).
+
+> - тип диаграммы: `Data table`
+
+> - шаблон индекса: `r-crm_registry_deals_plans_custom` 
+
+> - условие на отображаемые данные: `deleted:0`
+
+> Параметры агрегации: 
+
+>> Числовые (`metrics`):
+
+>> *Количество:*
+
+>> - тип агрегации: `Average`
+
+>> - поле агрегации: `plan_key_double`
+
+>> - отображаемое название параметра: "Средняя плановая стоимость продаж"
+
+>> Групповые агрегации (поля таблицы, `buckets`):
+
+>>> *Отделение:* 
+
+>>> - тип разделения: `Split Rows`
+
+>>> - тип агрегации: `Terms`
+
+>>> - поле агрегации: `crm_form_deal_sales_pk1_value_sort`
+
+>>> - способ сортировки: `Term`
+
+>>> - направление сортировки: `Descending`
+
+>>> - количество отображаемых результатов: 12
+
+>>> - отображаемое название параметра: "Месяц"
+
+> Опции диаграммы:
+
+>> количество записей на страницу: 6
+
+3. **Исполнение плана**
+
+Отображает три числа:
+
+- суммарное значение вмех плановых показателей по стоимости продаж;
+
+- суммарное значение бюджета всех закрытых сделок;
+
+- процент исполнения плана продаж, рассчитываемый таким образом: 
+
+> %факт_продаж% / %план_продаж% * 100%
+
+>>> **Примечание 1:**
+
+>>> В диаграмме для подсчета факта продаж учитываются только сделки, 
+перешедшие в положительный конечный статус (`crm_dict_dealStatus_end=1`), 
+согласно записям реестра [Сделки](#registryDeal).
+
+>>> **Примечание 2:**
+
+>>> Для построения диаграммы используется специфический тип визуализации - 
+`Extended metric`. Он не включается в основной инструментарий Kibana, но 
+устанавливается автоматически при установке пакета kibana из репозитория 
+Synergy. 
+
+> - тип диаграммы: `Extended metric`
+
+> - шаблон индекса: `r-crm_registry_deals*` 
+
+> - условие на отображаемые данные: `deleted:0 && crm_form_deal_end_key_double:1`
+
+> Параметры агрегации: 
+
+>> *Суммарное значение плана продаж:*
+
+>> - тип агрегации: `Sum`
+
+>> - поле агрегации: `plan_key_double`
+
+>> - используемое название параметра: `sum_cost`
+
+> *Суммарное значение фактических продаж:*
+
+>> - тип агрегации: `Sum`
+
+>> - поле агрегации: `crm_form_deal_main3_budget_key_double`
+
+>> - используемое название параметра: `sum_budget`
+
+> Вычисляемые параметры (вкладка `Options`):
+
+>>> **Примечание 3:**
+
+>>> Во всех полях `Formula` используется синтаксис языка JavaScript. 
+Помимо непосредственного вычисления процента исполнения плана продаж, 
+дополнительно используются функции: 
+
+>>> - `toLocaleString()` - формат отображения числа, при котором в 
+качестве разделителя тысяч используется пробел;
+
+>>> - `.toFixed(2)` - округление числа до второго знака после запятой 
+(до сотых).
+
+>> *План продаж:*
+
+>> - формула: `(metrics['sum_cost'].value).toLocaleString()`
+
+>> - отображаемое название параметра: "План продаж"
+
+>> *Факт продаж:*
+
+>> - формула: `(metrics['sum_budget'].value).toLocaleString()`
+
+>> - отображаемое название параметра: "Факт продаж"
+
+>> *Процент исполнения плана продаж:*
+
+>> - формула: `(((metrics['sum_budget'].value / metrics['sum_cost'].value)) *100).toFixed(2)`
+
+>> - отображаемое название параметра: "% исполнения плана продаж"
+
+4. **Исполнение плана по темам сотрудничества**
+
+Отображает суммарные значения плана продаж, сумму потенциального 
+бюджета по всем сделкам, перешедшим в положительный конечный статус 
+(`crm_dict_dealStatus_end=1`), в разрезе [тем сотрудничества]((#registryThemes)). 
+В диаграмму включаются только те темы сотрудничества, для которых 
+был указан хотя бы один плановый показатель в реестре 
+[План продаж](#registrySalesCost).
+
+> - тип диаграммы: `Data table`
+
+> - шаблон индекса: `r-crm_registry_deals*` 
+
+> - условие на отображаемые данные: `deleted:0 && crm_form_deal_end_key_double:1`
+
+> Параметры агрегации: 
+
+>> Числовые (`metrics`):
+
+>>> *План продаж*
+
+>>> - тип агрегации: `Sum`
+
+>>> - поле агрегации: `plan_key_double`
+
+>>> - отображаемое название параметра: "План продаж"
+
+>>> *Факт продаж*
+
+>>> - тип агрегации: `Sum`
+
+>>> - поле агрегации: `crm_form_deal_main3_budget_key_double`
+
+>>> - отображаемое название параметра: "Факт продаж"
+
+>> Групповые агрегации (поля таблицы, `buckets`):
+
+>>> *Тема сотрудничества:* 
+
+>>> - тип разделения: `Split Rows`
+
+>>> - тип агрегации: `Terms`
+
+>>> - поле агрегации: `crm_form_deal_main2_theme_value_sort`
+
+>>> - способ сортировки: `metric: План продаж`
+
+>>> - направление сортировки: `Descending`
+
+>>> - количество отображаемых результатов: 30
+
+>>> - отображаемое название параметра: "Тема сотрудничества"
+
+> Опции диаграммы:
+
+>> количество записей на страницу: 10
+
+>> отображать итоговый результат: `true`
+
+>> функция итогового результата: `sum`
+
+5. **Исполнение плана по темам (гистрограмма)**
+
+Отображает показатели плана и факта продаж в разрезе тем сотрудничества 
+в виде гистограммы (столбиковой диаграммы, Bar chart). Диаграмма представляет 
+собой визуализацию данных в таблице **Исполнение плана по темам сотрудничества**.
+
+> - тип диаграммы: `Vertical bar chart`
+
+> - шаблон индекса: `r-crm_registry_deals*` 
+
+> - условие на отображаемые данные: `deleted:0 && crm_form_deal_end_key_double:1`
+
+> Параметры агрегации: 
+
+>> Числовые (`metrics`, ось Y):
+
+>>> *План продаж*
+
+>>> - тип агрегации: `Sum`
+
+>>> - поле агрегации: `plan_key_double`
+
+>>> - отображаемое название параметра: "План продаж"
+
+>>> *Факт продаж*
+
+>>> - тип агрегации: `Sum`
+
+>>> - поле агрегации: `crm_form_deal_main3_budget_key_double`
+
+>>> - отображаемое название параметра: "Факт продаж"
+
+>> Групповые агрегации (`buckets`, ось X):
+
+>>> *Тема сотрудничества:* 
+
+>>> - тип разделения: `Split Rows`
+
+>>> - тип агрегации: `Terms`
+
+>>> - поле агрегации: `crm_form_deal_main2_theme_value_sort`
+
+>>> - способ сортировки: `metric: План продаж`
+
+>>> - направление сортировки: `Descending`
+
+>>> - количество отображаемых результатов: 30
+
+>>> - отображаемое название параметра: "Тема сотрудничества"
+
+> Опции диаграммы:
+
+>> раположение столбцов: сгруппированное
+