Шаблоны отчетов

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

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

Для перехода на форму работы с шаблонами отчетов в меню надо выбрать раздел Отчеты -> Шаблоны.

Конструктор шаблонов отчетов

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

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

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

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

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

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

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

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

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

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

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

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

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

примечание

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

к сведению

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

Параметры

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

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

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

КАСКАД 3, WinCC OA, АСОКУ

Параметр для получения данных из системы КАСКАД версии 3. Использует протокол XMLRPC для доступа к точкам данных и архивам. Источник данных так же совместим со SCADA системами WinCC OA и АСОКУ.

Настройки параметра:

• Внешнее соединение — соединение с системой КАСКАД 3, настроенное в разделе Справочник соединений.

• Тип параметра — вид запроса:

  • Значение параметра за метку времени
  • Среднее за период для дискретного параметра
  • Средневзвешенное за период
  • Последнее за период
  • Минимальное за период для дискретного параметра
  • Максимальное за период для дискретного параметра
  • Среднее за период для непрерывного параметра
  • Минимальное за период для непрерывного параметра
  • Максимальное за период для непрерывного параметра
  • Сумма за период
  • Количество изменений параметра за период
  • Запрос dpQuery() — произвольный запрос к архиву, результат в виде HTML-таблицы
  • Запрос алармов — запрос событий из архива алармов, результат в виде таблицы
  • Значение параметра на начало отчетного дня
  • Значение параметра на первое число отчетного месяца
  • Значение параметра на первое число отчетного года
  • Изменение значения параметра за период — разница значений в начале и конце периода
  • Алармы за период — список алармов в виде массива
  • Значения параметра за период времени — массив значений точки данных
  • Значение пользовательского бита
  • Описание точки данных
  • Единица измерения точки данных
  • Формат точки данных
  • Запись из каталога сообщений

• Адрес тега — адрес точки данных. Можно ввести вручную или выбрать через дерево тегов.

• Архивная группа — номер архивной группы.

  • Настройка актуальна для проектов с NGA бекендом InfluxDB. Настройка является опциональной.
  • Данная опция предназначена для оптимизации количества запросов к БД InfluxDB, так как по умолчанию запросы рассылаются во все архивные группы, что повышает нагрузку на SCADA систему и БД InfluxDB.
  • При указании номера архивной группы в CONTROL-запрос добавляется выражение с ключевым словом ARCHIVENUM, которое говорит проекту из какой группы читать данные.

КАСКАД 4

Параметр для получения данных из системы КАСКАД версии 4.

Настройки параметра:

• Внешнее соединение — соединение с системой КАСКАД 4, настроенное в разделе Справочник соединений.
• Тип параметра — вид запроса:
  • Значение параметра на текущее время — текущее значение точки данных.
  • Значение параметра за метку времени — значение на указанный момент времени.
  • Значения параметра за период времени — массив значений за интервал.
• Имя системы — имя подсистемы КАСКАД (например, System1).
• Адрес тега — адрес точки данных. Можно ввести вручную или выбрать через дерево тегов.

OPC UA, DA, HDA

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

Настройки параметра:

• Внешнее соединение — соединение с OPC-сервером, настроенное в разделе Справочник соединений. Стандарт соединения (UA, DA, HDA) определяет доступные типы параметра.
• Тип параметра — вид запроса:
  • Значение параметра на текущее время — текущее значение тега.
  • Значение параметра за метку времени — значение тега на указанный момент времени.
  • Значения параметра за период времени — массив значений тега за заданный интервал
• Адрес тега — адрес тега на OPC-сервере. Можно ввести вручную или выбрать через дерево тегов.
• Включать границы — включать ли в выборку значения на граничных временных метках.
• Максимальное количество возвращаемых записей — ограничение числа строк в результате.

СУБД Microsoft SQL Server, MySQL, PostgreSQL, InfluxDB

Параметр для выполнения запросов к базам данных и использования результатов в отчёте. Поддерживаются Microsoft SQL Server, MySQL, PostgreSQL и InfluxDB. С помощью встроенного редактора запросов можно просматривать структуру БД и формировать запросы как вручную, так и с помощью графического конструктора.

Порядок настройки параметра:

1. Настройте внешнее соединение с базой данных в разделе Справочник соединений.
2. Создайте новый параметр в шаблоне отчёта и выберите тип СУБД.
3. Укажите свойства параметра:
   • Внешнее соединение — соединение, созданное на первом шаге.
   • Тип параметра — определяет формат вывода данных. Выберите подходящий вариант в зависимости от задачи.

Тип параметра СУБД

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

• Таблица (html) — легковесная HTML-таблица без возможности редактирования. Для вывода больших объёмов данных в читаемом виде.
• Таблица (числа) — таблица с исключительно числовыми данными. К элементам можно обращаться по индексам строк и столбцов (например, %Параметр%[1][0]). Оптимально, когда один запрос нужно многократно использовать в расчётах.
• Матрица объектов — таблица для данных любого типа (строки, числа, даты). К элементам можно обращаться по индексам матрицы.
• Ячейка (строка) — одно значение в виде строки. Можно размещать в табличных ячейках с шагом. Поддерживает редактирование в отчёте и подсветку.
• Ячейка (число) — одно значение в виде числа. Можно размещать в табличных ячейках с шагом. Поддерживает редактирование в отчёте и подсветку.

4. Настройте редактор запросов. Доступны два режима:
   • Расширенный — ручной ввод запроса. Включает Обозреватель базы данных для просмотра структуры БД (таблицы, столбцы, типы данных).
   • Простой — Low-code конструктор для построения запросов к одной таблице.

Тип параметра СУБД (Простой режим)

В простом режиме доступны следующие блоки:

1. Схема и таблица — выберите целевую таблицу из выпадающего списка.
2. Столбцы — выберите нужные столбцы, при необходимости укажите агрегатную функцию и псевдоним.
3. Отфильтровать (WHERE) — задайте условия выборки. В поле Значение можно ввести константу или выбрать другой параметр шаблона.
4. Дополнительно (опционально): GROUP BY, ORDER BY, LIMIT.

Пример отображения данных в отчете

ODBC

Параметр для выполнения SQL-запросов через драйвер ODBC.

Настройки параметра:

• Внешнее соединение — соединение через ODBC, настроенное в разделе Справочник соединений.
• Тип параметра — формат возвращаемых данных:
  • Таблица (html) — результат запроса в виде HTML-таблицы.
  • Массив дробных чисел — двумерный массив числовых значений.
  • Матрица объектов — двумерный массив значений любого типа.
  • Ячейка (строка) — одно значение в виде строки.
  • Ячейка (число) — одно значение в виде числа.
  • Множество строк — одномерный массив строк.
• SQL-запрос — текст запроса к базе данных.
• Включать заголовок — добавлять ли строку с именами столбцов в результат (для типа Таблица (html)).

OLE DB

Параметр для выполнения SQL-запросов через провайдер OLE DB.

Настройки параметра:

• Внешнее соединение — соединение через OLE DB, настроенное в разделе Справочник соединений.
• Тип параметра — формат возвращаемых данных:
  • Таблица (html) — результат запроса в виде HTML-таблицы.
  • Ячейка (строка) — одно значение в виде строки.
  • Ячейка (число) — одно значение в виде числа.
• SQL-запрос — текст запроса к базе данных.
• Включать заголовок — добавлять ли строку с именами столбцов в результат (для типа Таблица (html)).

WinCC

Параметр для получения данных из SCADA-системы WinCC через её базу данных.

Настройки параметра:

• Внешнее соединение — соединение с БД WinCC, настроенное в разделе Справочник соединений.
• Адрес тега — имя тега в WinCC.
• Тип агрегации — способ обработки данных за период:
  • Значения параметра за период времени — массив всех значений за интервал.
  • Первое за период — первое зафиксированное значение.
  • Последнее за период — последнее зафиксированное значение.
  • Минимальное за период — минимальное значение.
  • Максимальное за период — максимальное значение.
  • Среднее за период — среднее значение.
  • Сумма за период — сумма значений.
• Параметр с именем БД — параметр шаблона типа string, содержащий имя базы данных WinCC.

HTTP

Параметр для получения данных через HTTP-запрос. Результат возвращается в виде строки.

Настройки параметра:

• Внешнее соединение — соединение с HTTP-сервером, настроенное в разделе Справочник соединений.
• Метод — HTTP-метод запроса: GET, HEAD, POST, PUT, DELETE, OPTIONS.
• Путь — путь к ресурсу, добавляемый к базовому URL соединения.
• Тело запроса — тело запроса (для методов POST, PUT).
• Заголовки — список HTTP-заголовков в виде пар ключ — значение.

Наработка

Параметр для получения расчётных показателей из модуля Наработка.

Настройки параметра:

• Тип параметра — функция расчёта:
  • Продолжительность пребывания оборудования в определённом состоянии за период — суммарная длительность нахождения в состоянии за интервал.
  • Количество вхождений оборудования в определённое состояние за период — число переходов в состояние за интервал.
  • Информация по последнему пребыванию оборудования в определённом состоянии с начала года — длительность последнего периода нахождения в состоянии с начала года.
  • Журнал изменения состояний оборудования за период — полный журнал переходов за интервал.
• Параметр — параметр учёта времени работы, настроенный в модуле Наработка.
• Устройство — устройство из параметра учёта.
• Состояние — состояние, по которому ведётся расчёт.

Отчет

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

Настройки параметра:

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

ПК Пирамида

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

Настройки параметра:

• Внешнее соединение — соединение с ПК Пирамида, настроенное в разделе Справочник соединений.
• Тип параметра — вид запроса (значение параметра, дискретное состояние и т.д.).
• Параметр — имя параметра в ПК Пирамида.
• Имя объекта — имя объекта, к которому относится параметр.
• Код объекта (ObjCode) — числовой код объекта.
• Элемент объекта (ObjItem) — числовой код элемента объекта.
• Имя группы дискрет — название группы дискретных состояний (для дискретных запросов).
• Имя дискреты — название конкретного дискретного состояния.
• Значение по умолчанию — состояние по умолчанию для дискретных значений.

Справочники

Параметр для получения данных из справочников ТехноДок (модуль Справочники). Позволяет читать атрибуты экземпляров классов и фильтровать объекты по имени или значению атрибута.

Настройки параметра:

• Тип параметра — вид запроса к справочнику: список экземпляров класса, значение атрибута, фильтрация по имени или атрибуту и т.д.
• Словарь — справочник, из которого запрашиваются данные.
• Экземпляр класса — узел в дереве словаря (выбирается интерактивно).
• Фильтр по имени — строка для фильтрации экземпляров класса по имени.
• Атрибут — атрибут класса для чтения или фильтрации.
• Значение атрибута — значение для фильтрации экземпляров.

Для типа Атрибут экземпляра класса:

• Экземпляр класса — идентификатор экземпляра, введённый текстом.
• Имя атрибута — имя атрибута, введённое текстом.

Файл (Текст)

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

Настройки параметра:

• Источник — откуда берётся файл:
  • Сервер — файл читается с сервера через внешнее соединение.
  • Клиент — файл загружается пользователем в браузере при открытии отчёта.

Для источника Клиент:

• Расширение файла — фильтр допустимых расширений (например, xlsx, csv).

Для источника Сервер:

• Формат файла — формат читаемого файла: TXT, CSV или Excel.
• Внешнее соединение — соединение с файловым хранилищем, настроенное в разделе Справочник соединений. Для формата Excel используется отдельный тип соединения.

Дополнительные настройки для формата Excel:

• Тип параметра — формат возвращаемых данных:
  • Таблица — диапазон ячеек в виде таблицы.
  • Ячейка (строка) — одна ячейка в виде строки.
  • Ячейка (число) — одна ячейка в виде числа.
• Название или номер страницы — имя или порядковый номер листа книги (нумерация с 1).
• Адрес первой ячейки — адрес ячейки или начала диапазона в формате A1.
• Адрес последней ячейки — адрес конца диапазона в формате A1 (только для типа Таблица).

Расчетные параметры

Агрегация

Параметр, вычисляющий агрегированное значение по данным другого параметра за заданный период. Совместим с параметрами типов: КАСКАД 3, КАСКАД 4, ПК Пирамида, OPC UA, СУБД (числа), а также другими параметрами агрегации.

Настройки параметра:

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

Расчетный параметр

Расчетные параметры предназначены для вычисления значения параметра при помощи скриптов на языке C#. Расчетные параметры могу ссылаться на другие параметры шаблона и использовать как встроенные функции ТехноДок, так и стандартные функции доступные в SDK .NET, например, математические функции.

Настройки и действия с расчетными параметрами:

• Тип возвращаемого значения - Дробное, Целое, Дата и т.д. Определяет тип значения которое возвращает расчетный параметр. Тип возвращаемого значения может быть выбран как из выпадающего списка, так и введен вручную если формула возвращает сложные типы данных, например IDictionary<string, string>. Поддерживаются все ,базовые типы данных и структуры .NET SDK.
• Кнопка Проверить - выполняет проверку введенной формулы, при обнаружении ошибок подсвечивает строки с ошибками и указывает подробный комментарий к ошибке.
• Кнопка Вставить параметр - показывает список параметров отчета который может быть использован в формуле, позволяет выбрать параметр и вставить в формулу как ссылку, например, %Параметр из отчета%.
• Кнопка Вставить метку времени - показывает список меток времени которые могут быть использованы в формуле: Дата начала отчета, Дата окончания отчета, Метка времени начала шага, Метка времени окончания шага (для отчетов с шагом) и т.д.
• Кнопка Вставить формулу - показывает список формул которые определены в справочнике формул.
• Кнопка Открыть справку - показывает встроенную справку с описанием системных функций ТехноДок.
• Кнопка Развернуть - переводит редактор формул в полноэкранный режим.

Настройки параметра:

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

Случайное значение

Параметр, генерирующий случайное число в заданном диапазоне. Используется для тестирования шаблонов отчётов.

Настройки параметра:

• Минимальное значение — нижняя граница диапазона.
• Максимальное значение — верхняя граница диапазона.

Компоненты

Выпадающий список

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

Настройки параметра:

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

Для ручного заполнения:

• Варианты — список значений для выбора.
• Значение по умолчанию — вариант, выбранный при открытии отчёта (может быть задан как значение другого параметра).

Для заполнения из словаря:

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

Для заполнения из другого параметра:

• Параметр — параметр шаблона, значения которого образуют список.

График

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

Настройки параметра:

• Тип графика — вид визуализации: линейный, столбчатый, круговой.
• Серии — набор параметров шаблона, отображаемых на графике. Для каждой серии задаётся параметр-источник данных, цвет и дополнительные настройки (тип линии, маркеры и т.д.).
• Настройки оси Y:
  • Минимум и максимум — границы оси (если не задано — подбираются автоматически).
  • Интервал — шаг делений оси.
  • Дополнительные линии — горизонтальные линии на графике, привязанные к значениям параметров.
• Настройки оси X:
  • Формат — автоматическая временная ось или массив меток из параметра.
  • Формат даты — строка форматирования временных меток (для автоматического режима).
  • Интервал — шаг временных меток.
  • Минимум и максимум — параметры, определяющие границы оси.
• Дополнительные настройки:
  • Заголовок — текст над графиком.
  • Ширина и высота — размеры графика в пикселях.
  • Позиция легенды — расположение подписей серий (вверху, внизу, слева, справа, скрыта).

Дата

Компонент, отображающий дату и время. Источником может служить системная дата отчёта или дата, введённая вручную, с возможностью задать смещение.

Настройки параметра:

• Значение — источник даты: начало/конец периода отчёта, текущее время, дата, введённая вручную и т.д.
• Формат — строка форматирования даты (например, dd.MM.yyyy HH:mm).
• Смещение — поправка к дате: месяцы, дни, часы, минуты, секунды (положительные и отрицательные значения).

Диаграмма наработки

Компонент для визуализации состояний оборудования на временной оси (диаграмма Ганта). Отображает периоды нахождения оборудования в различных состояниях.

Настройки параметра:

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

Журнал

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

Настройки параметра:

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

Навигация

Компонент для создания гиперссылки или кнопки перехода: на другой отчёт ТехноДок или на произвольный URL.

Настройки параметра:

• Текст — подпись ссылки или кнопки.
• Отображение — вид элемента: кнопка или гиперссылка.
• Открывать в новом окне — открывать ли цель перехода в новой вкладке браузера.
• Тип ссылки — цель перехода: отчёт ТехноДок или внешний URL.

Для перехода на отчёт:

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

Для перехода на URL:

• Адрес — полный URL-адрес для перехода.

Подпись

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

Настройки параметра:

• Подписанты — список пользователей системы, чьи подписи предусмотрены в данной позиции отчёта.

Строка

Компонент для отображения и ввода текстового значения. Значение задаётся как константа или берётся из другого параметра шаблона.

Настройки параметра:

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

Число

Компонент для отображения и ввода числового значения. Значение задаётся как константа или берётся из другого параметра шаблона.

Настройки параметра:

• Значение — константа или ссылка на другой параметр шаблона.