Базовый сценарий использования¶
Для настройки инфраструктуры Системы необходимо выполнить следующие действия:
- Определить, в каких сервисах будут храниться шаблоны, параметры шаблонов и сформированные отчеты.
- Настроить хранение шаблонов и параметров шаблонов.
Классы шаблонов и параметров шаблонов должны храниться в одном сервисе. Если хранение определено в сервисе хранения моделей и экземпляров системных объектов (ldm-system-objects-service), то модели классов добавляются автоматически при старте данного сервиса.
Необходимо убедиться, что классы шаблонов и параметров шаблонов не перезаписываются из сервиса «Управление моделью данных», например, в сервисе «Управление настройками» через настройку «docshouse.datamodel.starter.classes». Модели классов, полученные из сервиса «Управление моделью данных», имеют приоритет перед системными классами.
Если хранение определено в документном сервисе (например, dh-documents-service), то в сервисе «Управление моделью данных» (dh-datamodel-service) необходимо создать классы «ReportTemplate», «ReportParamItems». Распространить созданные классы на сервис, например, используя сервис «Управление настройками» через настройку «docshouse.datamodel.starter.classes». Изменить настройки окружения сервиса отчетов на соответствующие (при необходимости):
- LDM_RS_MSLDM_RS_MSREPORTTEMPLATECLASSNAME – системный код класса шаблона.
- LDM_RS_MSLDM_RS_MSReportParamItemsCLASSNAME – системный код класса параметра шаблона.
- LDM_REPORT_TEMPLATE_STORAGE_URL – URL сервиса хранения шаблонов и параметров шаблонов.
Настроить frontend для работы с шаблонами, через сервис конфигураций переопределяя для сервиса ldm-reports-service-ui настройки, перечисленные в таблице.
Настройки frontend для работы с шаблонами отчетов
| Ключ | Тип | Обязательность | Описание |
|---|---|---|---|
| ldm.reports.templates.sourceService | string | + | Системный код сервиса, где хранятся шаблоны и параметры шаблонов |
| ReportTemplateClassName | string | Переопределенный код класса шаблона | |
| ReportParamItemsClassName | string | Переопределенный код класса параметров шаблона |
3. Настроить хранение сформированных отчетов.
Если хранение определено в сервисе хранения моделей и экземпляров системных объектов (ldm-system-objects-service), то модели классов добавляются автоматически при старте данного сервиса.
Необходимо убедиться, что классы шаблонов и параметров шаблонов не перезаписываются из сервиса «Управление моделью данных», например, в сервисе «Управление настройками» через настройку «docshouse.datamodel.starter.classes». Модели классов, полученные из сервиса «Управление моделью данных», имеют приоритет перед системными классами.
Если хранение определено в документном сервисе (например, dh-custom-documents-service), то необходимо создать в сервисе «Управление моделью данных» (dh-datamodel-service) класс «ReportInstance».
Распространить созданный класс на сервис, например, используя сервис «Управление настройками» через настройку «docshouse.datamodel.starter.classes». Изменить настройки окружения сервиса отчетов на соответствующие (при необходимости):
- LDM_RS_MSREPORTINSTANCECLASSNAME – системный код класса отчета.
- LDM_REPORT_INSTANCE_STORAGE_NAME – код сервиса, хранящего сформированные отчеты.
- LDM_REPORT_INSTANCE_STORAGE_URL – URL сервиса хранения отчетов.
Настроить глобальный список файлов для сервиса, в котором хранятся шаблоны, через сервис конфигураций добавив в настройку «docshouse.documents.allowed_file_formats» строку с соответствующим типом файла и его «mimeType».
Разрешить прикреплять нужные типы файлов к классу отчета в модели класса.
Настроить frontend для работы с отчетами, через сервис конфигураций переопределяя для сервиса ldm-reports-service-ui настройки, перечисленные в таблице.
Настройки frontend для работы с отчетами
| Ключ | Тип | Обязательность | Описание |
|---|---|---|---|
| ldm.reports.instances.sourceService | string | + | Системный код сервиса, где хранятся отчеты |
| ReportInstance | string | Переопределенный код класса отчета |