Аналитическая платформа Modus BI

• 1: Начало работы
• 1.1: Быстрый старт
• 1.2: Назначение и порядок работы с Modus BI
• 2: Администрирование
• 2.1: Основные настройки
• 2.1.1: Настройки конфигурации Аналитического портала
• 2.1.2: База данных Аналитического портала
• 2.1.3: База данных Аналитического портала
• 2.1.4: Сетевые настройки Аналитического портала
• 2.1.5: Как настроить https
• 2.1.6: Технические сведения о используемых стандартах для HTTPS
• 2.1.7: Как настроить https с прокси-сервером
• 2.2: Установка и запуск
• 2.3: Обновление Modus BI
• 2.4: Лицензирование портала
• 2.5: Кэширование аналитического портала
• 2.6: Права доступа и роли аналитического портала
• 2.7: Провайдеры аутентификации
• 2.8: Профиль наборов данных
• 2.9: Настройка прав доступа на уровне записей (RLS)
• 2.10: Настройка RLS запросами с пользовательскими переменными
• 2.11: Настройка пользовательских переменных
• 2.12: Размещение через iframe портала Modus на стороннем ресурсе
• 2.13: Использование безопасного режима для отладки отчётов
• 3: Подготовка данных
• 3.1: Источники данных
• 3.2: Произвольные наборы данных
• 3.3: Загрузка данных из файлов Excel
• 3.4: Источник данных Data From Files
• 4: Создание и настройка отчетов
• 4.1: Использование переменных в дашборде
• 4.2: Панель индикации фильтров
• 4.3: Пользовательская палитра
• 4.4: Экспорт в файл презентации pptx
• 4.5: Управление разделами и панелями отчетов
• 4.6: Настройка отчетов при помощи конструктора
• 4.7: Инструкция по изменению стилей CSS
• 4.8: Замена наборов данных
• 4.9: Экспорт отчёта
• 4.10: Перенос отчетов и наборов данных между порталами
• 5: Настройки визуализаций
• 5.1: Общие настройки визуализаций
• 5.1.1: Кнопка отправки HTTP-запросов
• 5.1.2: Логирование действий пользователя
• 5.1.3: Настройка и использование общих фильтров и категорий
• 5.1.4: Настройка и использование производного фильтра
• 5.1.5: Настройка линии тренда и отсечки
• 5.1.6: Настройка перехода между отчетами
• 5.1.7: Настройка «Стилизация» или «Стиль элемента»
• 5.1.8: Настройка перехода между уровнями детализации данных/дрилла
• 5.1.9: Настройка представления внутри отчета
• 5.1.10: Настройка фильтров внутри компонента визуального отображения
• 5.1.11: Объединение нескольких элементов в общий визуальный блок
• 5.1.12: Отображение даты актуальности наборов данных на панели «Информация» дашборда
• 5.1.13: Дополнительно
• 5.1.14: Всплывающее окно
• 5.1.15: Сохранение текста запроса визуализации
• 5.1.16: Функционал по настройке внешнего вида диаграммы
• 5.1.17: Настройка всплывающей подсказки
• 5.2: Контейнер с переключениями
• 5.3: Пузырьковая диаграмма
• 5.4: Гистограмма (столбчатые и линейчатые диаграммы)
• 5.5: Настройка графика
• 5.6: Временные ряды
• 5.7: Настройка iFrame
• 5.8: «Граф/дерево»
• 5.9: «Солнечные лучи»
• 5.10: Диаграмма площади
• 5.11: Настройка табличного представления
• 5.12: Панель Закладок
• 5.13: Индикатор значений (стрелочный)
• 5.14: Геокарта
• 5.15: Картинка
• 5.16: Контейнер с фильтрами
• 5.17: Представление в виде параллельных координат
• 5.18: Круговая диаграмма
• 5.19: Панель показателей
• 5.20: Радарная диаграммы
• 5.21: Настройка сводной таблицы
• 5.22: Настройка таблицы сравнения
• 5.23: Настройка плиточной карты
• 6: Формы ввода данных
• 6.1: Форма ввода данных
• 6.2: Формирование таблицы для хранения данных и настройка свойств полей данных в форме ввода
• 6.3: Форма ввода данных. Использование существующей таблицы.
• 6.4: Настройка форм ввода данных в режиме конструктора
• 6.5: Форма ввода данных. Компонент iframe.
• 6.6: Варианты использования форм ввода данных
• 6.7: Открытие формы добавления новой записи
• 7: Отчетные формы
• 7.1: Предварительные действия перед настройкой ОФ
• 7.2: Создание профилей доступа
• 7.3: Настройка Отчетных Форм
• 7.4: Заполнение и загрузка Отчетной Формы
• 8: Новое в версии
• 9: Лицензии
• 10: Инструкции и лучшие практики
• 10.1: Настройка drill down в таблицах
• 10.2: Применение стилей CSS в дизайне дашбордов

1 - Начало работы

1.1 - Быстрый старт

В этой статье рассмотрим пример подготовки тестового дашборда «Общественное питание в Москве». Источником данных дашборда является набор данных, опубликованный на «Портале открытых данных Правительства Москвы». Скачать файл EXCEL можно, перейдя по ссылке.

Запуск аналитического портала

После установки и настройки портала:

1. перейдите по адресу портала;
2. введите логин и пароль.

Логин и пароль по умолчанию: Admin / Admin

Подключение источника данных

Существует два варианта получения данных для построения отчета:

• подключение напрямую к базе данных, где хранится таблица-источник (см. здесь.);
• получение данных из файла Excel.

В данном примере используется стандартный инструмент аналитического портала ля получения данных из файла Excel — «Загрузка из Excel».

1. Перейдите в режим «Администрирование». Находится в нижней левой части экрана, между кнопкой перехода на главную страницу и значком аккаунта.
2. Выберите раздел «Загрузка из Excel».
3. В пункт «Книги Excel» добавьте заранее подготовленный файл .xlsx с данными. Данные из файла отобразяться в виде плоской таблицы.
4. Выберите лист для загрузки в выпадающем списке «Лист»;
5. Выберите строку Заголовка (шапки) таблицы в Excel, щёлкнув по ячейке в первой (серой) колонке.
6. Введите «Имя» набора данных в строке «Таблица БД» — «mos_food».

К имени автоматически будет добавлен префикс «xls», в результате набор данных будет называться «xls_mos_food».

7. Нажмите на кнопку «Импортировать данные». По завершении — система выведет сообщение об успешной загрузке данных во внутреннюю БД и формировании Набора данных.

В результате успешной загрузки, автоматически добавляется набор данных, который доступен для выбора в Конструкторе дашбордов в Редакторе компонентов. В то же время, имеется возможность внести некоторые изменения в созданный набор.

Редактирование набора данных

По умолчанию при загрузке из Excel, набор данных создается автоматически и сохраняется в источнике «DataFromFiles», его сразу можно использовать для построения отчета. В данном примере необходимо добавить поле «adm», которое понадобиться при построении карты на дашборде:

1. перейдите в режим «Администрирование». Находится в нижней левой части экрана, между кнопкой перехода на главную страницу и значком аккаунта;

2. выберите раздел «Наборы данных»;

3. выберите «Источник данных» / «DataFromFiles»;

4. используя выпадающий список «Наборы данных», найдите ранее созданный «xls_mos_food»;

5. нажав значок «Глаз» рядом с надписью «SQL Запрос», появляется возможность отредактировать запрос к таблице в базе данных;

   5.1. Вставьте выражение replace("AdmArea",' административный округ','') as adm перед From;

6. далее необходимо «Проверить запрос», нажав соответствующую кнопку, в правой части экрана. В списке данных, который отображается ниже появиться дополнительная колонка «adm»;

7. если изменения внесены корректно и ошибок не обнаружено, появиться надпись: «SQL запрос успешно прошёл проверку»;

8. теперь можно сохранить и перейти к следующему шагу — созданию отчета.

Создание отчета

После подключения источника и редактирования набора данных, следующий шаг — создание отчета. Создание ответа состоит из двух основных шагов:

1. Добавление отчета в соответствующем разделе меню;
2. Настройка визуальной части дашборда.

Добавление отчета

1. Перейдите в режим «Администрирование». Находится в нижней левой части экрана, между кнопкой перехода на главную страницу и значком аккаунта.
2. Выберите раздел «Отчеты».

В интерфейсе управления отчетами можно добавить раздел отчетов и добавить новый отчет, а также управлять включением / исключением отчетов в раздел, порядком вывода отчетов в разделе и вносить изменения в настройки отчетов.

3. Нажмите кнопку «Добавить отчет», заполните в форме сведения о новом отчете:

• «Наименование» — «Общественное питание в Москве» (будет отображаться в меню отчетов);
• «Заголовок отчета» — «Общественное питание в Москве» (будет выведен в шапке отчета);
• «Группу отчета» — «Общественное питание в России» (раздел, в котором будет размещен отчет).

Прочие настройки являются необязательными, подробное описание (см. здесь).

4. Нажмите кнопку «Создать».

Настройка визуальной части дашборда

1. После создания отчета, кликните на название в списке, откроется окно конструктора.

Так как панель еще не настроена, она по умолчанию открывается в режиме конструктора. Заштрихованное поле представляет собой чистый лист («холст»), на котором можно размещать разные элементы. Изначально на панели размещен один пустой контейнер.

2. В режиме конструктора перейдите в меню настройки контейнера, нажатием на шестеренку в правом верхнем углу.

3. В правой части выбирете тип отображения — «Диаграмма столбчатая», на которой будет отображаться количество заведений для каждого административного округа с детализацией по районам Москвы.

   3.1. В левой части экрана, из выпадающего списка выбирете созданный ранее набор данных «xls_mos_food».

   3.2. Путем перетаскивания, помещаем данные («Пилюли») на «Полки» (см. здесь).

• На полку «Значения» помещаем «ID объекта» (для подсчета количества уникальных заведений).

  • Для настройки нажимаем на стрелку в нижней части «Пилюли» «ID объекта» и выбираем:

    • «Имя поля» — вводим «Количество»;

    • «Агрегация» — выбираем «COUNTD» (количество уникальных записей);

    • «Сортировка» — выбираем «по убыванию».

• На полку «Категории» помещаем «AdmArea» (для группировки данных по административному округу).

  • Для настройки нажимаем на стрелку в нижней части «Пилюли» «AdmArea» и выбираем:

    • «Имя поля» — вводим «Административный округ».

• На полку «Категории» помещаем «District» (для детализации каждого административного округа по районам по средствам дрилла (см. здесь).

  • Для настройки нажимаем на стрелку в нижней части «Пилюли» «District» и выбираем:

    • «Имя поля» — вводим «Район».

• На полку «Фильтры» помещаем «TypeObject» (для фильтрации гистограммы по типу объекта) и «District» с «AdmArea» для активации дрилла.

В качестве «Пилюли» может выступать вычисляемое поле (см. здесь).

3.3. Заполнив «Полки», перейдите на вкладку настроек компонента отображения (правый верхний угол, средняя вкладка):

• «Общие настройки»:

  • «Заголовок» — «Количество заведений по административным округам\районам, шт.»;

  • «Ориентация» — «верт.»;

  • «Cтекинг» — «вкл.».

• «Всплывающая подсказка»:

  • Объединить — «вкл.».

• «Легенда» — «выкл.».

• «Дрилл» — «вкл.»:

  • «Создать»;

  • «Уровень 1» — «AdmArea»;

  • «Уровень 2» — «District».

  3.4. Настройка визуализации «Диаграмма столбчатая» завершена, теперь нажмите кнопку «Сохранить» и приступайте к созданию следующей визуализации.

  3.5. Нажмите значек «+» для добавления нового контейнера и перейдите в конструктор.

4. В правой части выбираем тип отображения — «Геокарта», на которой в виде карты будет отображатся количество посадочных места по административным округам\заведениям.

   4.1. В левой части экрана, из выпадающего списка выбирается созданный ранее набор данных.

   4.2. Путем перетаскивания, помещаем данные («Пилюли») на «Полки» (см. здесь).

   • На полку «Значения» помещаем «SeatsCount» (для подсчета количества посадочных мест).

     • Для настройки нажимаем на стрелку в нижней части «Пилюли» «SeatsCount» и выбираем:

       • «Имя поля» — вводим «Количество»;

       • «Агрегация» — выбираем «SUM» (общее количество мест);

       • «Добавить в подсказку» — «вкл.».  

   • На полку «Значения» помещаем «SeatsCount» (для определения размера кружка в зависимости от количества посадочных мест).

     • Для настройки нажимаем на стрелку в нижней части «Пилюли» «SeatsCount» и выбираем:

       • «Тип» — размер;

       • «Агрегация» — выбираем «SUM» (общее количество мест).

   • На полку «Значения» помещаем «TypeObject» (для добавления в подсказку типа объекта).

     • Для настройки нажимаем на стрелку в нижней части «Пилюли» «TypeObject» и выбираем:

       • «Добавить в подсказку» — «вкл.».

   • На полку «Категории» помещаем «Adm» (для группировки данных по административному округу).

     • Для настройки нажимаем на стрелку в нижней части «Пилюли» «AdmArea» и выбираем:

       • «Имя поля» — вводим «Административный округ».

   • На полку «Категории» помещаем «Neme» (для детализации каждого административного округа по заведениям посредством дрилла (см. здесь).

   • Для настройки нажимаем на стрелку в нижней части «Пилюли» «Name» и выбираем:

     • «Имя поля» — вводим «Называние заведения».

   • На полку «Фильтры» помещаем «TypeObject» (для фильтрации карты по типу объекта) и «Neme» с «Adm» для активации дрилла.

   4.3. Заполнив «Полки» перейдите на вкладку настроек компонента отображения (правый верхний угол, средняя вкладка).

   • «Общие настройки»:

     • «Заголовок» — «Количество посадочных мест по Округам\заведениям»;

     • «Авто-центровка карты» — «вкл.»;

     • «Режим фильтра — «вкл.».

   • «Геоданнын»:

     • «Категория» — «adm»:

       • «Тип» — «округа Москвы»;

       • «Поле привязки в геоданных» — «Name»;

       • «Поле связывания в данных» — «adm»;

     • «Категория» — «Name»:

       • «Тип» — «Маркеры (из данных)»;

       • «Поле долготы» — «Longitude_WGS84»;

       • «Поле широты» — «Latitude_WGS84»;

   • «Дрилл» — «вкл.»:

     • «Создать»;

     • «Уровень 1» — «Adm»;

     • «Уровень 2» — «Name».

   4.4. Настройка визуализации «Геокарта» завершена, теперь нажмите кнопку «Сохранить» и приступайте к созданию следующей визуализации.

   4.5. Нажмите значек «+» для добавления нового контейнера и перейдите в конструктор.

5. В правой части выбираем тип отображения — «Контейнер с фильтрами», который позволит выводит срез данных в зависимости от выбранного типа объекта.

   5.1. В левой части экрана, из выпадающего списка выбирается созданный ранее набор данных. 5.2. Путем перетаскивания, помещаем данные («Пилюли») на «Полки» (см. здесь).

   • На полку «Фильтры» помещаем «TypeObject».

     • Для настройки нажимаем на стрелку в нижней части «Пилюли» «TypeObject» и выбираем:

       • «Имя поля» — вводим «Тип объекта».

     5.3. Заполнив «Полку» перейдите на вкладку настроек компонента отображения (правый верхний угол, средняя вкладка).

     • «Настройки отображения»:

       • «Тип отображения» — «Кнопки»;

       • «Множественный выбор» — «Вкл.».

     5.4. нажмите кнопку «Сохранить».

     5.5. Теперь необходимо активировать фильтры, для этого находясь на «полотне» в режиме редактирования, перейдите в меню фильтров, расположеном в правом верхнем углу, значек в виде воронки. Включите фильтр «Тип объекта».

     5.6 Настройка «Фильтров» завершена, теперь нажмите кнопку «Сохранить».

6. Измените размер получившегося элемента, путем перетягивания мышкой, зажав правый нижний угол.

7. Измените положение элементов на холсте, путем перетаскивании с зажатой левой кнопкой мыши.

8. По окончанию работы, нажмите кнопку «Сохранить» и выйдете из режима конструктора, нажав кнопку в виде шестеренки.

9. Дашборд готов и опубликован.

1.2 - Назначение и порядок работы с Modus BI

Программа «Modus: Аналитический портал» представляет собой веб-приложение, которое предназначено для визуального представления и публикации данных, подготовленных для формирования аналитических отчетов.

Программный продукт имеет широкие возможности интерактивного анализа и визуализации, что позволяет представить данные в виде, удобном для принятия решений. Гибкие настройки фильтрации, агрегации, детализации (drill-down, drill-up, drill-trough) данных предоставляют пользователю возможность интерактивно сужать и расширять область анализа, получать как агрегированные так и детальные данные для проверки гипотез и предположений.

Программный продукт включает в себя конструктор отчетов. Простой и понятный интерфейс конструктора даёт возможность пользователю, после небольшого обучения — создавать макеты отчетов различной сложности.

Программный продукт работает в веб-интерфейсе всех распространенных браузеров и платформ. Адаптивная верстка отчетов позволяет настроенным отчетам подстраиваться под разрешение экрана и адекватно отображаться как на компьютерных мониторах, так и на мобильных устройствах.

Варианты использования:

• представление данных в удобном для анализа виде;

• публикация готовых отчетов для внутренних пользователей;

• публикация информации для внешних пользователей;

• просмотр отчетов удаленно, в т.ч. с мобильных устройств.

Как это работает:

• настраиваем доступ к источникам и наборам данных;

• создаём отчеты для проведения анализа информации из источников для решения бизнес-задач;

• формируем отчеты, визуализирующие результаты анализа;

• даём доступ к отчетам определенному кругу пользователей.

2 - Администрирование

2.1 - Основные настройки

Modus: Аналитический портал является веб-приложением и состоит условно из трёх частей:

• «Клиента» (Frontend) — средство отображения интерфейсов приложения в браузере;
• «Сервера» (Backend) — основное приложение, выполняющее роль веб-сервера, взаимодействующего с источниками данных и выполняющего пользовательские команды;
• «Данные и метаданные» — служебные данные необходимые для работы (настройки, команды, списки сущностей и т.д.). Распологаются в базе данных Аналитического портала. Для размещения базы данных Аналитического портала используется СУБД PostgreSQL.

2.1.1 - Настройки конфигурации Аналитического портала

Изменение базовых настроек портала выполняются из WEB-клиента аналитического портала и в файле настроек «modusbi.json», расположенного в каталоге исполняемого файла аналитического портала.
Настройки Аналитического портала, редактируемые из WEB-клиента сохраняются и считываются в базе метаданных.
Настройки в файле редактируются вручную, изменения в WEB-клиенте не изменяют файл настроек.
Часть настроек доступных из WEB-клиента дублируется настройками из файла. Настройки из файла имеют более высокий приоритет. Список смежных настроек приведён ниже.
Если есть необходимость настраивать смежные настройки из WEB-клиента, настройку из файла необходимо убрать (как значение, так и само свойство).

Настройки из WEB-клиента

Используя WEB-клиент, перейдите в меню «Администрирование» и выберите раздел «Настройки портала»:

Откроется окно с настройками:

Доступные из WEB-клиента настройки:

Файл настроек «modusbi.json»

Файл настроек «modusbi.json» находится в каталоге размещения исполняемого файла аналитического портала.

{
	"metadata": {
		"driver": "postgres",
		"datasource": "postgres://pg_user:pg_passw@pg_server:5432/BASE_NAME?application_name=modusbi&sslmode=disable",
		"maxopenconns": 100,
		"maxidleconns" : 20,
		"maxlifetime": 3600
	},
	"server": {
		"host": "192.168.0.1",
		"port": 3000,
		"debug": "enabled"
	},
	"backend": {
		"protocol": "http",
		"host": "192.168.0.1",
		"port": 3000,
		"base_url": "/v1/api/"
	},
	"frontend": {
		"base_url": "/"
	},
	"form": {
		"base_url": "/fvd"
	},
	"update": {
		"path": "update"
	},
	"backup": {
		"path": "backup"
	},
	"Databases": {
		"Vertica" : {
			"InMemoryResultRowLimit": 1000			
		}
	},
	"CollLogger": "enabled",
	"auth": {
		"log": {
			"to_file": true,
			"to_metadata": false
		}
	}
}	

, где

Соответствие настроек WEB-клиента и ифайла настроек

Некоторые настройки можно редактировать как в интерфейсе WEB-клиента так и в файле настроек «modusbi.json»:

Примечание: Настройки в файле имеют приоритет перед аналогичными настройками в WEB-клиенте. Если необходимо иметь возможность выполнять некоторые настройки из WEB-клиента, аналогичную настройку из файла необходимо убрать (как значение, так и само свойство).

2.1.2 - База данных Аналитического портала

Совокупность объектов, используемых Аналитическим порталом для хранения служебной информации: структуры команд API, настроек, данных о пользователях, дашбордах и т.д.
Объекты, используемые порталом локализованы в рамках одной базы данных, которая используется порталом постоянно для работы и является его неотъемлемой частью.
Перед использованием Аналитического портала, базу данных необходимо создать. О том как сделать базу данных для Аналитического портала будет описано ниже.

В качестве СУБД, для размещения базы данных Аналитическому порталу требуется PostgreSQL (версии не ниже 10).
Всё дальнейшее описание будет вестись из расчета использования именно этой СУБД.
СУБД PostgreSQL предварительно необходимо установить и настроить.

Примечание: за дистрибутивами СУБД PostgreSQL и инструкциями по установке и настройке перейдите на официальный сайт разработчика:

• https://www.postgresql.org/download/
• https://www.postgresql.org/docs/10/runtime-config.html

Если СУБД PostgreSQL устанавливается впервые и будет использоваться без дополнительного ПО – пуллеров соединений (PgBouncer, Pgpool-II и т.д.), то для корректной работы с Аналитическим порталом в файле конфигурации PostgreSQL необходимо правильно сконфигурировать следующий параметр:

• max\_connections — пиковое количество одновременно работающих пользователей (значение рассчитывается в зависимости от мощности сервера, по-умолчанию 100).

Примечание: до версии Аналитического портала 3.0 использовалась встраиваемая СУБД — SQLite.

Инициализация базы данных портала

Для инициализации базы данных Аналитического портала необходимо:

1. создать пустую базу данных;
2. указать параметры подключения к базе данных в файле настроек;
3. выполнить первоначальное заполнение при помощи специальной команды.

Шаг 1. Создание базы данных СУБД

В СУБД необходимо создать базу данных с любой основной схемой (в PostgreSQL по умолчанию — это «public»).
Никаких элементов внутри созданной базы данных дополнительно создавать не требуется.

Примечание: О том, как создать базу данных в СУБД PostgreSQL можно прочесть в официальном руководстве:

• https://www.postgresql.org/docs/current/manage-ag-createdb.html

Шаг 2. Указание параметров подключения к базе в файле настроек

Для подключения Аналитического портала к базе данных, необходимо в файле настроек Аналитического портала «modusbi.json», в разделе metadata указать параметры подключения к базе данных:

{
  ...
  "metadata": {
    "driver": "postgres",
    "datasource": "postgres://<ПОЛЬЗОВАТЕЛЬ_БД>:<ПАРОЛЬ_БД>@<IP-АДРЕС_PG>:<ПОРТ_PG>/<ИМЯ_БД>?application_name=modusbi&sslmode=disable",
    "maxopenconns": <максимальное количество одновременно открытых соединений>,
    "maxidleconns" : <максимальное количество открытых соединений в пуле>,
    "maxlifetime": <максимальное время жизни соединения в пуле>
  }
  ...
}

• driver — Строка — Имя драйвера для подключения к серверу СУБД, всегда «postgres»;
• datasource — Строка — Строка, в которой закодированы параметры подключения к базе данных:
  • <ПОЛЬЗОВАТЕЛЬ_БД> — Строка — Логин пользователя СУБД;
  • <ПАРОЛЬ_БД> — Строка — Пароль пользователя СУБД;
  • <IP-АДРЕС_PG> — Строка — IP-адрес сервера СУБД;
  • <ПОРТ_PG> — Число — Порт используемый сервером СУБД;
  • <ИМЯ_БД> — Строка — Имя базы данных на сервере СУБД, созданной на предыдущем шаге;
• maxopenconns — Число — Максимальное количество одновременно открытых соединений. Не должно быть больше значения max_connections в настройках СУБД PostgreSQL;
• maxidleconns — Число — Максимальное количество открытых (ожидающих) соединений в пуле;
• maxlifetime — Число — Максимальное время жизни соединения в пуле. Указывается в секундах.

Пример: Аналитический портал и СУБД PostgreSQL установлены на одном сервере. Сервер СУБД PostgreSQL «слушает» стандартный порт «5432». Для подключения используется учетная запись пользователя СУБД с логином «admin» и паролем «pass». Имя базы данных для портала — «modusbi». Для описываемого случая, раздел «metadata» файла настроек будет следующим:

{
  ...
  "metadata": {
    "driver": "postgres",
    "datasource": "postgres://admin:pass@localhost:5432/modusbi?application_name=modusbi&sslmode=disable",
    "maxopenconns": 100,
    "maxidleconns" : 20,
    "maxlifetime": 3600
    }
  ...
}

Примечание: Пользователь СУБД, чей логин и пароль указывается в файле настроек портала, должен иметь в подключаемой базе данных права следующих типов: SELECT, INSERT, UPDATE, DELETE, TRUNCATE, REFERENCES, TRIGGER, CREATE, CONNECT, TEMPORARY, EXECUTE, USAGE.

Шаг 3. Первоначальное заполнение базы данных

Для первоначального заполнения базы данных необходимо запустить выполнение файла портала в режиме инициализации. Для запуска портала в режиме инициализации используется ключ -init.
Для Windows:

C:\portal>modusbi.exe -init

Для Linux:

/opt/modusbi# ./modusbi -init

Примечание: Пользователь операционной системы, под чьей учетной записи производится запуск приложения портала, должен иметь право на создание, изменение, удаление файлов в каталоге размещения исполняемого файла портала и на запуск исполняемого файла портала.

Если всё настроено верно, в файле лога «modusbi.log» появится соответствующее сообщение:

«Cозданы метаданные в <БД PostgreSQL>, необходимо перезапустить сервер.»

где

• <БД PostgreSQL> — Имя созданной вами базы данных;
• сервер — (который необходимо перезапустить) — это сам Аналитический портал, исполняющий роль сервера в клиент-серверной архитектуре.

Запуск с ключом -init выполняется только при первоначальной настройке. Последующие запуски производятся без использования данного ключа.

2.1.3 - База данных Аналитического портала

Совокупность объектов, используемых Аналитическим порталом для хранения служебной информации: структуры команд API, настроек, данных о пользователях, дашбордах и тд.
Объекты, используемые порталом локализованы в рамках одной базы данных, которая используется порталом постоянно для работы и является его неотъемлемой частью.
Перед использованием Аналитического портала, базу данных необходимо создать. О том как сделать базу данных для Аналитического портала будет описано ниже.

В качестве СУБД, для размещения базы данных Аналитическому порталу требуется PostgreSQL (версии не ниже 10).
Всё дальнейшее описание будет вестись из расчета использования именно этой СУБД.
СУБД PostgreSQL предварительно необходимо установить и настроить.

Примечание: За дистрибутивами СУБД PostgreSQL и инструкциями по установке и настройке перейдите на официальный сайт разработчика:

• https://www.postgresql.org/download/
• https://www.postgresql.org/docs/10/runtime-config.html

Если СУБД PostgreSQL устанавливается впервые и будет использоваться без дополнительного ПО – пуллеров соединений (PgBouncer, Pgpool-II и т.д.), то для корректной работы с Аналитическим порталом в файле конфигурации PostgreSQL необходимо правильно сконфигурировать следующий параметр:

• max\_connections - пиковое количество одновременно работающих пользователей (значение рассчитывается в зависимости от мощности сервера, по-умолчанию 100).

Примечание: До версии Аналитического портала 3.0 использовалась встраиваемая СУБД – SQLite

Инициализация базы данных портала

Для инициализации базы данных Аналитического портала необходимо:

1. Создать пустую базу данных
2. Указать параметры подключения к базе данных в файле настроек
3. Выполнить первоначальное заполнение при помощи специальной команды

Шаг 1. Создание базы данных СУБД

В СУБД необходимо создать базу данных с любой основной схемой (в PostgreSQL по умолчанию – это public).
Никаких элементов внутри созданной базы данных дополнительно создавать не требуется.

Примечание: О том, как создать базу данных в СУБД PostgreSQL можно прочесть в официальном руководстве:

• https://www.postgresql.org/docs/current/manage-ag-createdb.html

Шаг 2. Указание параметров подключения к базе в файле настроек

Для подключения Аналитического портала к базе данных, необходимо в файле настроек Аналитического портала modusbi.json, в разделе "metadata" указать параметры подключения к база данных:

{
  ...
  "metadata": {
    "driver": "postgres",
    "datasource": "postgres://<ПОЛЬЗОВАТЕЛЬ_БД>:<ПАРОЛЬ_БД>@<IP-АДРЕС_PG>:<ПОРТ_PG>/<ИМЯ_БД>?application_name=modusbi&sslmode=disable",
    "maxopenconns": <максимальное количество одновременно открытых соединений>,
    "maxidleconns" : <максимальное количество открытых соединений в пуле>,
    "maxlifetime": <максимальное время жизни соединения в пуле>
  }
  ...
}

• driver - Строка - Имя драйвера для подключения к серверу СУБД, всегда “postgres”.
• datasource - Строка - Строка, в которой закодированы параметры подключения к базе данных.
  • <ПОЛЬЗОВАТЕЛЬ_БД> - Строка - Логин пользователя СУБД.
  • <ПАРОЛЬ_БД> - Строка - Пароль пользователя СУБД.
  • <IP-АДРЕС_PG> - Строка - IP адрес сервера СУБД.
  • <ПОРТ_PG> - Число - Порт используемый сервером СУБД.
  • <ИМЯ_БД> - Строка - Имя базы данных на сервере СУБД, созданной на предыдущем шаге.
• maxopenconns - Число - Максимальное количество одновременно открытых соединений. Не должно быть больше значения max_connections в настройках СУБД PostgreSQL.
• maxidleconns - Число - Максимальное количество открытых (ожидающих) соединений в пуле.
• maxlifetime - Число - Максимальное время жизни соединения в пуле. Указывается в секундах.

Пример: Аналитический портал и СУБД PostgreSQL установлены на одном сервере. Сервер СУБД PostgreSQL слушает стандартный порт 5432. Для подключения используется учетная запись пользователя СУБД с логином admin и паролем pass.Имя базы данных для портала – modusbi. Для описываемого случая, раздел «metadata» файла настроек будет следующим:

{
  ...
  "metadata": {
    "driver": "postgres",
    "datasource": "postgres://admin:pass@localhost:5432/modusbi?application_name=modusbi&sslmode=disable",
    "maxopenconns": 100,
    "maxidleconns" : 20,
    "maxlifetime": 3600
    }
  ...
}

Примечание: Пользователь СУБД, чей логин и пароль указывается в файле настроек портала, должен иметь в подключаемой базе данных права следующих типов: SELECT, INSERT, UPDATE, DELETE, TRUNCATE, REFERENCES, TRIGGER, CREATE, CONNECT, TEMPORARY, EXECUTE, USAGE.

Шаг 3. Первоначальное заполнение базы данных

Для первоначального заполнения базы данных необходимо запустить выполнение файла портала в режиме инициализации. Для запуска портала в режиме инициализации используется ключ "-init".
Для Windows:

C:\portal>modusbi.exe -init

Для Linux:

/opt/modusbi# ./modusbi -init

Примечание: Пользователь OS, под чьей учетной записи производится запуск приложения портала, должен иметь право на создание, изменение, удаление файлов в каталоге размещения исполняемого файла портала и на запуск исполняемого файла портала.

Если всё настроено верно, в файле лога modusbi.log появится соответствующее сообщение:

Созданы метаданные в '<БД PostgreSQL>', необходимо перезапустить сервер.

где,

• <БД PostgreSQL> - Имя созданной вами базы данных.
• сервер - (который необходимо перезапустить) это сам Аналитический портал, исполняющий роль сервера в клиент-серверной архитектуре.

Запуск с ключом “-init” выполняется только при первоначальной настройке. Последующие запуски производятся без использования данного ключа.

2.1.4 - Сетевые настройки Аналитического портала

В этом разделе отдельно перечислены настройки, используемые для взаимодействия клиента и сервера Аналитического портала.

Сетевые настройки портала устанавливаются в WEB-клиенте аналитического портала или в файле настроек «modusbi.json», находящегося в каталоге исполняемого файла аналитического портала. Настройки в файле редактируются вручную. Изменения сделанные в WEB-клиенте не изменяют файл настроек.
Часть настроек доступных из WEB-клиента дублируется настройками из файла. Настройки из файла имеют более высокий приоритет, список смежных настроек приведён ниже.
Если есть необходимость настраивать смежные настройки из WEB-клиента, настройку из файла необходимо убрать (как значение, так и само свойство).

Структура URL

После загрузки клиентской части Аналитического портала в память браузера по первоначальной ссылке, клиент отправляет запросы на сервер, генерируя URL на основании настроек:

• «Протокол»:
  • «Протокол сервера данных»;
• «Доменная часть»:
  • «Адрес сервера данных»;
  • «Порт сервера данных»;
• «Путь на сервере»:
  • «Корневой каталог приложения на сервере» — имя службы, если доменное имя маскирует несколько служб или «/» если доменное имя представляет только Аналитический портал;
  • «Путь к API данных» — путь относительно корневого каталога, где опубликован API сервера портала, по умолчанию «/v1/api/»;
    • «Корневой каталог приложения Форм Ввода Данных» — путь к подразделу форм ввода данных относительно пути к API. По умолчанию «/fvd».

Настройки из WEB-клиента

Файл настроек modusbi.json

Файл настроек «modusbi.json» находится в каталоге размещения исполняемого файла аналитического портала.

{
	"metadata": {
    ...
	"server": {
		"host": "192.168.0.1",
		"port": 3000,
		"debug": "enabled"
	},
	"backend": {
		"protocol": "http",
		"host": "192.168.0.1",
		"port": 3000,
		"base_url": "/v1/api/"
	},
	"frontend": {
		"base_url": "/"
	},
	"form": {
		"base_url": "/fvd"
	},
	...
}	

, где

Соответствие сетевых настроек WEB-клиента и файла настроек

Некоторые настройки можно редактировать как в интерфейсе WEB-клиента так и в файле настроек modusbi.json:

Примечание: Настройки в файле имеют приоритет перед аналогичными настройками в WEB-клиенте. Если необходимо иметь возможность выполнять некоторые настройки из WEB-клиента, аналогичную настройку из файла необходимо убрать (как значение, так и само свойство).

2.1.5 - Как настроить https

Использование протокола https для связи клиента и сервера можно организовать как сторонними средствами (например, при помощи прокси сервер), так и средствами Аналитического портала.
В данной статье описывается как включить использование https протокола средствами Аналитического портала.

Для включения HTTPS протокола вам понадобится файл сертификата и файл закрытого ключа, оба в формате PEM. Данные файлы необходимо загрузить в настройки Аналитического портала.

Примечание: Более подробная информация о используемых форматах и стандартах находится в разделе “TLS: стандарты, ключи, шифры”

Далее описан процесс настройкй по шагам.

Шаг 1: Загрузка файлов

Используя WEB-клиент, перейдите в меню «Администрирование» и выберите раздел «Настройки портала»:

В этом разделе вам нужно поочерёдно загрузить файлы сертификата и закрытого ключа:

• «Ключ SSL» — настройка для загрузки закрытого ключа
• «Сертификат SSL» — настройка для загрузки сертификата

Для загрузки файла нажмите на кнопку с надписью «Выберите файл».
Файл будет загружен, а вместо кнопки выбора появится кнопка очистки:

Если вы хотите заменить ранее загруженный файл, нужно нажать на кнопку с надписью «Очистить». Кнопка очистки исчезнет, а на её месте вновь появится кнопка выбора.

Примечание: Загрузка и очистка производят изменения локально, в памяти WEB-Клиента. То есть, файл сначала загружается в память WEB-клиента, а после сохранения настроек (кнопка «Сохранить настройки») файл из памяти клиента попадает в базу данных Аналитического портала. При очистке, клиент запоминает факт очистки, и при записи файл удаляется из базы данных Аналитического портала.

Шаг 2: Выбор протокола

В том же разделе «Настройки портала», выберете протокол HTTPS в качестве значения для настройки «Протокол сервера данных».

Аналогично, выбор протокола можно произвести, указав его в файле настроек modusbi.json:

{
  ...
  "backend": {
    "protocol": "https",
  ...
  },
  ...
}

Примечание:

1. Настройка «Протокол сервера данных», находящаяся в файле, имеет приоритет перед аналогичной настройкой в WEB-клиенте. Если есть необходимость иметь возможность настраивать протокол из WEB-клиента, настройку из файла необходимо убрать (как значение, так и само свойство protocol).

2. Параметры «Ключ SSL» и «Сертификат SSL» настраиваются только из WEB-клиента.

Шаг 3: Сохранить настройки

После того как файлы загружены и выбран протокол, необходимо сохранить сделанные изменения в настройках.
Для сохранения изменений, сделанных в WEB-клиенте, в том же разделе «Настройки портала» нажмите на кнопку «Сохранить настройки».

Шаг 4: Перезагрузить сервер Аналитического портала

Для применения сохраненных изменений настроек сервер Аналитического портала нужно перезагрузить.
Для перезагрузки сервера с новыми настройками можно воспользоваться кнопкой «Перезагрузка», в том же разделе «Настройки портала».

После перезагрузки, если всё было настроено верно, сервер портала будет использовать https-протокол для связи с WEB-клиентом.

Примечание:

1. В текущей реализации сервера, валидация загруженных файлов сертификата и ключа на предмет их соответствия техническим требованиям происходит только при запуске сервера Аналитического портала. Если при запуске файлы не пройдут проверку, то сервер запустится с поддержкой http-протокола, о чём в файле лога будет сделана отметка. Там же, в файле лога будет указана причина несоответствия файлов нужным требованиям.

2. В текущей реализации сервера, проверка файлов на предмет соответствия параметрам производится при условии правильного определения mime типа файлов сертификата и ключа со стороны браузера WEB-клиента. Если сервер не переходит в режим использования https-протокола, а в файле лога присутствует сообщение о ошибке декодирования файла сертификата или ключа, обратитесь в техническую поддержку.

2.1.6 - Технические сведения о используемых стандартах для HTTPS

Транспорт

В качестве транспортного механизма для HTTPS Аналитический портал использует TLS.
Поддерживаемые версии TLS: 1.0, 1.1, 1.2 (RFC 5246), 1.3 (RFC 8446).

Файлы

• Файл сертификата:

  • Должен быть в формате Privacy Enhanced Mail (PEM);
  • PEM должен быть контейнером для ASN.1 DER.

• Файл закрытого ключа:

  • Должен быть в формате Privacy Enhanced Mail (PEM);
  • PEM должен быть контейнером для ASN.1 DER;
  • Поддерживаются PKCS#1 и PKCS#8.

Допустимые комбинации стандартов для файла закрытого ключа:

• PEM » ASN.1 DER » PKCS#1 » RSA;
• PEM » ASN.1 DER » PKCS#8 » RSA;
• PEM » ASN.1 DER » PKCS#8 » ECDSA;
• PEM » ASN.1 DER » PKCS#8 » ED25519;
• PEM » ASN.1 DER » ED25519.

Сертификат

Формат сертификата определён стандартом X.509. Данный тип сертификата в обиходе имеет второе, не техническое наименование — сертификат SSL. Поддерживаются версии до X.509v3 включительно. Актуальной на момент написания инструкции является версия X.509v3.

Ключевая пара

Поддерживаются следующие типы ключей:

• RSA – PKCS#1v2, RFC8017 — без ограничения на размер ключа. Максимальное значение открытой экспоненты (2^31)-1;
• ECDSA – FIPS186-4, SEC1v2 — поддерживаются именованные кривые: secp224r1, secp256r1, prime256v1, secp384r1, secp521r1;
• ED25519 – RFC8032 — только для TLS 1.3.

Защита передаваемых данных

Поддерживаемые типовые шифронаборы для TLS 1.0–1.2:

• TLS_ECDHE_RSA_WITH_RC4_128_SHA;
• TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA;
• TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256;
• TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256;
• TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA;
• TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA;
• TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305;
• TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384;
• TLS_ECDHE_ECDSA_WITH_RC4_128_SHA;
• TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA;
• TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256;
• TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256;
• TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA;
• TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305;
• TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384;
• TLS_RSA_WITH_AES_256_CBC_SHA;
• TLS_RSA_WITH_AES_256_GCM_SHA384;
• TLS_RSA_WITH_AES_128_CBC_SHA;
• TLS_RSA_WITH_RC4_128_SHA;
• TLS_RSA_WITH_3DES_EDE_CBC_SHA;
• TLS_RSA_WITH_AES_128_CBC_SHA256;
• TLS_RSA_WITH_AES_128_GCM_SHA256.

Поддерживаемые типовые шифронаборы для TLS только 1.2:

• TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256;
• TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256;
• TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305;
• TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384;
• TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256;
• TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256;
• TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305;
• TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384;
• TLS_RSA_WITH_AES_128_GCM_SHA256;
• TLS_RSA_WITH_AES_128_CBC_SHA256;
• TLS_RSA_WITH_AES_256_GCM_SHA384.

Общий шаблон имени набора для TLS 1.0–1.2:

TLS_<**Алгоритм аутентификации**>_WITH_<**Шифр данных**>_<**Хеш-функция**>

, где

• «Алгоритм аутентификации» — криптосистема, используемая для аутентификации (аутентифицируются сервер и сеансовый секрет);
• «Шифр данных» — симметричный алгоритм, который послужит для защиты передаваемых данных;
• «Хеш-функция» — хеш-функция, являющаяся основой для HMAC.

Поддерживаемые типовые шифронаборы для TLS только 1.3:

• TLS_AES_128_GCM_SHA256;
• TLS_CHACHA20_POLY1305_SHA256;
• TLS_AES_256_GCM_SHA384.

Общий шаблон имени набора для TLS 1.3:

TLS_<**Шифр данных**>_<**Хеш-функция**>

, где

• «Шифр данных» — симметричный алгоритм, который послужит для защиты передаваемых данных;
• «Хеш-функция» — хеш-функция, являющаяся основой для HMAC.

Примечание: Списки поддерживаемых версий TLS и типовых шифронаборов используются в указанном составе. Однако есть техническая возможность доработать продукт в части добавления возможности выбора минимальной и максимальной версии протокола TLS и ручного комплектования списков шифронаборов из числа перечисленных. Подобная доработка может быть произведена при согласовании с заказчиком.

2.1.7 - Как настроить https с прокси-сервером

Альтернативным вариантом настройки протокола HTTPS для связи клиента и сервера является использование прокси- сервера, как промежуточного звена между клиентом и сервером Аналитического портала. При этом сервер аналитического портала должен иметь соответствующие настройки.

Настройки сервера Аналитического портала

Сервер Аналитического портала сообщает клиенту аналитического портала информацию нужную для построения URL к API сервера, с указанием типа используемого протокола. При использовании HTTPS протокола, настроенного на прокси-сервере, связь прокси-сервера с Аналитическим порталом имеет смысл вести с использованием протокола HTTP, для снижения нагрузки. Нагрузка при этом ложится на прокси-сервер.

Если в настройках сервера выбрать в качестве протокола HTTPS, но файлы сертификата и закрытого ключа не загружать, то сервер будет использовать HTTP протокол, а параметры для построения URL клиенту будет сообщать нужные для построения HTTPS запросов.

Примечания:

1. Настройка «Протокол сервера данных» находящаяся в файле имеет приоритет перед аналогичной настройкой в WEB-клиенте. Если есть необходимость иметь возможность настраивать протокол из WEB-клиента, настройку из файла необходимо убрать (как значение, так и само свойство protocol).
2. Параметры «Ключ SSL» и «Сертификат SSL» настраиваются только из WEB-клиента.

Настройки прокси-сервера

Настройка прокси-сервера будет показана на примере Ngnix.

Nginx

Операционная система: Debian GNU/Linux 12 (bookworm).

Способ установки: из репозитория дистрибутива.

Шаг 1. Обновление информации и установка Ngnix

Обновляем информацию о репозитории и устанавливаем пакет Ngnix:

apt-get update  
apt-get install nginx

Шаг 2. Перенос файлов в каталоги

Помещаем сертификат и ключ в каталоги:

cp ./ssl-cert.pem /etc/ssl/certs/
cp ./ssl-cert.key /etc/ssl/private/

Шаг 3. Создание файла конфигурации

Создаем файл конфигурации SSL nginx:

nano /etc/nginx/snippets/ssl.conf

Добавляем строки о сертификате и ключе в созданный файл:

ssl_certificate /etc/ssl/certs/ssl-cert.pem;
ssl_certificate_key /etc/ssl/private/ssl-cert.key;

Сохраняем изменения.

Шаг 4. Настройка файла nginx

Настраиваем Ngnix. Удаляем link дефолтного файла конфигурации:

rm /etc/nginx/sites-enabled/*

Создаём новый файл конфигурации:

nano /etc/nginx/sites-available/new_site

Добавляем в файл строки:

server {
 	listen 443 ssl;
	server_name  new_site;
	include snippets/ssl.conf;

	location / {
		proxy_pass http://127.0.0.1:3000;
		proxy_set_header Host $host;
		proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;

		client_max_body_size 200M;
		proxy_max_temp_file_size 0;
		proxy_buffering off;
	}
}

, где

• http://127.0.0.1:3000 — адрес сервера и порта на котором запущена служба Аналитического портала.
• new_site — адрес сайта.

Сохраняем и выходим.

Создаем link на созданный нами файл конфигурации:

ln -s /etc/nginx/sites-available/new_site /etc/nginx/sites-enabled/new_site

Шаг 5. Настройка внешнего адреса в файле «modusbi.json»

Необходимо настроить параметры подключения к серверу Backend в файле «modusbi.json». К указанному адресу будут обращаться клиентские соединения из браузера при работе с аналитическим порталом. В общем случае обращение должно выполняться к устройству, на котором запущен аналитический портал.

Примечание: По умолчанию сервер обращается к локальному хосту 127.0.0.1 на порт 3000. Для работы с других устройств необходимо указать значения и параметры подключения к внутреннему или внешнему адресу сервера, с указанием протокола, по которому будет проходить соединение.

Добавляем в файл «modusbi.json» строки:

{
...
  "backend": {
    "protocol": "https",
    "host": "new_site",
    "port": 443,
    "base_url": "/v1/api/"
  }
...
}

, где

• new_site — адрес сайта.

Шаг 6. Перезагрузка

Перезапускаем службу Nginx:

systemctl reload nginx.service

Настройка завершена.

2.2 - Установка и запуск

Состав и содержание дистрибутива

Дистрибутив содержит:

• «modusbi» — исполняемый файл, являющийся сервером для Аналитического портала. Расширение файла зависит от платформы (операционной системы):
  • «Windows» — исполняемый файл «modusbi.exe»;
  • «Linux» — исполняемый файл «modusbi»;
• «modusbi.json» — файл настройки, который можно использовать для быстрой первичной настройки. Позволяет не изменяя метаданные запустить портал с любыми предварительными настройками;
• «modusbi-init.mbm» — файл инициализации базы данных Аналитического портала;
• «modusbi.mbv» — триальный ключ, позволяющий работать с Аналитическим порталом 30 дней.
• «update/modusbi.mbu» — файл обновления базы данных Аналитического портала до последней версии.

Дополнительно, в дистрибутиве для «Windows» содержатся:

• «modusbi.bat» — файл для запуска Аналитического портала как приложения;
• «service-create.bat» — файл создания сервиса Аналитического портала;
• «service-delete.bat» — файл удаления сервиса Аналитического портала.

Примечание: если с дистрибутивом поставляются дополнительные файлы, которые не описаны здесь, то не стоит их учитывать и тем более выполнять системные команды, которые могут содержаться в файлах.

Подготовка перед установкой АП

1. Перед установкой аналитического портала необходимо развернуть базу данных под управлением СУБД PostgrеSQL для хранения настроек АП.

Для установки СУБД Postger SQL обратитесь к официальному руководству:

https://www.postgresql.org/download/

https://www.postgresql.org/docs/10/runtime-config.html_

2. После установки СУБД, создайте новую базу данных, например «modusbi»:

CREATE DATABASE "modusbi"

Установка АП для Windows

Необходимо запустить файл дистрибутива «ModusBI-xx.xx.xx.exe», где «хх.хх.хх» - номер устанавливаемого релиза. В появившемся окне нажать кнопку «Далее» и указать путь к каталогу, куда будет установлен аналитический портала, затем подождать пока файлы распакуются и завершить установку.

Запуск портала в режиме службы

Для запуска портала в режиме службы необходимо запустить файл «service-create.bat», для удаления «service-delete.bat». Оба файла находятся в каталоге, куда была выполнена установка.

Установка АП из .deb пакета

Необходимо скопировать на диск файл установки с расширением «.deb» и выполнить команду:

sudo dpkg -i ИмяФайла.deb

По умолчанию программа будет установлена в каталог «/opt/modusbi».

Запуск и остановка службы выполняется командами:

systemctl start/stop modusbi

Важно! У пользователя, под которым работает служба аналитического портала, должен быть создан домашний каталог.

Установка АП из .rpm пакета

Необходимо скопировать на диск файл установки с расширением «.rpm» и выполнить команду:

sudo rpm -i ИмяФайла.rpm

По умолчанию программа будет установлена в каталог «/opt/modusbi».

Запуск и остановка службы выполняется командами:

systemctl start/stop modusbi

Важно! У пользователя, под которым работает служба аналитического портала, должен быть создан домашний каталог.

Первоначальная настройка аналитического портала

Настройка «modusbi.json»

После установки необходимо перейти в каталог, куда были распакованы файлы и в первую очередь необходимо отредактировать файл «modusbi.json». Далее требуется несколько действий, описанных ниже.

1. Настроить параметры подключения к СУБД PostgreSQL в блоке «metadata».

{
  "metadata": { 
    "driver": "postgres", 
    "datasource": "postgres://<ПОЛЬЗОВАТЕЛЬ_БД>:<ПАРОЛЬ_БД>@<IP-АДРЕС_PG>:<ПОРТ_PG>/<ИМЯ_БД>?application_name=modusbi&sslmode=disable", 
    "maxopenconns": <максимальное количество одновременно открытых соединений, не больше значения max_connections в PostgreSQL>, 
    "maxidleconns": <максимальное количество открытых (ожидающих) соединений в пуле>, 
    "maxlifetime": <максимальное время жизни соединения в пуле, секунды> 
    }
}

Например, СУБД установлена на том же сервере, что и аналитический портал, и подключение к ней выполняется стандартный порт 5432. Была создана база данных «modusbi» и был создан пользователь «postgres», ему задан пароль «my_pass». Тогда строка подключения будет выглядеть по умолчанию следующим образом:

{
  "metadata": { 
    "driver": "postgres", 
    "datasource": "postgres://postgres:my_pass@127.0.0.1:5432/modus?application_name=modusbi&sslmode=disable", 
    "maxopenconns": 100, 
    "maxidleconns" : 20, 
    "maxlifetime": 3600 
    }
}

2. Настроить хост сервера в блоке «server». По умолчанию сервер прослушивает порт 3000 только на локальном хосте 127.0.0.1, если предполагается переход в аналитический портал с других устройств, необходимо установить в качестве значение "host": "0.0.0.0"

Например, предполагается вход на аналитический портал с других устройств на порт 3000. Тогда блок «server» будет иметь следующие настройки:

{
...
  "server": {
    "host": "0.0.0.0",
    "port": 3000
  }
...
}

3. Настроить параметры подключения к серверу Бэкэнда. К этому адресу будут обращаться клиентские соединения из браузера при работе с аналитическим порталом. В общем случае обращение должно выполняться к устройству, на котором запущен аналитический портал. По умолчанию сервер обращается к локальному хосту 127.0.0.1 на порт 3000. Для работы с других устройств необходимо указать значения и параметры подключения к внутреннему или внешнему адресу сервера, с указанием протокола, по которому будет проходить соединение.

Например, предполагается вход на аналитический портал для пользователей с других устройств, находящихся в локальной сети. Аналитический портал развернут по адресу 192.168.0.3, сервер слушает порт 3000. Тогда блок «backend» будет иметь следующие настройки:

{
...
  "backend": {
    "protocol": "http",
    "host": "192.168.0.3",
    "port": 3000,
    "base_url": "/v1/api/"
  }
...
}

Подробней о настройке конфигурации аналитического портала читать здесь.

Запуск инициализации Базы данных

После настройки портала необходимо выполнить его первичную инициализацию. Для этого необходимо в командной строке в режиме администратор или в среде bash перейти в каталог портала и запустить исполняемый файл «modusbi.exe» (в Linux системах «modusbi») с параметром -init.

Например, Аналитический портал установлен в каталог «C:\Program Files\ModusBI». Тогда команда инициализации будет иметь вид:

cd "Program Files\ModusBI"
"modusbi.exe" -init

После выполнения команды начнется создание структуры метаданных в указанной в настройках информационной базе. Результатом выполнения команды должно стать информационное сообщение «созданы метаданные в ‘<БД PostgreSQL>’, необходимо перезапустить сервер». Детальная информация о процессе инициализации будет записана в файл журнала «modusbi.log».

Важно! Инициализация базы данных портала выполняется только один раз при первом запуске.

Получение временной лицензии. Если аналитический портал устанавливается на устройство впервые, автоматически будет получена временная лицензия на срок 30 дней, информация об этом будет отражена в информационном сообщении и в командной строке. Подробней о лицензировании см. здесь.

После инициализации необходимо заново запустить исполняемый файл аналитического портала. Портал готов к работе.

Проверьте работоспособность портала

Для проверки перейдите по адресу аналитического портала в своем браузере. На новом портале доступна учетная запись:

• имя: «admin»;
• пароль: «admin».

Поле первого входа, рекомендуется поменять стандартные параметры подключения.

Портал готов к работе.

2.3 - Обновление Modus BI

Обновление выполняется с помощью файлов «.mbu». В имени файла указывается:

• операционная система, для которой предназначено обновление (Linux / Windows);
• версия АП(X.Y.Z), с которой это обновление можно применить;
• версия АП(X.Y.Z), которая будет результатом обновления.

Например, файл обновления «modusbi-windows-3.0.0-3.1.9.mbu» предназначен для обновления Аналитического портала, развернутого на Windows, для любой версии Аналитического портала, начиная с 3.0.0 (подойдут порталы версии 3.0.0, 3.0.1, … ,3.0.9, 3.1.3 и т.д.). После успешного обновления версия АП будет установлена в 3.1.9.

Перед обновлением портала необходимо сделать копию базы метаданных средствами Postrge SQL.

Важно! До версии 3.0.0 обновление было не кумулятивным и требовалось строгое совпадение номеров версий обновляемого портала, и версии применяемого обновления. Например, обновление «modusbi-linux-2.4.0-2.4.4.mbu» можно установить только если версия портала 2.4.0. Применить такое обновление для портала версии 2.4.1 нельзя.

Поиск подходящих файлов обновлений и их применение выполняется всегда автоматически при запуске портала, до старта основного функционала.

Поиск файлов обновления выполняется в каталоге «update» по месту установки портала. Путь до каталога задается в параметре update.path файла настроек «modusbi.json».

После обработки у файла обновления добавляется расширение в имени:

• «invalid» — если обновление не удалось применить;
• «apply» — если обновление успешно применено.

Файл обновления можно скопировать в эту папку через файловую систему. Либо через веб-интерфейс портала — «Настройки портала» / «Импортировать обновление»:

Если при старте портала было найдено подходящее обновление, то портал выполняет бэкап основных файлов портала:

• исполняемый файл портала;
• файл настроек;
• файл базы метаданных для базы формата SQLite.

Резервная копия сохраняется в папке заданной в настройках backup.path. По умолчанию папка «backup». Формат «.mbb» — по сути zip-архив с дополнительной метаинформацией в файле.

Процедура обновления портала состоит из следующих этапов.

1. Оповещение пользователей.

2. Остановка портала и создание бэкапа базы метаданных из СУБД PostgreSQL с помощью средств самой субд. Для SQLIte достаточно скопировать файл с метаданными. Остановка портала:

   • для Linux можно использовать команду systemctl stop modusbi;
   • для Windows службу можно остановить через оснастку службы;
   • если портал запущен не как служба, необходимо завершить процесс связанный с исполняемым файлом («modusbi»).

3. Копирование нужного файла обновления в папку для обновлений («update»).

4. Запуск портала. В процессе запуска портал попробует применить обновление. Процесс обновления логирует свои действия в основной лог, поэтому контролировать его можно по этому логу.

5. После применения обновления портал попробует выполнить перезапуск. Текущая реализация работы в режиме службы не всегда позволяет автоматический перезапуск портала, поэтому иногда может требоваться ручная остановка портала и запуск, уже новой версии портала.

Версию портала и его частей можно проверить в разделе Аналитического портала «Лицензия».

Важно! Остановка и запуск портала могут потребовать административных («root») прав. До обновления нужно проверить их наличие.

2.4 - Лицензирование портала

Для использования Аналитического портала необходимо, чтобы на портале была активирована действующая лицензия. Ознакомиться с параметрами лицензии можно пользователю с правами администратора в разделе «Настройки», «Лицензия»:

Лицензия регламентирует:

• срок её действия;
• количество пользователей;
• количество дашбордов;
• доступность функционала ограничения на уровне записей («РЛС»);
• доступность функционала Форм ввода данных;
• доступность функционала Отчетных форм;
• доступность опции «white label».

С версии 2.4.0 дистрибутив программного продукта «Модус: Аналитический портал» поставляется с 30-дневной лицензией для ознакомления. Аналитический портал в ознакомительной версии имеет ограничения:

• по сроку использования — 30 дней с момента первого запуска;
• количеству пользователей — 5;
• количеству дашбордов — 5.

Для работы с коммерческой версией портала необходимо активировать коммерческую лицензию. После покупки программного продукта пользователь получает PIN-код для активации лицензии. Лицензия портала привязывается к оборудованию сервера, на котором он установлен.

При использовании ОС Linux для запуска приложения «Аналитического портала», для работы алгоритмов проверки лицензии требуется наличие домашнего каталога у пользователя, от учетной записи которого выполняется запуск. В данном каталоге будет создан каталог “.hasplm”, для размещения ключей.

Параметры, с которыми связывается лицензия:

• MAC-адреса устройств;
• характеристики процессора;
• UUID виртуальной машины.

При изменении параметров сервера лицензия на аналитический портал перестает действовать. Для получения новой лицензии необходимо обратиться на линию технической поддержки 112@modusbi.ru.

Восстановление лицензии

В рамках действующей технической поддержки для пользователей доступно одно льготное восстановление лицензии за период обслуживания. Стоимость восстановления лицензии можно уточнить, обратившись к сопровождающему партнёру, или направив запрос по адресу post@modusbi.ru.

Активация лицензии аналитического портала

1. Войдите в Аналитический портал с правами администратора.
2. В разделе «Настройки» / «Лицензии» нажмите на кнопку «Создать файл запроса для создания нового ключа». Введите присланный ранее PIN-код и ИНН организации.
3. Сохраните файл запроса «license_request.mbc».
4. Направьте сформированный файл запроса по электронной почте на адрес технической поддержки 112@modusbi.ru. При запросе необходимо указать ИНН компании, для которой был приобретен Аналитический портал. В ответ будет направлен файл ответа.
5. После получения файла-ответа перейдите в раздел «Администрирование» / «Лицензии» и нажмите на кнопку «Установить ключ».
6. Выберите полученный файл-ответ формата «.mbv».
7. Перезагрузите Аналитический портал. Для этого на вкладке «Настройки портала» следует нажать кнопку «Перезагрузка»:

8. После перезагрузки будет доступен функционал портала в рамках, заданных лицензией. Параметры лицензии будут отображены в таблице «Лицензии», а активный ключ будет выделен желтым цветом в «Списке ключей»:

Обновление лицензии

Если срок лицензии закончится, либо изменится инфраструктура, на которой развернут «Аналитический портал», ключ лицензии перестанет работать. Необходимо выпустить новый ключ на основании нового PIN-кода. При этом, для обновления существующего ключа (например, при покупке дополнительного пакета) новый PIN-код не нужен, следует использовать текущий.

Последовательность действий при окончании срока лицензии и изменении инфраструктуры:

1. Связаться с сопровождающим партнёром Modus BI.
2. В Modus BI будет создана и согласована заявка на выпуск нового ключа лицензии, после чего сопровождающий партнёр Modus BI предоставит новый PIN-код доступа.
3. На вкладке «Лицензия» Аналитического портала необходимо нажать кнопку «Создать файл запроса для создания нового ключа». В появившемся диалоговом окне следует указать новый PIN-код и ИНН организации, после чего скачать файл-запрос («license_request.mbc»).
4. Файл-запроса следует отправить сопровождающему партнёру Modus BI.
5. Сопровождающий партнёр Modus BI предоставит новый файл ключа лицензии, сгенерированный на основании полученного файла-запроса.
6. На вкладке «Лицензия» Аналитического портала следует нажать кнопку «Установить ключ» и предоставить для окна запроса новый ключ лицензии.
7. На вкладке «Настройки портала» следует нажать кнопку «Перезагрузка» для перезагрузки Аналитического портала.

Кроме сопровождающего партнёра Modus BI, взаимодействие по лицензии можно выстроить с помощью линии технической поддержки (если она предусмотрена договором).

В случае покупки дополнительного пакета, также необходимо обновить лицензию:

1. На вкладке «Лицензия» Аналитического портала следует нажать кнопку «Создать файл запроса для обновления ключа». Скачается файл запроса («license_request.mbc»).
2. Файл-запроса следует отправить сопровождающему партнёру Modus BI.
3. Менеджер Modus BI предоставит новый файл ключа лицензии, сгенерированный на основании полученного файла-запроса.
4. На вкладке «Лицензия» Аналитического портала следует нажать кнопку «Установить ключ» и предоставить для окна запроса новый ключ лицензии.
5. На вкладке «Настройки портала» следует нажать кнопку «Перезагрузка» для перезагрузки Аналитического портала.

2.5 - Кэширование аналитического портала

Для ускорения работы с отчетами аналитический портал может сохранять результаты запросов к данным, и на высокой скорости возвращать их при повторном запросе аналогичных данных пользователями. Это происходит благодаря хранению кэша Аналитического портала. Для его настройки необходимо открыть раздел «Настройки Кэширования» на панели «Администрирование».

Для использования функционала необходимо активировать переключатель «Использование КЭШ» и перезапустить портал.

Настройки КЭШ:

• «Время жизни КЭШ» — время которое данные после их получения будут считаться актуальными.
• Оптимальное время жизни КЭШ 10-30 минут.
• «Периодичность сброса» — время в минутах проверки и сброса устаревших данных.
• Оптимальная периодичность сброса КЭШ — 2 минуты.
• «Вариант настройки исключений» — позволяет настроить исключения наборов данных, к которым кэширование не будет применяться. Данные таких наборов будут каждый раз получаться из хранилища. При помощи кнопки «Выбор набора данных» можно настроить исключения.

Рекомендуем отключать кэширование наборов на этапе разработки и настройки аналитических панелей.

Статистика КЭШ

Функционал ведет статистику использования КЭШ:

1. «Текущее состояние»: «Используется» / «Отключен».
2. «Количество кэшированных наборов данных».
3. «Всего записей кэш» — итоговое количество записей кэша.
4. «Занимаемая память» — измеряется в байт.

Сброс КЭШ

Если необходимо очистить КЭШ память портала можно использовать команду «Очистить весь КЭШ». Очистить КЭШ набора данных можно в форме настройки набора данных, при помощи кнопки «Сбросить КЭШ».

2.6 - Права доступа и роли аналитического портала

Ролевая модель Программного продукта представляет собой двухуровневую структуру:

«1 уровень» — определяется ролью пользователя – роль определяет основные функциональные возможности этого пользователя;

«2 уровень» — предоставление доступа для пользователя к перечню разделов (пользователь сможет просматривать все отчеты этого раздела) и / или на определенные отчеты раздела (будет виден раздел, но доступны только часть отчетов раздела).

Описание ролей

На портале созданы три роли:

• «Администратор» — имеет полные права, может создавать пользователей и предоставлять им права, подключать источники данных, настраивать наборы данных, настраивать расположение отчетов меню, а также настраивать отчеты в режиме конструктора;

• «Аналитик» — может добавлять и редактировать наборы данных, самостоятельно создавать и настраивать отчеты в режиме «Конструктор» и просматривать отчеты, настроенные другими аналитиками;

• «Пользователь» — может только просматривать предварительно настроенные отчеты, на которые у него есть доступ.

Создание нового пользователя и предоставление прав доступа

Для создания нового пользователя необходимо перейти в список пользователей в режиме «Администрирование» (см. рисунок «Настройка пользователей») и нажать кнопку «Добавить пользователя».

Заполните «фамилию», «имя», «отчество» пользователя, «логин» и «пароль». Также можно указать дополнительную информацию по пользователю: «организация», «подразделение», «должность», «e-mail», «телефон». Обязательные поля для заполнения: «логин», «пароль», «фамилия», «имя». Выберите роль пользователя из вариантов («Администратор», «Аналитик», «Пользователь»), по умолчанию устанавливается роль «Пользователь». В системе предусмотрена возможность настройки доступа через профили. «Общий профиль» создается, если предполагается использовать один и тот же набор прав у нескольких пользователей. «Личный профиль» — если настройки на права у пользователя индивидуальные. Если пользователю присвоены общие профили и настроен личный профиль — происходит «конкатенация» прав. Для создания общего профиля необходимо перейти в раздел «Профили доступа к отчетам» в режиме «Администрирование» и нажать кнопку «Добавить профиль»:

В появившемся окне формы ввода нового профиля (рисунок выше) заполните «наименование» и «описание». Здесь обязательное поле — «наименование». Нажмите кнопку «Настроить разрешения». Откроется окно для установки доступа к отчетам:

Для предоставления доступа ко всем отчетам раздела установите флаг около названия раздела (см. п.1 рисунка выше). Для предоставления доступа к конкретному отчету необходимо установить флаг около названия отчета (см. п.2 рисунка выше).

После установки прав нажмите кнопку «Сохранить» в окне настройки доступа к отчетам (см. п.3 рисунка выше), затем «Создать» в форме ввода профиля. Для настройки профилей необходимо зайти в карточку пользователя (первые два рисунка).

Для присваивания общего профиля нажать кнопку «Профили» (см. п.2 рисунка «Настройка пользователей»).

В появившемся окне назначения профилей доступа поставить флаг напротив профилей, которые необходимо присвоить пользователю, нажать «Сохранить» в окне назначения профилей доступа, нажать «Сохранить» в окне настройки пользователя:

Для присваивания личного профиля нажать кнопку «Личный профиль» (см. п.1 рисунка «Форма ввода нового пользователя»).

В появившемся окне настройки личного профиля для предоставления доступа ко всем отчетам раздела установите флаг около названия раздела. Для предоставления доступа к конкретному отчету необходимо установить флаг около названия отчета, нажать «Сохранить» в окне настройки личного профиля, нажать «Сохранить» в окне настройки пользователя:

Для просмотра прав у пользователя нажать кнопку «Отчет» (см. п.3 рисунка «Форма ввода нового пользователя»). В появившейся форме будет отображена информация о текущих правах доступа:

Управление пользователями и изменение настроек пользователя

Операции «управления пользователями» и «настройками» расположены в списке пользователей:

Для изменения настроек пользователя воспользуйтесь кнопкой в виде ручки в строке пользователя в списке. При нажатии кнопки откроется форма для изменения настроек. Внесите необходимые изменения и нажмите кнопку «Сохранить».

Для управления отключения или удаления пользователя воспользуйтесь кнопкой в виде мусорной корзины. После отключения пользователя можно при необходимости сделать его вновь активным.

2.7 - Провайдеры аутентификации

1. Общее описание

Для обеспечения возможности входа пользователя на аналитический портал (АП) посредством разных методов идентификации и аутентификации, спроектированы и разработаны провайдеры аутентификации.

1.1. Провайдер аутентификации

«Провайдер аутентификации (ПА)» — это некоторый внутренний/внешний метод/сервис, который может выполнить идентификацию и последующую аутентификацию пользователя, результатом работы которого будет как минимум информация об учётных данных пользователя и маркер доступа с периодом действия («токен»).

Пока период действия маркера доступа не истёк, пользователь автоматически входит на АП.

На основе текущей реализации вариантов входа на АП созданы следующие провайдеры аутентификации :

1. «Password» — провайдер использующий имя пользователя для идентификации и пароль для аутентификации;

2. «LDAP for Active Directory» — провайдер передающий имя пользователя и пароль в службу каталогов «Active Directory» посредством протокола «LDAP»;

3. «SAML» — провайдер выполняющий создание подписанного «XML–документа» по стандарту «SAML», который используется для идентификации системы и передающий созданный документ внешней системе для выполнения аутентификации пользователя;

4. «OAuth2.0 Client Credentials» — провайдер аутентификации выполняющий авторизацию посредством стандарта авторизации «OAuth 2.0», с использованием типа предоставления учётных данных «ClientCredentials», который используется для конфиденциальных клиентов, которые запрашивают доступ к своим ресурсам или ресурсам, заранее согласованным с сервером авторизации;

5. «OAuth2.0 Authorization Code» — провайдер аутентификации выполняющий авторизацию посредством стандарта авторизации «OAuth 2.0», с использованием типа предоставления учётных данных «Authorizationcode», который в основном используется для «Web-сервисов», которые выполняют перенаправление запроса на сервер авторизации и обрабатывают ответ.

1.2. Конфигурация провайдера аутентификации

Так как для одного провайдера аутентификации могут быть разные настройки, то совокупность уникальных настроек и провайдера аутентификации объединены понятием конфигурация провайдера аутентификации.

Таким образом получается, что администратор АП может управлять методом идентификации и аутентификации на АП посредством создания/изменения конфигураций провайдера аутентификации.

1.3. Параметры конфигурации провайдера аутентификации

Параметры конфигурации провайдера состоят из двух частей постоянных параметров и динамического набора полей, который определяется схемой провайдера аутентификации.

Постоянные параметры конфигурации описаны ниже.

1. «Провайдер» аутентификации/авторизации — выбирается при добавлении конфигурации и не может быть изменён.

2. «Тип хеширования» — алгоритм который используется для обработки пароля пользователя, выбирается при добавлении конфигурации и не может быть изменён.

3. «Имя конфигурации» — уникальное внутреннее название для конфигурации.

4. «Отображаемое наименование» — уникальное название конфигурации, которое отображается пользователю.

5. «Администратор доступа» — пользователь, от имени которого выполняются автоматические операции после успешной обработки ответа от службы/сервиса идентификации/аутентификации.

6. «Иконка» — графическое изображение которое выводится на форме Входа/Выхода пользователя.

7. «Встроенный» — признак, который устанавливается разработчиками и не может быть изменён, характеризует конфигурацию провайдера аутентификации, встроенную в АП, которая используется всегда при отсутствии других конфигураций.

8. «По умолчанию» — признак, указывающий на конфигурацию, которая используется для идентификации/аутентификации пользователя, если пользователь не существует в списке пользователей АП или создан без указания конфигурации провайдера.

9. «Показывать форму» — признак указывает на необходимость отображения формы Входа.

Для каждого провайдера аутентификации набор динамических полей определяют разработчики на основе схемы.

Для следующих провайдеров аутентификации на текущий момент определены наборы динамических полей:

1. «Password»:

   • необходимо ввести имя пользователя — требует ввода имени пользователя на форме Входа;

   • необходимо ввести пароль — требует ввода пароля на форме Входа;

2. «LDAP for Active Directory»:

   • необходимо ввести имя пользователя — требует ввода имени пользователя на форме Входа;

   • следует ввести пароль — требует ввода пароля на форме Входа;

   • адрес («host») — обязательное поле, содержит IP-адрес или DNS-имя сервера LDAP;

   • порт («port») — не обязательное поле, содержит порт, который прослушивается службой LDAP на «адрес».

   По умолчанию 0.

   Если равен 0, то используется стандартный порт «389» для не защищённого соединения или порт «636» для защищённого соединения (параметры указываются ниже);

   • база поиска («base_dn») — обязательное поле, содержит уникальное имя базы поиска («DN»), состоящее из одного или нескольких относительных уникальных имён («RDN»).

   Пример: «dc=example,dc=com»;

   • база поиска с пользователем («bind_dn») — не обязательное поле, содержащее уникальное имя базы поиска, содержащее клиента/пользователя.

   Пример: «cn=username,dc=example,dc=com»;

   • пароль пользователя ( «bind_pass») — не обязательный если не указан «база поиска с пользователем», содержит пароль клиента/пользователя, указанного в «база поиска с пользователем»;

   • не использовать шифрование TLS («skip_tls») — не обязательное поле, по умолчанию значение «Да», не использовать шифрование TLS при выполнении запросов;

   • использовать шифрование SSL («use_ssl») — не обязательное поле, по умолчанию значение «Нет», использовать шифрование SSL при выполнении запросов (параметры указываются ниже);

   • SSL-сертификат («ssl_cert») — не обязательное поле, путь и наименование файла, содержащего SSL-сертификат, используется если «использовать шифрование SSL» установлено в «Да»;

   • SSL-ключ («ssl_key») — не обязательное поле, путь и наименование файла, содержащего SSL-ключ, используется если «использовать шифрование SSL» установлено в «Да»;

   • название сервера из SSL-сертификата («server_name») — не обязательное поле, содержащее название сервера, указанное в SSL сертификате (Server Name Indication), используется если «использовать шифрование SSL» установлено в «Да»;

   • NetBIOS имя домена («server_netbios») — необязательное поле, содержит NetBIOS имя домена по умолчанию. Используется для формирования логина пользователя sAMAccountName стандарта. Если данная настройка указана, и не включена настройка «использовать в качестве имени пользователя UPN», то имя домена будет добавляться к логину пользователя автоматически, если логин не содержит имени домена. Например имя домена “HOUSE”, а логин введенный пользователем “v.ivanov”, то логин используемый для аутентификации будет “HOUSE\v.ivanov”, однако если пользователь введет логин вместе с именем домена “HOUSE\v.ivanov”, то ничего к логину прибавляться не будет;

   • пропускать проверку безопасность при использовании SSL («insecure_skip_verify») — не обязательное поле, по умолчанию установлено в «Да», пропускать проверку безопасность при использовании SSL;

   • использовать в качестве имени пользователя UPN («user_principal_name») — не обязательное поле. Указывает порталу, что в качестве логина пользователи будет использовать userPrincipalName (UPN) — имя участника-пользователя. Это новый формат указания имени пользователя для входа в систему, основанный на интернет-стандарте RFC 822. UPN образуется сочетанием имени пользователя с доменным суффиксом, например “ivanov_ii@home.local”. По умолчанию настройка установлена в значение «Да» - использовать UPN. Если настройка указана «Нет», то в качестве логина будет использоваться sAMAccountName свойство учетной записи пользователя.

   Пример: username@example.com.

3. «SAML»:

   • поставщик учётных записей: «Файла метаданных» — обязательное поле, содержит наименование и полный путь к файлу, содержащему метаданных поставщика идентификации/аутентификации.

   Пример: «metadata.xml»;

   • поставщик сервиса: «Адрес сервера портала» — обязательное поле, содержит адрес сервера портала.

   Пример: «https://dev.modusbi.ru/v1/api»;

   • поставщик сервиса: «Использовать самозаверенный сертификат» — не обязательное поле, если значение установлено в «Да», то автоматически создаётся сертификат и ключ для доменного имени используемого в адресе сервера портала;

   • поставщик сервиса: «Файла сертификата» — обязательное поле, если сервер портала использует протокол «HTTPS» и значение «Поставщик сервиса: Использовать самозаверенный сертификат» установлено в «Нет», содержит наименование и полный путь к файлу, содержащему сертификат, созданный для доменного имени, используемого в адресе АП.

   Пример: «domain.cert»;

   • поставщик сервиса: «Файла ключа для сертификата» — обязательное поле, если сервер портала использует протокол «HTTPS» и значение «Поставщик сервиса: Использовать самозаверенный сертификат» установлено в «Нет», содержит наименование и полный путь к файлу, содержащему ключ для сертификата созданный для доменного имени, используемого в адресе АП.

   Пример: «domain.key»;

   • поставщик сервиса: «Создавать пользователя» — не обязательное поле, если установлено в «Да», то после получения ответа от «Поставщик учётных записей» об успешной идентификации/аутентификации, создаётся новый пользователь в АП с данными полученными из ответа;

   • поставщик сервиса: «Устанавливать Профили» — не обязательное поле, если установлено в «Да», то после получения ответа от «Поставщик учётных записей» об успешной идентификации/аутентификации, пользователю устанавливаются «Профили» с использованием «Групп для конфигурации провайдера аутентификации»;

   • поставщик учётных записей: «способ передачи для Входа» (SingleSignOnService) – определяет значение атрибута «Binding» «XML-тэга» «SingleSignOnService», который необходимо использовать в файле настроек, указанного в пункте «1».

   Если значение настройки не указано, то используется первая запись «XML-тэга» «SingleSignOnService» из файла настроек, указанного в пункте «1». Допустимые поддерживаемые значения:

   • «urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST» — значение по умолчанию;

   • «urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect»;

   • поставщик учётных записей: «способ передачи для Выхода» (SingleLogoutService) – определяет значение атрибута «Binding» «XML-тэга» «SingleLogoutService», который необходимо использовать в файле настроек, указанного в пункте «1».

   Если значение настройки не указано, то используется первая завись «XML-тэга» «SingleLogoutService» из файла настроек, указанного в пункте «1».

   Допустимые поддерживаемые значения:

   • «urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST» - значение по умолчанию;

   • «urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect»;

   • поставщик сервиса: «Формат идентификатора пользователя» (NameIDFormat) – задаёт значение «XML-тэга» из которого необходимо получать формат представления идентификатора пользователя.

   В соответствии с документацией (http://docs.oasis-open.org/security/saml/v2.0/saml-metadata-2.0-os.pdf, §4.2), поддерживаются следующие значения:

   - «urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified» — используется как значение по умолчанию;
   - «urn:oasis:names:tc:SAML:2.0:nameid-format:persistent»;
   - «urn:oasis:names:tc:SAML:2.0:nameid-format:transient»;
   - «urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress»;
   - «urn:oasis:names:tc:SAML:1.1:nameid-format:x509SubjectName»;
   

   • поставщик сервиса: «Подписать запрос аутентификации» — определяет необходимость использования шифрования отправляемых данных;

   • пставщик сервиса: «Проверять действительность сертификата шифрования» — перед тем как подписывается запрос аутентификации выполняется проверка срока годности сертификата, используемого для шифрования;

   • поставщик сервиса: «Не проверять подпись» — при обработке ответа от поставщика учётных записей не выполняется проверка подписи перед расшифровкой;

   • поставщик сервиса: «Разрешить отсутствие атрибутов» — если в результате обработки ответа от поставщика учётных записей не будут найдены некоторые атрибуты в «XML-тэгах», то не возвращать ошибку обработки;

   • поставщик сервиса: «Проверять данные подтверждения субъекта» — при обработки ответа от поставщика учётных записей проверяются атрибуты «XML-тэга» «urn:oasis:names:tc:SAML:2.0:assertion Subject».

4. «OAuth2.0 Client Credentials»:

   • «Необходимо ввести имя пользователя» — требует ввода имени пользователя на форме Входа;

   • «Необходимо ввести пароль» — требует ввода пароля на форме Входа;

   • «Идентификатор приложения» — строковое значение, полученное при регистрации на сервере авторизации («client id»);

   • «Код приложения» — строковое значение, полученное при регистрации на сервере авторизации («client secret»);

   • «Адрес сервера авторизации» — интернет адрес сервера авторизации;

   • «Адрес получения маркера доступа» — интернет адрес куда необходимо отправлять запросы на получение маркера доступа;

   • «Адрес получения данных пользователя» — интернет адрес куда необходимо отправлять запросы с полученным маркером доступа, чтобы получить данные пользователя;

   • «Получать области пользователя» (разделённые пробелом) — строка, содержащая значения, описывающие данные пользователя на стороне сервера авторизации и использующиеся при создании и обновлении пользователя после успешной аутентификации в АП, по умолчанию равно «openid name email groups roles»;

   • «Области для установки профилей» (разделённые пробелом) — строка, содержащая значения, описывающие данные пользователя на стороне сервера авторизации и использующиеся для установки профилей после успешной аутентификации в АП, посредством «Групп конфигурации провайдера аутентификации», по умолчанию равно «groups roles»;

   • «Создавать пользователя» — не обязательное поле, если установлено в «Да», то после успешной авторизации на сервере авторизации, создаётся новый пользователь в АП с данными полученными из ответа;

   • «Устанавливать Профили» — не обязательное поле, если установлено в «Да», то после успешной авторизации на сервере авторизации, пользователю устанавливаются «Профили» с использованием «Групп для конфигурации провайдера аутентификации».

5. «OAuth2.0 Authorization Code»:

   • «Необходимо ввести имя пользователя» — требует ввода имени пользователя на форме Входа;

   • «Необходимо ввести пароль» — требует ввода пароля на форме Входа;

   • «Идентификатор приложения» — строковое значение, полученное при регистрации на сервере авторизации («client id»);

   • «Код приложения» — строковое значение, полученное при регистрации на сервере авторизации («client secret»);

   • «Адрес сервера портала» (https://demo.modusbi.ru/v1/api) – интернет адрес публикации API Аналитического портала. На этот адрес будет выполнено перенаправление с сервера авторизации. Обычно интернет адрес публикации API состоит из интернет адреса Аналитического портала «https://demo.modusbi.ru» и относительного пути к точке публикации API «/v1/api».

   • «Адрес сервера авторизации» — интернет адрес сервера авторизации;

   • «Адрес получения маркера доступа» — интернет адрес куда необходимо отправлять запросы на получение маркера доступа;

   • «Адрес получения данных пользователя» — интернет адрес куда необходимо отправлять запросы для получения данных о пользователе (атрибутов учетной записи);

   • «Имя атрибута из которого получать ’login’ пользователя» - не обязательное поле. Имя атрибута учетной записи, значение из которого следует использовать в качестве логина пользователя. Если не заполнено, используется атрибут “email”;

   • «Имя атрибута из которого получать ‘Имя’ пользователя» - не обязательное поле. Имя атрибута учетной записи, значение из которого следует использовать в качестве имени пользователя. Если не заполнено, используется атрибут “given_name”;

   • «Имя атрибута из которого получать ‘Фамилию’ пользователя» - не обязательное поле. Имя атрибута учетной записи, значение из которого следует использовать в качестве фамилии пользователя. Если не заполнено, используется атрибут “family_name”;

   • «Имя атрибута из которого получать ‘Отчество’ пользователя» - не обязательное поле. Имя атрибута учетной записи, значение из которого следует использовать в качестве отчества пользователя. Если не заполнено, используется атрибут “middle_name”;

   • «Имя атрибута из которого получать ‘E-mail’ пользователя» - не обязательное поле. Имя атрибута учетной записи, значение из которого следует использовать в качестве адреса электронной почты пользователя. Если не заполнено, используется атрибут “email”;

   • «Получать области пользователя» — строка, в которой перечислены имена областей (scope) к которым нужно запрашивать доступ для получения информации о пользователе (атрибутов учетной записи). Имена областей следует отделять пробелами. Значение по умолчанию «openid name email groups roles»;

   • «Атрибуты для установки профилей» — строка, в которой перечислены имена атрибутов учетной записи пользователя (получаемых от сервера аутентификации) содержащих информацию о членстве пользователя в группах. Имена атрибутов следует отделять пробелами. По умолчанию используются атрибуты «groups» и «roles». Значения атрибутов, перечисленных в этой настройке, должны быть массивами из строк - имен групп. Имена групп, получаемые из перечисленных атрибутов, должны совпадать с именами групп указанным в «Настройка групп» конфигурации провайдера аутентификации.

   Примечание: 
   В Keycloak для получения нужного типа данных значения атрибутов, при создании атрибута необходимо выбрать следующие параметры:  
   - "Claim JSON Type": String  
   - "Aggregate attribute": On  
   

   • «Создавать пользователя» — не обязательное поле, если установлено в «Да», то после успешной авторизации на сервере авторизации, создаётся новый пользователь в АП с данными полученными из ответа;

   • «Устанавливать Профили» — не обязательное поле, если установлено в «Да», то после успешной авторизации на сервере авторизации, пользователю устанавливаются «Профили» с использованием «Групп для конфигурации провайдера аутентификации» и значений из свойств перечисленных в настройке «Свойства для установки профилей».

1.4. Создание/изменение пользователя

Так как в результате идентификации и аутентификации пользователя может возникнуть необходимость создания/изменения учётных данных для пользователя в АП, а также назначение доступа пользователя к разным частям АП посредством назначения «Профилей», то для каждой конфигурации провайдера аутентификации возможно:

1. указание необходимости создании пользователя после успешной идентификации и аутентификации;

2. назначение пользователю «Профилей» (любых типов) на основании полученного «Списка доступа» в результате идентификации и аутентификации в провайдере аутентификации.

1.5. Группы для конфигурации провайдера аутентификации

Для корректного назначения «Профилей» пользователю необходимо, что бы с каждым возможным элементом «Списка доступа» были установлены связи с одним или несколькими существующими «Профилями».

Таким образом для каждой конфигурации провайдера аутентификации можно создать свой уникальный «Список доступа», который называется «Группы конфигурации».

Каждый элемент «Группы конфигурации» может быть связан с одним или несколькими существующими «Профилями».

1.6. Установка «Профилей» пользователю

Для обеспечения корректного текущего доступа пользователя к частям АП, установка «Профилей» на основании связи с «Группами конфигурации» выполняется каждый раз после успешной идентификации и аутентификации пользователя в провайдере аутентификации, посредством удаления установленных «Профилей» кроме профиля с типом «Личный» и назначения новых «Профилей» на основании «Группами конфигурации».

2. Инструкции и пример настройки

2.1. Добавление конфигурации провайдеров доступа

1. Зайти на портал с правами администратора. Перейти в меню «Администрирование» (см. рисунок ниже, 1), «Настройки провайдеров» (2) и нажать «Добавить конфигурацию» (3):

2. Заполнить поля «Имя» (см. рисунок ниже, 1), «Отображаемое наименование» (2), «Выбрать провайдера авторизации» (3), тип хэширования (4) и нажать «Создать»:

3. Перейти в редактирование конфигурации по кнопке «Настройки» (см. самый первый рисунок, 1).

4. При необходимости — изменить «Имя» (см. рисунок ниже, 1) и «Отображаемое наименование» (2), установить опции и (3), выбрать иконку (4), выбрать администратора доступа (5); заполнить поля (6) — поля меняются в зависимости от выбранного провайдера авторизации:

2.2. Пример настройки для Active Directory

1. Добавляем конфигурацию с параметрами:

2. Заполняем настройки конфигурации — поля «Адрес», «База поиска» и выбираем иконку для конфигурации:

3. Создаем пользователя. Имя пользователя (UPN) по умолчанию в интернет-стиле, также указываем конфигурацию:

4. Проверяем доступ на портал указывая логин, пароль и нажимая на иконку созданной конфигурации:

2.8 - Профиль наборов данных

Профиль наборов данных предназначен для настройки доступов пользователей к определенным наборам данных, а также сохранений этих настроек для повторного использования.

Для настройки профилей наборов данных необходимо перейти в «Настройки» / «Профили наборов данных». Для добавления нового профиля необходимо нажать на «Добавить профиль».

В открытой форме присутствуют следующие поля:

• «Наименование»;
• «Описание»;
• «Тип профиля».

Для создания доступны следующие типы наборов данных:

1. «Все наборы данных» — предназначен для администраторов, которым нужен доступ ко всем наборам данных;
2. «Только свои наборы данных» — предназначен для аналитиков, которые создают свои отчеты. Имеют доступ только к своим данные, которые загрузили;
3. «Выбранные наборы данных» — предназначен для аналитиков, которые хотят получить доступ к определенным наборам данных.

При нажатии на кнопку «Настроить разрешения» будет открыто окно выбора наборов данных для типа профиля «Выбранные наборы данных».

Также наборы данных можно сочетать между собой:

• «Все наборы данных» + «Только свои наборы данны» = «Все наборы данных»;
• «Только свои наборы данных» + «Выбранные наборы данных» = свои созданные наборы данных и выбранные наборы данных, созданные другими пользователями.

Для применения к определенному пользователю наборов данных, необходимо перейти в карточку пользователя, перейти в раздел «Профили» и во вкладку «Профиль наборов данных». В открытой форме выбрать нужные наборы данных.

Примененные профили будут отображаться в карточке профиля.

2.9 - Настройка прав доступа на уровне записей (RLS)

Разграничение прав доступа на уровне записей (Record Level Security — сокр. RLS) — это настройка прав пользователей, которая позволяет разделить права в разрезе динамически меняющихся данных. Основное преимущество этого разграничения, что пользователи, просматривая одни и те же отчеты, не увидят недоступные им данные и могут даже не догадываться об их существовании.

Чаще всего RLS используют для ограничения видимости в разрезе организаций или клиентов (пользователь видит лишь «свои» данные), но применение может быть любым — территориальным, категориальным и т.п.

Механизм RLS реализован через настраиваемое автоматическое дополнение запроса к источнику данных специальным фильтром, связанным с ограничением части набора данных или ограничением на весь набор для конкретного пользователя. Таким образом, пользователь не увидит в отчете данные, на которые ему не был предоставлен доступ.

Для возможности использования одних и тех же настроек RLS для разных наборов данных была реализована следующая архитектура: RLS это надстройка над целевым набором данных, правила настраиваются с помощью профиля и объектов RLS. Связь с пользователем объектов RLS может быть напрямую или через специальные роли. Один профиль и его объекты могут применяться к разным целевым наборам:

Для настройки нужно выполнить следующие шаги:

• сформулировать принципы разграничения доступа;
• подготовить справочные данные;
• включить механизм;
• настроить роли RLS;
• настроить профили RLS;
• объединить профили и роли в объекты RLS;
• установить ограничения в целевом наборе данных;
• присвоить пользователям соответствующие роли RLS;
• включить использование RLS.

Принципы разграничения прав и подготовка справочных наборов данных

Для использования RLS необходимо подготовить справочники значений (наборы данных для профиля RLS), содержащие записи, по которым будет осуществляться предоставление или ограничение доступа к данным основного набора.

Набор данных для профиля RLS может содержать «Поле RLS» (идентификатор), «Представление поля RLS» (значение), «Поле родителя RLS» (идентификатор атрибута), «Представление поля родителя RLS» (значение атрибута).

Предоставление или ограничение доступа может осуществляться как по «Полю RLS», так и по «Родителю поля RLS» (группе полей с одинаковым атрибутом). Значения в полях представления служат для удобства восприятия информации и будут отображаться в настройках вместо значений идентификаторов.

Примеры использования RLS и соответствие данных справочного набора:

Установка механизма RLS для источника

Поскольку механизм RLS является надстройкой над основным функционалом, возможность его использования необходимо установить в нужном источнике данных. Установка механизма RLS производится под ролью «Администратор». Дальнейшая настройка и управление возможны под ролью «Аналитик».

Для включения RLS нужно перейти в раздел «Источники» в режиме «Администрирование», выбрать источник данных, для которого необходимо включить RLS. В разделе «Дополнительные опции» нажать «Установить» напротив поля «Поддержка RLS»:

При успешной установке появится информационное сообщение:

После установки RLS для выбранного источника, в режиме «Администрирование» в меню станут доступны следующие разделы: «Настройки RLS», «Роли RLS». В параметрах наборов данных раздела «Наборы данных» появится пункт «Настройки RLS»:

Важно! При отмене установки RLS все настройки («Роли», «Профили», «Объекты») удаляются. Для восстановления настроек придеться проделать всю работу заново. Если необходимо сохранить настройки, но не использовать RLS в работе, пользуйтесь возможностью включения/выключения RLS.

Настройка ролей RLS

Роли RLS — один из типов ролей, используемых на портале. Этот тип ролей нужен для привязки пользователей к объектам RLS. Если пользователю присвоили роль, то он имеет права, указанные в объекте RLS, привязанного к этой роли. При включенном RLS для набора данных, пользователь, у которого нет соответствующей роли RLS, не увидит данные из набора.

В разделе «Роли RLS» можно создать и отредактировать роли RLS. Для этого надо выбрать источник данных и нажать кнопку «Добавить роль»:

В открывшемся окне указать наименование роли, пользователей, которым присваивается эта роль RLS и нажать «Создать»:

Добавленные роли RLS можно изменять или удалять с помощью кнопок «Редактировать» и «Удалить». В этом же интерфейсе можно присваивать роль новым пользователям или убрать ее использование у пользователя.

Настройка Профилей RLS

Профиль RLS — это надстройка над справочным набором данных, здесь устанавливается какие поля справочного набора будут являться фильтрами по значениям и группам значений.

Для создания профиля необходимо перейти в режиме «Администрирование» в раздел «Настройки RLS», выбрать источник данных и нажать кнопку «Новый профиль»:

В открывшемся окне указать наименование профиля, выбрать набор справочных данных, из выбранного набора справочных данных выбрать поле RLS — идентификатор и поле представления — значение, опционально поле родителя RLS и поле представление родителя, и нажать «Создать».

Добавленные Профили RLS можно изменять или удалять с помощью кнопок «Редактировать» и «Удалить».

Настройка Объектов RLS

Объект RLS — это описание варианта ограничения для выбранного профиля и привязка к этому ограничению ролей RLS и/или пользователей. Для каждого профиля может быть создано неограниченное количество объектов (вариантов ограничений). Рекомендуется создать один из вариантов, разрешающих доступ ко всем объектам профиля.

Настройка объекта RLS вызывается из того же интерфейса, где настраиваются профили.

Для этого надо перейти в раздел «Настройки RLS», выбирать источник данных, выбирать профиль RLS (нажать на него мышью) и нажать кнопку «Новый объект»:

В открывшемся окне Профиль RLS заполнится автоматически, указать наименование объекта, выбрать Роль RLS (по кнопке «Роли RLS Выбрать») и/или Пользователей (по кнопке «Пользователи Выбрать»), выбирать Тип условия. При выборе Типа условия «включение»/«исключение» необходимо будет выбрать Тип поиска («по элементу» / «по родителю») и указать значения (по кнопке «Значения Выбрать», откроется список элементов или список родителей в зависимости от выбранного типа поиска). После заполнения нажать «Создать»:

Добавленные Объекты RLS можно изменять или удалять с помощью кнопок «Редактировать» и «Удалить».

Возможны следующие типы условий:

• «Включение» — требует указания значений, которые будут доступны;
• «Включение всех» — не требует указания значений, все значения будут доступны;
• «Исключение» — требует указания значений, которые будут недоступны;
• «Исключение всех» — не требует указания значений, все значения будут недоступны.

Включение и настройка RLS для нужного набора данных.

После того, как настроены все правила RLS (профили, роли, объекты), нужно привязать их к целевым наборам данных. Эта привязка устанавливается вручную, чтобы не ограничивать возможность использования определенными названиями полей. При ручной привязке аналитик должен указать, какое именно поле целевого набора соответствует полю справочного набора данных и будет ограничивать видимость данных для пользователя.

Для включения использования RLS на определенном наборе данных необходимо перейти в раздел «Наборы данных», выбрать нужный набор и открыть «Настройки RLS»:

Указать с каким профилем и по какому полю связать набор данных и нажать «Применить RLS» — в результате сформируется SQL-запрос RLS. Далее, необходимо включить RLS с помощью переключателя и нажать «Сохранить», чтобы изменения вступили в силу:

Важно!!! Пока не включено использование RLS для Источника, включение в наборе данных не работает и все пользователи, имеющие доступ к отчету, видят все данные. Если данные конфиденциальные, до включения RLS нужно ограничивать доступ к отчетам.

Включение RLS для источника.

Настройка RLS довольно сложный многошаговый процесс, поэтому его активация включается отдельной настройкой. Таким образом, настройку всего процесса можно проводить в несколько этапов, останавливать и возобновлять по мере необходимости. Незавершенная настройка RLS не повлияет на работу системы.

Когда все настройки для работы механизма RLS завершены, можно начать его использовать. Для этого надо включить механизм RLS для источника. Эта операция доступна для Администратора системы.

Включить/отключить механизм RLS (без потери произведенных настроек) можно в режиме «Администрирование» в разделе «Настройки RLS» или в разделе «Источники»:

После включения RLS для всех Пользователей, кому присвоены Роли с RLS или указаны в настройках напрямую, будут действовать настроенные правила в Объектах RLS. Для всех остальных доступ к данным будет закрыт.

Особенности применения ограничений:

1. Cозданные настройки RLS суммируются.

• Если создано 2 RLS-объекта с включением и исключением одного и того же элемента, то в итоге будет применено исключение;

• Если пользователю предоставлены права «включение всех» элементов и дополнительно «включение» конкретного элемента, то права «включение всех» будут перекрыты логикой «включение».

1. Настройки RLS применяются при сохранении. Поэтому если для пользователя (или группы пользователей) необходимо реализовать ограничение доступа, например, ко всем организациям «Восточного округа» кроме «Управа района Богородское города Москвы» и «Управа района Вешняки города Москвы», то потенциально может возникнуть ситуация, когда пользователю будут доступны данные еще непримененного ограничения. Т.е. исключение одной из управ применяется, а другая ещё не исключена.

Варианты корректной настройки такого рода ограничений:

• создать объект RLS с исключением целевых элементов (т.е. исключения двух управ настроены в одном объекте);
• если же ограничение необходимо применить несколькими простыми объектами, то сначала необходимо добавить пользователя в роль «исключение всех», с этого момента ему не будут доступны все организации, настроить конкретные исключения, а после удалить пользователя из роли «исключение всех».

Важно! Ограничения RLS действуют также и на пользователей с правами администратора. Если у администратора нет прав на просмотр данных, он их не увидит.

2.10 - Настройка RLS запросами с пользовательскими переменными

Пользовательские переменные представляют атрибуты пользователя Аналитического портала. Они подразделяются на встроенные (системные, определяемые структурой метаданных Аналитического портала) и дополнительные (на усмотрение администратора портала в зависимости от решаемых задач).

Настройка пользовательских переменных осуществляется администратором в блоке меню «Переменные» и в окне «Редактирование пользователя» (блок меню «Пользователи»).

см. Список встроенных пользовательских переменных

Настройка RLS с использованием пользовательских переменных

Настройка RLS на основании значений пользовательских переменных предполагает ограничения значений набора данных путем наложения условий в запросе по значениям той или иной пользовательской переменной и описывается при создании набора данных аналитиком.

Предварительная подготовка данных

Для использования разделения доступа с использованием переменных, набор данных должен содержать ключевое поле, по которому осуществляется фильтрация RSL (например, table.rslkey).

Пример 1:

В источнике данных должна быть создана таблица соответствия атрибута пользователя, по которому предполагается вводить ограничения, и значений rslkey, к которым данному пользователю разрешен (запрещен) доступ. Например, таблица «rlstable», содержащая поля rlstable.userid и rlstable.rslkey.

Пример 2:

Такую таблицу можно создавать и редактировать при помощи ФВД.

Подготовка запроса для набора данных

К базовому запросу для получения данных из таблицы «table» необходимо добавить условие WHERE, фильтрующее строки, отвечающие условию выборки из таблицы «rlstable» по значению пользовательской переменной.

Базовый запрос (пример):

SELECT table.data, table.anotherdata FROM table

Модифицированный запрос (пример):

SELECT table.data, table.anotherdata FROM table 
WHERE table.rslkey IN (SELECT rlstable.rslkey from rlstable WHERE rlstable.userid = $user.ID$)

Для каждого пользователя, авторизованного на Аналитическом портале и просматривающего отчет, значение $user.ID$ будет равно идентификатору этого конкретного пользователя, таким образом он увидит только те строки, которые ему предназначены. В нашем примере пользователю «id 101» будут показаны только строки с rlskey = 'Иванов' (№ 1 и 2 в таблице «table»), пользователю «id 102» — данные по Петрову, а «id 100» увидит все строки таблицы «table».

Используя диалект SQL источника данных, можно проектировать более сложные запросы для набора данных, накладывая как включающие (разрешающие), так и исключающие (запрещающие) фильтры, в том числе по нескольким пользовательским переменным (встроенным и дополнительным)

2.11 - Настройка пользовательских переменных

Пользовательские переменные представляют атрибуты пользователя Аналитического портала. Они подразделяются на встроенные (системные, определямые структурой метаданных Аналитического портала) и дополнительные (на усмотрение администратора Портала в зависимости от решаемых задач).

Список встроенных пользовательских переменных

Создание дополнительных переменных

Для создания дополнительных переменных необходимо перейти в раздел «Переменные» бокового меню настроек. Для этого требуются права администратора портала.

1. Нажмите кнопку «Добавить переменную» в верхнем правом углу экрана.
2. В окне создания переменной введите имя переменной (краткое), её описание и тип (Строка, Число или Дата). Имя должно быть уникальным (недопустимо дублирование имен как встроенных, так и других дополнительных переменных).
3. Нажмите кнопку «Создать».
4. После того, как переменная появится в списке, станут доступны операции редактирования (кнопка «карандаш» в правой части списка) и удаления (кнопка «корзина»).

Присвоение значений пользовательским переменным вручную

Редактирование значений пользовательских переменных возможно в интерфейсе редактирования пользователей. Для этого нужны права Администратора портала.

1. Перейдите в раздел бокового меню настроек «Пользователи».
2. Выберите пользователя, для которого необходимо отредактировать значения, и нажмите кнопку «карандаш» в правой части списка.
3. В окне редактирования пользователя измените значения ФИО, Организации, Логина и др., значения системных (встроенных) переменных будут изменены соответственно.
4. Для редактирования дополнительных переменных нажмите кнопку Переменные в окне редактирования пользователя.
5. Перейдите на вкладку «Пользовательские». В ней отображается список переменных, ранее созданных Администратором портала.
6. Выберите переменную для редактирования, нажмите на содержащую её строку. Раскроется меню редактирования переменной.
7. Нажмите кнопку «Добавить значение».
8. В появившейся строке введите значение, При несоблюдении формата (типа переменной) будет выведено предупреждение, сохранить изменения будет невозможно, потребуется внести исправления.
9. Существующие значения переменной можно удалять, нажав на кнопку “корзина”, либо изменять.
10. После добавления новых или редактирования существующих значений переменных нажмите кнопку «Сохранить».

Получение значений пользовательских переменных от провайдера авторизации

При использовании внешнего провайдера авторизации получение значений пользовательских переменных (как встроенных, так и дополнительных) возможно из внешних систем. Для этого необходимо перейти в раздел бокового меню настроек Настройки провайдеров и выбрать для редактирования настроенного ранее провайдера авторизации (кнопка «карандаш» в правой части списка).

1. В окне редактирования провайдера включите опцию «Загружать автоматически значения серверных переменных по данным провайдера».
2. Нажмите кнопку «Серверные переменные».
3. В списке переменных укажите внешние имена (алиасы) тех переменных, которые должен передавать провайдер. При наличии соответствующего параметра авторизации значение переменной будет обновляться для пользователя при каждой авторизации.
4. Нажмите кнопку сохранить.

Переменные могут быть использованы для расширения функционала портала, например, для ограничения прав доступа пользователей к определенным данным.

2.12 - Размещение через iframe портала Modus на стороннем ресурсе

1. Размещение через iframe портала Modus на стороннем ресурсе.

Для размещения дашбордов BI портала Модус на стороннем веб ресурсе, предварительно необходимо «разрешить» на стороне настроек окружения серверного оборудования публикацию домена через iframe. Непосредственно на стороне платформы Модус каких-то дополнительных настроек не требуется.

Для публикации Модуса на стороннем веб портале, необходимо вставить код iframe на странице стороннего ресурса следующего вида:

<iframe src="(URL_дашборда)" frameborder="0" scrolling="yes" height="1000" width="100%">
</iframe>

где:

• frameborder — ширина рамки iframe;
• scrolling — включена отключена прокрутка iframe;
• height — высота iframe (в нашем случае высота на 100% экрана, так как мы отображаем весь сайт);
• width — ширина iframe (в нашем случае ширина на 100% экрана для отображения по всей ширине экрана.

2. Публикация дашборда без авторизации

Для доступа к выбранным дашбордам без авторизации пользователя необходимо сделать следующие настройки:

• создать пользователя и назначить права на выбранные дашборды;
• перейти в настройки портала;
• выбрать пользователя для автоматической аутентификации;
• сохранить настройки и перезагрузить портал.

Для вызова дашборда без авторизации (при условии, что данный дашборд доступен выбранному пользователю «по умолчанию») необходимо добавить к URL дашборда следующую запись: «?login=default»

Пример:
https://covid.modusbi.ru/report/553?login=default.

3. Размещение дашборда через iframe без авторизации

По результату настройки пользователя без авторизации по умолчанию, достаточно к коду iframe добавить в URL запись «?login=default»

Пример кода iframe без авторизации для встраивания в сторонний ресурс:

<iframe src="https://covid.modusbi.ru/report/553?login=default" frameborder="0" scrolling="yes" height="1000" width="100%">
</iframe>

Работу iframe можно проверить на стороннем ресурсе:
https://codepen.io/SnapToPixels/pen/BjgvRM.

4. Настройка сквозной авторизации на BI Портале Modus.

Инструкция по настройке провайдера аутентификации размещено в инструкции в разделе Провайдеры аутентификации.

5. Настройка сквозной авторизации в Modus ETL

Настройка осуществляется типовыми средствами платформы 1С:Предприятие, подробнее по ссылке:
https://v8.1c.ru/platforma/openid-autentifikatsiya/;
https://v8.1c.ru/platforma/mehanizmy-autentifikacii/.

2.13 - Использование безопасного режима для отладки отчётов

Если дашборд не отображается нормальным образом (вместо визуализаций появляется белый экран и т.д.), в него можно внести необходимые исправления в безопасном режиме.

Последовательность действий следующая.

1. При необходимости, можно проводить восстановление на копии отчета. В этом случае, сначала сделайте копию.
2. Скопируйте ссылку на отчет в адресной строке браузера.
3. Добавить к адресу текст ?safemode и выполнить переход по адресу.

Например, если в адресной строке браузера отчёта указано «https://free.modusbi.ru/report/847», то после добавления нужного текста, адрес должен принять вид «https://free.modusbi.ru/report/847?safemode»:

4. Откроется окно «Меню безопасного режима»:

В открывшемся окне есть два выпадающих списка («Показать» и «Удалить»). Установка флажков в списке «Показать» позволяют выборочно отображать элементы дашборда по идентификатору. По мере включения селекторов (перебором сверху вниз) дашборд будет обновляться и показывать элементы с учетом нового выбора. Как только отображение дашборда будет нарушено (белый экран), это позволит определить номер последнего выбранного элемента: именно он вызывает ошибку.

5. Повторите переход в безопасный режим. В списке «Удалить» необходимо выбрать элемент, который вызывает ошибку и нажать кнопку «Удалить» — элемент будет удален из дашборда.

Например, после включения в список «Показать» элемента с номером «3» отчёт не отобразился корректно. Выставляем в списке «Удалить» номер «3», и под списком «Удалить» появится кнопка «Удалить 3»:

Кнопка «Удалить 3» позволит удалить элемент, ведущий к ошибке.

Аналогичным способом можно удалить и другие элементы визуализации по их номерам, а потом следует нажать кнопку «Закрыть» в диалоговом окне.

6. После закрытия окна «Меню безопасного режима», отчёт отобразиться в режиме со всеми визуализациями, кроме удалённых на предыдущем шаге. Удаление в безопасном режиме в действительности не изменяет дашборд, однако теперь можно отредактировать отчёт без проблемных элементов (кнопка с изображением шестерёнки в врехнем правом углу экрана — вход в режим конструктора).

7. Исправьте отчет в режиме конструктора сохраните его.

3 - Подготовка данных

3.1 - Источники данных

Для отображения данных в отчетах, эти данные нужно подготовить и получить в виде наборов данных. Программный продукт позволяет получать данные из хранилищ / баз данных, работающих на СУБД PostgreSQL, MS SQL, Oracle, MySQL, Vertica, ClickHouse. Описание требуемых данных осуществляется с помощью SQL-запроса, сформулированного на диалекте используемой СУБД. Поэтому, для получения данных необходимо настроить доступ к базе данных и при помощи SQL-запроса описать — какие поля и из каких таблиц поместить в «Набор данных».

Таким образом, получается двухуровневая структура:

• «Источник данных» — сервер БД, куда будет обращаться запрос;
• «Набор данных» — результат работы SQL-запроса к таблицам БД (см. «Произвольные наборы данных»).

Настройка источников и наборов данных производится в режиме «Администрирование».

Подключение источника данных

Просмотреть список подключенных источников можно в интерфейсе управления источниками. Откройте режим «Администрирование», выберите раздел «Источник».

Для подключения нового источника данных (сервера) в интерфейсе работы с источниками данных (см. рисунок ниже) нажмите кнопку «Добавить источник». Заполните поля описания источника и нажмите кнопку «Создать».

• «Имя источника данных» — наименование источника на аналитическом портале (уникальное);
• «Заголовок источника данных» — отображаемое название источника на аналитическом портале, то что будет отображаться в списке (может быть не уникальным);
• «Выбрать тип подключения» — MS SQL Server, PostgreSQL, SQLite, OLAP (XMLA), ClickHouse, Полиматика, Метаданные, Vertica;
• «Порядок сортировки» — порядковый номер вывода в фильтре «Выберите источник данных».

После создания источника его необходимо выбрать в фильтре «Выберите источник данных» и дозаполнить настройки.

• «ID» — заполняется автоматически;
• «Имя источника» — уникальное наименование, внесенное ранее, нельзя изменить;
• «Отображаемое название» — заголовок источника данных, можно изменить;
• «Хост БД» — IP адрес или иное указание на расположение компьютера в сети, по которому будет осуществляться подключение;
• «Порт» — дополнительные параметры для соединения;
• «Имя БД» — имя базы данных по умолчанию;
• «Схема БД» — схема базы данных по умолчанию;
• «Логин подключения к БД» — имя пользователя для подключения к источнику;
• «Пароль подключения к БД» — пароль для подключения к источнику;
• «URL БД» — адрес базы;
• «MDX-сервер и Флаг MDX» — для запросов к OLAP-кубам;
• «Флаг Форма ввода» — см. раздел документации;
• «Флаг Коррекция данных» — см. раздел документации;
• «Флаг Импорт из Excel» — указывает на возможность сохранения в БД данных, загружаемых из xlsx-файлов, используя интерфейс «Загрузка из Excel» (по умолчанию используется внутреннее хранилище — DataFromFiles);
• «Краткое описание» — описание источника на аналитическом портале;
• «Порядок сортировки» — порядок, внесенный ранее, можно изменить.

После ввода всех настроек нажмите кнопку «Сохранить».

Проверить подключение возможно по кнопке «Проверить». Сообщение об установке подключения появится в нижнем правом углу портала (см. рисунок выше).

3.2 - Произвольные наборы данных

Настройка произвольного набора данных

Просмотреть список настроенных наборов данных можно в интерфейсе «управления наборами». Откройте режим «Администрирование», выберите раздел «Наборы данных», выберите источник данных, так как каждый набор относится к конкретному источнику. В списке «Наборы данных» можно просмотреть список наборов этого источника и выбрать нужный для просмотра и редактирования его настроек:

Для настройки нового набора данных нажмите кнопку «Добавить набор». Введите имя набора (обязательно уникальное), отображаемое наименование набора, и нажмите кнопку «Создать»:

Набор создан, теперь нужно его настроить. Для этого найдите набор данных в списке наборов и щелкните по нему мышью. Откроется окно нового набора данных, где еще не введены настройки.

Откройте поле для ввода текста запроса для получения данных набора:

Введите текст запроса на языке SQL:

• Синтаксис запроса должен соответствовать синтаксису диалекта SQL, используемого в источнике. Наличие ошибок в запросе можно проверить, нажав кнопку «Проверить запрос»;
• Если запрос обращается к базе данных и к схеме базы данных, которые были указаны по умолчанию в настройках раздела «Источники данных», их можно не указывать в тексте запроса.

Нажмите кнопку «Проверить запрос» (см. рисунок ниже, 2). Если запрос прошел проверку на работоспособность, внизу окна появится сообщение «SQL запрос прошел проверку» и заполнятся выходные поля запроса (см. рисунок ниже, 3).

В выходных полях запроса названия, алиасы (псевдонимы) и типы полей по умолчанию заполняются из базы данных. Алиасы можно изменить, чтобы название стало интуитивно понятным, и в последствии было удобно пользоваться набором данных. Также можно ввести описание полей. После окончания настройки набора нажмите кнопку «Сохранить набор»:

Дополнение набора данных полями с частями даты

Части даты обычно используются при анализе и визуализации данных в разрезе выбираемых пользователем временных интервалов — годов, кварталов, месяцев, недель, дней недели, часов и т.д.

Для использования частей дат не нужно знать SQL-функции для работы с датами и их особенности для разных СУБД, а достаточно выбрать требуемые части даты в удобных интерфейсах.

Для использования функционала необходимо:

1. В наборе данных — настроить дополнительные поля с частями даты. Для этого нажмите на «шестеренку» рядом с полем типа «Дата» (см. рисунок ниже, U ) и выберите необходимые дополнения (см. рисунок ниже, X).

2. В Конструкторе компонента — разместить доп.поля с частями даты (см. рисунок ниже, P) на «полки» «Значения» / «Категории» / «Серии» / «Фильтры» (см. рисунок ниже, R), а также настроить правила детализации в разделе «Дрилл» (см. рисунок ниже, D):

В результате в режиме просмотра на дашборде будут отображаться поля с частями даты при группировке, фильтрации и детализации данных в выбранных временных разрезах:

3.3 - Загрузка данных из файлов Excel

Программный продукт помимо работы с хранилищами данных позволяет загрузить свои данные из файла Excel и использовать его как обычный набор данных. Данные загружаются в источник данных DataFromFiles.

Возможна как единоразовая загрузка данных из файла, так и обновление ранее загруженных данных.

Создание и заполнение таблицы во внутренней базе аналитического портала

Для загрузки xlsx-файлa необходимо в режиме «Администрирование» перейти в раздел «Загрузка из Excel».

На вкладке «Создание» необходимо выполнить следующие действия.

1. Выбрать книгу Excel по кнопке «Обзор» (см. рисунок ниже, 1).
2. Выбрать рабочий лист для загрузки: либо в выпадающем списке, либо щелкнув по нужной закладке внизу интерфейса (рисунок ниже, 2).
3. Выбрать строку заголовка (шапки) таблицы в Excel, щёлкнув по ячейке в первой (серой) колонке (рисунок ниже, 3).

Если строки заголовка в файле нет, необходимо заполнить самостоятельно «Алиас» для каждого столбца.

Возможно изменить имя и алиас для полей вручную для части заголовков, следуя правилу: имя поля в БД должно быть внесено латинскими буквами, алиас — русскими или латинскими.

4. Если загружать столбец не нужно, снимите галочку с этого столбца.
5. В каждой ячейке справа указан тип данных для столбца. Для изменения щелкните по нему и выберете нужный тип поля.
6. Для числа можно указать длину и точность.

7. Ввести имя «Набора данных» в строке «Таблица БД» (это же имя будет присвоено таблице во внутренней базе данных) (см. первый рисунок, 6).

Правила формирования имени набора данных и таблицы в БД:

• к имени автоматически будет добавлен префикс «xls_», чтобы отличать наборы данных, загруженные из файлов от прочих;
• если имя не уникально, то система выведет пользователю сообщение, и предложит добавить постфикс с текущей датой-временем в формате «ГГГГММДД_ЧЧММСС».

8. Также возможно ограничить количество строк выгрузки через настройки «Импортировать строки с … по …». Автоматически выгружаются все строки с листа, начиная с первой строки после заголовка (см. первый рисунок, 7).
9. Нажать на кнопку «Импортировать данные». По завершении — система выведет сообщение об успешной загрузке данных во внутреннюю БД и формировании Набора данных (см. первый рисунок, 8).

В результате успешной загрузки данных автоматически добавляется набор данных, который доступен для выбора в Конструкторе дашбордов в Редакторе компонентов.

Обновление данных таблицы во внутренней базе аналитического портала

Если необходимо добавить данные или перезаписать уже внесенные ранее, необходимо на вкладке «Дополнение данных» (в панели «Загрузка» из Excel) выполнить следующие действия:

1. выбрать книгу Excel через кнопку «Обзор» (см. рисунок ниже, 1);
2. выбрать рабочий лист для загрузки: либо в выпадающем списке, либо щелкнув по нужной закладке внизу интерфейса (см. рисунок ниже, 2);
3. выбрать схему импорта, тогда автоматически применяться настройки, которые использовались ранее для загрузки файла, включая таблицу БД, в которую будет происходить запись. Если схема не выбрана, необходимо будет настроить вручную (см. рисунок ниже, 3);
4. выбрать тип добавления (см. рисунок ниже, 4):
   • Если переключатель «Очистить и добавить» не включен, данные добавятся к уже имеющимся данным, т.е. происходит добавление данных.
   • Если включен, таблица сначала очищается, потом добавляются данные, т.е. происходит перезапись загруженных ранее данных;
5. нажать на кнопку «Импортировать данные».

По завершении — система выведет сообщение о успешной загрузке данных во внутреннюю БД и обновлении Набора данных (см. см. рисунок ниже, 5).

3.4 - Источник данных Data From Files

Источник данных «Data From Files» используется, когда необходимо загружать данные на портале из файлов. Портал может использовать существующую базу данных (BD) для хранения данных из файлов. Для активации этой функции, необходимо настроить источник данных «Data From Files» в разделе «Источники» на вкладке «Источники».

Для настройки источника «Data From Files» необходимо, чтобы база данных (DB) уже была настроена, либо локально на портале, либо на отдельном сервере. Подробную информацию можно найти в статье по следующей ссылке: в статье «База данных Аналитического портала».

Настройка источника «Data From Files»

Для активации функционала «Импорт из Excel», откройте режим «Администрирование», выберите раздел «Источники», затем на вкладке «Источники» выберите источник «Data From Files» и укажите тип подключения и параметры подключения. Не забудьте включить флаг «Импорт из Excel».

Также можно включить флаг «Импорт из Excel» в существующем источнике.

Загрузка данных из файлов Excel

Теперь вы можете легко загружать данные из файлов Excel. Дополнительные инструкции по загрузке файлов из Excel доступны по ссылке: в статье «Загрузка данных из файлов Excel»

4 - Создание и настройка отчетов

4.1 - Использование переменных в дашборде

В скриптах вычисляемых выражений и наборов данных, используемых в Аналитическом портале Modus BI, можно предусматривать различные алгоритмы в зависимости от настроек фильтра визуального элемента.

Примеры использования:

1. значение сумм продаж надо рассчитывать в различных национальных валютах, вид которой выбирается в фильтре;

2. необходимо по ключу объединить данные нескольких таблиц (используя для объединения временные периоды, наименования регионов и подразделений, мест возникновения затрат и т.д.). Если фильтрами выбраны лишь некоторые значения для ключей, то процесс объединения может быть более оптимизированным с точки зрения ресурсов и времени выполнения — объединение будет производиться сразу только по выбранным в фильтрах значениям. В этой ситуации популярная в моделировании данных каноническая схема «звезда» будет работать наиболее эффективно.

Для реализации такого механизма предусмотрены пользовательские переменные.

Синтаксис переменной имеет следующий вид:

{…!env.\<Имя переменной\>!...; \<Выражение пустого условия\>}

где env — это пространство имен для пользовательских переменных.

В примере с валютой синтаксис может выглядеть следующим образом:

Область выражения { ...<!env.ИмяПеременной!>...; ... } может содержать произвольное выражение в левой и в правой части, но с условием, что в левой части конструкции будет объявлена переменная <!env.ИмяПеременной!>.

Конкретно в примере, если переменная VAL выбрана в фильтре как «USD», то используется цена в валюте из поля «Цена_вал», в противном случае (при невыполнении условия, когда в фильтре выберут, например, валюту «Руб») — цена в рублях из поля «Цена_руб». Если фильтр не выбран, то прописывается условие «1=1», которое всегда возвращает истину (true), и для этого — вариант по умолчанию: применяется цена в валюте (возвращается опять-таки поле «Цена_вал»).

К примеру, имеется «большая» таблица продаж «modus_big_table» следующего вида:

В фильтре видов валют выберем «USD»:

В следующей таблице производится пересчёт суммы в валюту:

Если в фильтре валют выбрать «Руб», то будет произведен соответствующий пересчёт.

Посмотрим, как сконструирована предыдущая таблица в Аналитическом портале, включая код двух вычисляемых выражений:

Как видно из рисунков выше, для вычисляемых выражений «Цена» и «Сумма» использован одинаковый механизм обращения к тем или иным значениям фильтра («USD» / «Руб») и полям набора данных, отвечающих за цену («Цена_вал», «Цена_руб») и сумму соответственно («Сумма_вал», «Сумма_руб»). Везде задействована переменная VAL.

Чтобы механизм работал, нужна соответствующая настройка фильтра валюты. Набор данных для фильтра формируется специальным запросом:

Здесь просто объединяются в набор две текстовых константы: «Руб» и «USD». Самое главное здесь, что переменной присваивается имя «Валюта».

При этом, в настройке фильтра предусмотрен раздел «Переменные», в котором мы можем с помощью кнопки «Добавить» указать нашу переменную «Валюта» и связать её с VAL, которая используется в вычисляемых выражениях:

В следующем примере надо пересчитать сумму продаж для региона:

Здесь верхняя «маленькая» таблица из двух колонок имеет имя «modus_small_table».

В настройке фильтра региона добавлена переменная фильтра региона «Кол», связанная с переменной REGION:

Для набора данных нижней (итоговой) таблицы используется следующий скрипт:

SELECT 
FROM "modus_big_table" pr
JOIN (
        SELECT 
        FROM "modus_small_table"
        WHERE "Кол" in ({!env.REGION!; 2})
    ) vz 
ON pr."id_Региона" = vz."Кол"

Здесь есть подзапрос с «маленькой» таблицей «modus_small_table». В ней данные фильтруются по условию, что столбец «Кол» попадает в список значений фильтра REGION. То есть согласно совпадению с фильтром выбирается либо строка {"Москва", 1}, либо {"Санкт-Петербург", 2}, либо {Татарстан, 3}.

Затем идёт объединение этой таблицы с «большой» таблицей продаж «modus_big_table». В большой таблице есть поле-ключ «id_Региона». Объединение идёт по совпадению значения «Кол» в отфильтрованной в подзапросе таблице и ключом «id_Региона» большой таблицы (цифры 1, 2 или 3).

Цифра 2 дает запасной вариант («страховочное» условие, если вычисление переменной произошло с ошибкой) для скрипта: ему соответствует «Санкт-Петербург».

На основе полученного набора данных в конструкторе настраивается макет итоговой таблицы:

В процессе применения переменных есть определённые особенности.

1. Значение переменной должно быть числом или текстом. Для дат лучше делать преобразование, например:

{toDate(!env.Date!) ; '2020-01-01'} = '2023-11-08'

2. Значение может быть единичным значением или списком, в зависимости от настройки фильтра:

Region IN ({!env.Reg! ; })

3. Даты начала и окончания периода фильтра обозначаются суффиксами .BEGIN и .END:

Date between ({ toDate(!env.Reg.BEGIN!) ; '2020-01-01'} AND ({ toDate(!env.Reg.END!) ; toDate(now()) }

4.2 - Панель индикации фильтров

Панель индикации фильтров (сокращенно — ПИФ) вместе с возможностью использования режима фильтра для большинства диаграмм, обеспечивают новый — гибкий и наглядный подход к управлению общими фильтрами дашборда.

Отображение на дашборде «Панели фильтров» включается в настройках дашборда — при этом панель ПИФ выводится вверху дашборда и компактно отображает текущие значения фильтров, а также дает возможность выбора значений из списков, в том числе — отбор значений по введенной пользователем подстроке:

В панель ПИФ также передаются значения:

• выбранные в контейнерах фильтров дашборда;
• категорий детализации при drill-down;
• отмеченные на диаграммах, работающих в режиме фильтра:

Панель ПИФ также может использоваться  для управления наборами фильтров:

• пользователь может сохранить текущий набор фильтров, задав ему имя (см. рисунок ниже, 1);
• сохраненные наборы фильтров возможно выбирать из списка см. рисунок ниже, 2);
• предусмотрен функционал отправки другому пользователю cсылку на дашборд с набором фильтров (см. рисунок ниже, 3):

4.3 - Пользовательская палитра

Настройка пользовательской палитры в отчете

В отчетах Аналитического портала (АП) кроме предустановленных палитр раскрасок, пользователь может сам установить палитру.

Для этого в окне Modus надо перейти в режим «Администрирования» (если у пользователя есть доступ на редактирование) (см. рисунок ниже, 1), выбрать раздел «Отчеты» (см. рисунок ниже, 2), выбрать отчет в котором необходимо установить собственную палитру цветов и нажать на редактирование (см. рисунок ниже, 3):

В открывшемся окне выбрать «Палитру пользователя»:

В результате откроется массив из 10 квадратов, кликая на которые можно открыть окно для выбора цвета:

После установки всех необходимых цветов, необходимо нажать кнопку «Сохранить» в окне «Редактирование отчета».

Далее, после перехода в отчет, можно увидеть, что элементы раскрашены согласно установленной палитры, если конечно в элементах предварительно не были установили цвета:

Создание общей пользовательской палитры.

Есть также возможность создавать палитры в целом для портала, чтобы их можно было использовать в нескольких отчетах, не настраивая для каждого. Для этого на страницы «Администрирования» выбирается пункт «Темы интерфейса» (см. рисунок ниже, 1):

Здесь можно выбрать или создать собственную тему для портала (см. рисунок выше, 2). Один из элементов для создания или изменения, является «Палитра диаграмм» (см. рисунок выше, 3).

Создается через нажатие кнопки «Добавить палитру» (см. рисунок ниже, 1). Для редактирования цветов, выбранной палитры, необходимо нажать кнопку «Редактор» (см. рисунок ниже, 2):

Откроется окно «Редактор палитры». После редактирования цветов нажать кнопку «Сохранить».

4.4 - Экспорт в файл презентации pptx

На основании дашборда возможно сформировать презентацию, экспортировав подготовленные и скомпонованные изображения компонентов дашборда в шаблон презентации — файл «pptx».

Сценарий использования:

1. перейти в режим подготовки — «верстки» изображений для слайдов презентации — так называемых «фреймов»:

2. добавить фрейм с именем-идентификатором:

Разместить в фрейме один или несколько компонентов дашборда перенося компоненты из секции с компонентами дашборда (см. рисунок выше, 4) и изменяя размер и взаиморасположение компонентов (см. рисунок выше, 5);

3. скопировать идентификатор фрейма. Добавить в шаблон презентации (файл «pptx») прямоугольную область и вставить в неё идентификатор фрейма;

4. повторить п. 2 и 3 для нескольких фреймов;

5. добавить и сохранить файл шаблона презентации для дашборда (см. первый рисунок, 3);

6. сохранить скомпонованные фреймы (см. первый рисунок, 6) и выйти из режима «верстки»;

7. При экспорте отчета (дашборда) в файл «pptx» (см. рисунок ниже, P) будет показан интерфейс с фреймами, в котором возможно изменить / задать имя файла (см. рисунок ниже, N) и нажать кнопку «Экспорт» (см. рисунок ниже, E) — и средствами браузера будет сформирован и сохранен файл презентации (см. рисунок ниже, F):

4.5 - Управление разделами и панелями отчетов

В режиме «настройки» перейдите в раздел «Отчеты»:

В интерфейсе управления отчетами можно добавить раздел отчетов и добавить новый отчет, а также управлять включением/исключением отчетов в раздел, порядком вывода отчетов в разделе и вносить изменения в настройки отчетов:

Настройка разделов / групп меню

Нажмите кнопку «Добавить группу» и заполните поля (см. рисунок ниже, 1):

• «Имя группы» (обязательно уникальное);
• «Заголовок группы» — имя группы, которое будет выводится в меню;
• «Цвет» плашек группы в меню;
• «Признак» «Показывать в меню».

Сохраните группу, нажав на кнопку «Создать» (см. рисунок выше, 6).

Положение группы отчетов в списке регулируется стрелками вверх / вниз, расположенными напротив названия группы.

Размещение отчета в группе отчетов и настройка атрибутов / опций отчета

Нажмите кнопку «Добавить отчет»:

Заполните в форме сведения о новом отчете:

• «Наименование» в меню отчетов (см. рисунок ниже, 1);
• «Заголовок» отчета — будет выведен в шапке отчета (см. рисунок ниже, 2);
• «URL ссылки» на внешний ресурс — если ссылка указана, то из меню будет происходить не открытие отчета, а переход по указанной ссылке;
• «Группу» отчета — в каком Разделе будет размещен отчет (см. рисунок ниже, 3);
• «Индекс сортировки» — числовой параметр, влияющий на порядок сортировки внутри группы отчетов (см. рисунок ниже, 6);
• «Описание» отчета — в текстовом многострочном поле «Аннотация отчета» (см. рисунок ниже, 4);
• «Добавить файл картинки» (см. рисунок ниже, 5) — подходящее изображение или скрин отчета, для отображения в меню отчетов;

Примечание: требования к файлу — формат jpg или png, и желательный размер — 640x480 пикселей.

• Выбрать «Цветовую палитру» отчета (см. рисунок ниже, 7). При разработке отчета по умолчанию категории/серии в диаграммах будут раскрашены в соответствии с выбранной палитрой. Возможно также настроить пользовательскую палитру;
• Включить «Общий курсор» (см. рисунок ниже, 8). Опция позволяет выделять и отображать сущности с совпадающими наименованиями категорий сразу на нескольких диаграммах при наведении курсора на одной из диаграмм. Если опция «Общий курсор» включена при настройке отчета, то Пользователь в режиме просмотра может включить/выключить общий курсор самостоятельно в панеле «Фильтров и переключений» отчета. Если опция для отчета выключена, то Пользователю доступен только обычный курсор;
• Включить «Общий дрилл» (см. рисунок ниже, 9). Опция позволяет одновременную детализацию (изменение категории группировки) для компонентов. Настраивается только при создании/редактировании отчета, т.е. Пользователь не может включить / выключить эту опцию в режиме просмотра.

Порядок размещения отчетов в разделе регулируется полем «Сорт.» (сортировка). Устанавливая число в сортировке больше или меньше, можно регулировать положение отчета (см. рисунок ниже, 1). Скопировать, изменить или удалить отчет можно, используя кнопки операций (см. рисунок ниже, 2):

Создание отчета копированием

Отчет можно создать копированием существующего отчета, для этого нужно нажать на кнопку в строке выбранного для копирования отчета. В открывшемся окне заполните / измените атрибуты и опции для нового отчета и нажмите кнопку «Копировать»:

Также можно скопировать отчеты для передачи на другой портал или загрузить отчеты с другого портала, подробно этот функционал описан в этом разделе.

4.6 - Настройка отчетов при помощи конструктора

Программный продукт включает в себя конструктор отчетов. Конструирование отчетов происходит в web-интерфейсе браузера. Для успешного конструирования отчетов не нужны навыки программирования.

Терминология, использующаяся при создании отчетов

«Отчет» (или «дашборд») — набор скомпонованных элементов представления данных на одном экране. Если речь идет о настройке отчета, то подразумевается общая настройка, влияющая на все элементы представления (контейнеры) на экране. В одном отчете / на одном дашборде может быть размещено несколько элементов представления.

«Контейнер» — элемент отчета, представляющий собой «единицу смысла», который отображает данные из одного набора в одном типе представления. Для достижения лучшего понимания данных и визуальной привлекательности отчета, в контейнере также может располагаться управляющий элемент, произвольный текст, произвольное изображение, пустое поле.

«Режим Просмотр отчета» — обычный пользовательский режим, когда можно только просматривать отчеты без возможности корректировки источника, вида и настроек представления данных. При этом в режиме просмотра можно пользоваться выведенными на специальную панель фильтрами, увеличивать (максимизировать) отчет до полного экрана и возвращать к первоначальному размеру, включать и выключать часть диаграммы, детализировать данные и переходить в другой отчет, если такие настройки были заранее сделаны.

«Режим Конструктор отчета» — режим для работы пользователя с соответствующими правами (с ролью аналитика или администратора), позволяющий создавать новые отчеты и компоненты на листе отчета, редактировать существующие отчеты, настраивать источники данных, внешний вид отчетов и переходы между отчетами, настраивать пользовательское меню.

«Полка» — специальный управляющий элемент в конструкторе для настройки правил расчета, группировки и отбора данных из набора данных для их визуального представления. Каждая полка обозначает элемент настройки, на полке можно размещать пилюли с полями набора данных, вычисляемыми полями и дополнительными настройками.

«Пилюля» — управляющий элемент, визуально представляющий поле набора данных (точнее функцию, аргументами которой является одно / несколько полей набора данных) и предоставляющий возможности настройки работы с этим полем (правил агрегации, сортировки, применения функций). Пилюли размещаются на нужную полку.

Порядок действий при создании отчета в конструкторе

1. Создание нового отчета.
2. Переход в режим «Конструктора отчета».
3. Добавление контейнера.
4. Изменение размеров и расположения контейнеров.
5. Использование буфера контейнеров: копирование и вставка.
6. Настройка отчета для разных разрешений экрана.
7. Настройка общих фильтров.
8. Сохранение и просмотр готового отчета.

Внешний вид отчета и управляющих элементов

Отчет в режиме «Просмотр» и в режиме «Конструктор» имеет разные управляющие элементы:

Переход между режимами осуществляется при помощи кнопки «шестеренки».

Подготовка к созданию отчета

Работа над отчетом начинается еще до создания первой визуализации: чтобы получить качественный отчет, его нужно тщательно спланировать. Определите характер используемых данных и запишите все требования к новому отчету. Найдите ответ на вопрос о том, какую бизнес-задачу необходимо решить, а также как и кем будут использоваться эти данные. И самый важный вопрос: какие решения сможет принять пользователь на основе этого отчета.

Отчеты помогают выполнять поиск, отслеживание, прогнозирование, измерение, управление, мониторинг и множество других операций с данными.

Включите в отчет привычную для целевой аудитории терминологию и данные соответствующего уровня детализации и сложности. Если предполагается разнородная аудитория, то рекомендуется создавать для разных групп пользователей разные страницы отчета с учетом их задач и уровня осведомленности.

Место на странице отчета ограничено, поэтому непросто разместить все нужные элементы, сохраняя информативность и наглядность. При этом не нужно забывать эстетический фактор. Залог успеха — найти баланс между эстетикой и утилитарностью.

Страница отчета должна отражать информацию четко, быстро и связно. Перегруженную страницу отчета сложно просматривать. Исключите все ненужные элементы отчета. Не привносите избыточность, которая только мешает восприятию и навигации.

Создание нового отчета

После создания отчета кликните на название отчета в списке, откроется окно конструктора отчета.

Новая панель отчета в режиме конструктора выглядит следующим образом:

Так как панель еще не настроена, она по умолчанию открывается в режиме конструктора. Заштрихованное поле представляет собой чистый лист («холст»), на котором можно размещать разные элементы. Изначально на панели размещен один пустой контейнер (см. рисунок выше, 1).

Добавлять контейнеры на лист можно с помощью кнопки «Добавить панель» (см. рисунок выше, 2). Для сохранения настроек воспользуйтесь кнопкой «Сохранить», (см. рисунок выше, 4).

Для перехода в режим «Просмотр» воспользуйтесь кнопкой «шестеренкой» (см. рисунок выше, 3).

Редактирование основных свойств, палитры, описания отчета доступно также и на странице отчета, в режиме конструктора — вызывается пиктограммой рядом с заголовком отчета (см. рисунок выше, 5).

Компоновка контейнеров на листе отчета

Элементы представления в отчете расположены в специальных контейнерах. Можно добавлять сколько угодно контейнеров на лист, главное руководствоваться удобством восприятия информации пользователем. Контейнеры на листе можно увеличивать / уменьшать, перемещать, добавлять / удалять. В правом нижнем углу указан размер контейнера (длина х ширина). Настроенное представление будет размещаться в пределах размеров контейнера.

• «Добавить контейнер» — с помощью кнопки «Добавить панель» (см. рисунок выше, 2 );
• «Удалить контейнер» — с помощью кнопки в правом верхнем углу контейнера:

• «Изменить размер контейнера» — потянуть мышкой за правый нижний угол контейнера:

• «Перемещение контейнера» — потянуть мышкой за любую свободную область контейнера и переместить в нужное место.

Для аккуратного внешнего вида отчета на листе расположена невидимая сетка. При изменении размера контейнера его размер будет изменяться с шагом кратным ячейке этой сетки, благодаря чему примерно одинаковые по высоте контейнеры станут одинаковыми и разместятся на экране в одну линию. Также можно подгонять размеры разных элементов по ширине и высоте. Расположение контейнера на экране также зависит от ячеек сетки и от наличия других контейнеров. Контейнер всегда прижимается к самому верху свободной области по вертикали и к ближайшему левому краю сетки по горизонтали.

Настройка для разных размеров экрана

Удобство просмотра отчета будет зависеть от экрана, на котором его просматривают.

Для того, чтобы обеспечить максимальное удобство просмотра на разных типах экранов, создана специальная ручная настройка расположения контейнеров в отчете для разных типов экрана. Эта настройка доступна в режиме «Конструктор»:

Можно установить настройки для шести типов экрана:

• экран мобильного телефона;
• экран смартфона;
• горизонтальное расположение на экране смартфона / планшета;
• экран планшета / ноутбука;
• экран компьютерного монитора;
• для широкоформатных мониторов с шириной более 1600 пикселей.

Для настройки расположения контейнеров нужно последовательно выбрать все шесть вариантов экрана и расположить-скомпоновать контейнеры для максимально удобного восприятия информации пользователем. Можно менять контейнеры местами, менять их размер и соотношение высоты и ширины. Если контейнеров в отчете много, то для каждого типа экрана можно будет прокручивать поле экрана по высоте. При выборе варианта экрана, пропорции доступного для расположения контейнеров поля соответствуют выбранному варианту:

Для упрощения настройки компоновки дашборда для разных разрешений экрана разработан «Ассистент компоновки дашборда», он автоматически размещает компоненты дашборда для разрешений экрана (брейкпойнтов), не настроенных пользователем. Но после изменения положения или размеров любой из панелей «Ассистент компоновки дашборда» для выбранного брейкпойнта отключается. Для измененных / настроенных пользователем брекпойнтов выводится признак «галочка».

Правила авто-компоновки учитывают приоритет и размер для каждого типа компонента:

После окончания настройки вариантов расположения отчета, нажмите кнопку «Сохранить» и перейдите в режим просмотра (кнопка «Просмотр»). В режиме просмотра можно проверить удобно ли настроены представления в отчете. Для этого плавно изменяйте размер окна браузера для имитации разных пропорций экрана пользователя и убедитесь в правильности настройки внешнего вида. При необходимости можно вернуться в режим конструктора и внести изменения в настройку.

Для выхода из режима настройки для определенного типа экрана, нажмите на иконку выбранного экрана еще раз, и вернетесь в обычный режим настройки.

4.7 - Инструкция по изменению стилей CSS

Для изменения стиля компонентов отчёта и их отдельных элементов можно использовать встроенную возможность написания и применения пользовательских стилевых инструкций CSS.

Чтобы перейти в настройки CSS дашборда необходимо перейти в режиме редактирования дашборда в меню редактирования «Редактировать отчет» в верхнем левом углу экрана и в открывшейся форме открыть форму CSS.

Для надёжного определения местоположения стилизуемого элемента отчёта в HTML-коде страницы, а также наименования его селектора CSS проще всего воспользоваться встроенными возможностями браузера. Для этого необходимо на странице отчёта открыть встроенный в браузер отладчик кода. Как правило отладчик вызывается нажатием клавиши «F12», либо сочетания клавиш «Ctrl» + «Shift» + «i», либо через меню «Настройки» / «Инструменты разработчика».

Откроется отладчик. Рассмотрим поиск элемента отчёта на примере отладчика Google Chrome.

В левом верхнем углу отладчика можно видеть пиктограмму со стрелкой, при наведении на которую, появляется подсказка о возможности инспектирования кода выбираемых на экране элементов.

После нажатия пиктограммы браузер предоставляет возможность визуально выбрать элемент отчёта наведя на него курсор и кликнув левой клавишей мыши. При этом в окне отладчика будет подсвечено место в коде HTML, где располагается выбранный элемент.

Как видим, после клика по элементу подписей шкалы диаграммы в HTML-коде оказался подсвечен тег <TSPAN\>, расположенный внутри тега <TEXT\>, имеющего имя класса amcharts-axis-label.

Также видно, что таким именем класса обладают все подписи шкалы диаграммы. Запомним его.

Если мы хотим, например, изменить цвет всех подписей шкалы на всех диаграммах отчёта, то можно сразу написать стилевое правило CSS и сохранить его в блок пользовательских стилей отчёта:

.amcharts-axis-label > TSPAN{
    fill:#FF0000
 }

Стоит обратить внимание, что тег <TSPAN\> относится не элементам HTML, а к элементам SVG, поскольку диаграмма представляет из себя SVG-изображение. Поэтому для раскраски подписей мы не можем применить здесь свойство color:#FF0000 как это принято в HTML, а должны использовать свойство fill: #FF0000, меняющее цвет заливки текста внутри тега <TSPAN\>.

Подробнее о тегах SVG и их свойствах можно прочесть тут: https://developer.mozilla.org/en-US/docs/Web/SVG/Element

Если же нам необходимо более индивидуально адресовать стиль, например только для верхней диаграммы, тогда необходимо выяснить имя класса, принадлежащее контейнеру диаграммы.

Для этого снова идём в отладчик браузера и снова нажимаем пиктограмму поиска элемента на экране. Затем выбираем нужную нам диаграмму на экране.

В данном случае видно, что подсветился элемент с классом componentBody, принадлежащий нужной нам панели с диаграммой. Если посмотреть дерево элементов, внутри которого находится подсвеченный элемент, то видно, что панель диаграммы имеет ID «panel_8», а внутри него ещё один контейнер с ID «container_8». Для адресации нашего стиля можно использовать любой из них.

Изменим написанное ранее стилевое правило так, чтобы адресовать его диаграмме в панели 8:

#panel_8.amcharts-axis-label > TSPAN  {
fill:#FF0000
 }

Обратите внимание, что по правилам CSS обращение к элементам по ID осуществляется при помощи символа # (решётка), а обращение по имени класса при помощи точки «.».

Символ > означает, что тег \<TSPAN\> находится сразу внутри элемента с классом amcharts-axis-label. Таким образом теперь наше стилевое правило применено лишь к подписям диаграммы, находящейся в панели 8:

Схожим способом можно адресовать пользовательские стилевые правила практически любым элементам страницы отчёта.

Подробнее о правилах написания CSS можно прочесть в руководстве по основам CSS: https://html5book.ru/osnovy-css/

4.8 - Замена наборов данных

Функционал «Замена наборов данных» предназначен для быстрой замены в отчете одного набора данных на другой без необходимости настраивать каждый компонент отдельно.

Перед использованием механизма замены наборов данных рекомендуется выполнить копию дашборда.

Для использования функционала необходимо подготовить конечный набор данных, который нужно установить в отчет. Перед переносом, убедитесь, что типы данных полей для переноса между наборами соответствуют друг другу.

После подготовки набора данных необходимо перейти в отчет в режим редактирования и нажать на кнопку «Замена наборов данных в отчете». В выпадающем списке кнопок будет доступна кнопка «Редактировать».

При нажатии на «Редактировать» откроется интерфейс «Замена наборов данных».

В интерфейсе представлены элементы:

1. слева представлен список используемых наборов данных в отчете;
2. справа представлена часть интерфейса, где выполняется сопоставление полей наборов данных; В выпадающем списке необходимо выбрать набор данных, на который будет заменен существующий.

Поля наборов данных необходимо сопоставить между собой, используя drag-n-drop.

После окончания настроек замены набора данных, нажать на «Сохранить». Перед сохранением отчета необходимо опять нажать на «Заменить наборы данных отчетов».

Теперь доступно 3 кнопки: «Редактировать»,«Применить», «Удалить».

• «Редактировать» – открывает интерфейс «Заменить набора данных отчетов»;
• «Применить» – обновляет отчет и применяет новый набор данных. Для сброса настроек необходимо выйти из режима редактирования, не сохраняя отчет;
• «Удалить» – удаляет созданные настройки замены данных.

Вычисляемые поля не переносятся. поэтому после замены набора данных их необходимо проверить и при необходимости перенести вручную

4.9 - Экспорт отчёта

Порядок действий для экспорта

При работе с отчетами нередко возникает задача экспортировать и сохранить отчет, конкретную диаграмму или данные в файлы. Это требуется при составлении презентаций; сохранении информации на определенный момент / с определенными фильтрами; работы с данными в Excel или использовании данных в других отчетах.

Для экспорта отчета необходимо в режиме просмотра в правом верхнем углу нажать кнопку «фотоаппарат». Далее требуется выбрать вариант экспорта («Экспорт отчёта» или «Экспорт компонента») и опции для выбранного варианта:

Вариант 1: экспорт всего отчета. Доступные форматы – JPEG, PNG, PDF:

Вариант 2: экспорт компонента отчета. Далее выбрать нужный компонент (диаграмма, таблица и так далее) выделив его и щелкнув на нем мышью, затем выбрать - формат: Excel, JPEG, PNG:

При выборе экспорта в Excel, данные, которые используются при построении диаграммы экспортируются в виде простой таблицы. В качестве заголовков используются псевдонимы полей, в случае, если псевдоним не задан, то используются названия полей.

Особенности экспорта таблицы в Excel-файл:

• числовые значения выводятся с учетом заданной в настройках компонента точности;
• выводятся строки итогов и подитогов (если их вывод настроен для таблицы);
• в «xlsx»-файл экспорта выводится заголовок компонента и значения фильтров. При этом Если для отчета нет «xlsx»-шаблона, то заголовок выводится в 1-ую колонку 1-ой строки, фильтры - в первую колонку второй строки.

Установка шаблона для экспорта таблиц в Excel

При экспорте таблиц в Excel для отчета в виде таблицы дополнительно возможно настроить выгрузку данных в подготовленный заранее пользователем шаблон «xlsx»-файла. В шаблоне пользователь может настроить оформление выгружаемого отчета: заголовок, шапку отчета, ширину колонок и высоту строк, размер и цвет шрифта, условное форматирование ячеек.

Файл шаблона «xlsx»-файла загружается в режиме конструктора. Для загрузки выполните следующие действия:

1. В режиме «Конструктора» выбрать интересующую таблицу;
2. Зайти в конструктор компонента;
3. В разделе «Основные настройки» в настройке «Шаблон экспорта» нажать кнопку «Загрузить»;
4. Выбрать заранее подготовленный файл и сохранить его. В настройке «Шаблон экспорта» отразится название файла:

Кнопка «Сбросить» удаляет шаблон.

Кроме того, шаблон можно привязать к уровню детализации. Если заполнен шаблон экспорта, то возможно выбрать для какого уровня дрилла (какой категории) будет применяться шаблон при экспорте в Excel.

Правила создания шаблона следующие:

• значащие столбцы должны начинаться с первого столбца на листе;
• повторяющаяся строка таблицы в шаблоне должна быть последней непустой строкой в файле шаблона;
• количество столбцов шаблона должно совпадать с количеством столбцов в отчете.

В шаблоне возможно задать ячейки и формат для вывода заголовка и значений фильтров, используя переменные (наименования переменных вводить в фигурных скобках):

• {Title} — для вывода заголовка;
• {Filter} — для вывода значений фильтров.

Пример настройки шаблона:

Результат — вывода с использованием шаблона с заголовком и фильтрами:

Если пользователь не выбрал шаблон, то экспорт будет осуществляться в xlsx-фалы в виде простой таблицы с названиями столбцов (названия колонок в таблице отчета).

Изменение формата даты при выгрузке в Excel

По умолчанию, при выгрузке полей с типом дата в Excel, они представлены в формате timestamp. Например, дата “01.01.2020” будет отображаться как “01.01.2020 00:00:00.000”.

Для изменения формата выгружаемых полей, выполните следующие шаги:

1. Перейдите в конструктор таблицы: Здесь вы найдете все настройки, связанные с вашей таблицей.
2. Откройте настройки колонок: В этом разделе вы можете управлять настройками каждой колонки в вашей таблице.
3. Выберите колонку с типом дата: Найдите и выберите колонку, которую вы хотите выгружать в другом формате.
4. Измените форматирование: В разделе “Форматирование” выберите требуемый формат из выпадающего списка.

После выполнения этих шагов, при следующей выгрузке в Excel, поле даты будет выгружаться в выбранном вами формате. Это позволит вам легче работать с данными и улучшит читаемость вашего файла Excel.

4.10 - Перенос отчетов и наборов данных между порталами

Для копирования отчетов между порталами сначала нужно экспортировать отчеты. Для этого перейдите в режиме «Администрирование» в раздел «Отчеты» и нажмите кнопку «Экспорт»:

В открывшемся списке групп отчетов и отчетов отметьте нужные и нажмите кнопку «Экспортировать». В выбранное место на диске пользователя будет сохранен файл «exported_reports.json»:

Далее нужно импортировать отчеты на другой портал. Для этого в разделе «Отчеты» режима «Администрирование» на другом аналитическом портале нажмите кнопку «Импорт» (см. первый рисунок).

Выберите файл, получившийся в результате экспорта отчетов «exported_reports.json»). В открывшемся списке групп отчетов и отчетов отметьте нужные (см. рисунок выше и рисунок ниже) и нажмите кнопку «Импортировать»:

Отчеты будут импортироваться вместе с созданием необходимых для их работы наборов данных. От пользователя требуется обеспечить наличие исходных данных для этих наборов в базе данных источника этого аналитического портала. В противном случае в импортированном отчете не будет данных.

Ознакомиться со списком необходимых наборов данных и их структурой можно, нажав на кнопку «Изменить» в строке отчета (см. два предыдущих рисунка). Откроется окно настройки данных отчета:

В верхней части формы расположен список использованных в отчете наборов данных. При щелчке мыши по строке набора в нижней части формы отобразятся его поля с указанием используются они в отчете (выделены зеленым цветом) или нет (выделены розовым цветом).

Если на аналитическом портале — приемнике отчетов нет наборов данных с такими названиями, но есть аналогичные наборы, то привязку к набору можно изменить перед импортом. Основное условие работы отчетов после импорта — названия необходимых для отчета полей в новом наборе данных совпадают с названиями полей в старом наборе.

Изменить набор на имеющийся на портале-приемнике можно следующим образом:

• выбрать нужный драйвер (при необходимости) (см. рисунок выше, 1);
• выбрать источник данных (при необходимости) (см. рисунок выше, 2);
• выбрать набор данных (см. рисунок выше, 3);
• удостовериться, что в нем есть все необходимые поля (правая таблица, см. рисунок ниже, 4):

• если подходящего нового набора данных нет, то можно настройки вернуть к исходному состоянию и вернуться к ним позднее, для этого нажать кнопку (см. рисунок выше, 5).

После установки всех необходимых настроек, нажмите кнопку «Применить».

5 - Настройки визуализаций

5.1 - Общие настройки визуализаций

5.1.1 - Кнопка отправки HTTP-запросов

«Кнопка» является модификацией элемента «Панель с закладками».

1. Позволяет отправлять http-запросы.
2. Поддерживает методы:

• POST;
• GET;
• PUT;
• PATCH;
• DELETE.

3. Предусмотрена возможность использовать значения фильтров в качестве параметров запроса.
4. Предусмотрена кнопка подтверждения отправки запроса с возможностью отправки текстового комментария.

Выбор и настройка элемента «Кнопка»

Чтобы создать «Кнопку» в отчете, нужно:

• зайти в отчет на аналитическом портале;
• перейти в режим конструктора (см. рисунок ниже, 1);
• зайти в меню настройки элемента (см. рисунок ниже, 2);
• в открывшемся окне настройки элемента выбрать тип отображения — «Панель закладок» (см. рисунок ниже, 3);
• перейти во вкладку действие кнопки (см. рисунок ниже, 4)
• выбрать из выпадающего списка Отправка запроса (см. рисунок ниже, 5);
• выбрать тип запроса (см. рисунок ниже, 6);
• включить флаг «подтверждение при отправке» (см. рисунок ниже, 7);
• добавить URL (см. рисунок ниже, 8);
• заголовки запроса (см. рисунок ниже, 9);
• тело запроса (см. рисунок ниже, 10);
• нажать кнопку «Сохранить» (см. рисунок ниже, 11) для сохранения настроек:

Детальная настройка кнопки

В действие кнопки имеются поля, которые необходимо настроить для корректной работы «кнопки»:

• «Тип запроса» — позволяет выбрать метод запроса из выпадающего списка;
• «URL запроса» — строка адреса, куда отправляется запрос;
• «Заголовки запроса» — позволяют клиенту и серверу отправлять дополнительную информацию;
• «Тело запроса» — непосредственно данные запроса.

Тип запроса:

• POST;
• GET;
• PUT;
• PATCH;
• DELETE.

URL запроса

В данную область вводится URL для взаимодействия с API:

Пример URL: https://api.telegram.org/bot{token}/{method}.

Заголовки запроса

В данную область, вводятся дополнительные параметры запроса

Пример заголовков:

[
   {
      "key":"Content-Type", 
      "val":"application/json; charset=utf-8"
   },
   {
      "key":"Accept-Encoding", 
      "val":"identity"
   }
]

Тело запроса

Данный блок заполняется данными, которые необходимо отправить в запросе

Пример тела запроса:

{    
     "startDate": "2020-12-31",
     "endDate": "2023-01-14",
     "comment" : "Комментарий"
}

Значения фильтров в качестве параметров запроса

Разработан механизм, позволяющий использовать значения фильтров в качестве параметров запроса. Необходимо сформировать ссылку на фильтр, путем написания наименования фильтра в двойных фигурных скобках {{Фильтр.Наименование Фильтра}}

1. Если изменяемый параметр должен быть в строке URL, непосредственно в строке URL необходимо добавить ссылку на фильтр:

https://api.telegram.org/bot{{Фильтр.Наименование Фильтра 1}}/{{Фильтр.Наименование Фильтра 2}}

2. Если изменяемый параметр должен быть в заголовках или теле запроса, к ключу добавляется ссылка на фильтр:

{
   "val_1": "{{Фильтр.Округ}}",
   "val_2": "{{Фильтр.Дата}}"
}

3. Если значение параметра даты требует форматирования, необходимо использовать маску даты, для этого после ссылки на фильтр добавляется символ >>, затем в квадратных скобках вводится формат даты.

Подробнее о форматах даты: https://learn.microsoft.com/ru-ru/dotnet/standard/base-types/custom-date-and-time-format-strings.

Пример:

   "val_3": "{{Фильтр.Дата>>[DD.MM.YYYY]}}"
   "val_4": "{{Фильтр.Дата>>[YYYY-MM-DD]}}"
   "val_5": "{{Фильтр.Дата>>[DD.MM.YYYY HH:mm:ss]}}"

4. Если значение параметра даты является периодом, т.е в фильтре используются даты начала и конца этого периода, необходимо использовать дополнительные обозначения к наименованию фильтра. Через точку добавляется признак Начало или Окончание периода, которые соответствуют значениям фильтра.

Пример:

   "val_6": "{{Фильтр.Дата.Начало}}"
   "val_7": "{{Фильтр.Дата.Окончание]}}"

Подтверждение отправки запроса

Для предотвращения случайных нажатий, реализован механизм подтверждения отправки запроса, который активируется одноименным флагом. Так же предусмотрена возможность включить опцию Комментарий, который может быть интегрирован в тело запроса, путем добавления ссылки на это поле {{comment}}.

Пример:

   "val_6": "{{Фильтр.Дата.Начало}}"
   "val_7": "{{Фильтр.Дата.Окончание]}}"
   "val_8": "{{comment}}"

Пример использования связки Аналитический портал — Modus ETL

Для интеграции аналитического портала и Modus ETL в последнем должны быть произведены настройки позволяющие принимать HTTP-запросы (ссылка на статью TO BE).

В Modus ETL необходимо добавить учетную запись с правами администратора, которая позволит производить запуск составов выгрузки, сценариев и пакетов непосредственно из аналитического портала.

В URL для отправки запросов необходимо добавить учетные данные ETL, затем через @ адрес сервера, где развернут ETL, далее по шаблону указанному в инструкции (ссылка на статью TO BE):

http://[login]:[password]@[Адрес публикации]/hs/object/run

Заголовки и тело запроса заполняются согласно инструкции (ссылка на статью TO BE).

5.1.2 - Логирование действий пользователя

Журнал просмотра отчетов пользователями

Действия пользователей в системе логируются. Данные из лога работы возможно получить из набора данных «Лог работы».

На основании этого набора, используя конструктор, можно построить разнообразные отчеты, характеризующие работу пользователей — вывести информацию работы пользователей по дням, топ-10 самых популярных отчетов, топ-10 самых активных пользователей.

Для примера ниже приведен отчет «Журнал действий пользователей»:

Журнал содержит информацию по пользователям, датам / времени, отчетам, действиям с возможностью анализа по фильтрам: «пользователи», «дата», «действия». Переключая и настраивая различные фильтры, есть возможность получить более детальную информацию по действиям пользователя за определенный период.

5.1.3 - Настройка и использование общих фильтров и категорий

Для одновременной фильтрации данных во всех визуальных представлениях (компонентах) отчета, в которых эти фильтры существуют, используют общие фильтры.

К настройке общих фильтров следует переходить после настройки одинаковых фильтров в более чем одном визуальном представлении в отчете.

Настройка общих фильтров для нескольких представлений отчета

Откройте панель «Фильтры и переключения» и установите нужные настройки:

1. общий фильтр», если включить будет влиять на все диаграммы, в которых этот фильтр есть и не установлен флаг «Локальный»;
2. «Тип фильтра»: по значению / диапазонный;
3. «Автофильтр» — при изменении данных будет автоматически выбираться максимальное или минимальное значение;
4. «Зависит от» — список выводимых значений будет зависеть от значений другого общего фильтра в этом отчете (фильтра-родителя), т.е. после выбора значения в фильтре-родителе список значений подчиненного фильтра будет предварительно отфильтрован. Зависимость можно установить как от одного фильтра, так и от нескольких:

5. «Сброс» — позволяет включить/отключить функцию сброса значений зависимого фильтра при изменении значений фильтра-родителя. Если опция сброса отключена, то пользователю придется контролировать, что значения в фильтре-родителе и подчиненном фильтре не будут взаимоисключающими;
6. «Значение при сбросе» — опция работает при включенной настройке «Сброс». При изменении настройки фильтра-родителя будут сброшены значения зависимого фильтра и либо не выбрано значение (вариант «все значения») или установлено минимальное (первое в списке по возрастанию) из подходящих значений (этот вариант используется, если в фильтре обязательно должно быть установлено какое-то значение);
7. «Сортировка по другому полю» (например, для периода, когда в фильтре выводится название периода, а сортировка производится по дате начала периода);
8. «Направление сортировки» — по возрастанию / по убыванию;
9. «Основной датасет» — если на дашборд выводятся данные из нескольких наборов данных и поле, используемое в фильтрах присутствует более чем в одном наборе данных, то для однозначности фильтрации данных возможно выбрать набор данных, на основании которого фильтр будет заполняться значениями. Это важно, например, когда наборы данных не синхронизированы - для общего фильтра в таком случае рекомендуется выбрать набор данных со значениями поля фильтра, которые присутствуют во всех наборах данных, используемых в дашборде;
10. «Доп. информация» — при включенном флаге позволяет просмотреть список компонентов, в которых используется данный фильтр.

Загрузка данных в отчёте по кнопке «Применить»

У пользователей есть возможность настроить отображение отчёта так, чтобы данные отображались только после выбора фильтров. Это значит, что при открытии отчёта на компонентах визуального отображения сначала не будут отображаться никакие данные, а появятся они там после выбора фильтров и нажатия на кнопку «Применить» в разделе «Фильтры общие» на панели общих настроек:

Для того, чтобы включить / выключить функцию загрузки данных по кнопке «Применить»:

1. перейдите в режим конструктора (путем нажатия «шестерёнки» на панели управления);
2. откройте панель общих настроек (путем нажатия «воронки» на панели управления);
3. в разделе «Фильтры общие» включите функцию «Загрузка данных после нажатия на кнопку «Применить»», установив флаг «Вкл.»/«Выкл.»:

Настройка диапазонных фильтров

Если требуется установить фильтр не по дискретным значениям из списка, а с использованием интервала значений, нужно выбрать тип фильтра «По диапазону» и установить условия отбора с использованием операторов сравнения или оператора like (в интерфейсе «~»), что обозначает «Содержит».

• Фильтр — условие like (в интерфейсе «~»), при этом условии отображаются строки, поля которых содержат искомую подстроку.

• Фильтр с двумя условиями: « > X > ».

Для настройки фильтра с двумя условиями выберите указатель «Количество условий», для каждого условия нужно выбрать оператор сравнения и установить значение (см. рисунок ниже). По умолчанию эти два условия работают с логическим оператором «И» (отбираются строки, в которых выполняются оба условия), но можно включить оператор «ИЛИ», тогда будут отбираться строки, в которых выполняется хотя бы одно из условий:

Использование общих фильтров

Переключение общих фильтров производится в режиме просмотра отчета:

Для переключения общих фильтров:

1. Откройте панель общих настроек (путем нажатия «воронки» на панели управления);
2. В разделе «Фильтры общие» выберите необходимый фильтр и установите нужные значения;
3. Нажмите «Применить».

После выполненных действий во всех представлениях отчета, в которых выбранная фильтры существует, данные отфильтруются.

Если в отчете для фильтров, определенных как общие, настроены специальные представления в виде панели фильтров, то для установки значений фильтров можно пользоваться ими, без перехода в панель общих настроек.

Примечание: в разделе «Фильтры общие» на панели общих настроек некоторые фильтры могут подсвечиваться серым цветом и для них будет невозможен выбор значения на данной панели:

Это значит, что выбор значения для данного фильтра настроен в отдельном визуальном компоненте отчёта — «Контейнер с фильтрами» (см. раздел Настройка контейнера с фильтрами).

Сохранение набора фильтров

У пользователя аналитического портала есть возможность запомнить выбранные фильтры, сохранив их в наборы фильтров, чтобы в последующем быстро применять необходимые фильтрации в отчётах.

Для того, чтобы сохранить выбранные в данный момент значения фильтров необходимо нажать на иконку:

«Сохранить НФ» в левом верхнем углу отчёта и ввести имя для этого набора.

Для того, чтобы выбрать сохранённый набор фильтров необходимо нажать на иконку:

«Открыть НФ» в левом верхнем углу отчёта и выбрать необходиый набор из выпадающего списка.

Для того, чтобы сохранить / изменить / удалить набор фильтров необходимо перейти в панель общих настроек (путем нажатия «воронки» на панели управления). В разделе «Наборы фильтров» можно в выпадающем списке выбрать необходимый для изменения набор фильтров, изменить его имя и настроить очерёдность отображения в выпадающем списке при выборе набора. Чтобы изменения вступили в силу надо нажать на кнопку «Обновить», чтобы удалить выбранный набор фильтров на кнопку «Удалить»:

Настройка и использование общих категорий

Создание общих категорий вызвано потребностью одновременно переключать разрезы данных во всех представлениях отчета, в которых переключаемые разрезы существуют.

Настройка общих категорий

Для активации функции «Переключения общих категорий» выполните следующие действия:

1. перейдите в режим конструктора (путем нажатия «шестерёнки» на панели управления);
2. откройте панель общих настроек (путем нажатия «воронки» на панели управления);
3. в разделе «переключения общие» включите функцию, установив флаг «Вкл.»;
4. выберите из выпадающего списка те категорий, которые должны использоваться как общие (путем проставления флагов «✓»);
5. нажмите «Применить».

После этого в режиме просмотра появится возможность переключения выбранных общих категорий.

Переключение общих категорий

Переключение общих категорий производится в режиме просмотра отчета:

Для переключения общих категорий:

• откройте панель общих настроек (путем нажатия «воронки» на панели управления);
• в разделе «Переключения общие» выберите необходимую категорию из выпадающего списка;
• нажмите «Применить».

После выполненных действий во всех представлениях отчета, в которых выбранная категория существует, она изменится.

5.1.4 - Настройка и использование производного фильтра

«Производный фильтр» — это опция в настройках контейнера с фильтрами, которая позволяет решить узкоспециализированную задачу по настройке фильтрации данных в отчете с последовательными цепочками значений:

Использование производного фильтра

Например, «Производный фильтр» может быть использован при работе с цепочками поставок продукции от производителя к потребителю. «Производный фильтр» позволяет получить последовательность звеньев от первого звена до звена с выбранным значением фильтра (все, что слева от выбранного значения). Также он позволяет получить последовательность звеньев после выбранного значения (звенья справа от выбранного значения). Чтобы «Производный фильтр» работал корректно, Набор данных должен содержать текстовое поле с иерархической последовательной цепочкой элементов с запятыми в качестве разделителей. Кроме того, Набор данных должен быть организован строго определенным образом (см. пример и пояснения ниже).

Исходные данные

Производный фильтр требует предварительной настройки отображения в исходных данных:

Для того, чтобы фильтр работал, в исходных данных необходимо иметь следующие столбцы:

• «Столбец с указанием значения всей цепочки», где звенья в установленной иерархии перечислены через запятую («path);
• «Столбцы со значениями звеньев цепочки», в которых раскрыта иерархия («producer_brand», «dealer», «showroom», «customer»);
• «Столбец исходного фильтра», который дублирует последнее значение цепочки в столбце «path» на каждом уровне иерархии;
• «Столбец производного фильтра», который дублирует значения столбца исходного фильтра.

Настройка фильтра в отчёте

• «Таблица» для отображения цепочки поставок до выбранного значения фильтра (подробнее см. раздел Настройка табличного представления). Эта таблица должна иметь столбцы исходного набора данных описанные выше на полках «Значения» и производный фильтр («proizvodnii_filter») на полке «Фильтры»:

• «Таблица» для отображения цепочки поставок после выбранного значения фильтра. Эта таблица должна иметь столбцы исходного набора данных описанные выше на полках «Значения» и «path» на полке «Фильтры»:

• «Контейнер с фильтром» (подробнее см. раздел Настройка контейнера с фильтрами), в котором на полке «Фильтры» будет находиться исходный фильтр («ishodnii_filter»), в котором необходимо включить опцию «Производный фильтр» и выбрать столбец производный фильтр («proizvodnii_filter») в «Поле производного фильтра», а также «path» в «Списковое поле»:

• «Контейнер с фильтром», в котором на полке «Фильтры» будет находиться производный фильтр («proizvodnii_filter»). Тут настраивать что-то дополнительно не требуется:

• «Контейнер с фильтром», в котором на полке «Фильтры» будет находиться цепочка «path». Тут настраивать что-то дополнительно не требуется:

Важно: после настройки всех контейнеров необходимо в режиме конструктора открыть панель фильтров при помощи нажатия на «воронку» в правом вернем углу отчёта и установить плашку «Вкл.» для всех выбранных фильтров:

В итоге отчёт должен выглядеть примерно так:

Теперь при выборе значения исходного фильтра в соответствующем контейнере в таблицах будут отображаться цепочки до выбранного значения и цепочки после:

Контейнеры с производным фильтром и цепочкой будут при этом заполнены автоматически.

5.1.5 - Настройка линии тренда и отсечки

Настройка линии тренда

Линия тренда позволит отобразить тенденцию изменения значений на графике.

Линия тренда может быть включена для диаграмм: линейная, столбчатая, площади. Линия тренда включается / выключается в настройках в разделе «Стиль элементов»:

Настройка линии отсечки

На диаграммах линейная, столбчатая, площади можно выводить линии минимума, максимума или среднего. Кроме того, возможно добавить на диаграммы дополнительно еще другие линии отсечек:

Для настройки надо перенести на полку «Значения» числовое поле с костантой и выбрать Тип пилюли «Отсечка»:

На диаграмме в качестве подписи линии отсечки буде использовано «Имя поля».

5.1.6 - Настройка перехода между отчетами

Для перехода из отчета на другой отчет или произвольную ссылку используется настройка «Переход в другой отчет».

Настройка ссылки и текста всплывающей подсказки:

• «Выберите отчет» — позволяет выбрать отчет из выпадающего списка (отчет должен быть создан заранее);
• «URL ссылки» — заполняется автоматически из выбранного отчета;
• «Текст ссылки» — всплывающая подсказка;
• «Открывать в» — позволяет выбрать вид открытия ссылки при переходе («Той же вкладке» / «Новой вкладке»);
• «Правило передачи значений фильтров при переходе в другой отчет». При переходе в другой отчет передаются общие фильтры для отчета и фильтры компонента, из которого осуществляется переход:

Вернуться в исходный отчет можно стандартными средствами браузера (кнопка со стрелкой назад) или настроить в отчете аналогичный переход в отчет, из которого был осуществлен переход.

5.1.7 - Настройка «Стилизация» или «Стиль элемента»

Стилизацию можно настроить для каждой категории данных индивидуально. Категория для настройки устанавливается в поле «Объект данных». После окончания настройки для одной категории, переходите к другой и устанавливайте для нее нужные настройки.

Эта возможность используется в случае, если нужно установить смысловые цвета и настройки. Например, если в одном отчете на разных представлениях используются одни и те же исходные данные, и они образуют одни и те же категории. Тогда удобно, если во всех представлениях одна и та же категория отображается одинаковым цветом. Другой пример, если нужно показать, что какие-то данные хорошие — цвет зеленый, а другие плохие — цвет красный.

Ручные настройки цвета, линий и маркеров также могут выражать индивидуальные предпочтения пользователя. Подробно о настройках этой группы смотрите в таблице ниже.

Выбор цвета для всех элементов диаграмм (фон, линии, рамка, надпись, легенда) происходит из цветовой палитры:

На цветовой палитре можно выбрать цвет из предлагаемых рядов или ввести номер цвета. В выбранном цвете можно настроить интенсивность и прозрачность.

Таблица

Настройка	Описание
Подгруппа «Объект данных»
Сглаживание графика
Тип визуализации (столбцы, линии, площади)
Авто-раскраска категорий
Основной цвет	Цвет по контуру фигуры
Цвет заливки	Цвет внутри фигуры, для линии он замещает и основной цвет
Группа «Линии»
Толщина линии (толщину линии можно убрать до 0 и включить маркеры)
Цвет линии	Можно изменить цвет линии
Группа «Маркеры»	Можно дополнить линии маркерами, т.е. отметками на границах отрезков
Группа «Линии»	Аналогично настройке для линии

Для диаграмм столбчатой, линейной и площади иерархия настроек стиля содержит три уровня:

Основной стиль является общими для всех визуализаций оси «Значения» и «Серии». Переопределить стиль для конкретного элемента можно во вкладке «Стиль элементов».

5.1.8 - Настройка перехода между уровнями детализации данных/дрилла

Дрилл — это изменение детализации данных. Для указания параметров для группировки данных для разных уровней детализации, нужно настроить уровни дрилла.

Уровни дрилла выбираются из установленных категорий:

Количеством уровней можно управлять при помощи кнопок «Добавить уровень», «Удалить уровень».

При настроенных уровнях детализации на диаграмме появляются специальные управляющие элементы для перехода между уровнями:

Дрилл может осуществляться двумя способами:

• дрилл с передачей фильтра — позволяет отобразить информацию на уровень ниже по выбранному элементу;
• дрилл без передачи фильтра — позволяет отобразить информацию на уровень ниже по всем элементам.

Детализация с передачей значения фильтра

Для перехода к нижележащему уровню на диаграмме с передачей фильтра нужно нажать на элемент диаграммы (например, для гистограммы это прямоугольник, для круговой диаграммы часть круга). Диаграмма перейдет на более детальный уровень с отбором по выбранному элементу верхнего уровня. Для возврата достаточно нажать на управляющий элемент «Стрелка вверх»:

Для перехода к нижележащему уровню на диаграмме без передачи фильтра нужно выбрать указатель «Стрелка вниз» в правом верхнем углу компонента. Диаграмма отобразит элементы, лежащие на уровне ниже без передачи фильтра:

Для каждого поля на полке значений возможно настроить на каком уровне детализации оно будет выводиться. Такие настройки доступны для компонентов «таблица» и «гистограмма».

Для настройки нужно нажать стрелочку на «пилюле» на полке «Значения» и выбрать из выпадающего списка «Уровень дрилла» (см. рисунок выше, 1) одну или несколько категорий (уровней дрилла), для которых выводить поле.

Если для поля настроен уровень дрилла, то это отображается для «пилюли» оранжевой стрелочкой (см. рисунок выше, 2). Если для поля не настроено, то поле выводится для всех уровней дрилла.

Детализация с фильтром на карте

Для перехода к нижележащему уровню на карте с передачей фильтра нажать на элемент карты. Карта приблизится (если настроен параметр «Автонаведение») и покажет элементы, лежащие на уровень ниже, и определенные для них значения. Для возврата достаточно нажать на управляющий элемент «Стрелка вверх»:

Для перехода к нижеследующему уровню на карте без передачи элемента в фильтр нужно выбрать указатель «Стрелка вниз» в правом верхнем углу компонента. Карта отобразит элементы, лежащие на уровне ниже без передачи фильтра:

Детализация с фильтром в таблице

Для перехода к нижележащему уровню с передачей фильтров в табличном представлении нажать на элемент таблицы. Отобразится таблица с данными следующего уровня детализации и с выбранным фильтром. Для возврата достаточно нажать на управляющий элемент «Стрелка вверх»:

Для перехода к нижележащему уровню без передачи фильтров нужно выбрать указатель «Стрелка вниз» в правом верхнем углу компонента. Таблица отобразит элементы, лежащие на уровне ниже без передачи фильтра:

5.1.9 - Настройка представления внутри отчета

Настройка отчета в режиме «Конструктор» предполагает несколько основных шагов:

• «Выбрать набор данных» — набором определяются исходные данные, которые представляют собой плоскую таблицу;
• «Выбрать внешний представления данных» — выбором типа диаграммы определяется не только внешний вид представления, но и набор «Полок» для размещения данных, поэтому выбрать тип диаграммы нужно на этом этапе (рисунок ниже, слева):

• «Расположить нужные поля из набора данных в областях настройки представления («полках»)» — поля размещаются простым перетаскиванием при помощи мыши, назначение каждой полки будет подробно рассмотрено для каждого типа диаграммы;
• «Настроить правила агрегации, сортировки, отбора» — так как исходные данные представляют собой плоскую таблицу, для правильного отображения нужно сделать требуемые дополнительные настройки данных;
• «Добавить вычисляемые поля» — вычисляемое поле дает возможность получить производные значения от имеющихся в исходном наборе данных. Настройка вычисляемого поля производится с использованием набора элементов формул или написанием формулы вручную;
• «Настроить внешний вид (подписи, оси, цвета и прочее)» — для каждой группы настроек разворачивается специальный интерфейс (см. первый рисунок по центру), подробнее о них в описаниях для каждого типа диаграммы:

• «Установить фильтры» — выбранные для фильтра поля размещаются на специальной «Полке», а для установки фильтров открывается специальный интерфейс (см. первый рисунок справа);
• «Установить переходы в другой отчет» или «настроить детализацию (дрилл)» для текущей диаграммы.

Интерфейс и компоновка управляющих элементов при настройке визуализации в контейнере

Экран в режиме «Конструктор» диаграммы разделен на несколько областей, каждая из которых имеет свое функциональное назначение. Внешний вид экрана для настройки отчета в режиме конструктора отражены на рисунках выше и ниже:

1. «1». Область заголовка. Здесь расположены название отчета и название компонента, а также кнопки «Сохранить» и «Отмена».
2. «2». Область набора данных. В списке показаны поля выбранного набора.
3. «3» и «4». Область настройки представления». При нажатии на иконки выбора шага настройки в области «4» изменяется набор настроек в области «3»: выбор типа (см. первый рисунок, слева), настройка выбранного компонента (см. первый рисунок, по центру), настройка фильтров (см. первый рисунок, справа).
4. «5». Область связи набора данных и представления» — размещая поля набора на «Полках», можно настроить как будут выводиться данные в представлении.
5. «6». Область просмотра результата настройки.

Выбор набора данных внутри контейнера

Выберите набор данных из списка. Поля выбранного набора отобразятся ниже:

Все поля набора для удобства пользователя сгруппированы по типу данных, каждый тип данных помечен специальным значком:

• выбранный набор данных;
• строковые поля;
• поля типа дата;
• числовые поля;
• заготовка для создания вычисляемого поля.

Выбор визуального представления

Выбор визуального представления данных зависит от целей представления. Ответьте на вопрос, какую историю Вы хотите рассказать с помощью этой визуализации. И теперь попробуйте определить, какой шаблон визуализации лучше всего подойдет для этого. Например, распределение расходов по статьям бюджета можно отобразить на линейчатой диаграмме, а можно в виде «пирога» (круговой диаграммы), на котором сразу видно соотношение разных статей между собой. Для выбора лучшего варианта попробуйте несколько шаблонов, и выберите тот, который лучше всего передает основную идею.

Доступные представления открываются при нажатии кнопки. Перетащите мышью выбранное представление на поле отчета. После этого можно настраивать данные.

Основные настройки данных из набора для визуального представления

Для настройки расположения данных на диаграмме используются специальные управляющие элементы — «Полки», на которые простым перетаскиванием мыши можно разместить поля набора данных или созданное вычисляемое поле.

Каждая «Полка» имеет свое назначение. Для удобства пользователя назначение полки подписано на экране бледным шрифтом:

Полка «Значения» — полка для размещения результирующих значений. Если на этой полке располагается числовое поле, то значение будет подсчитываться в зависимости от выбранной функции агрегации. Если поле типа «строка», то доступны только функции подсчета количества значений, минимума и максимума. Значений может быть несколько. По умолчанию установлена настройка показа только одного значения, переключатель в положении «первое», но можно включить отображение всех значений, переключатель в положении «все». Порядок отображения значений будет зависеть от порядка их расположения на полке.

Полка «Категории» — категории определяют группировку (агрегацию) для значений. Например, по датам, по менеджерам, по месяцам. Группировок может быть несколько, расположение их на диаграмме зависит от вида диаграммы.

Полка «Серии» — позволяет сделать дополнительную группировку внутри группы «Категория». На диаграмме отображается несколькими значениями внутри одной категории, конкретное отображение значения зависит от выбранной визуализации. Использование серий можно включать и выключать, используя переключатель «вкл.».

Полка «Фильтры» — для размещения полей, которые будут использоваться в качестве фильтров. Для возможности настройки общих фильтров для нескольких представлений в отчете, в каждом представлении в качестве фильтра должно быть выбрано соответствующее общему фильтру поле. Если такое поле не выбрано в представлении, общий фильтр на это представление распространяться не будет.

Настройка правил агрегации, сортировки, отбора

Для детальной настройки поля данных на «Полке» нажмите стрелку вниз на «Пилюле» нужного поля, откроется список возможных настроек:

«Имя поля» — можно переименовать исходное поле из набора данных для сокращения названия или для лучшего понимания данных конечным пользователем. Также существует возможность использования одного и того же исходного поля для нескольких выходных полей с разными функциями агрегации. В этом случае обязательно дать выходному полю соответствующее смыслу уникальное имя.

«Сортировка» — можно выбрать сортировку по значению из вариантов:

• не сортировать (по умолчанию);
• по возрастанию;
• по убыванию.

Так же возможно указать порядок сортировки для нескольких полей. Причем сортировка может быть по любым полям, которые лежат на полках «Значения», «Категории», «Серии».

Функция агрегации — правило определения значения в группе («Категория»-«Серия»). Доступны следующие функции:

«-» — если функция не выбрана, то значение не агрегируется, а выводится весь список значений (используется в табличном представлении);

«AVG» — среднее значение (сокращенно от «average»), доступна для числовых полей;

«MIN» — минимальное значение (сокращенно от «minimum»), для полей любого типа;

«MAX» — максимальное значение (сокращенно от «maximum»), доступна для полей любого типа; устанавливается как функция по умолчанию для полей типов «строка» и «дата»;

«SUM» — сумма значений (сокращенно от «summa»), доступна для числовых полей; устанавливается как функция по умолчанию для полей числового типа;

«COUNT» — количество значений, доступна для полей любого типа;

«COUNTD» — количество уникальных значений (сокращенно от «countdistinct»), доступна для полей любого типа.

Настройка вычисляемых полей

Вычисляемые поля — это возможность получить производные значения от имеющихся данных. Для добавления вычисляемого поля перетащите его заготовку, выведенную в конце списка полей набора данных на «полку» значений. Возможно использовать вычисляемое поле и на «полках» категорий или серий. Задайте имя и переходите для настройки формулы вычисления при помощи кнопки «Редактировать»:

При настройке формулы можно перетаскивать на поле «Настройки» поля из набора данных, функции и действия (см. рисунки ниже):

Дополнительно можно вводить знаки с клавиатуры. Правила настройки формул соответствуют математическим вычислениям. Для настройки порядка вычислений, устанавливайте скобки. Дополнительно к функциям, выведенным в интерфейс, можно вводить с клавиатуры функции языка SQL. После ввода всей формулы, нажмите кнопку «Сохранить».

Возможен вывод вычисляемого поля как «Подзаголовка» диаграмм. Для этого выбрать «Тип» поля «Подзаголовок», в формуле вычисления ввести желаемое выражение.

Использование в вычисляемых полях переменных

В качестве переменных могут применяться элементы, размещенные на полках (категории, серии, фильтры, значения). Правила описания переменных в расчете:

• шаблоны для категорий, серий и значений — $Категория$, $Серия$, $Значение$;
• шаблон для фильтров — $Фильтр.ИмяФильтра.ИмяФункции()$.

Поддерживаемые функции: КоличествоЗначений(), Максимум(), Минимум(), Сумма().

Переменные удобно использовать, если на диаграмме настроена детализация, и расчет значений зависит от используемой категории. Например, на рисунке ниже показано отображение нарастающего итога по годам с детализацией по месяцам и пример использования шаблонов $Категория$ и $Серия$:

5.1.10 - Настройка фильтров внутри компонента визуального отображения

Полка «Фильтры» используется для размещения полей, которые будут использованы в качестве фильтров для настраиваемого компонента. Для того, чтобы выбрать фильтры необходимо перенести поле набора данных на полку «Фильтры»:

Чтобы фильтрация начала работать — нужно включить соответствующий фильтр в настройках общих фильтров (подробнее см. раздел Настройка и использование общих фильтров и категорий):

Работа фильтров настраивается в настройках общих фильтров, либо сделать локальным и, если необходимо настроить локальный фильтр для одного выбранного визуального компонента, то это можно сделать, нажав на стрелку вниз в пилюле на полке фильтров (см. рисунок выше) или нужно нажать на кнопку:

в правом верхнем углу и открыть специальный интерфейс настройки фильтров:

В данном интерфейсе есть следующие опции настройки фильтров:

• «Уровень отбора» — позволяет выбрать на каком уровне сработает фильтрация в многоуровневых SQL-запросах (Настройка уровня отбора может быть необходима в ситуациях, когда, например, требуется чтобы на одном визуальном компоненте для одного показателя набора данных применялся один фильтр, а для другого показателя набора данных применялся другой фильтр. В таком случае у показателя набора данных, размещённого на полке «Значения» необходимо установить соответсвующий уровень вычисления);
• «Выпадающий список значений» — из выпадающего списка значений поля данных можно выбрать одно или несколько значений, которые будут выбраны по умолчанию;
• «Тип фильтра» — необходим для выборки данных по значению / диапазону / сравнению;
• «Автофильтр» — помогает при изменении данных автоматически выбирать минимальное или максимальное значение;
• «Зависит от» — помогает настроить список выводимых значений, который будет зависеть от значений другого общего фильтра в этом отчете (фильтра-родителя), т.е. после выбора значения в фильтре-родителе список значений подчиненного фильтра будет предварительно отфильтрован. Зависимость можно установить как от одного фильтра, так и от нескольких;
• «Сброс» — позволяет включить / отключить функцию сброса значений зависимого фильтра при изменении значений фильтра-родителя. Если опция сброса отключена, то пользователю придется контролировать, что значения в фильтре-родителе и подчиненном фильтре не будут взаимоисключающими;
• «Значение при сбросе» — опция работает при включенной настройке «Сброс». При изменении настройки фильтра-родителя будут сброшены значения зависимого фильтра и либо не выбрано значение (вариант «все значения») или установлено минимальное (первое в списке по возрастанию) из подходящих значений (этот вариант используется, если в фильтре обязательно должно быть установлено какое-то значение);
• «Сортировка по другому полю» — необходима, например, для периода, когда в фильтре выводится название периода, а сортировка производится по дате начала периода;
• «Невидимый» — позволяет включить / отключить функцию отображения данного фильтра при настройке общих фильтров отчёта;
• «Локальный» — позволяет включить / отключить функцию фильтрации по значениям общего фильтра. Если опция локального фильтра включена, то изменения общего фильтра по выбранному полю не будут затрагивать данный визуальный компонент, благодаря этому, для отдельно выбранного компонента можно применить фильтрацию, которая не будет затрагивать другие компоненты.

5.1.11 - Объединение нескольких элементов в общий визуальный блок

В подсказке можно объединить несколько элементов в общий визуальный блок.

Для объединения нескольких элементов в общий визуальный ряд, вы можете использовать рамки компонента:

Для этого выполните следующие шаги:

1. включите опцию «Рамка компонента»;
2. настройте цвет и ширину рамки в соответствии с вашими предпочтениями;
3. увеличив ширину рамки до 4px, вы сможете создать эффект перекрытия соседних визуальных элементов;
4. если вы выберете одинаковый цвет рамки для соседних компонентов, они будут выглядеть как единый блок.

На примере, представленном ниже, фильтры (в желтом блоке), геоКарта (в салатовом блоке) и таблицы (в синем блоке) объединены в один визуальный блок:

В этом примере элементы выделены цветовыми блоками для наглядности и демонстрации объединения различных компонентов в один визуальный блок. Для объединения фильтров внутри одного компонента контейнера с фильтрами и управления необходимым количеством фильтров можно использовать следующий подход: компонент контейнера с фильтрами позволяет включать любое количество фильтров внутри себя, что обеспечивает более удобное и гибкое организовывание фильтрации данных в одном визуальном блоке.

5.1.12 - Отображение даты актуальности наборов данных на панели «Информация» дашборда

Для дашборда на панели «Информация» возможно отображать дату актуальности используемого набора данных. Пример отображения представлен на рисунке ниже:

Для этого необходимо выполнить следующие действия.

1. В хранилище создать специальную таблицу, в которой будет записываться информация по обновлению наборов данных. В ней обязательно должны быть поля с наименованием наборов данных и датой их обновления.
2. Заполнить таблицу по основным наборам данных.
3. Если для получения данных используется Modus ETL, то при обработке данных в сценарии последним предусмотреть шаг для обновления (UPDATE) поля, в котором будет храниться дата актуальности. Пример:

update [BI_НаборыДанных]
set ДатаАктуальности=GetDate()
where НаборДанных='ДОГМ(ЗП)'

4. Зайти на Аналитический портал с правами администратора и открыть режим «Администрирование», перейти в раздел «Наборы данных» и добавить набор данных с созданной выше таблицей.
5. Перейти в раздел «Настройки портала» и настроить «Источник дат обновления».

Для этого выбрать выше созданный набор данных (см. рисунок ниже, 1) и для него указать поле, содержащее наименования наборов (см. рисунок ниже, 2) и поле, содержащее даты актуальности (см. рисунок ниже, 3):

6. Открыть дашборд в режиме конструктора, открыть панель «Информации» [i] и выбрать «набор данных» (если на дашборде несколько наборов данных — выбрать ключевой / основной из них):

7. Сохранить сделанные изменения на дашборде.

5.1.13 - Дополнительно

Настройка отображения на диаграммах 2 оси

Использование второй (дополнительной) оси будет полезно в тех случаях, когда необходимо отобразить значения разной величины на одном графике. Например, увидеть и сопоставить на диаграмме численность населения района и площадь района в квадратных метрах.

Для этого необходимо:

1. разместить на полке «Значения» — несколько полей и включить переключатель «Все»;
2. в режиме «Конструктор» включить в «Общих настройках» параметр «Дополнительная ось значений»;
3. в разделе настроек «Стиль элементов» для «Объекта данных», выбрать поле / показатель, который должен быть изображен на дополнительной оси и выбрать тип оси «Дополнительная»:

Внести дополнительные настройки можно в разделе «Ось дополнительная».

Как результат, получается итоговая диаграмма с двумя осями:

Пользователь может управлять количеством и длиной подписей на осях диаграмм.

В настройках компонента «Ось Категории» подписи на шкале ограничены до шести символов. Названия осей выводятся по правилу «через две», т.е. каждая третья подпись:

Настройка статистики данных (экстремумов и среднего) для диаграмм

При необходимости можно определить в диаграмме линии максимального, среднего и минимальных значений. Настроить статистику данных можно в группе «Ось значений» выбрать настройки:

Общие настройки для представлений отчета

Для использования общих функций для всех визуальных представлений (компонентов) отчета в режиме просмотра, предварительно их нужно настроить. Для установки общих настроек сделайте следующие действия:

1. перейдите в режим конструктора;
2. откройте панель общих настроек:

Общий курсор

Возможно настроить синхронное выделение значений на диаграммах при совпадении категорий.

Примечание: Для общих курсоров проверяется совпадение по приоритету полей категорий (исходное имя, имя поля, заданное в конструкторе).

Подключение общего курсора осуществляется в карточке «Редактирование свойств отчета». После этого пользователь дашборда может сам включать выключать эту опцию в разделе «Фильтры и переключения»:

Общий дрилл

Включается при создании или редактировании отчета. Если опция включена, то детализация («дрилл») происходит одновременно для всех компонентов, содержащих одинаковые категории.

В подзаголовкке отчета отображается путь дрилла для всех компонентов:

Обновление компонента по таймеру

Если данные получаются «on-line» или обновляются в источнике данных периодически, то возможно настроить обновление компонентов дашборда по таймеру. Для каждого компонента возможно задать индивидуальные настройки обновления.

Для установления настроек в конструкторе компонента откройте панель «Настройка компонента» и в разделе «Данные» включите опцию «Интервальное обновление», а затем укажите:

• периодичность обновления — установив «Интервал обновления» в секундах (см. рисунок ниже, «I»);
• анимацию обновления — если анимация включена (см. рисунок ниже, «A»), то обновление данных в компоненте будет отображаться «крутящимся спинером» (см. рисунок ниже, «O»), иначе обновление будет происходить без индикации:

Информация для компонента дашборда «на перевертыше»

Во все основные компоненты дашбордов добавлена возможность редактирования и отображения текстового описания / информации для компонента. Вывод описания настраивается при необходимости сообщить пользователю информацию о особенностях, присущих данным или их представлению в конкретном компоненте.

Для настройки необходимо включить опцию в разделе «Инфо» (см. рисунок нниже, «R»), запустить текстовый редактор по кнопке «Редактировать описание» и заполнить — отформатировать текст:

В режиме просмотра — при наведении курсора на компонент, с включенной опцией «Инфо», будет отображаться кнопка «i», при нажатии на которую — панель компонента «перевернется» и на ее обороте отобразится текстовое описание:

Копирование контейнера в буфер и вставка из буфера в отчет

Контейнер с настроенной диаграммой можно скопировать в буфер и вставить в тот же самый или другой отчет, а потом внести нужные изменения. Таким образом, можно повторно использовать настроенные компоненты и сущестсвенно ускорить работу по настройке аналогичных отчетов.

Для копирования контейнера необходимо нажать кнопку «Копирования в буфер» (см. рисунок ниже, 1), на затемненном экране выбрать контейнер (он будет подсвечиваться) и щелкнуть по нему мышкой. В результате в буфере обмена появится указатель, что добавился контейнер с компонентом скопирован в буфер (см. рисунок ниже, 2):

Чтобы вставить контейнер из буфера, необходимо открыть «буфер обмена» и перетащить нужный контейнер на поле отчета:

Буфер обмена у каждого пользователя свой. Контейнеры в буфере доступны пользователю, который их туда сохранил. Они будут храниться в буфере до удаления. Удалить контейнер из буфера можно нажав на кнопку «Очистить все» (см. рисунок ниже, 1). Полностью очистить буфер обмена можно, нажав на кнопку (см. рисунок ниже, 2):

Горячие клавиши

Для настройки отчетов у пользователя есть возможность использовать горячие клавиши. «Горячие клавиши» помогут сделать работу более эффективной и быстрой:

• «Ctrl» + «M» — Вызов меню (в «конструкторе» и «просмотре»);
• «Ctrl» + «B» — Режим сохранения в буфер (в режиме «конструктора»);
• «Ctrl» + «S» — Сохранение отчета (в режиме «конструктора»);
• «Shift» + «Plus» — Создать новый «контейнер».

5.1.14 - Всплывающее окно

Всплывающее окно

Механизм всплывающего окна позволяет нажатием на строку таблицы, открыть ссылку на определенную запись формы ввода данных. Что дает вносить изменения в без перехода на дополнительные вкладки. Окно откроется «поверх» текущего дашборда и сразу же отображает меню редактирования той записи, на которую нажали.

Для активации всплывающего окна следует:

• перейти в настройки таблицы;
• добавить поле со ссылкой на форму ввода данных;
• перейти на вкладку «Колонки»;
• из выпадающего списка выбрать колонку со ссылкой на форму ввода данных;
• включить опцию «Всплывающее окно»;
• сохранить изменения.

Создание поля содержажего ссылки на строку для всплывающего окна

Для генерации поля со ссылкой на определенную строку формы ввода данных, необходимо использовать шаблон:

http://[Адрес портала]/fvd/form/[номер формы]?rowKey=[Поле с PK формы ввода данных]

Пример:

В каждой строке таблицы отдельная ссылка на поле в ФВД - https://free.modusbi.ru/fvd/form/221?rowKey=2231.

Для генерации подобного поля можно использовать функцию CONCAT():

CONCAT(https://free.modusbi.ru/fvd/form/221?rowKey=2231, fvd_demo_id)

5.1.15 - Сохранение текста запроса визуализации

Иногда, для решения проблем, связанных с построением корректной визуализации, необходимо сохранить текст запроса компонента дашборда. Для этого в Modus BI, в режиме редактирования дашборда, в каждой визуальной компоненте добавлена кнопка «Сохранить текст запроса». При нажатии на кнопку будет сформирован файл с описанием текстов запроса с учетом всех активных фильтров дашборда.

5.1.16 - Функционал по настройке внешнего вида диаграммы

Функционал по настройке внешнего вида диаграммы включает подробные настройки для каждого элемента визуализации:

• настройка заголовка, осей, подписей данных, легенды, всплывающих подсказок;
• настройка форматирования чисел и дат;
• настройка детализации (дрилла);
• настройка перехода в другой отчет;
• настройка цветовой палитры и графических элементов в изображении.

Подробная настройка каждого элемента диаграммы позволяет формировать разнообразные и отвечающие первоначальному замыслу аналитика отчеты.

Настройки разных видов диаграмм во многом похожи. В этом разделе ниже описаны наиболее типичные настройки. Специфические настройки для каждого типа диаграммы описаны в соответствующих разделах.

Если автообновление включено, то изменение настроек сразу отображается в области просмотра результата настройки. Это удобно, но постоянное обновление результата замедляет процесс настройки, если данных в источнике много.

Настройки компонента по разделам (в зависимости от визуализации могут меняться):

Раздел «Общие настройки» описан ниже.

• «Заголовки» — позволяет включить/выключить функцию отображения заголовка и подзаголовка элемента. Заголовок и подзаголовок элемента вводятся в соответствующие поля.
• «Ориентация» — горизонтальная или вертикальная — меняет взаимное расположение осей «X» и «Y» на графиках.
• «Стекинг» — объединяет значения серий по одной категории в единый графический элемент.
• «Zoom-детализация» — в режиме «Просмотр» позволяет приближать область диаграммы, выбранную мышью.
• «Дополнительная ось» — для отображения на одной диаграмме значений разных единиц измерения одного набора данных.
• «Отступы контейнера» — позволяет настроить расположение объекта в контейнере.
• «Цвет фона» — позволяет определить цвет фона объекта.
• «Точность чисел» — позволяет определить количество отображаемых цифр после запятой в числах.
• «Точность проц.» — позволяет определить количество отображаемых цифр после запятой в процентах.
• «Суффиксы чисел» — позволяет выбрать единицу измерения. По умолчанию выбраны все варианты, что позволяет системе автоматически подбирать единицу измерения. Алгоритм округления чисел с суффиксами: если число после добавления суффикса получилось меньше 10 и отображение дробной части выключено, то дробная часть числа отображается принудительно с округлением до одного знака.
• «Формат даты» — позволяет выбрать необходимый формат даты для применения по умолчанию к полям с типом «дата».
• «Шаблон экспорта» — выбор шаблона для экспорта с возможностью настройки правил форматирования данных отчета. Только для таблиц. Подробнее в разделе Установка шаблона для экспорта таблиц в Excel.

Раздел ««Данные»:

• «Лимит при запросе (строк)» — позволяет определить максимальное количество строк, получаемых при запросе. По умолчанию «0» — без ограничения.
• «Лимит при показе (строк)» — позволяет определить максимальное количество строк, отображаемых при выводе на дашборд. По умолчанию «0» — без ограничения.
• «Лимит при экспорте (строк)» — позволяет определить максимальное количество экспортируемых. По умолчанию «0» — без ограничения.
• Переключатель «Дополнять пустые Серии и категории» - включать в случае если значения есть не для всех серий или категорий.
• «Интервальное обновление» включает периодическое обновление элемента, период обновления указывается в поле «Интервал (сек.)».
• Если «Анимация обновления» включена, то обновление данных в компоненте будет отображаться «крутящимся спинером», иначе обновление будет происходить без индикации.

Примечание: отображение осей можно полностью выключить.

Раздел «Ось «Категории» и аналогичный Раздел «Ось «Значения»:

Для каждой оси можно настроить:

• «Заголовок» — подпись по оси;
• «Сетка» — линии сетки на поле размещения диаграммы;
• «Шкала» — отображение шкалы на экране;
• «Скроллбар» — если категорий много, то они не будут сжиматься, чтобы поместились на весь экран, а появится полоса прокрутки;
• «Первое деление» — отображение первого деления на оси диаграммы;
• «Последнее деление» — отображение последнего деления на оси диаграммы;
• «Тип шкалы» — выбор типа в зависимости от задачи:
  • «Авто» — установка по умолчанию, подбирается наиболее удобная шкала автоматически.
  • «Линейная» — равномерная шкала, значения равноудалены друг от друга. Например, значения 100 и 200, и 200 и 300 отстают друг от друга на одно и тоже расстояние.
  • «Логарифм» — неравномерная логарифмическая шкала, используется для отображения широкого диапазона величин, когда значения, которые попадают на график отличаются на много порядков. То есть, когда необходимо одновременно видеть и значения 0.1, 0.2, и значения 100, 200, 2000 на одном графике;
• «Диапазон шкалы» — часть шкалы для отображения (варианты «Авто», «От нуля», «От мин.», «От макс.»).
  • «Правила отображения»:
    • «От нуля» — при всех положительных значениях нижний предел шкалы = «0». При наличии отрицательных значений «0» будет в центре шкалы, пределы задаются по абсолютному максимуму значений;
    • «От минимума» — нижний предел шкалы по минимальному значению диаграммы, верхний вычисляется автоматически;
    • «От максимума» — верхний предел шкалы по максимальному значению диаграммы, нижний вычисляется автоматически;
• «Цвет шкалы» — цветовое отображение линии шкалы, делений и подписей.
• «Наклон подписей» — регулирует наклон делений;
• «Подписи шкалы через» — можно регулировать число делений с подписями, чтобы не захламлять изображение. Если указано все, в этом случае будет подписано каждое деление;
• «Ограничение подписи» — показывает количество знаков будет в подписях. Если установлен 0, то подписи будут ограничиваться автоматически.

Отдельные настройки для раздела «Ось «Значения»:

• «Точность шкалы» — показывает сколько дробных знаков будет в подписях;
• «Экстремумы» — возможно на диаграмме вывести линии максимума, минимума и / или среднее.

Раздел «Подписи данных»: при включении будут выводиться подписи к данным на диаграмме:

• «Шаблон подписей» — выбором шаблона устанавливается какие данные будут выводиться в подписи (например, при шаблоне «Кат.:Знач.» будет выводится название категории и значение, разделенные «:»;
• «Положение подписей» — расположение подписей (внутри элементов диаграммы, снаружи элементов диаграммы или определяется автоматически);
• «Цвет подписей» — можно установить цвет подписей, расположенных на элементах диаграммы;
• «Размер шрифта» — размер шрифта подписей;
• «Поворот» — поворот подписей на определенный угол (значение в градусах от горизонтали).

Раздел ««Легенда»:

• «Реверс» — меняет порядок расположения категорий в легенде на обратный;
• «Положение» — определяет положение легенды относительно диаграммы;
• «Вывод отношения (в %)» — свойство включает показ процентного соотношения между значениями (категорий легенды) при наведении курсора на элемент диаграммы;
• «Текст для» — для круговых диаграмм: в списке можно значение категории и ввести текст, который будет выводится в легенде (например, сократить длинное название);
• «Цвет фона» — настроить цвет фона для легенды;
• «Цвет рамки» — настроить цвет рамки для легенды;
• «Ширина рамки» — настроить ширину рамки для легенды.

В связи большим количеством настроек в группах «Стилизация» или для некоторых диаграмм «Стиль элемента», «Дрилл» и «Переход в другой отчет» они рассмотрены в отдельных пунктах (см. Настройка «Стилизация» и «Стиль элемента», Дополнительно общий дрилл, и Настройка перехода между отчетами соответственно).

5.1.17 - Настройка всплывающей подсказки

«Всплывающая подсказка» («ToolTip») появляется при наведении мыши на элементы диаграммы. Ее можно включить / выключить в соответствующем разделе настроек . Ниже описаны опции раздела «Всплывающая посказка»:

• «Объединить» — включение опции приводит к отображению значений для нескольких серий в одну единую всплывающую подсказку. Шаблон подсказки — выбором шаблона устанавливается какие данные будут выводиться в подсказку (например, при шаблоне «Кат.:Знач.» будет выводится название категории и значение, разделенные знаком «:»;
• «Размер шрифта» — размер шрифта подсказки (по умолчанию 12 px);
• «Цвет шрифта» — цвет шрифта для подсказки;
• «Цвет фона» — цвет фона для подсказки.

Для того, чтобы диаграмма выглядела легко читаемо, рекомендуется использовать короткие наименования в категории. Но, пользователю, который плохо знаком с сокращениями, такая диаграмма будет непонятна. В таком случае для гистограмм и круговой диаграммы возможно настроить всплывающую подсказку по другому полю. Для этого, надо развернуть пилюлю с полки «Категория» (см. рисунок ниже, 1). И во всплывающем списке «Подсказка по другому полю» выбрать поле, по которому будет выводиться подсказка (см. рисунок ниже, 2):

5.2 - Контейнер с переключениями

«Контейнер с переключениями» позволяет менять детализацию отображаемых данных. Его действие имеет сходство с другим инструментом – «Дрилл» (см. раздел Настройка перехода между уровнями детализации данных/дрилла). Однако, тип отображения «Контейнер с переключениями» позволяет произвольно выбирать детализацию, отображаемых данных, в отличие от «Дрилла», который переключает детализацию уровней только последовательно друг за другом.

В случае, когда одни и те же компоненты отчета необходимо использовать для отражения данных в различных аналитических разрезах (которые можно произвольно выбирать из выпадающего списка) можно воспользоваться «Контейнером с переключениями».

Чтобы добавить «Контейнер с переключениями» в отчет, следует выбрать соответствующую пиктограмму:

После выбора компонента отображения «Контейнер с переключениями» следует осуществить его настройку. Для этого в режиме редактирования компонента «Контейнер с переключениями» на полку «Категории» следует поместить несколько полей из Набора данных, которые будут использоваться для переключения разрезов анализа данных:

Далее в режиме редактирования компонента «Контейнер с переключениями» в разделе «Общие настройки» указываем заголовок контейнера в подразделе «Переопределить заголовок меню». По умолчанию в качестве заголовка используется наименование поля, которое стоит первым на полке «Категории». После заполнения подраздела «Переопределить заголовок меню» для контейнера будет использоваться указанный заголовок:

При необходимости в общих настройках можно также настроить отступы контейнера, а в разделе «Рамка» можно установить цвет и ширину рамки контейнера.

Далее на тех компонентах отчета (диаграммы, таблицы и т.д.), на которых предполагается переключение разрезов данных для анализа, на полку «Категории» помещаем те же поля, которые ранее были размещены на полке «Категории» в «Контейнере с переключениями»:

Важно: в компонентах отчета, в которых должно работать переключение, а также в «Контейнере с переключениями» самое первое поле на полке «Категории» должно обязательно совпадать (иначе переключение данных работать не будет).

После того, как в компонентах отчета и в «Контейнере с переключениями» на полке «Категории» размещены необходимые поля, в режиме редактирования отчета следует перейти в «Панель фильтров», которая вызывается кнопкой:

и отображается в правом верхнем углу отчета.

В открывшейся панели в появившемся разделе «Переключения общие» следует переключатель перевести в положение «вкл.»:

Затем следует сохранить все изменения в отчете и выйти из режима редактирования.

После всех проделанных операций, описанных выше, в отчете появляется возможность переключать разрезы данных («Категории») через контейнер с выпадающим списком:

5.3 - Пузырьковая диаграмма

Пузырьковая диаграмма используется для выявления взаимосвязи и распределения переменных величин. Данный вид диаграмм позволяет отображать для элемента на диаграмме до четырех метрик одновременно: значения по осям X и Y, размер и цвет.

Как и любые другие диаграммы, пузырьковые диаграммы имеет свои ограничения. Наличие слишком большого количества элементов (пузырьков) может затруднять чтение, так что приходится экономно обращаться с размерами. Эта проблема может быть решена с помощью фильтрации.

Внешний вид диаграммы показан на рисунке:

Настройка данных для отображения: на полку «Категории» нужно разместить категории. По этим категориям будут отображаться точки на диаграмме.

На полки «Значения Y», «Значения Х» размещаем данные, на основе которых будет отображаться расположение точки соответствующей категории на диаграмме. На полке «Значения: размер и цвет» размещаем данные, по которым будет определяться размер и цвет пузырька:

Цвет пузырьков настраивается «пилюлей» с типом «Цвет» и может:

• устанавливаться автоматически по значениям выбранного поля данных. В этом случае («Цвет из данных» — «Выкл.») цвета подбираются последовательно из палитры дашборда.

• или получаться из данных в виде «Hex»-значения цвета (опция в пилюле «Цвет из данных» — «Вкл.»); при такой настройке необходимо дополнительно заполнить поле «Подпись по другому полю», из которого будут получаться значение для подписи легенды.

Настройка цвета на пузырьковой диаграмме:

Общие настройки пузырьковой диаграммы:

Другие настройки:

• «Размер пузырьков» (минимальный / максимальный «радиус» в пикселях) настраивается на слайдере (см. рисунок выше, 1) ;
• При включении опции «Режим точного масштабирования» (см. рисунок выше, 2) шкалы для осей «X» и «Y» будут настроены так, чтобы минимизировать «пустое пространство на диаграмме»;
• компонент может работать в режиме фильтра, если включить опцию «Режим фильтра» (см. рисунок выше, 3);
• возможно управлять отображением легенды для цветов и размера (см. рисунок выше, 4, 5). Для легенды размера пузырька возможно вывести в шапке диаграммы только имя показателя для размера или выбрать графическое представление.

5.4 - Гистограмма (столбчатые и линейчатые диаграммы)

Как графики являются стандартным решением для временных рядов данных, так линейчатые диаграммы идеально подходят для рассмотрения определенного значения по разным категориям. Если отсортировать столбцы по значению параметра, будут сразу хорошо видны максимальные значения и распределение значений. Горизонтальные линейчатые диаграммы хорошо подходят для длинных названий категорий.

Гистограмма с накоплением (добавить в стек). Пользователь может добавить в гистограмму или линейчатую диаграмму дополнительное измерение, разместив в каждом столбце или строке несколько категорий. В таком случае диаграмма не только передает сведения об одной общей тенденции (по высоте и длине элементов), но и демонстрирует влияние отдельных категорий на эту тенденцию.

Комбинированные гистограммы и линейчатые диаграммы. Комбинирование гистограммы и графика помогает сэкономить пространство на экране, объединяя две визуализации в одну. Помимо этого, так проще искать связи между двумя тенденциями. При комбинировании учитывайте следующее:

• комбинированные диаграммы лучше всего работают в тех случаях, когда у двух визуализаций есть хотя бы одна общая ось;
• следите за осями. Удобно ли читать и легко ли понимать комбинированную диаграмму в каждом конкретном случае? Или на ней используются разные диапазоны и значения? Например, если шкала оси «Y» для гистограммы будет существенно мельче, чем шкала оси «Y» для графика, комбинированная диаграмма не сможет донести смысл. В этих случаях используйте логарифмическую шкалу, которая покажет тенденции для значений разных диапазонов. Если необходимо отобразить значения разных единиц измерения одного набора данных на одном графике, возможно добавить дополнительную ось отображения, подробнее в этом разделе.

Выбрать гистограмму можно при помощи пиктограммы «Диаграмма столбчатая» . Пример комбинирования гистограммы и графика (см. рисунок ниже). Для настройки графика не требуются специфические действия отличные от описанных в том разделе:

5.5 - Настройка графика

Графики — это средство для просмотра временных рядов данных. Считывание данных в табличном виде не сравнится по скорости с восприятием пиковых значений и плато, а также закономерностей и повторов в графическом представлении.

Когда человек смотрит на график, он прежде всего замечает форму кривой. Это означает, что нужно выбрать такой параметр для оси «X», который сделает эту кривую осмысленной, например, время или категорию распределения. Если поместить на ось «X» категориальные поля, например, товары или регионы, график будет неинтересным, так как форма кривой не отобразит значимые сведения.

Выбрать график можно при помощи пиктограммы «Диаграмма линейная»:

Для настройки графика не требуются специфические действия отличные от описанных в разделе «Настройка представления внутри отчета».

5.6 - Временные ряды

Диаграмма Временные ряды позволяет выводить значения нескольких величин за выбранный период, причем, на оси времени («X») подписи формируются динамически, с подстраивающейся автоматически под ширину диаграммы степенью детализации: год, месяц, дата, дата-время. Вид диаграммы показан на рисунке:

Компонент состоит из нескольких блоков и горизонтальных секций, видимость блоков, кроме основной секции, можно включить / отключить в настройках:

• управление диапазоном дат: «Диапазон дат» (см. рисунок выше, 1) и «кнопки» для выбора последнего месяца, квартала, полугодия, года и т.д. (см. рисунок выше, 2);
• «Скроллбар» с мини-графиком для управления границами периода с помощью ползунков справа и слева (см. рисунок выше, 3);
• «Основная диаграмма:» диаграмма, выводящая значения одной / нескольких величин (см. рисунок выше, 4). Для каждой величины возможно настроить тип диаграммы: линейная, столбчатая или диаграмма площади;
• «Дополнительная диаграмма» отображающая значения одной величины на диаграмме, если включена опция «Доп.диаграмма» (см. рисунок выше, 5).

Для настройки диаграммы на полку «Категории» необходимо положить «пилюлю» с типом данных «Дата», а на полку «Значения» разместить числовые или количественные данные. Если включить опцию «Доп. диаграмма», то данные последней пилюли на полке «Значения» будут отображены на нижней диаграмме.

5.7 - Настройка iFrame

Элемент является контейнером для различных объектов (документы, видео и интерактивные медиафайлы и прочие), которые доступны по ссылке.

Чтобы добавить элемент «iFrame» в отчет, следует выбрать соответствующую пиктограмму:

По умолчанию в окне отображается объект по ссылке в поле «Свойства iFrame» / «Начальный URL».

Если необходимо изменять объекты в зависимости от фильтров, то нужно выбрать заранее подготовленный набор данных. И на полку «Значения» перенести поле, содержащее ссылки. В этом случае элемент будет отображать первую ссылку из выборки с учетом фильтров.

Дополнительно есть возможность задать ключ для объектов набора данных. Это нужно, например, если при переходе в отчет нужно отображать ссылку по умолчанию, а при использовании фильтров менять отображение на необходимое. В случае использования ключа алгоритм работы будет следующим:

• Если в выборке есть объекты с разным значением ключа, то по умолчанию отображается ссылка из поля «Свойства iFrame / Начальный URL» (если значение указано, иначе пусто);
• Если в выборке остались объекты, у которых одинаковый ключ (например, при использовании фильтров), то отображается первая ссылка из выборки.

5.8 - «Граф/дерево»

Диаграмму «Граф (дерево)» возможно использовать:

• для отображения связей между иерархическими сущностями в виде дерева или векторного графа;
• для визуализации дерева решений для правил вида «Если…, то»;
• при решении задач по классификации и регрессии;

На следующих рисунках приведены примеры графов для типов «дерево» / «векторный».

Граф типа дерево с вертикальная ориентация иерархии:

Граф типа дерево с горизонтальной ориентацией:

Граф векторного типа:

Для использования диаграммы «Граф» необходимо чтобы в данных были поля «Родитель~Потомок» («Parent~Child») — для настройки, предназначены «полки» «Связь» и «Признак», соответственно (см. на рисунке ниже, «J»).

С помощью настройки «пилюль» возможно управлять:

• цветом узла — при помощи «пилюли» с типом «Цвет» (см. на рисунке выше, «C»);
• размером узла — при помощи «пилюли» с типом «Размер» (см. на рисунке выше, «S»).

В общих настройках возможно управлять:

• «типом» графа — «Векторный граф» или «Дерево» (см. на рисунке выше, 1);
• «ориентацией иерархии» для «Дерева» — «горизонтальная» или «вертикальная» (см. на рисунке выше, 4);
• «автомасштабированием» (см. на рисунке выше, 3) — при этой опции весь граф будет вписан-отображен в контейнере, что при большом количестве узлов дает возможность увидеть общую картину, но без надписей и деталей. Для детализации возможно использовать zoom (см. ниже) / устанавливать фильтры;
• «начальным масштабом» (см. на рисунке выше, 2) как альтернативой автомасштабированию.

Иллюстрация автомасштабирования (на следующем рисунке — слева) или установки конкретного начального масштаба (справа):

Для всплывающей подсказки в соответствующем разделе настроек возможно управлять размером, цветом шрифта и цветом фона подсказки:

В режиме просмотра компонента возможно:

• управлять масштабом-зумированием при нажатии на «Ctrl» + «+» / «-» или «Ctrl» + колесо прокрутки мыши;
• скрывать и раскрывать дочерние узлы при нажатие на контроллы «-» / «+» на родительских узлах (см. рисунок ниже, «m» и «p», соответственно)

5.9 - «Солнечные лучи»

Диаграмма «Солнечные лучи» подходит для демонстрации иерархических данных. Каждый уровень иерархии представлен одним кольцом или кругом, а ее верхом является самый близкий к центру круг. На такой диаграмме с несколькими уровнями категорий отображается связь между внешними и внутренними кольцами. Диаграмма «Солнечные лучи» предназначена для того, чтобы показать, как одно кольцо разбивается на составляющие его фрагменты, при этом размер сегмента кольца будет зависеть от соотношения между собой фактических данных (сумма, количество и т.п.). Внешний вид диаграммы показан на следующем риснуке:

Настройка данных для отображения: на полку «Категории» нужно разместить категории в иерархическом порядке. По этим категориям будут отображаться кольца на диаграмме:

На полку «Значения» размещаем данные, на основе которых будет отображаться ширина сегмента соответствующей категории на кольце.

Настройки для диаграммы «Солнечные лучи»:

• «Тип разворачивания» — при послойном типе при нажатии сегмента кольца открывается только один следующий уровень, если отключено, то отображаются все более низкие уровни;
• «Цвет подписей» — по умолчанию подписи данных на внутренних кольцах белые, но можно установить темные подписи;
• «Двустрочные подписи» — подходит для подписей из нескольких слов;
• «Лимит длины подписей» — ограничит отображаемое наименование категории;
• «Начальное количество слоев» — задается количество колец при открытии отчета;
• «Кнопки управления количеством слоев» — включает отображение кнопок изменения количества слоев в правом нижнем углу контейнера
• «Точность чисел» — позволяет определить количество отображаемых цифр после запятой в числах;
• «Порог скрывания подписей» позволяет не выводить подписи сегментов, величина которых меньше порога.

Режим фильтра

При включенной опции после выделения области на диаграмме — выбранное значение категории передается в фильтр, прочие сектора диаграммы закрашиваются серым. И остальные компоненты дашборда, на которых применен данный фильтр, отфильтруются по выбранному значению:

5.10 - Диаграмма площади

Диаграмма площади (или иначе, диаграмма с областями) является гибридом между графиком и гистограммой. Позволяет одновременно проследить изменение каждой из нескольких величин и изменение их суммы в нескольких точках. А также расширяет набор средств визуального представления.

Выбрать этот вид диаграммы можно при помощи пиктограммы «Диаграмма площади». Для настройки диаграммы площади не требуются специфические действия отличные от описанных в этом разделе.

5.11 - Настройка табличного представления

Табличное представление предназначено для детализированных данных. Рекомендуется использовать для конечного уровня переходов между отчетами.

Также раскрашенные при помощи условного форматирования таблицы могут имитировать тепловую карту.

Выбор табличного представления при помощи пиктограммы «Таблица». Для таблиц используются дополнительные настройки:

В разделе «Режимы» устанавливаются основные правила работы с таблицей:

• «Автоширина колонок» — ширина колонок будет изменяться автоматически в зависимости от размеров экрана. Колонки, у которых установлена фиксированная ширина изменяться не будут;
• «Перетаскивание колонок» — позволяет менять колонки местами в режиме просмотра;
• «Многострочный заголовок» — переносит надпись в заголовке колонки на следующую строку;
• «Подытоги» — позволяет отображать промежуточные итоги показателей (отдельная строка в таблице, подытоги разного уровня вложенности выделяются цветами с разной насыщенностью). При включении этого режима предыдущие настройки «Категорий» и «Серий» удаляются и появляется специальная «полка», на которой нужно разместить группировочные для подытогов (категории для подытогов).

• «Итоги» — позволяет отображать итоговые значения по данным в строках таблицы (отдельная строка в конце таблицы, выделена цветом). Структура настроек таблицы (категории, серии и группировка по ним) не меняется. Для настройки функции агрегации по столбцу таблицы, нужно пользоваться настройкой в поле Значения;

• «Число закрепленных колонок» — позволяет закрепить нужное число колонок таблицы. Удобно использовать в случае длинных таблиц;
• «Высота ячеек» — позволяет закрепить высоту строк в таблице (параметр задается в количестве строк);
• «Высота заголовка» — позволяет закрепить высоту заголовка таблицы (параметр задается в количестве строк):

В разделе «Колонки» устанавливаются настройки для каждой колонки. Выберите из списка нужную колонку и установите настройки:

• «Колонка»:

  • «Показывать» — позволяет скрыть колонку для режима просмотра. Используется в случае, если в таблице нужна служебная колонка, например, для сортировки данных, которую при этом не нужно отображать для пользователя отчета;
  • «Конвертация в гиперссылку» — осуществляет парсинг значений, начинающихся с «http://…». При включении функциональности, позволяет переходить по ссылке, заданной в разделе «Гиперссылка»;
  • «Гиперссылка» — позволяет выбрать колонку с ссылкой, по которой будет осуществлен переход;
  • «Порядок отображения» — влияет на последовательность колонок в таблице:
    • сначала выводятся колонки, для которых заполнено поле «Порядок отображения» в порядке увеличения значения этого поля затем, колонки с незаполненным полем «Порядок отображения» по базовому правилу:
    • сначала «Категории»;
    • затем «Серии» и «Значения», с учетом порядка, в котором эти поля размещены на полках;
  • «Псевдоним» — наименование колонки для отображения в режиме просмотра;
  • «Ширина» — фиксированная ширина, если не установить, то будет подбираться автоматически.

• «Выравнивание»:

  • «Горизонтальное и Вертикальное» — выравнивание по ширине и высоте соответственно — для любых колонок.

• «Форматирование»:

  • «Формат даты» — используется для колонок с данными типа «Строка» или «Дата»;
  • «Знаков после запятой» — используется для колонок с числовыми полями;
  • «Отображать спарклайн» — выявляет соотношения максимального и минимального значения по колонке и показывает соответствие этим величинам в виде длины графика. (см. Рисунок 9);
  • «Отображать пустое как ноль» — опция позволяет выводить вместо пустых ячеек таблицы нули для колонок с числовыми полями.

В разделе «Стилизация» можно настроить цвета для шапки таблицы, зебры и спарклайна.

В разделе «Условное форматирование» можно настроить цвет колонки или всей строки в зависимости от данных в колонке. Настройка форматирования:

• для добавления правила нажмите кнопку «Добавить правило»;
• выберите колонку, данные в которой будут проверяться;
• задайте условия проверки, одновременно может проверяться два условия (если нужно проверить несколько диапазонов значений для одного поля, можно сделать несколько правил). После ввода значения необходимо нажимать «Enter», при этом цвет введенного значения должен измениться с красного на черный, это является подтверждением правильности ввода;
• установить цвет текста и цвет фона для ячеек, когда сработали условия;
• включенный переключатель «Вся строка» распространит форматирование на все ячейки строки.

При настройке нескольких правил нужно учитывать, что они будут отрабатывать последовательно, т.е. следующее правило может перекрыть предыдущее.

В разделе «Сортировка» можно включить / выключить возможность сортировки в таблице.

• «Выключен» переключатель «Сортировка по нескольким колонкам» — при включении сортировки на колонке таблица отсортировывается по этой колонке;
• «Включен» переключатель «Сортировка по нескольким колонкам» — можно установить знак сортировки на нескольких колонках таблицы. Порядок сортировки устанавливается в порядке выбора колонок для сортировки, при этом рядом со знаком сортировки появляется ее номер. Количество уровней сортировки не ограничено; Переключение между сортировкой в алфавитном и в обратном порядке и выключение сортировки в колонки осуществляется последовательным нажатием на знак сортировки в колонке.

«Смена сортировки нажатием на заголовок» — в режиме просмотра для таблицы с этой опцией, при наведении на заголовок столбца, курсор превращается в значок «рука» и при нажатии срабатывает сортировка. Эта опция полезна для работы с таблицами на планшетах.

Пример спарклайна:

Пример использования множественных серий:

Настройка цвета фона ячейки

Цвет фона ячеек таблицы настраивается через меню «пилюли» (стрелочка вниз в левом нижнем углу). В настройке «Цвет по другому полю» должен быть указан столбец с данными в виде «Hex»-значения цвета:

Чтобы изменить прозрачность цвета, нужно в разделе «Колонки» выбрать колонку, к которой применена настройка с цветом, и в поле «Прозрачность цвета (%)» указать величину прозрачности:

На полку «Значения» так же можно положить «пилюлю» с типом «Цвет» и к этой колонке применить настройку «Прозрачность цвета (%)».

Опция «Предупреждение о неполных данных» для таблицы

Опция «Предупреждение «неполные данные» (см. рисунок ниже, A), предназначена для настройки отображения предупреждения для таблицы на дашборде (см. рисунок ниже, I) и в заголовке при экспорте данных в файл Excel (см. рисунок ниже, E). Условие, по которому выводится предупреждение — если количество строк равно настроенному пользователем лимиту при запросе / показе / экспорте:

5.12 - Панель Закладок

Когда отчет содержит обширный объем данных, не помещающийся на одной странице, и требуется обеспечить быстрый доступ к другим отчетам или внешним ресурсам, система предоставляет функционал создания кнопок-закладок. Эти кнопки позволяют имитировать закладки путем настройки прямых ссылок на другие отчеты, или внешние веб-адреса, обеспечивая удобство навигации:

Добавить кнопки можно при помощи пиктограммы «Панель закладок».

Далее выполните настройки панели закладок:

Общие настройки

Интерфейс предоставляет возможность добавления произвольного количества кнопок-закладок с помощью команды «Добавить кнопку». В разделе «Стиль кнопки» доступна опция задания названия для кнопки в поле «Заголовок», а также настройка её размеров и цвета. В разделе «Действие кнопки» пользователь может определить функционал кнопки, выбрав одну из двух опций:

1. Переход по ссылке

Выбирая функцию «Переход по ссылке», пользователь может назначить целевой отчет, доступный на портале, либо указать желаемый URL для перенаправления. С помощью опции «Открывать в» можно определить, будет ли ссылка открыта в текущей вкладке браузера или в новой. Кроме того, переключатель «Без передачи фильтров» позволяет управлять, будут ли применённые в отчете фильтры переданы вместе с переходом по ссылке.

2. Отправка запроса

Функция «Отправка запроса» дает возможность выполнить запрос с выбором его типа: GET, POST, PUT, PATCH или DELETE. Подробно об этом функционале написано в разеделе документации: «Кнопка для отправки http запросов»

5.13 - Индикатор значений (стрелочный)

Стрелочный индикатор значений может быть полезен в случаях, когда необходимо сравнение фактического показателя в сравнении с некой целью, которую необходимо достичь. При этом интуитивно показывает какой объем нехватает до достижения цели. Например, выполнение планов по факту.

Выбрать диаграмму индикатор можно при помощи пиктограммы «Индикатор стрелочный V2.0». Ниже перечислены настройки стрелочкого индикатора:

Раздел «Шкала» (см. рисунок выше):

• «Начальный угол» — позволяет определить начальный угол шкалы элемента. По умолчанию «-150»;
• «Конечный угол» — позволяет определить конечный угол шкалы элемента. По умолчанию «150»;
• «Минимум» — позволяет определить начальное значение шкалы. По умолчанию «0»;
• «Максимум» — позволяет определить конечное значение шкалы. По умолчанию определяется как максимальное значение объекта;
• «Положение шкалы» — позволяет выбрать вариант положение шкалы в объекте («Снаружи» / «Внутри»);
• «Ширина шкалы» — позволяет определить ширину шкалы. По умолчанию 15px;
• «Цвет шкалы» — позволяет выбрать цвет шкалы из палитры;
• «Цвет подписей» — позволяет выбрать цвет подписей из палитры;
• «Количество цветов» — позволяет определить количество цветов шкалы с отсечками (от 2 до 7);
• «Цвет 1» и т.д. — позволяет выбрать цвет соответствующей части шкалы из палитры;
• «Инверсия» — позволяет применить инверсию к порядку выбранных цветов;

Раздел «Легенда» (см. рисунок выше):

• «Положение» — позволяет выбрать из выпадающего списка вариант расположения легенды;
• «Реверс» — позволяет изменить порядок элементов легенды на противоположный;
• «Текст для» — позволяет выбрать из выпадающего списка показатель, для которого будет производиться настройка;
• «Введите текст легенды» — позволяет определить псевдоним для показателя (как показатель будет отображаться на дашборде;
• «Цвет фона» — позволяет определить цвет фона легенды;
• «Цвет рамки» — позволяет определить цвет рамки легенды.

Раздел «Стилизация значений» (см. рисунок выше):

• «Объект данных» — позволяет выбрать из выпадающего списка показатель, для которого будут настраиваться параметры;
• «Ширина дуги» — позволяет определить ширину дуги показателя. По умолчанию «0»;
• «Насыщенность» — позволяет определить насыщенность дуги показателя. По умолчанию «1»;
• «Цвет» — позволяет определить цвет дуги показателя;
• «Ширина стрелки» — позволяет определить ширину стрелки. По умолчанию «5px»;
• «Насыщенность» — позволяет определить насыщенность стрелки. По умолчанию «0,5»;
• «Показывать» — позволяет включить / выключить отображение значения на дашборде («Да» / «Нет»). По умолчанию «Нет»;
• «Размер шрифта» — позволяет определить размер шрифта;
• «Шаблон вывода» — позволяет выбрать из выпадающего списка вид отображения значения;
• «Единица измерения» — позволяет выбрать из выпадающего списка единицу измерения (никакая, проценты или рубли).

Стрелочные индикаторы:

Состав стрелочного индикатора:

• «Шкала» — настройка диапазона и делений для индикатора. Есть возможность указать минимум / максимум шкалы. По умолчанию минимум берет равный 0, максимум вычисляется в зависимость от значения;
• «Указатель» — настройка параметров указателя для индикатора;
• «Значение» — настройка видимости и формата значения в центре индикатора;
• «Отсечка» — значение, которое является границей между состояниями показателей;
• «Всплывающее окно отсечки» — информационное поле, появляющееся при наведении на шкалу.

Для использования эмодзи (см. рисунок выше) необходимо:

1. перейти в режим настройки объекта;
2. нажать правой кнопкой мыши в имени поля;
3. в появившемся контекстном меню выбрать «Эмодзи»;
4. выбрать нужный элемент в списке «Эмодзи»;
5. зайти в раздел «Стилизация значений»;
6. выбрать измененный объект данных;
7. поставить «Да» рядом с полем «Показывать»;
8. в шаблоне вывода выбрать из выпадающего списка «Заголовок».

5.14 - Геокарта

Настройка использования геокарты

Для использования представления необходимо, чтобы нужный вариант геокарты был заранее загружен на портал и нужно правильно подготовить набор данных. Для правильного отображения данных на геокарте между картой и набором данных должно быть установлено однозначное соответствие. Для каждой карты есть внутренняя легенда с одним или нескольким ключами. Это могут быть официальные идентификаторы территорий типа ОКАТО, названия территорий, аббревиатуры. В наборе данных в каждой строке должен быть хотя бы один из таких же ключей, по которому можно будет связать геокарту и набор данных. Пример настройки геопривязки:

В разделе «Геопривязка» нужно установить связь между картой и набором данных:

• «Категория» – выбирается из списка установленных категорий;
• «Тип геоданных» — выбирается тип карты из заранее загруженных на портал;
• «Поле привязки геоданных» — ключ, по которому будет устанавливаться привязка;
• «Поле привязки данных» — соответствующее ключу поле из набора данных.

В разделе «Легенда» (см. рисунок выше) можно настроить цвета раскраски и градацию размеров элементов карты в зависимости от значений. Весь пул значения автоматически делится на диапазоны и раскрашивается в выбранные цвета:

• «Тип» — дискретный или плавный, настраивает переходы из цвета в цвет;
• «Инверсия» — меняет местами набор цветов.

При добавлении на полку элемента типа «Цвет» (см. рисунок выше, 1), появляется возможность управлять цветом элемента на карте независимо от тех настроек, которые указаны в конструкторе. Цвет элементов предопределяются в палитре HEX. Настраивать таким образом цвет возможно как для областей так и для точек.

При добавлении на полку элемента типа «Размер» (см. рисунок выше) появляется возможность управлять размером элемента (см. рисунок выше, 1) на карте, весь пул значений выстраивается в порядке от меньшего к большему. Так же изменяется тип легенды — переход с градаций цвета на размер показателя. При активации фиксированного диапазона (см. рисунок выше, 2) появляется возможность задать границы диапазона (см. рисунок выше, 3) с окраской при превышении значения.

В разделе «Подписи» (см. рисунок выше) отображены возможности по настройке подписей элементов на карте. Возможно настроить размер шрифта подписей, вид отображения подписей (выводить только значения, только наименования категорий или все вместе). Так же возможно настроить вывод подписей начиная с определенного уровня масштаба по опции «Нижняя граница масштаба». При масштабах ниже этой границы подписи не отображаются.

«Тайлы» — отображение карты для фона (см. рисунок выше). Вариант подложки в виде карты можно выбрать из списка. «Карта» — для фона возможно включить / выключить карту.

Режим фильтра

При щелчке по области на геокарте значение гео-Категории передается в фильтр, остальные области на геокарте становятся серыми:

Данную настройку возможно включить на панели «Общих настроек» в «Режиме фильтра».

Использование дополнительного слоя геокарты

Дополнительный слой используется для одновременного вывода маркеров и размеченных территорий на карте. Для правильной работы механизма необходимо следующая последовательность действий.

1. Перенести «пилюли» дополнительного слоя на соответствующие полки (как при обычной настройке карты). Рекомендуется располагать «пилюли» дополнительного слоя справа (на «полках» «Значения» и «Категории»).

2. Выбрать слой для «пилюль», 0 — основной, 1 — дополнительный. Пилюли дополнительного слоя выделяются красной рамкой. Учитываться в отображении они будут после включения «многослойного режима».

3. Настроить дополнительный слой аналогично основному.
4. Включить «Многослойный режим» в общих настройках.

Примечание:

• режим фильтра включается для всех слоев;
• дрилл доступен для использования только на основном слое.

Пример отображения карты с двумя слоями:

Пример настройки карты:

Расположение областей на карте по названию геообъекта

Система может самостоятельно сопоставить наименование геообъекта его области на карте и отрисовать её. Для этого необходимо соответствие данных определенному стандарту. Для каждого типа геоданных ниже представлена таблица с наименованиями геообъектов, а также дополительными идентификаторами.

Страны мира 2022

Боро Нью-Йорка

Районы Нью-Йорка

Области Казахстана

Федеральные округа России

Регионы России (с районами)

Районы Москвы

Выходы московского метро