Обработка данных в шаблоне Pentaho Report Designer. Функции

Данные отчета/печатной формы формируются несколькими путями: в SQL запросе и в скрипте.

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

Для создания изменяемых данных используются параметры:

параметры отчета/печатной формы, изменяемые пользователями (настраиваются в скрипте отчета);
системные параметры, например, report.date, который возвращает текущую дату, дату построения отчета (настраиваются в шаблоне отчета PRD).

Добавление функции в шаблоне Pentaho Report Designer
Добавление системного параметра в шаблоне Pentaho Report Designer
Редактор формул в Pentaho Report Designer
Описание стандартных функций Pentaho Report Designer

Добавление функции в шаблоне Pentaho Report Designer

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

Чтобы добавить функцию в Pentaho Report Designer, выполните следующие действия:

На вкладке "Данные" нажмите иконку Добавить функцию.

На экране отобразится форма добавления функции.
Выберите функцию и нажмите кнопку ОК.

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

Добавление системного параметра в шаблоне Pentaho Report Designer

В шаблоне отчета можно добавить системные параметры, например, report.date, который возвращает текущую дату (дату построения отчета).

Чтобы добавить новый параметр в шаблоне PRD, выполните следующие действия:

На вкладке "Данные" нажмите иконку Добавить новые параметры.

На экране откроется форма добавления параметра.
Заполните поля на форме и нажмите кнопку ОК.

Форма добавления закроется, новый параметр отобразится на вкладке "Данные".

Редактор формул в Pentaho Report Designer

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

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

Выберите элемент шаблона PRD, на вкладке "Атрибуты" или "Стиль" выберите атрибут элемента.
Для вызова редактора нажмите кнопку в строке атрибута. На экране отобразится форма с редактором формул.
Выберите параметры формулы:
- категорию — из раскрывающегося списка "Категория" в левом верхнем углу формы: логические, текст, математические, дата/время и др.;
- оператор/функцию — двойным нажатием на названии оператора в поле "Функция" слева.
  
  Подробное описание функции и возвращаемое значение приводится внизу формы.
  
  Дважды кликните на функции, чтобы появились поля опций.
В полях опций замените значения по умолчанию на нужные.

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

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

Итоговая формула отображается в поле "Формула".
Чтобы закрыть редактор формул нажмите кнопку ОК.

Описание стандартных функций Pentaho Report Designer

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

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

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

Общие функции

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


Имя функции	Назначение
Открытая формула	Позволяет создавать пользовательские функции с помощью встроенного инструмента Редактор формул в Pentaho Report Designer. Данная функция работает в зависимости от ее места в отчете. Если нужно применить пользовательскую функцию перед всеми другими действиями отчета, следует использовать функцию в "расширенной категории".
Страница	Подсчитывает количество страниц в отчете до определенной страницы
Общее количество страниц	Показывает общее количество страниц в готовом отчете
Страница из страниц	Показывает номер текущей страницы в соответствии с общим количеством страниц в готовом отчете, см. Оформление шаблона PRD

Отчет

Отчет — функции, которые изменяют расположение окна просмотра готового отчета.


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

Сводные

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


Имя функции	Назначение
Сумма	Вычисляет сумму выбранных числовых столбцов. Выводит итоговую сумму всех столбцов
Подсчет	Вычисляет общее количество элементов, содержащихся в группе. Если группа не указана, учитываются элементы во всем отчете
Подсчет для страниц	Вычисляет общее количество элементов, содержащихся в группе на одной отображаемой странице. Если группа не указана, подсчитываются все элементы страницы
Подсчет для групп	Вычисляет общее количество элементов в указанных группах. Если группа не указана, подсчитываются все элементы во всех группах
Минимум	Определяет наинизшее или наименьшее значение в группе
Максимум	Определяет наивысшее или наибольшее значение в группе
Сумма частных	Выполняет простое деление итоговых сумм из двух столбцов и показывает числовое значение
Сумма частных процента	Выполняет простое деление итоговых сумм из двух столбцов и показывает значение в процентах
Расчет	Выполняет сохранение результата расчета. Эта функция может быть использована для преобразования группы или для получения единой итоговой информации
Сумма для страницы	Суммирует все указанные элементы на странице. Значение обнуляется при переходе на новую страницу
Подсчет для страницы (текущие)	Выполняет подсчет элементов на странице в соответствии с заданными критериями. Значение обнуляется при переходе на новую страницу

Текущие

Текущие — математические функции работы с промежуточными суммами, в отличие от функций "Сводные".


Имя функции	Назначение
Сумма (текущие)	Вычисляет промежуточную сумму в определенной колонке
Подсчет (текущие)	Вычисляет сколько элементов в группе или в отчете
Количество групп (текущие)	Вычисляет количество групп в отчете
Подсчет уникальных (текущие)	Вычисляет количество исключений определенного значения колонки
Средние (текущие)	Вычисляет среднее значение определенной колонки
Минимум (текущие)	Вычисляет минимальное значение определенной колонки
Максимум (текущие)	Вычисляет максимальное значение определенной колонки
Процент от общего (текущие)	Вычисляет процентное значение числового столбца. Общая сумма делится на количество элементов

Продвинутые

Продвинутые функции для разработчиков.


Имя функции	Назначение
Формат сообщения	Форматирует текст согласно требованиям формата текстового сообщения Java
Формат локализованного сообщения	Форматирует текст из пакета ресурсов согласно требованиям формата текстового сообщения Java.
Поиск	Отображает строку одной колонки до следующей строки. Допустимые отображения даны в паре ("ключ", "текст"). Если значение строки колонки null или не соответствует предоставленным ключам, будет задано альтернативное значение.
Непрямой поиск	Выдает значение отображаемого поля. Значение поля используется как ключ к отображению поля. Формула преобразовывает значение в имени новой колонке.
Поиск файла ресурсов	Проводит просмотр пакета ресурсов, используя значении определенного поля как "ключ" для пакета ресурсов. Эта формула выглядит также как и поле ресурса.
Открытая форма	Позволяет создавать пользовательские функции с помощью инструмента Редактор формул в Pentaho Report Designer. Функция будет включена первой при работе с отчетом.

Устаревшие функции

Устаревшие функции — функции, которые обеспечивают обратную совместимость файлов, созданных в предыдущих версиях "Генератора отчетов".

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

Cмотри также: