Шаблоны

Для работы с отчётом создайте и настройте шаблон отчёта. Шаблон отчёта определяет внешний вид отчёта, перечень параметров, входящих в отчёт, и правила формирования отчёта.

На основе шаблона отчётов ТехноДок может создавать неограниченное число экземпляров отчётов. Например, можно создать шаблон отчёта «Рапорт начальника смены станции» и настроить создание отчётов каждый день в 08:00.

Для перехода на форму работы с шаблонами отчётов выберите в меню раздел «Отчёты» → «Шаблоны».

Создание шаблона отчёта

Добавление нового шаблона отчёта

Для добавления нового шаблона отчётов:

• Выберите в меню «Отчёты» → «Шаблоны».
• Нажмите кнопку «Добавить» и введите имя шаблона.
• Выберите раздел, по которому отчёт будет сгруппирован в списке отчётов, или введите имя нового раздела.
• Выберите тип шаблона и нажмите кнопку «Создать».
  • Используйте тип «Отчёт за период» с включённой опцией «С шагом», если в отчёте надо выводить данные с определённой частотой. Например, это может быть отчёт за сутки с шагом 1 час.
  • Используйте тип «Отчёт на срез времени», чтобы вывести данные за указанный момент времени.
• Сформированный шаблон появится в списке шаблонов в левой части окна.

Копирование шаблона отчёта

Для копирования шаблона отчёта:

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

Экспорт шаблона отчёта

Экспортировать можно как все шаблоны, так и один выбранный шаблон. Для экспорта всех шаблонов:

• Рядом с кнопкой «Добавить» выберите вспомогательное меню, нажав на кнопку в виде трёх вертикально расположенных точек.
• Выберите пункт «Экспортировать».
• В появившемся окне выберите шаблоны, которые хотите экспортировать, и нажмите кнопку «Экспорт».
• Экспортированные шаблоны будут сохранены в директории для загруженных файлов в виде файла с расширением json.

Импорт шаблона отчёта

Для импорта шаблонов:

• В разделе «Шаблоны отчётов» рядом с кнопкой «Добавить» выберите вспомогательное меню, нажав на кнопку в виде трёх вертикально расположенных точек.
• Выберите пункт «Импортировать». В появившемся окне выберите json-файл с шаблонами отчётов.
• В появившемся окне выберите шаблоны, которые хотите импортировать из файла, и нажмите кнопку «Импортировать».

Примечание

Новые отчёты будут доступны только для пользователей с правом «Администрирование отчётов». При необходимости укажите права для остальных пользователей после импорта шаблонов отчётов. Настройка прав доступа к отчётам выполняется на форме «Настройки» → «Роли» и «Настройки» → «Пользователи».

Предупреждение

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

Конфигурация шаблона

Для настройки шаблона доступны вкладки «Разметка», «Параметры», «Правила» и «Настройки».

Разметка

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

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

• получать данные из внешних систем — SCADA (КАСКАД, WinCC OA, Альфа Платформа, OPC), СУБД (Microsoft SQL Server, PostgreSQL, MySQL и др.), веб-ресурсов, файлов и других источников;
• вычислять значение по формуле на языке C# — расчётные параметры;
• отображать визуальные компоненты — графики, диаграммы, журналы, подписи, выпадающие списки и т. д.

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

Добавить параметр в разметку можно двумя способами:

• перетаскиванием (drag & drop) параметра из панели справа в нужное место формы;
• вручную — вставкой ссылки на параметр в виде %Название параметра%. При формировании отчёта такие ссылки заменяются значениями соответствующих параметров — числами, таблицами, диаграммами, графиками и т. д.

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

Шаблон может содержать несколько страниц (листов). Переключение между страницами и добавление новой выполняется в панели над редактором. Для каждой страницы доступны собственные настройки формата: кликните по вкладке страницы и выберите «Редактировать страницу».

Вкладка «Разметка»

Постраничное отображение больших таблиц

Для таблиц с большим числом строк можно включить постраничное отображение (пагинацию). Опция значительно уменьшает потребление оперативной памяти на клиентских АРМах при просмотре отчётов с миллионами значений: вместо загрузки всех строк сразу браузер запрашивает данные постранично.

Пагинация настраивается в свойствах таблицы в разметке шаблона (доступно для отчётов с шагом). Чтобы открыть свойства таблицы, нажмите на таблице правой кнопкой мыши и перейдите в настройки. В свойствах таблицы доступны параметры:

• «Включить пагинацию» — активирует постраничное отображение строк таблицы.
• «Количество записей на странице таблицы» — размер страницы (число строк). Должно быть целым числом.

При просмотре отчёта под таблицей отображается элемент навигации по страницам.

Параметры

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

Число параметров в шаблоне не ограничено, и параметры одного шаблона могут получать данные из разных источников. Держите в шаблоне не более 100–200 параметров: так отчёт быстрее загружает данные, а шаблон проще настраивать в конструкторе. Если параметров больше, разделите отчёт на несколько шаблонов.

• Описание всех групп параметров шаблона (источники данных, расчётные параметры, компоненты) вынесено на отдельную страницу — см. Параметры.
• Справочник встроенных переменных, функций и структур данных, которые можно использовать в формулах расчётных параметров, приведён на странице Расчётные параметры.

Вкладка «Параметры»

Правила

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

Добавить новое правило можно кнопкой «Добавить». Каждое правило можно временно отключить переключателем в заголовке блока «Триггер» — отключённое правило не выполняется, а его настройки становятся недоступны для редактирования. Удалить правило можно по кнопке с изображением корзины.

Вкладка «Правила»

Триггер

Триггер определяет, что и когда запускает правило.

• «Источник триггера» — источник события, запускающего правило:
  • «Периодическая задача» — правило проверяется по расписанию: по времени или по значению параметра.
  • «Событие отчёта» — правило срабатывает при изменении отчёта (своего или другого).
• «Дата начала правила» — дата и время, с которых правило начинает действовать.
• «Периодичность» — режим повторения правила:
  • «Однократно» — правило срабатывает один раз.
  • «Повторять в течение периода» — правило повторяется в течение заданной продолжительности.
  • «Бесконечно» — правило действует без ограничения по времени.
• «Продолжительность» — период, в течение которого повторяется правило. Поле отображается только для периодичности «Повторять в течение периода».

Условие

Набор полей блока «Условие» зависит от выбранного источника триггера.

Источник «Периодическая задача». Поле «Проверка» задаёт тип условия:

• «Время» — действие выполняется по расписанию. В зависимости от периодичности отображается поле «Совершать действие каждые» (для повторяющихся правил) или «Совершить действие через» (для однократного правила), где задаётся интервал срабатывания.
• «Параметр» — действие выполняется при выполнении условия по значению параметра. Задаются:
  • «Параметр» — параметр шаблона, значение которого проверяется (доступны параметры строкового, числового и логического типов, а также значения WinCC OA).
  • «Условие» — условие сравнения. Набор доступных условий зависит от типа параметра:
    • строковые: «Содержит подстроку», «Не содержит подстроку», «Равен строке», «Не равен строке»;
    • числовые: «Больше», «Меньше», «Равно», «Не равно», «Входит в интервал», «Не входит в интервал»;
    • логические: «Верно», «Неверно».
  • «Значение» — эталонное значение для сравнения (число, строка или границы интервала). Для логических условий поле не отображается.

Источник «Событие отчёта». Поле «Событие» задаёт источник события:

• «Своего отчёта» — правило срабатывает при изменении текущего отчёта. Задаётся «Тип изменения отчёта».
• «Другого отчёта» — правило срабатывает при изменении другого отчёта. Задаются:
  • «Отчёт» — шаблон отчёта, изменения которого отслеживаются.
  • «Тип изменения отчёта» — событие, на которое реагирует правило.
  • «Дата начала отсчёта» — метка времени, от которой отсчитывается период создаваемого отчёта: «Дата формирования отчёта», «День отчёта», «Месяц отчёта» или «Год отчёта».
  • «Сдвиг от начала отсчёта» — смещение относительно даты начала отсчёта (может быть отрицательным).
  • «Продолжительность отчёта по умолчанию» — период создаваемого отчёта (для отчётов за период).

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

Действие

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

• «Обновить» — пересчитать отчёт. Настройки определяют, какие данные сохранять при пересчёте:
  • «Сохранять рассчитанные значения» — сохранять ранее рассчитанные значения параметров.
  • «Сохранять значения из внешних источников» — сохранять загруженные из внешних источников значения (недоступно, если включена предыдущая опция).
  • «Сохранять значения изменённые вручную» — сохранять значения, отредактированные пользователем вручную.
  • «На основе последней версии шаблона» — выполнять пересчёт по актуальной версии шаблона.
• «Отправить по почте» — сформировать и отправить отчёт по электронной почте:
  • «Тема» — тема письма.
  • «Тип файла» — формат вложения: «PDF», «Excel», «Excel (без разметки)», «HTML», «CSV».
  • «Список отчётов» — перечень шаблонов отчётов, включаемых в отправку.
  • «Список адресатов» — адреса электронной почты получателей.
  • «Архивировать перед отправкой» — упаковать вложения в архив.
  • «Название архива» — шаблон имени архива (отображается при включённом архивировании); поддерживает подстановки {name}, {start}, {end}, {now} и {Дата:…}.
• «Сохранить в файл» — сохранить отчёт в файл:
  • «Тип файла» — формат файла (см. список выше).
  • «Путь до директории» — каталог для сохранения файла.
• «Заблокировать» — заблокировать отчёт от изменений:
  • «Сдвинуть время срабатывания на» — смещение времени срабатывания (может быть отрицательным).
• «Создать» — сформировать новый отчёт:
  • «Сдвиг относительно даты срабатывания правила» — смещение периода создаваемого отчёта относительно момента срабатывания.
  • «Продолжительность отчёта по умолчанию» — период создаваемого отчёта (для отчётов за период).
  • «Значения предопределённых параметров» — значения предопределённых параметров шаблона (при их наличии).
• «Напечатать» — отправить отчёт на печать:
  • «Принтер» — принтер для печати.
  • «Размер страницы» — размер листа (список зависит от выбранного принтера).
  • «Количество копий» — число копий (не менее 1).
• «Удалить» — удалить отчёт:
  • «Время хранения» — период, по истечении которого отчёт удаляется.

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

Настройки

На вкладке «Настройки» задаются основные свойства шаблона, сгруппированные по разделам «Общие», «Формат», «Ограничения» и «Доступ».

Вкладка «Настройки»

Общие

• «Наименование» — название шаблона отчёта.

• «Раздел» — раздел, по которому отчёт группируется в списке отчётов.

• «Тип отчёта» — «Отчёт за период» или «Отчёт на срез времени». Задаётся при создании шаблона и не изменяется.

• «Тип периодического отчёта» — для отчёта за период: с шагом или без шага. Задаётся при создании шаблона и не изменяется, так как от него зависят метки расчёта параметров.

• «Шаг» — частота вывода данных для отчёта с шагом (например, 1 час).

• «Журнал расчётов» — определяет, какие результаты расчёта значений параметров сохраняются в БД и показываются в журнале расчётов отчёта:

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

  Запись всех значений заметно замедляет сохранение отчёта и занимает много места в БД: на отчётах с большим количеством значений сохранение может занять несколько минут. Включайте режим «Все значения» на время разбора проблемы и возвращайте «Только ошибки» после него.

Формат

• «Формат даты» — формат отображения дат в отчёте.
• «Дата начала по умолчанию» — значение даты начала, подставляемое при открытии формы формирования отчёта.
• «Смещение» — поправка к дате начала отчёта.
• «Продолжительность отчёта по умолчанию» — период отчёта по умолчанию (для отчётов за период).
• «Шаблон имени файла» — шаблон названия файла при экспорте отчёта.

Ограничения

Раздел доступен для отчётов за период с шагом.

• «Максимальное количество шагов» — ограничивает количество шагов в отчёте при формировании. Если число шагов превышает заданное значение, формирование отчёта прерывается, а пользователю выводится оповещение. Значение по умолчанию — 86 400 (количество секунд в сутках). Если значение не задано — количество шагов не ограничено.

• «Максимальное количество шагов при экспорте» — ограничивает количество шагов (строк) в отчёте при экспорте в PDF, HTML и XLSX (с разметкой), а также при печати и отправке по почте. Значение по умолчанию — 3 600. Если число строк превышено, отчёт экспортируется частично, а пользователю выводится сообщение с указанием числа экспортированных и общего числа строк.

  Ограничение не применяется при экспорте в CSV и в Excel без разметки — эти форматы всегда выгружают все строки отчёта. Используйте их для выгрузки больших объёмов данных целиком.

Примечание

Не рекомендуется увеличивать значения настроек ограничения шагов без необходимости — это может привести к снижению производительности и повышенному потреблению ресурсов при формировании и экспорте отчётов. Для выгрузки всех строк большого отчёта используйте экспорт в CSV/Excel без разметки (см. Экспорт отчёта).

Доступ

• «Разрешить просмотр отчётов по ссылке» — любой пользователь сможет открыть отчёт по ссылке без авторизации.
• «Скрыть отчёты» — скрывает отчёты шаблона в списке отчётов.
• «Права» — перечень ролей и назначенных им прав доступа к отчёту.