Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Note

Доступно начиная с версии ExeReport 1.4.

Info

Параметры отчета — это переменные, которые определяют выборку данных для отчета. Они позволяют пользователю настраивать вывод данных в зависимости от его потребностей и предпочтений. Использование параметров отчета позволяет создавать более целенаправленные и информативные документы, которые лучше соответствуют запросам пользователей. При разработке отчета в формате frx параметры настраиваются в окне «Data» в раскрывающемся списке «Parameters» основного экрана дизайнера отчетов FastReport. Для каждого параметра при вызове отчета передается значение, которое определяет параметры выборки и фильтрации данных в отчете.

Table of Contents

Настройка отображения параметров отчетов

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

В появившемся окне необходимо перейти на вкладку «Настройка параметров»:

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

НастройкаОписание

Отображать

 Включение видимости параметра отчета в режиме просмотра отчета.

Код свойства

 Название параметра, которое указал разработчик при разработке отчета в файле frx.

Название в форме

 Описание параметра, которое будет отображаться в режиме просмотра отчета.

Тип

 Тип параметра, который может быть выбран из списка.

Anchor
По умолчанию
По умолчанию
Значение по умолчанию

Значение параметра по умолчанию. Значение по умолчанию будет автоматически передано в параметр при построении отчета.

Tip

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

Anchor
Типы
Типы
Типы параметров отчета

Тип параметраОписание

Строка


Строковое значение:

Целое число

Целочисленное значение:

Число с плавающей точкой

Число с плавающей точкой - число с дробной частью,:

Дата

Значение в формате даты:

Для параметров данного типа предоставлена возможность выбора способа конфигурации значения по умолчанию. Для этого необходимо нажать на кнопку Image Added справа от поля "Значение по умолчанию". Для выбора доступно 2 конфигурации значения по умолчанию:

  • статическое значение. Для выбора статического значения необходимо выбрать позицию "Ручной ввод" в открывшемся меню;
  • скрипт - генерация значения по умолчанию с использованием одного из предопределенных алгоритмов. Для выбора скрипта необходимо выбрать одну из доступных позиций в открывшемся меню.


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

Дата и время

Время в формате "Дата и время":Для параметров данного типа предоставлена возможность выбора способа конфигурации значения по умолчанию. Для этого необходимо нажать на кнопку справа от поля "Значение по умолчанию". Для выбора доступно 2 конфигурации значения по умолчанию:

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

Время

Время в формате "Время"::

Для параметров данного типа предоставлена возможность выбора способа конфигурации значения по умолчанию. Для этого необходимо нажать на кнопку справа от поля "Значение по умолчанию". Для выбора доступно 2 конфигурации значения по умолчанию:

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



Переключатель

Булевое значение:

Флажок,

Радиокнопка,

Список,

Список с множественным выбором.

Список значений параметров отчета — это набор возможных значений, которые могут быть использованы в качестве значения параметра при генерации отчета. 

Пример конфигурации параметра типа «Флажок»:

Пример конфигурации параметра типа «Радиокнопка»:

Пример конфигурации параметра типа «Список»:

Пример конфигурации параметра типа «Список с множественным выбором»:

Note

Типы параметра «Флажок» и «Список с множественным выбором» допускают возможность передачи нескольких значений из списка. 

Типы параметра «Радиокнопка» и «Список» допускают возможность передачи только одного значения из списка. 

Указанные типы параметров отличаются визуально.

Пример отображения параметра типа «Флажок»:

Пример отображения параметра типа «Радиокнопка»:

Пример отображения параметра типа «Список»:

Пример отображения параметра типа «Список с множественным выбором»:

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

Expand
titleСтатический список

Статический список - список фиксированных значений, доступных к выбору и конфигурируемых вручную.

Для настройки статического списка необходимо нажать кнопку «Настройка списков» для настраиваемого параметра:

После чего в открывшемся окне сконфигурировать элементы списка. Для каждого списка должен быть задан хотя бы 1 элемент. Для каждого элемента списка необходимо настроить следующие поля:

  • использовать - признак того, что элемент списка необходимо отображать в списке;
  • выбрано по умолчанию - признак того, что элемент списка должен быть использован как значение параметра по умолчанию;
  • ключ - уникальное значение в рамках одного списка, значение ключа будет передано в качестве значения параметра отчета при построении отчета;
  • значение - отображаемое значение в списке для пользователя.

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

Для удаления элемента списка необходимо использовать кнопку 

Note

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

Ниже представлен пример конфигурации статического списка материалов:

Expand
titleДинамический список использующий данные из ExeMES
Note

Для работы с данным функционалом необходимо настроить взаимодействие с ExeMES.

Динамический список - список значений, формируемый на основе данных, возвращаемых web API ExeMES Server.

Для настройки динамического списка необходимо нажать кнопку «Настройка списков» для настраиваемого параметра:

 Затем необходимо выбрать в выпадающем списке «Источник значений для списка» значение «MesMiddleware API». В окне появится анимация загрузки перечня API MesMiddleware:

После загрузки перечня доступных API, в выпадающем списке «Используемое Api» необходимо выбрать API для получения данных от ExeMES:

Для любых API из списка есть возможность настройки фильтра значений списка. Для настройки фильтра, разверните область «Фильтр»:

В выпадающем списке «Параметр» необходимо выбрать поле, по которому необходимо настроить фильтрацию (доступны все возвращаемые API поля):

В поле «Значение» вводится значение параметра, по которому необходима фильтрация. Фильтр может состоять из нескольких параметров. Добавление параметра фильтра осуществляется по нажатию кнопки . Для удаления параметра фильтра необходимо использовать кнопку .

В приведенном ниже примере сконфигурирован фильтр списка из 2-х параметров для API ItemProd - Производство Материала. Запрос в ExeMES будет сформирован с фильтрацией по идентификатору материала (item_id) «S101» и качеству производства (good_prod) «true»:

Tip

Фильтр не является обязательной настройкой списка элементов для параметра отчета

Для настройки динамического списка необходимо сконфигурировать следующие поля:

  • ключ - необходимо указать возвращаемое API поле, которое будет использовано в качестве ключа - уникального значения которое будет передано в качестве значения параметра отчета при построении отчета;
  • значение - необходимо указать возвращаемое API поле, которое будет использовано в качестве значений для отображения элементов списка для пользователя.

Tip

В списке доступных API присутствуют преднастроенные API, для которых уже настроены поля «Ключ» и «Значение» и которые выделены цветом.