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

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

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

Image RemovedImage Added

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

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

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

Отображать

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

Код свойства

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

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

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

Тип

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

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

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

передано в параметр при построении отчета.

Tip

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

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

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

Строка


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

Целое число

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

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

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

Дата

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

Для

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

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

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


Image Added

Image RemovedСкрипты автоматического формирования значения

Дата и время

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

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

Image Modified

Время

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

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

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


Image Modified

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

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

Флажок,

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

Список,

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

Выбор из списка значений:

Список значений

параметров отчета

это

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

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

Image Added

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

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

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

Image Added

Note

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

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

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

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

Image Removed

Image Added

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

Image Removed

Image Added

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

Image Removed

Image Added

Пример

отображения параметра

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

Image Removed

Image Added

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

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

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

Для настройки статического списка необходимо

выбрать настраиваемый отчет и

нажать кнопку

«Настройки»:Image RemovedДалее перейти на вкладку

«Настройка

параметров» и нажать кнопку «Настройка При настройке статического списка значений параметра отчета

списков» для настраиваемого параметра:

Image Modified

Окно настройки статического списка значений параметра отчета представлено ниже:
Image Removed

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

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

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

      Image Added

    • значение
    «Значение» , после этого элемент списка является сконфигурированным.
    • - отображаемое значение в списке для пользователя.
    После конфигурации полей «Использовать», «Выбрано по умолчанию», «Ключ» и «Значение» необходимо нажать кнопку Image Removed

    Image Added

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

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

    кнопку

    кнопку Image Modified

    Каждый настроенный список должен сожержать хотя бы один элемент.

    Note

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

    Image Removed

    Ниже представлен пример

    конфигурации

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

    Image Modified

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

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

    Динамический список - список значений, формируемый на

    основании

    основе данных, возвращаемых web API ExeMES Server.

    Для настройки динамического списка

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

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

    Image Modified

     Затем

    Затем необходимо выбрать в выпадающем списке «Источник

    значений 

    значений для списка» значение «MesMiddleware API». В окне появится анимация загрузки перечня API MesMiddleware:

    Image Modified

    MesMiddleware

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

    выберите

    необходимо выбрать API для получения данных от

    сервера MesMiddleware

    ExeMES:

    Image Modified

    Для любых API из списка

    MesMiddleware API

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

    Image Modified

    В выпадающем списке «Параметр»

    доступны для выбора все поля, которые возвращаются выбранной API:

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

    Image Added

    Image Removed

    В поле «Значение» вводится значение параметра, по которому

    будет отфильтрован список MesMiddleware API

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

    кнопки

    кнопки Image Modified. Для удаления параметра фильтра необходимо использовать кнопку Image Modified.

    В приведенном ниже примере сконфигурирован фильтр для списка значений из 2-х параметров фильтрации для API ItemProd - Производство Материала. Запрос в

    MesMidleware

    ExeMES будет сформирован с фильтрацией по идентификатору материала (item_id) «S101» и качеству производства (good_prod) «true»:

    Image Modified

    значений списка MesMiddleware API

    Tip

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

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

    «Ключ» - уникальное значение в рамках одного списка, значение ключа будет передано в параметр
    • ключ - необходимо указать возвращаемое API поле, которое будет использовано в качестве ключа - уникального значения которое будет передано в качестве значения параметра отчета при построении отчета;
  • «Значение» - отображаемое значение в списке для пользователя.
  • Image Removed

    Ключ и значение выбираются из выпадающих списков. Выпадающие списки формируются на основании всех полей, которые возвращает выбранная API. Таким образом можно сформировать любую пару ключ-значение для передачи в параметр и построения отчета:

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

    Image Added

    Image Removed

    Tip

    В

    выпадающем

    списке доступных API присутствуют преднастроенные API,

    которые выделены цветом. Для них

    для которых уже настроены поля «Ключ» и «Значение»

    :

    и которые в списке маркером. 

    Image Added

    Image Modified

    преднастроенного APIImage RemovedВыбор