Построитель пользовательских отчетов

Настройка пользовательских отчетов осуществляется в 3 этапа:

• Настройка подключений.
• Настройка запросов.
• Настройка дашбордов.

Для просмотра списка ранее созданных источников на Платформе перейдите в раздел Настройка → Построитель отчетов - настройка подключения.

На странице отображены все ранее созданные источники в табличном виде с указанием следующей информации:

• Создан — дата создания источника.
• Обновлён — дата последнего обновления источника.
• № — идентификатор источника.
• Наименование — имя источника для отображения в интерфейсе Платформы.
• Тип источника — краткое наименование типа источника.

• Настройки подключения — данные для подключения к БД:

  • user — логин для подключения к БД.
  • host — IP-адрес сервера.
  • port — номер порта сервера.
  • dbname — наименование БД.
  

Для создания источника выполните следующие шаги:

1. В интерфейсе Платформы перейдите в раздел Настройка → Построитель отчетов - настройка подключения.
2. Нажмите Создать источник (source).
3. В открывшемся модальном окне заполните следующие поля:
   • Тип источника — тип БД, к которой осуществляется подключение. В настоящее время доступно подключение только к PostgreSQL.
   • Название — наименование источника для отображения в интерфейсе Платформы.
   • Имя пользователя — логин для подключения к БД.
   • Пароль — пароль для подключения к БД.
   • Адрес сервера — IP-адрес сервера.
   • Порт сервера — номер порта сервера.
   • База данных — наименование БД.
4. Нажмите Создать.

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

1. В интерфейсе Платформы перейдите в раздел Настройка → Построитель отчетов - настройка подключения.
2. Определите источник для редактирования, нажмите ••• в строке с ним и выберите опцию Обновить параметры.
3. В открывшемся модальном окне внесите необходимые изменения.
4. Нажмите Проверить соединение, для проверки соединения с источником.
5. Нажмите Обновить.

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

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

1. В интерфейсе Платформы перейдите в раздел Настройка → Построитель отчетов - настройка подключения.
2. Определите источник для редактирования, нажмите ••• в строке с ним и выберите опцию Обновить параметры.
3. В открывшемся модальном окне укажите новый пароль.
4. Нажмите Проверить соединение, для проверки соединения с источником.
5. Нажмите Обновить.

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

1. В интерфейсе Платформы перейдите в раздел Настройка → Построитель отчетов - настройка подключения.
2. Определите источник для удаления, нажмите ••• в строке с ним и выберите опцию Удалить.
3. В диалоговом окне подтвердите удаление источника, нажав Удалить.

Для просмотра списка ранее созданных запросов на Платформе перейдите в раздел Настройка → Построитель отчетов - создание запросов.

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

• Создан — дата создания запроса.

• Обновлён — дата последнего обновления запроса.

• № — идентификатор запроса.

• Имя — наименование запроса для отображения в интерфейсе Платформы.

• Запрос — текст запроса.

• Аргументы запроса — параметры запроса.

  

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

1. В интерфейсе Платформы перейдите в раздел Настройка → Построитель отчетов - создание запросов.
2. Нажмите Создать запрос. Откроется окно создания запроса, состоящее из нескольких основных блоков:
   • Источник.
   • Имя запроса.
   • Параметры.
   • Текст запроса.
3. В поле Источник выберите имя источника, которому будет направлен создаваемый запрос.
4. В поле Имя запроса укажите наименование запроса для отображения в интерфейсе Платформы.
5. В блоке Текст запроса введите текст SQL-запроса в соответствующее поле. В блоке доступны дополнительные опции, которые могут облегчить написание запроса:
   • — добавление параметра. Работа с параметрами описана в разделе Параметры запроса.
   • — включение/отключение автозаполнения. При вводе первых букв слова система будет предлагать варианты его полного написания. Автозаполнение не доступно при превышении лимита колонок БД, указанного в конфигурационном файле.
   • — форматирование текста запроса. При форматировании текста запроса автоматически расставляются переносы строк.
   • — экспорт данных отчетов в формате Excel и/или CSV.
6. В блоке Параметры укажите значения созданных ранее параметров.

7. Нажмите Запустить для проверки правильности запроса. В нижней части страницы отобразится таблица с результатом запроса. При необходимости измените запрос и вновь нажмите Запустить.
8. Нажмите Создать.

При работе с SQL-запросами (создание/редактирование) в рамках пользовательских отчетов необходимо задавать значения параметров, используемых в запросе. Значение таких параметров задается в отдельном блоке Параметры, что упрощает работу с объемными SQL-запросами.

После создания параметра его можно использовать в тексте запроса в формате ‘{param}’.

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

1. Перейдите в окно создания или редактирования запроса.
2. Нажмите .
3. В открывшемся модальном окне заполните следующие поля:
   • Ключевое слово — наименование параметра для отображения в Платформе.
   • Имя — наименование колонки БД, значение которой будет указано в параметре.
   • Тип — тип параметра. Возможные значения:
     • Текст.
     • Число.
     • Дата.
     • Выпадающий список на основе справочника. Для данного типа также необходимо заполнить поля:
       • Справочник — название справочника, значения которого будут отображаться в выпадающем списке.
       • Множественный выбор — признак доступности множественного выбора значений справочника.
4. Нажмите Добавить параметр.

После создания параметра он отобразится в блоке Параметры.

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

1. Перейдите в окно создания или редактирования запроса.
2. В блоке Параметры нажмите напротив параметра, который необходимо изменить.
3. Внесите необходимые изменения в открывшемся модальном окне.
4. Нажмите Сохранить.

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

1. Перейдите в окно создания или редактирования запроса.
2. В блоке Параметры нажмите напротив параметра, который необходимо удалить.
3. В открывшемся модальном окне нажмите Удалить.

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

В системе предусмотрены следующие типы визуализации результатов запроса:

• таблица;
• график:
  • линейчатая гистограмма,
  • столбчатая гистограмма;
  • круговая диаграмма.

После добавления визуализации она будет отображена в нижней части страницы создания/редактирования запроса.

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

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

1. Перейдите в окно создания или редактирования запроса.
2. Нажмите Добавить тип визуализации.
3. В открывшемся модальном окне в поле «Тип визуализации» выберите значение «Таблица».
4. В поле «Название» укажите наименование таблицы, которое будет отображаться в интерфейсе Платформы.
5. Настройте визуализацию под ваши требования:
   • Для изменения порядка отображения колонок в таблице переместите их по одной в списке слева, удерживая напротив названия нужной колонки.
   • Для изменения признака отображения колонки в таблице используйте кнопку переключения напротив необходимой колонки:
     • — колонка отображается в таблице.
     • — колонка не отображается в таблице.
   • Для изменения названия колонки в таблице нажмите справа от необходимой колонки и заполните поле «Название колонки».
   • Для добавления описания колонки в таблице нажмите справа от необходимой колонки и заполните поле «Описание».
6. Нажмите Добавить.

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

1. Перейдите в окно создания или редактирования запроса.
2. Нажмите Добавить тип визуализации.
3. В открывшемся модальном окне в поле «Тип визуализации» выберите значение «График».
4. В поле «Название» укажите наименование гистограммы, которое будет отображаться в интерфейсе Платформы.
5. На вкладке Общее заполните поля:
   • Тип диаграммы — укажите значение «Гистограмма».
   • Линейчатая — выберите значение «Да».
   • Значения Y — поле запроса, которое будет отображаться по оси X.
   • Значения X — одно или несколько полей запроса, которые будет отображаться по оси Y.
6. На вкладке Ось Y заполните поля:
   • Шкала — отображение шкалы по оси Y:
     • Авто,
     • Линейная,
     • Логарифмическая,
     • Категории,
     • Дата / Время.
   • Имя оси — наименование оси Y, которое будет отображаться на графике.
   • Показать значения — признак отображения значений по оси Y на графике.
7. На вкладке Ось X заполните поля:
   • Шкала — отображение шкалы по оси X:
     • Линейная,
     • Логарифмическая,
     • Категории,
     • Дата / Время.
   • Имя оси — наименование оси X, которое будет отображаться на графике.
   • Мин. значение — минимальное значение, которое будет отображаться на графике по оси X.
   • Макс. значение — максимальное значение, которое будет отображаться на графике по оси X.
8. На вкладке Цвета выберите цвета для каждой категории данных по оси X.
9. Нажмите Добавить.

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

1. Перейдите в окно создания или редактирования запроса.
2. Нажмите Добавить тип визуализации.
3. В открывшемся модальном окне в поле «Тип визуализации» выберите значение «График».
4. В поле «Название» укажите наименование гистограммы, которое будет отображаться в интерфейсе Платформы.
5. На вкладке Общее заполните поля:
   • Тип диаграммы — укажите значение «Гистограмма».
   • Линейчатая — выберите значение «Нет».
   • Значения X — поле запроса, которое будет отображаться по оси X.
   • Значения Y — одно или несколько полей запроса, которые будет отображаться по оси Y.
6. На вкладке Ось X заполните поля:
   • Шкала — отображение шкалы по оси X:
     • Авто,
     • Линейная,
     • Логарифмическая,
     • Категории,
     • Дата / Время.
   • Имя оси — наименование оси X, которое будет отображаться на графике.
   • Показать значения — признак отображения значений по оси X на графике.
7. На вкладке Ось Y заполните поля:
   • Шкала — отображение шкалы по оси Y:
     • Линейная,
     • Логарифмическая,
     • Категории,
     • Дата / Время.
   • Имя оси — наименование оси Y, которое будет отображаться на графике.
   • Мин. значение — минимальное значение, которое будет отображаться на графике по оси Y.
   • Макс. значение — максимальное значение, которое будет отображаться на графике по оси Y.
8. На вкладке Цвета выберите цвета для каждой категории данных по оси Y.
9. Нажмите Добавить.

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

1. Перейдите в окно создания или редактирования запроса.
2. Нажмите Добавить тип визуализации.
3. В открывшемся модальном окне в поле «Тип визуализации» выберите значение «График».
4. В поле «Название» укажите наименование диаграммы, которое будет отображаться в интерфейсе Платформы.
5. На вкладке Общее заполните поля:
   • Тип диаграммы — укажите значение «Круговая».
   • Значения X — поле запроса, по которому отбираются данные.
   • Значения Y — одно или несколько полей запроса, по которым отображаются круговые диаграммы. Количество круговых диаграмм на графике соответствует количеству значений выбранных в данном поле.
   • Расположение легенды — местоположение легенды на графике:
     • Справа — легенда расположена справа от диаграмм.
     • Снизу — легенда расположена под диаграммами.
     • Скрыть — легенда не отображается на графике.
6. На вкладке Цвета выберите цвета для каждой категории данных по оси X.
7. Нажмите Добавить.

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

1. Перейдите в окно создания или редактирования запроса.
2. В нижней части страницы перейдите на вкладку с необходимой для редактирования визуализацей.
3. Нажмите Редактировать визуализацию.
4. В открывшемся модальном окне внесите необходимые изменения.
5. Нажмите Сохранить.

Для удаления типа визуализации выполните следующие шаги:

1. Перейдите в окно создания или редактирования запроса.
2. В нижней части страницы перейдите на вкладку с необходимой для удаления визуализацей.
3. Нажмите Редактировать визуализацию.
4. В открывшемся модальном окне нажмите Удалить визуализацию.

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

1. В интерфейсе Платформы перейдите в раздел Настройка → Построитель отчетов - создание запросов.
2. Определите запрос для редактирования, нажмите ••• в строке с ним и выберите опцию Редактировать.
3. Внесите необходимые изменения.
4. Нажмите Запустить для проверки правильности запроса. В нижней части страницы отобразится таблица с результатом запроса. При необходимости измените запрос и вновь нажмите Запустить.
5. Нажмите Сохранить.

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

1. В интерфейсе Платформы перейдите в раздел Настройка → Построитель отчетов - создание запросов.
2. Определите запрос для удаления, нажмите ••• в строке с ним и выберите опцию Удалить.
3. В диалоговом окне подтвердите удаление запроса, нажав Удалить.

Для просмотра списка ранее созданных дашбордов на Платформе перейдите в раздел Настройка → Построитель отчетов - дашборды.

На странице отображены все ранее созданные дашборды в табличном виде с указанием следующей информации:

• Создан — дата создания дашборда.

• Обновлён — дата последнего обновления дашборда.

• № — идентификатор дашборда.

• Наименование — наименование дашборда для отображения в интерфейсе Платформы.

• Код дашборда - уникальный код дашборда для определения прав доступа.

  

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

1. В интерфейсе Платформы перейдите в раздел Настройка → Построитель отчетов - дашборды.
2. Определите дашборд для просмотра, нажмите ••• в строке с ним и выберите опцию Открыть.

На странице отобразится выбранный дашборд.

При просмотре можно изменить значение параметров дашборда, для этого укажите новые значения в блоке «Параметры дашборда» и нажмите Обновить. Данные дашборда будут обновлены.

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

1. В интерфейсе Платформы перейдите в раздел Настройка → Построитель отчетов - создание запросов.
2. Нажмите Создать дашборд.
3. В открывшемся модальном окне введите название и код нового дашборда и нажмите Создать.

Созданный дашборд отобразится в общем списке дашбордов. Для дальнейшей настройки дашборда необходимо перейти в режим редактирования.

При редактировании дашборда можно:

• добавлять текстовые блоки,
• добавлять виджеты,
• определять расположение текстовых блоков/виджетов на дашборде,
• редактировать ранее созданные текстовые блоки/виджеты,
• перейти к запросу, на котором основан виджет,
• развернуть виджет для просмотра в отдельном модальном окне,
• удалять ранее созданные текстовые блоки/виджеты.

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

1. В интерфейсе Платформы перейдите в раздел Настройка → Построитель отчетов - дашборды.
2. Определите дашборд для редактирования, нажмите ••• в строке с ним и выберите опцию Открыть.
3. Нажмите Редактировать.

4. Внесите необходимые изменения:
   • Для добавления текстового поля:
     • Нажмите Добавить текст.
     • В открывшемся модальном окне укажите необходимый текст и нажмите Добавить.
   • Для добавления виджета:
     • Нажмите Добавить виджет.
     • В открывшемся модальном окне выберите запрос, на основании которого, будет строиться виджет.
     • Выберите тип визуализации для выбранного запроса.
     • Укажите параметры дашборда. Работа с параметрами дашборда описана в разделе Параметры дашборда.
     • Нажмите Добавить.
   • Для изменения расположения текстового блока/виджета на дашборде:
     • Перетяните текстовый блок/виджет на панели дашборда в требуемую область.
     • Измените размер текстового блока/виджета на панели дашборда потянув в правой нижней части виджета.
   • Для изменения текстового блока/виджета:
     • Нажмите в правом верхнем углу текстового блока/виджета.
     • В открывшемся модальном окне внесите необходимые изменения и нажмите Добавить. При редактировании виджета можно изменить только его параметры.
   • Для перехода к запросу, на котором основан виджет, нажмите Перейти к запросу в правой нижней части виджета.
   • Для просмотра виджета в отдельном модальном окне нажмите в правой верхней части виджета.

• Для экспорта в формате Excel и/или CSV нажмите .
  • Для удаления текстового блока/виджета:
    • Нажмите в правом верхнем углу текстового блока/виджета.
    • В открывшемся диалоговом окне подтвердите удаление, нажав Удалить.

5. Нажмите Завершить редактирование.

При работе с виджетами дашборда можно указать параметры, которые будут являться общими для всех виджетов, использующих их. Значение таких параметров задается в отдельном блоке Параметры дашборда, что упрощает работу с несколькими виджетами одновременно.

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

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

1. Перейдите в окно создания виджета и заполните поля «Запрос» и «Тип визуализации». Если в запросе были указаны параметры запроса, то они автоматически отобразятся в данном окне.
2. Нажмите справа от параметра.

3. В открывшемся окне редактирования параметра при необходимости измените автоматически заполненные значения параметров:
   • Название параметра — имя параметра дашборда для отображения в интерфейсе Платформы.
   • Источник — тип параметра:
     • Неизменное значение — статический параметр, который всегда будет иметь одно значение.
     • Новый параметр дашборда — новый параметр, общий для одного или нескольких виджетов в рамках дашборда.
     • Существующий параметр дашборда — параметр, общий для одного или нескольких виджетов в рамках дашборда, который был ранее создан, и к которому необходимо привязать создаваемый сейчас виджет.
     • Параметр виджета — параметр, предназначенный только для создаваемого виджета.
   • Значение — значение параметра дашборда.

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

1. В интерфейсе Платформы перейдите в раздел Настройка → Построитель отчетов - дашборды.
2. Определите дашборд для изменения названия, нажмите ••• в строке с ним и выберите опцию Редактировать.
3. В открывшемся модальном окне введите новое название дашборда и нажмите Сохранить.

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

1. В интерфейсе Платформы перейдите в раздел Настройка → Построитель отчетов - дашборды.
2. Определите дашборд для удаления, нажмите ••• в строке с ним и выберите опцию Удалить.
3. В диалоговом окне подтвердите удаление дашборда, нажав Удалить.