Построение отчета#
Отчеты системы GlobalFramework хранятся в базе данных — это позволяет легко адаптировать их под проекты. Для управления отчетами перейдите в приложение Global - Настройка системы.
Существует четыре типа отчетов:
произвольный;
динамический;
отчет с селекционным экраном;
экранная форма.
Варианты построения отчета#
Операция «Построить отчет»#
Стандартное построение отчета выбранного типа с заполнением параметров.
Для построения отчета перейдите в Отчеты - Настройки отчетных форм, выбрать нужный отчет, нажать Построить отчет и заполнить необходимые параметры.
Операция «Построить отчет c текущими параметрами»#
Построение отчета с уже настроенными ранее параметрами.
Для построения отчета перейдите в Отчеты - Настройки отчетных форм, выбрать нужный отчет, перейти на закладку «Журнал построения отчета», выбрать одну из предыдущих версий отчета и нажать Построить отчет с текущими параметрами. Система создаст новый отчет, используя параметры выбранного варианта.
Поведение идентично операции «Построить отчет».
Операция «Построить отчет в фоновом режиме»#
Для работы отчета в фоновом режиме необходимо:
Включить параметры:
«Вести журнал построения отчета» (закладка «Объектные характеристики»).
«Доступен фоновый режим» (закладка «Печатные формы отчета»).
Убедиться, что планировщик
Btk_Jobзапущен и корректно настроен в системе. Через него работает фоновая печать.Отчет не должен быть интерактивным. Печать интерактивного отчета в фоновом режиме невозможна.
Работает аналогично операции «Построить отчет», но в фоновом режиме. Запускается той же кнопкой.
При запуске (после окна с указанием параметров) открывается модальное окно с выбором:
режима выполнения;
даты и времени старта.
После завершения система показывает уведомление с перечнем построенных отчетов.
Результаты сохраняются:
в журнале построения отчета;
как прикрепленные файлы (если выбрано сохранение документа).
Если отчет запланирован, то в журнале можно удалить запись в состоянии «Запланирован к фоновой печати».
Подробности выполнения смотрите:
на вкладке Журнал построения отчета;
в меню
Сервис → Фоновые задания(отображает все фоновые процессы).
Механизм построения отчета#
Для произвольных отчетов#
Механизм поиска отчета: система ищет печатную форму, указанную на закладке «Объектные характеристики».
Открытие выборки с параметрами:
Вычисляет расширение файла (если выбрано несколько расширений по умолчанию), в котором будет создан отчет.
Открывает выборку в режиме
lookup, в которой заполняется карта параметровRpt_Pkg().docReportParamsMap(системное имя параметра → параметр).
Печать отчета: отчет формируется через метод
printReport.
Для остальных типов#
Механизм поиска отчета: система ищет печатную форму, установленную «По умолчанию», указанную на закладке «Печатные формы отчета».
Открытие выборки с параметрами:
Вычисляет расширение файла (если выбрано несколько расширений по умолчанию), в котором будет создан отчет.
Форма с параметрами указывается напрямую названием выборки и отображения.
Печать отчета: отчет формируется через метод
printReport.
Механизм поиска отчета#
Динамический отчет: поиск по
sSelectionNameиsRepresentationName.Отчет с селекционным экраном: поиск по
sSelectionNameиsRepresentationName.Экранная форма: поиск по
sSelectionNameиsRepresentationName.Произвольный отчет: механизм отличается (см. описание операций) .
Название выборки sSelectionName и отображения sRepresentationName указываются в карточке в объектных характеристиках отчетной формы Rpt_Entity.
Пример:
sSelectionName(имя выборки): Asf_InvNumbInSelScreenAvi.sRepresentationName(имя отображения): SelectionScreenCardDeprTax.
Проверка дубликатов отчетов по параметрам#
При построении нового отчета система определяет его ключевые параметры (все параметры указаны в разделе «Параметры отчета»), вычисляет их хэш и ищет готовые отчеты с такими же параметрами. При совпадении предлагается выбрать существующий отчет вместо создания нового.
Условия работы:
Параметр «Тип проверки отчета» выбран: «При построении» или «При построении и сохранении» (закладка «Объектные характеристики»).
Включен параметр «Вести журнал построения отчета» (закладка «Объектные характеристики»).
Если условия не выполнены — система всегда создает новый отчет.
Сохранение отчетов#
Вариант сохранения определяется параметрами на закладке «Объектные характеристики»:
«Сохранять отчет в документ».
Создается документ формата
Wf_Docс прикрепленным PDF-отчетом.В журнале появляется запись о построении отчета с указанием версии документа.
«Сохранять отчет в журнал как прикрепленный файл».
Создается документ
Wf_Docс PDF.В журнале появляется запись о построении отчета + документ прикрепляется к этой записи.
Оба варианта используют документ общего типа Wf_Doc, к которому прикрепляются файлы отчетов. Разница заключается в способе связи между записью в журнале и созданным документом.
Закладки справочника#
Параметры отчета#
Содержит параметры, настроенные на отчете.
Создание и удаление параметров по умолчанию выполняется в классе Печатные формы на соответствующей закладке.
Получить параметры можно с помощью операции Получить параметры отчета.
Объектные характеристики#
Настройки печати отчетов:
Тип проверки отчета при построении.
Ведение журнала построения отчета.
Сохранение отчета в журнал как прикрепленного файла.
Сохранение отчета в документ (прикрепление отчета к документу класса
Wf_Doc).
Журнал построения#
Содержит ранее сформированные отчеты.
Хранит параметры и метаданные отчетов.
Запись создается, только если включен соответствующий флаг на закладке Объектные характеристики.
Дополнительные настройки#
Тип документа: определяет тип документа, создаваемого при построении отчета.
JEXL для даты версии: содержит Jexl-выражение, которое вычисляет дату версии отчета.
Роли доступа отчета: определяет, какие пользователи могут создавать, просматривать и запускать отчет. Отчеты классифицируются по ролям доступа, которые соответствуют полномочиям пользователей, группам пользователей или отдельным пользователям. Если отчет предназначен для группы пользователей, соответствующая роль назначается всем участникам этой группы. Если отчет предназначен для конкретного пользователя, доступ ограничивается ролью, назначенной только этому пользователю. Если роли не указаны, применяются общие правила доступности отчета.
Процедуры интерактивного отчета: в закладке создаются процедуры, которые можно выполнить прямо в выборке построения отчета.
JEXL расширения сеттеров отчета: позволяет задать кастомную логику сеттера для интерактивного отчета.
Печатные формы отчета#
Для произвольных отчетов#
Допустима только одна печатная форма.
Из этой формы берутся все параметры отчета.
Для остальных типов#
Отображается список всех печатных форм.
Можно установить флаг печатной формы по умолчанию.