Изменения документа Руководство разработчика | Отчёты

Редактировал(а) admin 2026/09/01 21:59

Управление
- Копировать
Действия
- Экспорт
- Предварительный просмотр
Просмотр

От 4.5 до 4.4 От 5.3 до 5.2

От версии 5.2

отредактировано admin
на 2026/08/21 10:45

Изменить комментарий: Inline {{code language="none"}} -> ##monospace##; block none -> text

К версии 4.5

отредактировано admin
на 2026/08/13 01:37

Изменить комментарий: Set link label to page title after rename

Необработанный
Обработанный

Сводка

Свойства страницы (1 изменено, 0 добавлено, 0 удалено)

Подробности

Свойства страницы

Содержимое

@@ -43,11 +43,11 @@
  Настоящее руководство ориентировано только на использование JasperReports Library и Jaspersoft Studio. Формирование отчётов средствам НЕ JasperReports возможно, но обычно не востребовано. Соответствующий сценарий выходит за рамки данного руководства.
  {{/info}}
--== {{id name="Руководстворазработчика|Отчёты-Структуранаборашаблонов"/}}Структура набора шаблонов ==
++== {{id name="Руководстворазработчика|Отчёты-Структуранаборашаблонов"/}}Структура набора шаблонов\\ ==
  Набор шаблонов — это zip-архив, который должен содержать следующие папки и файлы:
--{{code language="text"}}
++{{code language="none"}}
  definitions/    // папка с шаблонами
    <папка шаблона 1>/
      ...         // другие файлы шаблона
@@ -59,15 +59,15 @@
  deployment.conf // определение набора
  {{/code}}
--Файл ##deployment.conf## содержит определение набора, этот файл обязательно должен присутствовать в составе архива. Если файла нет, то Платформа НЕЙРОСС не примет загружаемый zip-архив. Подробное описание данного файла приведено в разделе [[#Определение набора шаблонов>>doc:||anchor="Руководстворазработчика|Отчёты-Определениенаборашаблонов"]].
++Файл {{code language="none"}}deployment.conf{{/code}} содержит определение набора, этот файл обязательно должен присутствовать в составе архива. Если файла нет, то Платформа НЕЙРОСС не примет загружаемый zip-архив. Подробное описание данного файла приведено в разделе [[#Определение набора шаблонов>>doc:||anchor="Руководстворазработчика|Отчёты-Определениенаборашаблонов"]].
--Для каждого шаблона в наборе должна быть отдельная подпапка в директории ##definitions##. В этой подпапке должен присутствовать файл определения шаблона — ##reports.conf##. Подробное описание поддиректории шаблона отчёта приведено в разделе [[#Шаблон отчёта>>doc:||anchor="Руководстворазработчика|Отчёты-Шаблонотчёта"]].
++Для каждого шаблона в наборе должна быть отдельная подпапка в директории {{code language="none"}}definitions{{/code}}. В этой подпапке должен присутствовать файл определения шаблона — {{code language="none"}}reports.conf{{/code}}. Подробное описание поддиректории шаблона отчёта приведено в разделе [[#Шаблон отчёта>>doc:||anchor="Руководстворазработчика|Отчёты-Шаблонотчёта"]].
--В директории ##libs## могут размещаться jar-файлы, используемые в наборе. При использовании нестандартных компонентов ввода параметров или реализации собственной логики формирования отчёта на языке Scala / Java соответствующий код должен быть собран и в форме jar-файлов помещён в данную директорию. Подробная информация по использованию библиотек приведена в разделе [[#Программные компоненты>>doc:||anchor="Руководстворазработчика|Отчёты-Программныекомпоненты"]].
++В директории {{code language="none"}}libs{{/code}} могут размещаться jar-файлы, используемые в наборе. При использовании нестандартных компонентов ввода параметров или реализации собственной логики формирования отчёта на языке Scala / Java соответствующий код должен быть собран и в форме jar-файлов помещён в данную директорию. Подробная информация по использованию библиотек приведена в разделе [[#Программные компоненты>>doc:||anchor="Руководстворазработчика|Отчёты-Программныекомпоненты"]].
--=== {{id name="Руководстворазработчика|Отчёты-Определениенаборашаблонов"/}}Определение набора шаблонов ===
++=== {{id name="Руководстворазработчика|Отчёты-Определениенаборашаблонов"/}}Определение набора шаблонов\\ ===
--Текстовый файл ##deployment.conf## должен состоять из пар ##ключ=значение##, размещённых на отдельных строках. При создании набора необходимо корректно задать в файле значения для следующих ключей:
++Текстовый файл {{code language="none"}}deployment.conf{{/code}} должен состоять из пар {{code language="none"}}ключ=значение{{/code}}, размещённых на отдельных строках. При создании набора необходимо корректно задать в файле значения для следующих ключей:
  |=(((
  Ключ
@@ -79,13 +79,13 @@
  Пример значения
  )))
  |(((
--{{code language="text"}}
++{{code language="none"}}
  deployment.key
  {{/code}}
  )))|(((
  Строковой идентификатор набора
  )))|(((
--Для каждого набора такой идентификатор должен быть уникальным. При обновлении набора (например, добавлении в набор новых шаблонов или изменении существующих) //не следует// менять этот идентификатор, достаточно изменять версию набора (см. ключ ##deployment.version##).
++Для каждого набора такой идентификатор должен быть уникальным. При обновлении набора (например, добавлении в набор новых шаблонов или изменении существующих) //не следует// менять этот идентификатор, достаточно изменять версию набора (см. ключ {{code language="none"}}deployment.version{{/code}}).
  Идентификатор позволяет различить наборы разных видов. При загрузке набора выполняется проверка идентификатора. Если набор с таким идентификатором уже был загружен в Платформу НЕЙРОСС, то выполняется обновление набора. Если нет, то выполняется установка нового набора.
@@ -94,7 +94,7 @@
  ultima.reports.itrium
  )))
  |(((
--{{code language="text"}}
++{{code language="none"}}
  deployment.title
  {{/code}}
  )))|(((
@@ -107,7 +107,7 @@
  Типовые формы отчётов к Itrium
  )))
  |(((
--{{code language="text"}}
++{{code language="none"}}
  deployment.version
  {{/code}}
  )))|(((
@@ -120,9 +120,9 @@
 .6.0
  )))
--Пример файла ##deployment.conf## из набора [[типовых шаблонов СКУД ITRIUM>>doc:neyross.arm-reports.templates.skud-itrium-logs.WebHome]] приведён ниже:
++Пример файла {{code language="none"}}deployment.conf{{/code}} из набора [[типовых шаблонов СКУД ITRIUM>>doc:neyross.arm-reports.templates.skud-itrium-logs.WebHome]] приведён ниже:
--{{code language="text"}}
++{{code language="none"}}
  deployment.key=ultima.reports.itrium
  deployment.title=Типовые формы отчётов к Itrium
  deployment.version=0.6.0
@@ -129,12 +129,12 @@
  {{/code}}
  {{info}}
--Формат файла ##deployment.conf## должен отвечать требованиям к файлу конфигурации [[scala-библиотеки config>>url:https://github.com/lightbend/config||shape="rect"]]. Учитывайте эти требования при использовании в файле специальных символов и т.д.
++Формат файла {{code language="none"}}deployment.conf{{/code}} должен отвечать требованиям к файлу конфигурации [[scala-библиотеки config>>url:https://github.com/lightbend/config||shape="rect"]]. Учитывайте эти требования при использовании в файле специальных символов и т.д.
  {{/info}}
  === {{id name="Руководстворазработчика|Отчёты-Шаблонотчёта"/}}Шаблон отчёта ===
--Для каждого шаблона в наборе должна быть отдельная подпапка в директории definitions. В этой подпапке должен присутствовать файл определения шаблона — reports.conf. Текстовый файл ##report.conf## должен состоять из пар ключ=значение, размещённых на отдельных строках. При создании шаблона необходимо корректно задать в файле значения для следующих ключей:
++Для каждого шаблона в наборе должна быть отдельная подпапка в директории definitions. В этой подпапке должен присутствовать файл определения шаблона — reports.conf. Текстовый файл {{code language="none"}}report.conf{{/code}} должен состоять из пар ключ=значение, размещённых на отдельных строках. При создании шаблона необходимо корректно задать в файле значения для следующих ключей:
  |=(((
  Ключ
@@ -146,7 +146,7 @@
  Пример значения
  )))
  |(((
--{{code language="text"}}
++{{code language="none"}}
  definition.class
  {{/code}}
  )))|(((
@@ -156,12 +156,12 @@
  Подробное описание данного параметра приведено ниже.
  )))|(((
--{{code language="text"}}
++{{code language="none"}}
  extensions.reports.itrium.ReportDefinition
  {{/code}}
  )))
  |(((
--{{code language="text"}}
++{{code language="none"}}
  definition.htmlPaging
  {{/code}}
  )))|(((
@@ -169,14 +169,14 @@
  )))|(((
  ЗАРЕЗЕРВИРОВАНО
--Значение __всегда__ должно быть равно ##false##.
++Значение __всегда__ должно быть равно {{code language="none"}}false{{/code}}.
  )))|(((
--{{code language="text"}}
++{{code language="none"}}
  false
  {{/code}}
  )))
  |(((
--{{code language="text"}}
++{{code language="none"}}
  definition.supportedFormats
  {{/code}}
  )))|(((
@@ -186,12 +186,12 @@
  За поддержку форматов отвечает класс реализации. Стандартная реализация поддерживает форматы PDF и XLS. Через данный параметр можно ограничить форматы экспорта, например, если шаблон не позволяет формировать корректный XLS-файл. В своей реализации разработчик может поддержать и другие форматы экспорта.
  )))|(((
--{{code language="text"}}
++{{code language="none"}}
  ["pdf","xls"]
  {{/code}}
  )))
--Параметр ##definition.class## является ключевым. В данном параметре необходимо указать имя программного компонента, который будет отвечать за подготовку и формирование отчёта по создаваемому шаблону. Разработчику доступно несколько готовых реализаций / компонентов, которые он может использовать в своём шаблоне. Разработчик может выбрать одно из следующих значений ##definition.class##:
++Параметр {{code language="none"}}definition.class{{/code}} является ключевым. В данном параметре необходимо указать имя программного компонента, который будет отвечать за подготовку и формирование отчёта по создаваемому шаблону. Разработчику доступно несколько готовых реализаций / компонентов, которые он может использовать в своём шаблоне. Разработчик может выбрать одно из следующих значений {{code language="none"}}definition.class{{/code}}:
  |=(((
  Значение
@@ -199,13 +199,13 @@
  Описание
  )))
  |(((
--{{code language="text"}}
++{{code language="none"}}
  extensions.reports.GenericJasperReportDefinition
  {{/code}}
  )))|(((
  __Базовая реализация__ шаблона отчёта с применением JasperReports Library со следующими возможностями:
--1. ключ, название, описание шаблона задаются в файле ##report.conf## (см. далее);
++1. ключ, название, описание шаблона задаются в файле {{code language="none"}}report.conf{{/code}} (см. далее);
 . отчёт формируется в соответствии с jasper-шаблоном средствами JasperReports Library;
 . можно формировать отчёты в форматах PDF, XLS (Excel) и HTML (для предпросмотра);
 . можно использовать разные шаблоны для предпросмотра и экспорта в PDF / XLS;
@@ -217,7 +217,7 @@
  Подробнее см. страницу [[doc:neyross.Настройка Платформы НЕЙРОСС.Настройка функций подготовки отчётов.Руководство разработчика | Отчёты.Базовый шаблон отчёта с JasperReports.WebHome]].
  )))
  |(((
--{{code language="text"}}
++{{code language="none"}}
  extensions.reports.itrium.ReportDefinition
  {{/code}}
  )))|(((
@@ -238,14 +238,14 @@
  |(((
  <Имя класса собственной разработки>
  )))|(((
--При желании разработчик может создать свой класс и указать его имя в значении для ключа ##definition.class##. В данном классе разработчик может либо расширить одну из существующих реализаций (стандартную, реализацию к ITRIUM), либо реализовать полностью свой алгоритм формирования отчёта.
++При желании разработчик может создать свой класс и указать его имя в значении для ключа {{code language="none"}}definition.class{{/code}}. В данном классе разработчик может либо расширить одну из существующих реализаций (стандартную, реализацию к ITRIUM), либо реализовать полностью свой алгоритм формирования отчёта.
  )))
--В зависимости от указанного значения ##definition.class## в файле ##report.conf## может потребоваться указать и другие параметры. См. описание конкретной реализации шаблонов.
++В зависимости от указанного значения {{code language="none"}}definition.class{{/code}} в файле {{code language="none"}}report.conf{{/code}} может потребоваться указать и другие параметры. См. описание конкретной реализации шаблонов.
--Пример файла ##report.conf## из [[модуля типовых шаблонов СКУД ITRIUM>>doc:neyross.arm-reports.templates.skud-itrium-logs.WebHome]] приведён ниже:
++Пример файла {{code language="none"}}report.conf{{/code}} из [[модуля типовых шаблонов СКУД ITRIUM>>doc:neyross.arm-reports.templates.skud-itrium-logs.WebHome]] приведён ниже:
--{{code language="text"}}
++{{code language="none"}}
  definition.class=extensions.reports.itrium.ReportDefinition
  definition.htmlPaging=false
  definition.supportedFormats=["pdf","xls"]
@@ -262,14 +262,14 @@
  {{/code}}
  {{info}}
--Формат файла ##report.conf## должен отвечать требованиям к файлу конфигурации [[scala-библиотеки config>>url:https://github.com/lightbend/config||shape="rect"]]. Учитывайте эти требования при использовании в файле специальных символов и т.д.
++Формат файла {{code language="none"}}report.conf{{/code}} должен отвечать требованиям к файлу конфигурации [[scala-библиотеки config>>url:https://github.com/lightbend/config||shape="rect"]]. Учитывайте эти требования при использовании в файле специальных символов и т.д.
  {{/info}}
--Кроме ##report.conf## в поддиректории шаблона отчёта также могут располагаться и другие файлы, необходимые для подготовки отчёта. Например *.jasper-файлы (в случае использования JasperReports Library). Состав файлов зависит от выбранной реализации шаблона отчёта.
++Кроме {{code language="none"}}report.conf{{/code}} в поддиректории шаблона отчёта также могут располагаться и другие файлы, необходимые для подготовки отчёта. Например *.jasper-файлы (в случае использования JasperReports Library). Состав файлов зависит от выбранной реализации шаблона отчёта.
  === {{id name="Руководстворазработчика|Отчёты-Программныекомпоненты"/}}Программные компоненты ===
--При загрузке набора шаблонов Платформа НЕЙРОСС распаковывает zip-архив и загружает все классы из всех jar-файлов (библиотек Java) из директории ##libs## в модуле. Эти классы могут быть использованы:
++При загрузке набора шаблонов Платформа НЕЙРОСС распаковывает zip-архив и загружает все классы из всех jar-файлов (библиотек Java) из директории {{code language="none"}}libs{{/code}} в модуле. Эти классы могут быть использованы:
 . для расширения или создания собственной реализации формирования отчёта;
 . для реализации новых полей ввода параметров;
@@ -279,9 +279,9 @@
  Для каждого модуля классы и jar-файлы загружаются независимо (для каждого модуля используется независимый [[class loader>>url:https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html||shape="rect"]]). Таким образом не может возникнуть коллизии между разными классами с одинаковыми именами или разными версиями одних и тех же классов в нескольких наборах шаблонов.
  {{/info}}
--Разработчик может самостоятельно реализовать соответствующие Java-классы, собрать jar-файл (один или несколько) и включить его в состав набора, поместив все необходимые jar-файлы в директорию ##libs## zip-архива набора.
++Разработчик может самостоятельно реализовать соответствующие Java-классы, собрать jar-файл (один или несколько) и включить его в состав набора, поместив все необходимые jar-файлы в директорию {{code language="none"}}libs{{/code}} zip-архива набора.
--Для пунктов 1 и 2 выше разработчику необходимы определения классов API (программного интерфейса), используемых в Платформе НЕЙРОСС. Такие классы поставляются в артефакте (библиотеке) ##ultima-reports-api## вместе с исходным кодом. Каждая версия Платформы НЕЙРОСС использует свою версию API. Последнюю версию ##ultima-reports-api## можно загрузить по ссылке ниже.
++Для пунктов 1 и 2 выше разработчику необходимы определения классов API (программного интерфейса), используемых в Платформе НЕЙРОСС. Такие классы поставляются в артефакте (библиотеке) {{code language="none"}}ultima-reports-api{{/code}} вместе с исходным кодом. Каждая версия Платформы НЕЙРОСС использует свою версию API. Последнюю версию {{code language="none"}}ultima-reports-api{{/code}} можно загрузить по ссылке ниже.
  |=(((
  Версия программы
@@ -299,7 +299,7 @@
  )))|(((
  [[doc:neyross.Настройка Платформы НЕЙРОСС.Настройка функций подготовки отчётов.Руководство разработчика | Отчёты.ultima-reports-api\:1\.4\.2.WebHome]]
  )))|(((
--ultima-reports-api_1.4.2_180719.zip
++[[attach:ultima-reports-api_1.4.2_180719.zip]]
  )))
  Список версий API для предыдущих версий программ приведён ниже. За получением ZIP-файлов просим обращаться к специалистам компании ИТРИУМ.
@@ -344,7 +344,7 @@
  {{info}}
  Библиотека API актуальной версии присутствует в составе Платформы НЕЙРОСС.
--Включать её в модуль (в директорию ##libs##) дополнительно не требуется.
++Включать её в модуль (в директорию {{code language="none"}}libs{{/code}}) дополнительно не требуется.
  {{/info}}
--Классы [[базовой реализации шаблона отчёта с JasperReports Library>>doc:neyross.Настройка Платформы НЕЙРОСС.Настройка функций подготовки отчётов.Руководство разработчика | Отчёты.Базовый шаблон отчёта с JasperReports.WebHome]] входят в API, поэтому для базовой реализации дополнительных jar-файлов включать в директорию ##libs## не требуется. Но, например, реализация полей ввода, используемых в [[типовых шаблонах СКУД к ITRIUM>>doc:neyross.arm-reports.templates.skud-itrium-logs.WebHome]], не входит в API. Соответствующие классы реализованы и упакованы в [[отдельный jar-файл>>doc:neyross.Настройка Платформы НЕЙРОСС.Настройка функций подготовки отчётов.Руководство разработчика | Отчёты.Шаблон отчёта к ITRIUM с JasperReports.WebHome]], который при их использовании необходимо поместить в директорию ##libs## в наборе шаблонов.
++Классы [[базовой реализации шаблона отчёта с JasperReports Library>>doc:neyross.Настройка Платформы НЕЙРОСС.Настройка функций подготовки отчётов.Руководство разработчика | Отчёты.Базовый шаблон отчёта с JasperReports.WebHome]] входят в API, поэтому для базовой реализации дополнительных jar-файлов включать в директорию {{code language="none"}}libs{{/code}} не требуется. Но, например, реализация полей ввода, используемых в [[типовых шаблонах СКУД к ITRIUM>>doc:neyross.arm-reports.templates.skud-itrium-logs.WebHome]], не входит в API. Соответствующие классы реализованы и упакованы в [[отдельный jar-файл>>doc:neyross.Настройка Платформы НЕЙРОСС.Настройка функций подготовки отчётов.Руководство разработчика | Отчёты.Шаблон отчёта к ITRIUM с JasperReports.WebHome]], который при их использовании необходимо поместить в директорию {{code language="none"}}libs{{/code}} в наборе шаблонов.