Public release from ruodoo-project: 19.0 - 2026-07-26 21:17:35 UTC

mklab_base_indicators/README.md

@@ -0,0 +1,84 @@
+# Слои показателей - Базовый модуль
+name: mklab_base_indicators
+version: 19.0.2025.11.17
+author: MK.Lab
+
+
+### 1. Общее описание
+Слой показателей — это инструмент для отслеживания числовых метрик (KPI) по любым объектам Odoo: задачам, заказам, проектам и т.д. В основе слоя показателей лежит модель гиперграфа. Объекты системы становятся вершинами, между вершинами строятся связи, к вершинам привязываются показатели с плановыми и фактическими значениями во времени.
+
+### 2. Установка
+1. Скопируйте папку модуля mklab_base_indicators в директорию addons Odoo
+
+2. Перезапустите сервер Odoo
+
+3. Обновите список приложений: Настройки — Приложения — Обновить список
+
+4. Найдите модуль через интерфейс администрирования и установите
+   
+5. Настройте права доступа для пользователей
+
+## Как это выглядит в интерфейсе
+
+В главном меню появляется раздел **«Слои показателей»** с двумя подразделами:
+
+**Граф:**
+- **Вершины графа** — список всех узлов с привязкой к объектам системы
+- **Матрица связности** — список направленных связей между вершинами
+
+**Показатели:**
+- **Показатели** — список метрик с текущим значением, кодом, вершиной
+- **Значения показателей** — история план/факт по датам
+- **Внутренний код** — справочник классификаторов
+
+![img_4](img_4.png)
+
+### 3. Функциональность
+3.1 Основные компоненты:
+
+| Понятие | Модель | Описание |
+|---|---|---|
+| Вершина графа | `hg.node` | Узел — представитель любого объекта Odoo (задача, заказ, проект...) |
+| Показатель | `hg.index` | Именованная метрика, привязанная к вершине |
+| Значение показателя | `hg.value` | Конкретное значение: план, факт, дата |
+| Матрица связности | `hg.link` | Направленная связь: одна вершина → множество вершин |
+| Внутренний код | `hg.index.code` | Классификатор для группировки показателей |
+
+3.2 Основные возможности:
+- Автоматическое создание и управление вершинами графа
+- Определение показателей и их характеристик
+- Управление связями между элементами
+- Вычисление текущих значений показателей
+- Работа с временными рядами данных
+
+
+### Пример использования
+
+Перейдите в меню Слои показателей
+
+![img.png](img.png)
+
+### Создать вершины
+
+Перейдите в **Слои показателей → Граф → Вершины графа** и создайте вершины для нужных объектов. Укажите название, модель (`project.task`, `sale.order` и т.д.) и ID записи.
+
+![img_1.png](img_1.png)
+
+### Настроить связи между сущностями
+Перейдите в **Матрица связности** и создайте связи между вершинами: выберите источник и одну или несколько вершин-приёмников.
+
+![img_2.png](img_2.png)
+
+### Добавить показатели
+В **Показатели** создайте метрику: укажите название, внутренний код, привяжите к вершине.
+
+![img_3.png](img_3.png)
+
+### Внести значения
+В форме показателя на вкладке **Значения** добавляйте строки: дата, план, факт, тип (`Простой` или `Формула`).
+
+**Текущее значение** обновляется автоматически — берётся последнее фактическое значение с датой не позднее сегодняшней.
+
+![img_5.png](img_5.png)
+
+![img_6.png](img_6.png)