Подключение и конфигурирование#

Содержание#

Подключение#

Для подключения программного компонента DCGL добавьте в pom.xml Spring Boot конечного приложения зависимость на spring-boot-starter компонента DCGL:

<dependency>
    <groupId>sber.platform.docgen</groupId>
    <artifactId>docgen-lib-spring-boot-starter</artifactId>
    <version>lib-version</version>
    <scope>compile</scope>
</dependency>

где lib-version — актуальная версия компонента DCGL.

Важно

В случае подключения компонента DCGL через spring-boot-starter поддерживаются стандартные темы графиков для движка шаблона JasperReports jasperreports-chart-themes. В случае подключения DCGL без spring-boot-starter необходимо подключить в проект зависимость jasperreports-chart-themes:

<dependency>
  <groupId>net.sf.jasperreports</groupId>
  <artifactId>jasperreports-chart-themes</artifactId>
  <version>{ VERSION }</version>
</dependency>

Конфигурирование#

Для DCGL задайте в файле конфигурации Spring Boot application.yaml следующие параметры:

Параметр	Описание	Обязательность	Значение по умолчанию	Версия
`rn`	Идентификатор ресурса проекта (resourceName)	Да	–	4.0.0
`dcgn.template-provider-url`	URL сервиса DCGN	Да	–	4.0.0
`dcgn.cache-max-size`	Максимальное количество кешируемых шаблонов, по достижении которого из кеша удаляется самый старый шаблон для добавления нового	Нет	`100`	4.0.0
`dcgn.cache-evict-timeout-seconds`	Период времени с момента кеширования шаблона, по истечении которого шаблон удаляется из кеша	Нет	`900 s`	4.0.0
`dcgn.customFonts.enabled`	Подключить дополнительные шрифты, используемые при генерации документа для движков JasperReports и XDocReports	Нет	`false`	4.0.0
`dcgn.customFonts.path`	Путь до директории с дополнительными шрифтами для движков JasperReports и XDocReports	Нет	`fonts`	4.0.0
`dcgn.customFonts.tempPath`	Путь до директории, в которую будут помещены распакованные шрифты, подключаемые через ZIP-архивы со шрифтами	Нет	`/tmp`	4.0.0
`dcgn.customFonts.fineTune.enabled`	Флаг использования ручной настройки подключаемых шрифтов, например, для управления псевдонимами шрифтов	Нет	`false`	4.0.0
`dcgn.customFonts.fineTune.fontFamilies`	Служит для определения дополнительных семейств шрифтов (псевдонимов)	Нет	–	4.0.0
`dcgn.customFonts.fineTune.fontFilesPaths`	Пути до файлов шрифтов относительно директории dcgn.customFonts.path	Нет	–	4.0.0
`dcgn.filling-template-timeoutInMillis`	Максимально допустимое время наполнения шаблона данными. Время получения шаблона из сервиса DCGN не учитывается	Нет	`60000 ms`	4.0.0
`dcgn.rn-in-header.enabled`	Передавать ресурс проекта (resourceName) для HTTP-запросов через параметр заголовка ufs-tenant (для обратной совместимости в окружении продукта Platform V Frontend Std (#FS))	Нет	`false`	4.0.0
`jasperreport.locale.language`	Язык, для которого осуществляется генерация документов с помощью движка шаблона JasperReports	Нет	`Язык локали системы`	4.0.0
`jasperreport.locale.region`	Регион, для которого осуществляется генерация документов с помощью движка шаблона JasperReports	Нет	`Язык локали системы`	4.0.0
`jasperreport.reheat.enabled`	Прогрев движка шаблона JasperReports для оптимизации времени генерации документов с помощью предварительной загрузки классов, необходимых для компиляции шаблона	Нет	`false`	4.0.0
`freemarker.classicCompatible.enabled`	Флаг режима обработки, более совместимого с FreeMarker Classic. Эмулируется версия 1.7.x	Нет	`false`	4.0.0

Пример конфигурации

rn: default

dcgn:
  template-provider-url: http://localhost:8090/template-provider
  filling-template-timeoutInMillis: 60000
  cache-max-size: 100
  cache-evict-timeout-seconds: 900

jasperreport:
  locale:
    language: ru
    region: RU
  reheat:
    enabled: true