Справка

Создание и редактирование виджета

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

Создать новый виджет

Разберём, как создать виджет в Сводке по форме. Как добавить виджет в отдельный отчёт, описано в статье «Как создать отчёт и открыть доступ к нему».

Обратите внимание: чтобы создавать и изменять SQL-виджеты в Сводке по форме, нужны права менеджера или администратора формы и доступ ко всем её полям.

Подробнее о правах пользователя в формах

Шаг 1. Выбор типа визуализации и подготовка данных

Перед написанием запроса определитесь с конечным видом отчёта. Этот выбор определит структуру вашего SQL-запроса и формат данных, которые вы будете извлекать из полей формы Pyrus.

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

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

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

Шаг 2. Добавление виджета в Сводку

Виджеты, созданные с помощью SQL-запроса по определённой форме, собраны в разделе Сводка этой формы. Такие — пользовательские — виджеты размещаются выше стандартных виджетов Pyrus.

Чтобы создать новый виджет, выполните следующие действия.

  • Откройте раздел Сводка интересующей вас формы.

  • Нажмите кнопку Добавить виджет в правом верхнем углу экрана.

  • Откроется редактор виджета. Окно редактора разделено на две части. Верхняя часть предназначена для отображения результатов запроса, нижняя — для ввода запроса.

  • Введите SQL-запрос, написанный на диалекте ClickHouse, и нажмите Выполнить.

    Подробно о структуре данных для SQL-запроса

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

Пример создания виджета

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

В блок редактирования в нижней части экрана введите следующий SQL-запрос:

SELECT
  creator_id,
  COUNT(task_id)
FROM #tasks
WHERE DATE(create_date) >= DATE(now()) - 7
GROUP BY creator_id
ORDER BY COUNT(task_id) DESC
LIMIT 100;

Нажмите Выполнить. Вы увидите таблицу с количеством задач, созданных разными сотрудниками в течение последних семи дней. LIMIT 100 ограничивает результат ста авторами.

Шаг 3. Добавление псевдонимов

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

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

Пример создания виджета с переименованием столбцов и данных в таблице

Добавьте псевдонимы в ваш SQL-запрос и нажмите Выполнить.

SELECT
  creator_id AS "#person_full_name('Автор')",
  COUNT(task_id) AS "Задач создано"
FROM #tasks
WHERE DATE(create_date) >= DATE(now()) - 7
GROUP BY creator_id
ORDER BY COUNT(task_id) DESC
LIMIT 100;

После выполнения запроса таблица покажет заголовки Автор и «Задач создано», а вместо ID — имена сотрудников. Количество задач останется прежним.

Шаг 4. Добавление параметров

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

Пример подключения периода и фильтров

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

В примере используется поле Стоимость заявки типа Деньги. В своём запросе замените ${Стоимость заявки} на код или название денежного поля вашей формы.

Введите в нижней части редактора запрос с SQL-параметрами:

SELECT
  creator_id AS "#person_full_name('Автор')",
  SUM(${Стоимость заявки}) AS "Общая сумма",
  COUNT(task_id) AS "Задач создано"
FROM #tasks
WHERE
  create_date >= @period_start
  AND create_date <= @period_end
  AND #task_filters
GROUP BY creator_id
ORDER BY COUNT(task_id) DESC
LIMIT 100;

Нажмите Выполнить. Вы увидите, сколько задач создал каждый автор за выбранный период и на какую сумму. Если изменить период в Сводке, данные пересчитаются: параметры @period_start и @period_end берут даты из фильтра. Параметр #task_filters применяет остальные фильтры Сводки, например по статусу или ответственному.

Шаг 5. Проверка и сохранение виджета

  1. Проверьте результат запроса в верхней части редактора. Цифры должны совпадать с данными формы. Например, количество задач в виджете должно быть таким же, как в списке задач формы с теми же фильтрами.
  2. При необходимости смените тип диаграммы и формат значений, скройте таблицу или сгруппируйте строки. Как это сделать, описано в статье «Настройка и использование виджетов», в разделе «Настройка внешнего вида виджета».
  3. Нажмите Сохранить в правом верхнем углу редактора. Убедитесь, что виджет появился в Сводке.

Если запрос не выполняется, исправьте его по сообщению об ошибке в редакторе.

Как указывать поля формы в запросе и какие есть ограничения, описано в SQL-справочнике. Какие данные нужны для каждого типа диаграммы, описано в справочнике типов данных.

Редактирование виджета

  • Откройте Сводку формы или отчёт с нужным виджетом.

  • Наведите курсор на виджет и откройте меню с тремя точками.

  • Нажмите Настройки.

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

  • Нажмите Сохранить.

Удалить виджет

  • Откройте Сводку.

  • Переведите курсор на нужный виджет и нажмите три точки.

  • Нажмите Удалить виджет.

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

Как это сделать, описано в статье «Настройка и использование виджетов», в разделе «Скрытие и возврат виджета».

Что дальше?

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

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

Как указывать поля формы и параметры в запросе, описано в SQL-справочнике. Готовые запросы для типовых задач собраны в примерах отчётов.

Была ли эта статья полезной?