воскресенье, 5 октября 2014 г.

Руководство технолога по разработке отчетов

Перейти к концу метаданных
Переход к началу метаданных
This is version 0.9.0 of this page. | Status: Draft
Working Version:
VersionStatusChange InfoActions
0.8.0Draft
Page added in 0.8.0.
View  Compare
0.9.0Draft
Page modified in 0.9.0. (show differences)
View  Compare
0.10Draft
Page modified in 0.10. (show differences)
View  Compare

Аннотация

Данное руководство является частью документации банковской системы «Colvir Banking System (CBS-3plus)» и содержит описание технологического процесса разработки оперативных отчетов для CBS-3plus.
Руководство ориентировано на технологов по разработке отчетов. В рамках этого руководства рассматривается только создание отчета на базе запроса к базе данных (используя адаптер cbs3DB). Вариант же с написанием и использованием Java сервиса не раскрывается, так как это задача программиста.
Документ соответствует состоянию Системы на Сентябрь 2014 года.

Содержание


Настройка рабочего окружения

Установка дизайнера iReport

  1. Запуск в среде Windows: запустить «../iReport-5.5.1/bin/ireport.exe». Для работы необходимо установить JRE от Oracle (если не установлено) например «jre-7u65-windows-i586.exe».
  2. Запуск в среде Linux: запустить «../iReport-5.5.1/bin/ireport».

Настройка дизайнера iReport

Настройка дизайнера iReport включает в себя следующие этапы:
  1. Задать значение в поле unit = cm: «Меню—Tools—Options—General».
Форма задания единиц измерения в сантиметры.
Рис. 1. Задание единицы измерения в сантиметры
2. Задать язык по умолчанию Java:
Форма задания языка по умолчанию Java.
Рис. 2. Задание языка по умолчанию Java
3. Задать путь к файлу «colvir.config»:
Для этого на закладке «JasperReports Properties» необходимо выбрать кнопку «»:
Рис. 3. Форма свойств iReport
Откроется форма для заполнения полей Имя и Путь к файлу:
 Форма задания пути к файлу colvir.config.
Рис. 4. Задание пути к файлу «colvir.config»
Icon
Поле Путь к файлу должен содержать в качестве разделителя «/» либо «\\». Значение переменной должно быть заключено в кавычки.
В Примере указан адрес веб-сервера приложения CBS colvir.host=localhost, colvir.port=8080. Для работы необходимо задать свой адрес, используемый веб-сервером, на котором развернуто приложение CBS. Так же следует указать значения: «ИМЯ_ПОЛЬЗОВАТЕЛЯ» и «ПАРОЛЬ_ПОЛЬЗОВАТЕЛЯ».
Локализия отчета
Icon
Чтобы использовать предпросмотр в режиме перевода на другой язык, нужно указать необходимый язык в параметре «colvir.reportLanguage». Например :
colvir.reportLanguage=en_EN 
4. Добавить «ColvirDataSourceProvider» дата провайдер. Алгоритм выполнения операций следующий:
  • Нажать на кнопку «Report Datasources»:
Форма iReport.
Рис. 5. Форма iReport
  • Нажать на кнопку «New»:
Рис. 6. Задание Datasource
  • Выбрать пункт «JRDataSourceProvider»:
Форма выбора типа Datasource.
Рис. 7. Выбора типа Datasource
  • Задать провайдер:
Форма задания Datasource.
Рис. 8. Задание Datasource
Заполнение полей должно быть следующим:
    1. Name: ColvirDataSourceProvider
    2. Class: com.colvir.report.jasper.datasource.ColvirDataSourceProvider
    • Нажать на кнопку «Test»:
Форма успешного теста Datasource.
Рис. 9. Успешное прохождение теста Datasource
    • Для сохранения заполненных полей нажать на кнопку «Save» (см. Рис.8).

Процесс разработки нового отчета

Новый отчет состоит из следующих компонентов, которые нужно создать или воспользоваться существующими:
  1. Шаблон отчета– сверстанная печатная форма, которая содержит статичный текст/графику и переменные, которые будут подставляться. В CBS3-Front поддерживаются следующие форматы шаблонов отчетов:
    1. JReport – шаблон, который создается в редакторе iReport или Jasper Studio. Это основной формат, который рекомендуется для печати стандартных отчетов.
    2. OOXML – шаблон, в основе которого лежат DOCX/XLSX файлы.
  2. Отчет – сущность CBS3-Front, в рамках которой хранится шаблон отчета и все необходимые параметры для использование его в Системе.
  3. Набор данных– источник, из которого будет производиться наполнения шаблона данными. Основными видами наборов данных являются:
    1. Наборы данных на основе запросов в БД CBS3.
    2. Java сервисы, которые предоставляют нужные данные.

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

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

Для создания шаблона отчета необходимо выполнить в меню «File—New», выбрать вид отчета из предложенных бланков и пройти все шаги Мастера создания шаблона отчета.

Используемые переменные

Созданный шаблон должен содержать переменные. Для добавления переменных в отчет необходимо выполнить следующие действия: в меню «Window—Report Inspector» —«Variables»—контекстное меню «Add Variable».
Переменные необходимы для построения предпросмотра в iReport; в дальнейшем не исключено, что механизм будет изменен.
Icon
При создании нового отчета из шаблона iReport следует проверить шаблон XML созданного отчета на предмет содержания текста «language="groovy"». При обнаружении указанного текста его необходимо удалить.
В правой части экрана требуется заполнить поля:
  • Name: COLVIR_CONTEXT_NAME;
  • Variable Class: java.lang.String;
  • Variable Expression: в данном случае возможны варианты:
а) "C_CTX_DATASET_LST" – указать код контекста, по которому строится отчет (C_CTX_DATASET_LST – пример контекста), см. Рис. 10:
Рис. 10. Задание кода контекста
Icon
Контекст, а, следовательно, и набор данных, связанный с контекстом, должны быть сделаны до создания шаблона отчета. Значение переменной должно быть заключено в кавычки.
Если контекст содержит завершающий символ '$', то при зачитывании полей следует указывать: "C_CTX_DATASET_LST\$" _после зачитывания вернуть к нормальному виду"C_CTX_DATASET_LST$".
б) "DATASET$C_TEST_REPORT_SUB" – указать код набора данных, по которому строится отчет (C_TEST_REPORT_SUB – пример набора данных).
Icon
Набор данных должен быть создан до создания отчета. Значение переменной должно быть заключено в кавычки.
в) "RPT$C_TEST_REPORT_SUB" – указать код отчета, из которого будут взяты связанные с отчетом Источники данных (заданные на закладке «Источники данных») (C_TEST_REPORT_SUB – пример отчета).
Icon
Отчет, Источники данных должны быть созданы до создания отчета. Значение переменной должно быть заключено в кавычки.
Переменные, описывающие наборы данных для CBS-3plus могут быть любые в зависимости от того, что нужно передать в отчет. Ниже представлен пример вызова конкретного адаптера с переменными type, path, method:
  • ADAPTER_type;
  • ADAPTER_path;
  • ADAPTER_method.
 Пример использования: Нажмите здесь для раскрытия.
Можно задать переменные с префиксом DS_ и они будут передаваться в качестве параметров DataSet в запрос.
 Нажмите здесь для раскрытия...

Добавление полей

Для ручного задания полей выбрать: «Report Inspector—Fields»—контекстное меню «Add Field».
В правой части экрана заполнить поля:
  • Name: имя поля;
  • Field Class: класс поля;
  • Description: описание. 
Для автоматического задания полей следует нажать на кнопку, указанную на Рис. 11:
Форма дизайнера отчетов.
Рис. 11. Форма дизайнера отчетов
Затем открыть закладку «DataSource Provider»:
Форма получения полей из Datasource связанных с текущим отчетом.
Рис. 12. Получение полей из Datasource, связанных с текущим отчетом
Нажать на кнопку «Get fields from datasource».
Поля будут вычитаны, надо оставить нужные для отчета поля и нажать кнопку «ОК»:
Форма полей связанных с текущим отчетом.
Рис. 13. Выбор полей, связанных с текущим отчетом

Добавление элементов в отчет

Чтобы добавить элементы в отчет, необходимо выбрать в меню: «Window—Palette» и мышкой перетянуть элемент из окна Palette на поле отчета в соответствующий раздел (см. Рис. 14).
Рис. 14. Добавление элементов в отчет
Разделы отчета следующие:
  • Title: название отчета;
  • Page Header: заголовок страницы;
  • Column Header: заголовок столбца;
  • Detail: подробно;
  • Column Footer: нижний колонтитул колонки;
  • Page Footer: нижний колонтитул страницы;
  • Summary: краткое изложение.
Примеры отчетов можно посмотреть в Приложение 2.

Использование изображений в отчетах

Возможны два варианта загрузки картинок в отчет:
1. При загрузке ресурса непосредственно в отчет. Загрузка осуществляется в детализации отчета на закладках «Шаблон—Файлы ресурсов». Для добавления нового изображения необходимо сперва добавить новую запись, нажав на кнопку «», расположенную под списком, после чего выполнить загрузку изображения, нажав на кнопку «». Замена изображения осуществляется по нажатию на кнопку «» и загрузке нового изображения, удаление - на кнопку «»(см. Рис. 15). На закладке «Шаблон» следует указать примерно Следующее:

Рис. 15. Пример загрузки изображения непосредственно в отчет
В поле Алиас отображается код параметра, указанного в шаблоне отчета.
Для отчета OOXML  загружается файл шаблона "ИМЯ-ФАЙЛА.docx" или "ИМЯ-ФАЙЛА.xlsx".
2.  При указании адреса расположения ресурса. Указание адреса ресурса осуществляется в детализации отчета на закладках «Шаблон—Файлы ресурсов» в поле Путь к ресурсу - путь для выгрузки ресурса перед формированием отчета (см. Рис. 16 и Пример записи).

Рис. 16. Пример загрузки изображения с помощью указания адреса

Параметры отчета: переменные сессии

Поддерживаемые переменные сессии, которые могут использоваться в качестве параметров отчета, перечислены в Примере.
Пример в файле отчета
Icon
 Объявление:
<parameter name="SESSION_MAIN_POSCODE" class="java.lang.String"></parameter>
Использование:
<![CDATA[$P{SESSION_MAIN_POSCODE}]]>

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

OOXML – шаблон, за основу которого берутся DOCX/XLSX файлы, обычно созданные в Word/Excel. Он рекомендуется в первую очередь, когда шаблоны уже существуют в этом формате или часто исправляются самими сотрудниками, или даже являются уникальными для каждого сотрудника.

Описание и примеры выражений

Поддерживаются следующие выражения :
  • $P{ПАРАМЕТР}:
Пример
Icon
$P{RPT_TITLE}
  • $F{АЛИАС.ПОЛЕ}:
Внимание
Icon
Алиас обязательно должен быть задан.
Пример
Icon
$F{MAIN.LONGNAME}
  • $J{МЕТОД_JAVA}:
Пример
Icon
$J{com.colvir.report.Format.getCurrentDate()}
  • $L{КОМАНДА_ЦИКЛА.АЛИАС}:
Icon
Если указаны команды цикла "BEGIN", "END", то соответствующие строки таблицы, если они будут не пустые, будут удалены. Если указаны команды цикла "START", "STOP", то соответствующие строки таблицы не будут удалены.
Пример 1
Icon
$L{BEGIN.LOG}
...
$L{END.LOG}
Пример 2
Icon
 $L{START.LOG}
...
$L{STOP.LOG}
Пример 3
Icon
№
Код


$L{BEGIN.MAIN}


$F{MAIN.CODE}

 $F{MAIN.LONGNAME} 

Код
Сумма
№
$L{BEGIN.DETAIL}
$C{FORMAT.MONEY}

$F{DETAIL.CODE}
$F{DETAIL.VALUE}
$C{INC.ARABIC}
$L{END.DETAIL}
Итог $C{TOTAL.MONEY}
№
$L{BEGIN.DTL2}
$C{FORMAT.MONEY}

$F{DTL2.CODE}
$F{DTL2.VALUE}
$C{INC.ARABIC}
$L{END.DTL2}
Итог $C{TOTAL.MONEY}
$C{INC.ROMAN}
$L{END.MAIN}Итого позиций :$C{COUNT.ARABIC}
Итог$C{TOTAL.MONEY.CHILD}
  • $C{КОМАНДА}: команды циклов:
  1. Суммирование:
    • Деньги: $C{TOTAL.MONEY};
    • Числа: $C{TOTAL.NUMBER} или $C{TOTAL.DOUBLE} или $C{TOTAL.FLOAT} - значения идентичны;
    • Целые числа: $C{TOTAL.INTEGER} или $C{TOTAL.INT} - значения идентичны.
2. Суммирование во вложенных циклах:
    • Деньги: $C{TOTAL.MONEY.CHILD};
    • Числа: $C{TOTAL.NUMBER.CHILD} или $C{TOTAL.DOUBLE.CHILD} или $C{TOTAL.FLOAT.CHILD} - значения идентичны;
    • Целые числа: $C{TOTAL.INTEGER.CHILD} или $C{TOTAL.INT.CHILD} - значения идентичны.
3. Инкремент:
    • Арабские цифры: $C{INC.ARABIC} или $C{INC.DECIMAL} - значения идентичны;
    • Римские цифры: $C{INC.ROMAN}.
4. Количество строк:
    • Арабские цифры: $C{COUNT.ARABIC} или $C{COUNT.DECIMAL} - значения идентичны;
    • Римские цифры: $C{COUNT.ROMAN}.
5. Формат колонки:
    • Деньги: $C{FORMAT.MONEY};
    • Числа: $C{FORMAT.NUMBER} или $C{FORMAT.DOUBLE} или $C{FORMAT.FLOAT} - значения идентичны;
    • Целые числа: $C{FORMAT.INTEGER} или $C{FORMAT.INT} - значения идентичны;
    • Проценты: $C{FORMAT.PERCENT} или $C{FORMAT.PRC} - значения идентичны.

Конвертация в другие форматы

Конвертация в форматы осуществляется при помощи пакета LibreOffice. Страница загрузки пакета http://www.libreoffice.org/download/
Icon
Для успешной конвертации необходимо, чтобы LibreOffice был загружен в память. Это задается в настройках LibreOffice, где необходимо включить следующий пункт : Меню—Сервис—Параметры—LibreOffice—Память—Запускать LibreOffice во время запуска Системы. После перезапуска Системы LibreOffice загрузится в память; соответствующий значок должен быть в трэй.
Примеры отчетов:
C_REPORTQUEUE_DOCX, C_REPORTQUEUE_XLSX, C_REPORTSET_DOCX

Создание отчета в CBS-3plus

Создание набора данных

Для заполнения шаблона значениями нужен набор данных. Можно воспользоваться существующим, или создать новый.
Рассмотрим случай отчета на основании данных CBS3. Самым простым способом реализации выборки из CBS3 для набора данных является вариант использования адаптера CBS3DB. Для понимания принципов функционирования адаптера рекомендуется ознакомится со статьёй Адаптер для работы с БД cbs3, для правильности описания запроса и его параметров - со статьей Задача ведения запросов к БД. Задание типа наборов данных, список и описание полей изложены в статье Задача ведения наборов данных, правила описания контекстов - в статье Задача ведения контекстов.

Создание Отчета. Задача ведения Отчетов

XML-текст отчета, полученный iReport, необходимо сохранить в задаче «Список отчетов».
После запуска задачи на экране появится фильтр, позволяющий выполнить поиск отчета по заданным параметрам (см. Рис. 17):
Рис. 17. Фильтр задачи «Список отчетов»
Признаки:
  • «Запрет»: признак запрета использования отчета;
  • «Подотчет»: при выборе признака отображается список подотчетов в Системе.
Поля:
  • Код: уникальный в рамках Системы;
  • Наименование: длинное наименование отчета;
  • Модуль: модуль, к которому относится данный отчет (выбирается из справочника модулей);
  • Генератор:JR – для JasperReport, OOXML для шаблона *.docx, TXT - для Text template (выбирается из справочника);
  • Устройство печати: вид устройства печати (из справочника);
  • Локализация: вид локализации (из справочника);
  • Файл экспорта: файл экспорта сформированного отчета.
Все поля фильтра не обязательные для заполнения. После ввода условий предварительного отбора следует нажать кнопку «». Для очистки заполненных полей фильтра предназначена кнопка «», для сохранения заданных условий фильтра - кнопка «». Кнопка «» предназначена для создания фильтра с другими условиями отбора.
Для создания нового отчета следует нажать кнопку «».
После подтверждения условий отбора откроется главная форма задачи, содержащая список отчетов/подотчетов, удовлетворяющий условиям отбора (см. Рис. 18).
Рис. 18. ЭФ задачи "Список отчетов"
Панель инструментов главной формы задачи содержит кнопки, которые предназначены для выполнения над отчетами ряда сервисных операций, а именно:
«» - изменение фильтра или установка одного из предварительно настроенных фильтров;
 «» - создать новый отчет;
«» - создать копию отчета;
«» - детализация записи в режиме просмотра;
«» - редактировать отчет;
«» - удалить отчет;
«» - предварительный просмотр отчета;
«» - выполнить отчет;
«» - печатать отчет;
«» - компилирование шаблона отчета. Предназначена для более быстрого последующего выполнения отчета.
«» - компилирование всех шаблонов отчетов;
«» - при создании отчета в поле Настройка на закладке «Описание» задается условие, доступен ли для кастомизации отчет;
«» - показывает, от каких элементов словаря данных зависит и где используется выбранный отчет.
Для создания нового отчета необходимо выполнить команду «». Откроется форма (см. Рис. 19), содержащая следующие закладки:

Закладка «Описание»

Рис. 19. ЭФ закладки «Описание»
Атрибуты, которые необходимо задать в детализации задачи:
  • Код – уникальный в рамках Системы;
  • Наименование: длинное наименование отчета;
  • Наименование(краткое): наименование;
  • Локализация: вид локализации (выбирается из справочника);
  • Настройка: тип настройки для кастомизации отчета (выбирается из справочника);
  • Модуль: модуль, к которому относится данный отчет (выбирается из справочника модулей);
  • Примечание: комментарий к отчету.
Поля Код, Наименование, Наименование (краткое), Модуль являются обязательными для заполнения.
Кнопки «» и «» позволяют посмотреть отчеты в виде Jasper Report и docx.

Закладка «Шаблон»

Рис. 20. ЭФ закладки «Шаблон»
Признак «Подотчет» выбирается при создании подотчета, который в дальнейшем будет включаться в отчеты.
Поля:
  • Генератор отчетов: JR – для JasperReport, OOXML для шаблона *.docx (выбирается из списка);
  • Устройство печати: вид устройства печати (выбирается из списка);
  • Локализация: вид локализации (выбирается из списка). Для локализации шаблонов необходимо установить значение Локализация шаблона и задать язык, в котором выполнен шаблон отчета. Далее необходимо задать переводы фраз для данного отчета в блоке Локализации ресурсов;
  • Файл экспорта: файл экспорта сформированного отчета;
  • Язык: язык шаблона отчета (выбирается из списка). Язык отчета выбираем в параметрах формирования отчета (см. Формирование отчета).
Закладка «Шаблон» в свою очередь содержит следующие закладки:
  1. Закладка «Шаблон» (см. Рис. 20). Заполняется только при выборе Генератора отчета Jasper Report. В поле копируется XML-текст шаблона из отчета в iReport, (для типа OOXML не заполняется).
  2. Закладка «Файлы ресурсов» предназначена для загрузки изображений в отчет, что подробно описано в разделе Использование изображений в отчетах.
  3. Закладка «Подотчеты» предназначена для привязки подотчетов, используемых в отчете. Для шаблонов отчетов OOXML подотчеты не включаются. 
Рис. 21. Пример привязки подотчета
С помощью кнопки «» создаются поля, в которое из справочника Подотчет выбираются включаемые в отчет подотчеты.

Закладка «Параметры»

Рис. 22. ЭФ закладки «Параметры»
Закладка служит для настройки параметров отчета, которые надо будет заполнять при формировании отчета (в режиме ручного вызова отчета), либо должны быть переданы в сервис при автоматическом формировании отчета. Введение нового параметра осуществляется с помощью кнопки «», удаление - с помощью кнопки «», расположенных в нижней части формы.
Поля:
  • Код: код параметра, указанный в шаблоне отчета;
  • Наименование: наименование параметра будет отображаться в форме ввода параметров отчета;
  • Номер по порядку: порядок отображения на форме;
  • Обязательность: обязательность ввода значения параметра;
  • Домен: домен параметра (выбирается из справочника);
  • Тип элемента формы: тип элемента формы для ввода значения параметра отчета (выбирается из справочника);
  • Условие доступности: условие, при выполнении которого будет доступен ввод значения данного параметра (выбирается из справочника);
  • Значение по умолчанию: значение параметра (выбирается из справочника).
Поле Условие доступности может содержать:
  • ЗНАЧЕНИЕ
  • ПЕРЕМЕННАЯ:
Поле Значение по умолчанию может содержать:
  • ЗНАЧЕНИЕ
  • ПЕРЕМЕННАЯ:

Закладка «Источники данных»

Рис. 23. ЭФ закладки «Источники данных»
Служит для задания источников данных, используемых в отчетах.
Поля:
  • Алиас – код параметра, используемого в отчете;
  • Основной алиас – зарезервировано для последующего использования;
  • Набор данных – связанный с параметром отчета набор данных CBS (выбирается из справочника).
Для настройки передаваемых в отчет параметров надо нажать на кнопку «» и задать код и значение параметра.
Параметры поддерживают следующие выражения: 
 Выражения «const» и «session» являются идентичными.
Пример: 
${const.MAIN_POSCODE}
Для сохранения созданного отчета и любых изменений в отчете необходимо нажать кнопку «». Кнопка «» служит для отмены внесенных изменений в отчет; если был открыт режим создания отчета, с помощью кнопки он закроется. 

Формирование отчета

Формирование отчета доступно с помощью кнопок «», «», «», которые присутствуют на главной форме задачи (см. Рис. 18) и на детализации отчета в режиме просмотра. После нажатия на кнопки выполнения и печати отчета откроется форма ввода предварительных параметров (см. Рис. 24):

Рис. 24. Форма ввода параметров генерации отчета для действий «Выполнить», «Печать»
Признаки:
  • «Отложенное выполнение»: постановка отчета в очередь для ожидания его выполнения;
  • «Запустить немедленно»: постановка отчета в очередь и запуск его выполнения.
Поля:
  • Приоритет 0 (max) .. 9 (min): задание приоритета формирования в очереди отчетов: 0 - максимальное значение, 9 - минимальное значение;
  • Тип экспорта: файл экспорта сформированного отчета (из справочника);
  • Язык: язык отчета (из справочника);
  • Институт: институт, в разрезе которого формируется отчет (из справочника).
На Рис. 25 представлена форма ввода параметров генерации (упрощенная) для действия «Предпросмотр».

Рис. 25. Форма ввода параметров генерации отчета для действия «Предпросмотр»
Нажимаем на кнопку «». Если для отчета заданы параметры, то откроется форма для ввода их значений, после чего будет сформирован отчет.
Icon
Для CBS-3plus должен быть создан пользователь системы с одинаковым наименованием (не забываем про регистрозависимость) в институте CBS и в Cистеме CBS-3plus.
Операция кастомизации отчетов описана в разделе Кастомизация.

Добавление отчета в комплект

Обычно комплекты отчетов создаются для группировки отчетов по определенным критериям. Часто из той или иной формы осуществляется вызов комплекта отчетов, и за счет добавления отчета в этот комплект можно расширить список отчетов, доступных пользователю из нужной задачи. Добавление отчетов в комплект осуществляется на закладке «Отчеты» на детализации комплекта отчетов в задаче «Список комплектов отчетов»:
Рис. 26. ЭФ закладки «Отчеты»
На закладке можно изменить состав отчетов в комплекте (добавить с помощью кнопки «», исключить - кнопки «», расположенной в левой нижней части экрана).
Группа «Отчеты». Поля:
  • Код отчета: указывается код выполняемого отчета (выбирается из справочника);
  • Номер по порядку: указывается номер по порядку формирования отчета;
  • Тип документа: выбирается из списка тип файла экспорта отчета;
  • Количество копий: указывается количество копий отчета;
  • Условие формирования: указывается условие формирования отчета (выбирается из справочника). Поле может содержать:
  • Имя файла: указывается имя файла отчета. Например: ${report.RPT_CODE}_${report.RPT_INDEX}. Поле может содержать:
Кроме того для имени файла доступна переменная ${report.RPT_INDEX}. RPT_INDEX: ${report.RPT_INDEX} - номер файла отчета одного кода по порядку, т.е. от 1 до количества, указанного в поле Количество копий.
Группа «Параметры отчета»: задаются параметры добавленным отчетам стандартным образом (добавить - «», удалить - «»). Поля:
  • Параметр - указывается код параметра отчета;
  • Значение - указывается значение параметра.
Например: ${data.CODE} – ${field.PRIM} – ${const.MAIN_DOPER} – ${param.RPT_SUBTITLE}. Поле Значение может содержать:

Создание комплектов отчетов

Создание комплектов отчетов позволяет пользователю сгруппировать некоторое количество отчетов, относящихся к определенной задаче. Для создания комплектов отчетов предназначена задача «Список комплектов отчетов». После запуска задачи на экране появится фильтр, позволяющий выполнить поиск комплекта отчетов по заданным параметрам (см. Рис. 27):
Рис. 27. Фильтр задачи «Список комплектов отчетов»
Кроме стандартных атрибутов фильтра, описанных в разделе Создание Отчета. Задача ведения Отчетов, заполнить следующие поля (заполнение не обязательное):
  • Выдача результата: в список попадут комплекты отчетов с выбранным типом отработки результатов формирования отчетов (выбирается из справочника);
  • Формат файлов: выбирается из справочника поддерживаемых форматов.
Признак «Интерактивный режим»: при его выборе в список попадут комплекты отчетов с установленным признаком.
Создать комплект отчетов можно нажав на кнопку «».
После подтверждения условий отбора откроется главная форма задачи, содержащая список комплектов отчетов, удовлетворяющий условиям отбора (см. Рис. 28):
Рис. 28. Главная форма задачи «Список комплектов отчетов»
Список сервисных операций аналогичный описанному в разделе Создание Отчета. Задача ведения Отчетов (см. Рис. 18) за исключением следующих:
«» - выполнить комплект отчетов;
«» - выполнить отчет из комплекта отчетов.
Для создания нового комплекта отчетов необходимо выполнить команду «». Откроется форма, содержащая следующие закладки:

Закладка «Описание»:

Поля экранной формы закладки стандартные и соответствуют описанным ранее (см. Рис. 19).

Закладка «Настройки»:

Рис. 29. ЭФ закладки «Настройки»
Поля:
  • Выдача результата: возможные значения из списка:
    1. ARC − Архив;
    2. DSK − Сохранение в файл;
    3. PRN − Печать на принтер с помощью агента печати;
    4. SND − Рассылка.
  • Формат файла: список поддерживаемых форматов;
  • Аргумент. С помощью кнопки «» можно добавить из справочника аргументы выполнения комплекта с выбранным Значением. Поддерживаются следующие аргументы:
    • COMPR_TYPE: тип сжатия в архив. Поддерживаются следующие типы сжатия файла результата:
      • Без архивации:
      • NONE;
      • Архивация в один файл:
        • AR;
        • AR-GZ, AR-GZIP;
        • AR-BZ, AR-BZIP, AR-BZ2, AR-BZIP2;
        • AR-XZ;
        • CPIO;
        • CPIO-GZ, CPIO-GZIP;
        • CPIO-BZ, CPIO-BZIP, CPIO-BZ2, CPIO-BZIP2;
        • CPIO-XZ;
        • TAR;
        • TAR-GZ, TAR-GZIP, TGZ;
        • TAR-BZ, TAR-BZIP, TBZ, TAR-BZ2, TAR-BZIP2, TBZ2;
        • TAR-XZ;
        • ZIP.
    • Компрессия (каждый отчет в отдельном файле):
      • GZ, GZIP;
      • BZ, BZIP, BZ2, BZIP2;
      • XZ.
Например:
archive.TGZ
archive.NONE
archive.ZIP
    • COMPR_NAME: имя файла архива.
Например: ${data.CODE}
    • COMPR_PATH: путь внутри архива.
Например: reports${system.file.separator}${const.MAIN_DOPER}${system.file.separator}${data.CODE}, что означает примерно следующее: report/01.01.2013/Z_REPORTSET_CODE.
Значение аргумента может содержать:
  • ЗНАЧЕНИЕ
  • ПЕРЕМЕННАЯ:
  • ${data.КОД_ПОЛЯ} (см. Табл. 2)
  • ${param.КОД_ПАРАМЕТРА}
  • ${const.КОД_ПЕРЕМЕННОЙ_СЕССИИ} (см. Приложение 1)
  • ${session.КОД_ПЕРЕМЕННОЙ_СЕССИИ} (см. Приложение 1)
  • ${system.JAVA_PROPERTY} (см. Табл. 6)
  • Набор данных. Аналогично заданию Аргумента указываем входные параметры для набора данных, по каждой строке которого будет запущено формирование комплекта.
  • Значение: может содержать:
    • ЗНАЧЕНИЕ 
    • ПЕРЕМЕННАЯ:
Признак интерактивного режима: при формировании комплекта отчетов будут отображены формы запроса режима и параметров.

Закладка «Параметры»

Форма закладки и описание полей аналогичны и изложены в разделе Закладка "Параметры".

Закладка «Отчеты»

Подробное описание закладки смотреть в разделе Добавление отчета в комплект.

Формирование комплекта отчетов

Формирование комплекта отчетов доступно с помощью кнопки «», которая присутствует на списке комплекта отчетов и на детализации комплекта отчетов в режиме просмотра. После нажатия на указанную кнопку откроется форма ввода предварительных параметров:
Рис. 30.  Форма задания параметров генерации комплекта отчетов
Признаки:
  • «Отложенное выполнение»: постановка отчета в очередь для ожидания его выполнения;
  • «Запустить немедленно»: постановка отчета в очередь и запуск его выполнения.
Поля:
  • Приоритет 0 (max) .. 9 (min): задание приоритета формирования в очереди отчетов: 0 - максимальное значение, 9 - минимальное значение;
  • Формат файлов: формат файлов экспорта отчетов, включенных в комплект отчетов (выбирается из списка);
  • Вариант выдачи: варианты отработки результатов формирования отчетов (выбирается из списка);
  • Язык: язык отчетов, включенных в комплект (выбирается из списка);
  • Институт: институт, в разрезе которого формируются отчеты, включенные в комплект.
После задания параметров следует нажать на кнопку «». Если для комплекта отчетов заданы параметры, то откроется форма для ввода их значений, после чего будет сгенерирован комплект отчетов.

Формирование отчета, включенного в комплект отчетов

Формирование отчета, включенного в комплект отчетов,  доступно с помощью кнопки «», которая присутствует на списке комплекта отчетов и на детализации комплекта отчетов в режиме просмотра.После нажатия на указанную кнопку откроется форма выбора отчета, включенного в комплект отчетов:
Рис. 31. Форма выбора отчета, включенного в комплект отчетов
Дальнейшая процедура формирования отчета описана в разделе Формирование отчета.

Кастомизация

Для кастомизации отчетов и комплектов отчетов предназначена кнопка «», расположенная на списке отчетов и комплектов отчетов соответственно, после чего на экране откроется форма (см.Рис. 32), позволяющая переопределить или удалить локализацию. Кастомизируется весь отчет/комплект отчетов. Если источник данных кастомизирован, то для построения отчета будет использоваться кастомизированный источник данных.
Рис. 32. Форма переопределения локализации

Приложение 1. Обрабатываемые переменные

${data.КОД_ПОЛЯ}
 Табл. 1. Выражения, которые могут использоваться в качестве «КОД_ПОЛЯ» для Отчета : Нажмите здесь для раскрытия...
 Табл. 2. Выражения, которые могут использоваться в качестве «КОД_ПОЛЯ» для Комплекта отчетов : Нажмите здесь для раскрытия...
${report.КОД_ПОЛЯ}
 Табл. 3. Выражения, которые могут использоваться в качестве «КОД_ПОЛЯ» для Отчета, заданного в Комплект отчетов, (отчеты задаются на закладке «Отчеты») : Нажмите здесь для раскрытия...
${field.КОД_ПОЛЯ}
В качестве «КОД_ПОЛЯ» могут использоваться поля, заданные в наборе данных Комплекта отчетов, если он задан.
${param.КОД_ПАРАМЕТРА}
Для Отчета в качестве «КОД_ПАРАМЕТРА» могут использоваться параметры Отчета, добавленные в детализации Отчета на закладке «Параметры».
 Табл. 4. Предопределенные параметры, которые могут использоваться в качестве «КОД_ПАРАМЕТРА» для Отчета : Нажмите здесь для раскрытия...
Для Комплекта отчетов в качестве «КОД_ПАРАМЕТРА» могут использоваться параметры Комплекта отчетов, добавленные в детализации Комплекта отчетов на закладке «Параметры».
 Табл. 5. Предопределенные параметры, которые могут использоваться в качестве «КОД_ПАРАМЕТРА» для Комплекта отчетов : Нажмите здесь для раскрытия...
${const.КОД_ПЕРЕМЕННОЙ_СЕССИИ}, ${session.КОД_ПЕРЕМЕННОЙ_СЕССИИ}
 Выражения, которые могут использоваться в качестве «КОД_ПЕРЕМЕННОЙ_СЕССИИ» : Нажмите здесь для раскрытия...
${system.JAVA_PROPERTY}
В качестве «JAVA_PROPERTY» могут использоваться системные свойства, поддерживаемые java.
 Табл. 6. Свойства, которые поддерживает JAVA v1.6, v1.7 : Нажмите здесь для раскрытия...
Icon
Приведен примерный перечень, в зависимости версии java и операционной системы набор свойств может отличаться.
 Табл. 7. Пример свойств JAVA, Java - Oracle 1.7.0_45, OS - Debian 7.2 : Нажмите здесь для раскрытия...

Приложение 2. Примеры отчетов

 Пример простого отчета : Нажмите здесь для раскрытия...
 Пример отчета содержащего подотчет «Головной отчет» «C_TEST_REPORT» : Нажмите здесь для раскрытия...
 Пример отчета содержащего «Подотчет» «C_TEST_REPORT_SUB»: Нажмите здесь для раскрытия...

Приложение 3. Прочие примеры

Пример файла конфигурации для подключения к серверу приложения:
 colvir.config : Нажмите здесь для раскрытия...
Пример записи в шаблоне отчета при загрузке ресурса непосредственно в отчет:
 Нажмите здесь для раскрытия...
 Пример записи при указании адреса расположения ресурса:
 Нажмите здесь для раскрытия...
Поддерживаемые переменные сессии:
 Поддерживаемые переменные сессии, которые могут использоваться в качестве параметров отчета : Нажмите здесь для раскрытия...
Автор: на

Комментариев нет:

Отправить комментарий

Подписаться на: Комментарии к сообщению (Atom)