...
С системой поставляется набор примеров генерации различных видов документов. Примеры JSP файлов с инструкциями по их настройке в комментариях расположены в каталоге webapps/WEB-INF/jspf/user/plugin/document/template/example.
Дополнительные примеры могут быть найдены в WiKi.
Конфигурация
| Якорь | ||||
|---|---|---|---|---|
|
...
- <id> - уникальный числовой идентификатор типа документа;
- <title> - отображаемое наименование шаблона, необходимо только для шаблонов, которые можно выбрать;
- <scope> - тип сущности, для которой генерируется документ, см. далее;
- <type> - тип генерируемого документа, описание типом см. далее;
- <jsp> - путь к JSP шаблону, генерирующему HTML, либо подготавливающему данные для шаблонов;
- <result> - допустимые значения через запятую: stream - не сохранять сгенерированный документ и сразу выдать его клиенту, file save - сохранить документ;
- <doc_title> - имя сгенерированного документа, не имеет смысла для result=streamсоздаваемого документа;
- <file> - имя файла со шаблоном документа (PDF форма либо иной исходный документ для подстановки параметров) рекомендуется располагать в каталоге BGCRM/docpattern;
- <title_pattern> - REGEXP шаблон имени сущности, для которой будет предлагаться к генерации данный тип документа;
- <additional_params_jsp> - JSP файл с дополнительными параметрами для генерации документа;
- <file> - исходный документ, заполняемый данными;
- <flattening> - 1, для типа pdfForm, если сгенерированный PDF документ следует сделать нередактируемым,<xslt> - XSLT 2.0 шаблон, генерирующий XML документ со значениями полей.
Возможные значения параметра <scope>, для генерации документов объектов ядра:
- processQueue - шаблон используется для генерации печатной формы в очереди процессов;
- process - шаблон для генерации печатной формы процесса, дополнительно вкладка "Документы" должна быть включена в конфигурации типа процесса следующим образом:
...
Плагин документов может быть использован для генерации отчётов в очереди процессов. Для запуска режима отладки в этом случае клавиша Alt должна быть зажата в момент выбора пункта обработчика в меню Ещё.
Интерфейс пользователя
В интерфейсе пользователя функционал плагина доступен на вкладках Документы различных сущностей. В таблице отображаются привязанные к объекту документы. Возможно удаление ранее привязанных документов, их открытие
В выпадающем списке выводятся настроенные для данного типа сущности шаблоны документов. Далее кнопки генерации документа с сохранением и без (настраиваются с помощью result параметра в конфигурации шаблона). Кнопка +? позволяет загружать произвольные файлы.
При удержании нажатой клавиши Alt в момент генерации документа без сохранения запускается режим отладки.
Примеры и документация к устаревшей XSLT технологии
| Информация |
|---|
Раздел будет удалён вскорости. Необходим лишь для возможности изучения логики работы устаревшей технологии и адаптации шаблонов. |
...
Для просмотра хода генерации включите вывод в лог отладочной информации. Работу можно начать с подобного шаблона, который просто выводит в результирующий документ (а следовательно и в лог) исходный XML.
...
Расширения пространства имён "http://bgcrm.ru/saxon-extension-math"
isbitset( <value>, <bitNumber> ) - возвращает результат проверки установленности в значении <value> бита <bitNumber>, нумерация с 0 от конца двоичного представления числа.
...
Расширения пространства имён "http://bgcrm.ru/saxon-extension"
customer( <id> ) - получение XML документа с данными контрагента с кодом <id>.
...
param( <objectId>, <paramId> ) - получение XML документа с данными о параметре <paramId> объекта с кодом <objectId>.
Интерфейс пользователя
В интерфейсе пользователя функционал плагина доступен на вкладках Документы различных сущностей. В таблице отображаются привязанные к объекту документы. Возможно удаление ранее привязанных документов, их открытие
В выпадающем списке выводятся настроенные для данного типа сущности шаблоны документов. Далее кнопки генерации документа с сохранением и без (настраиваются с помощью result параметра в конфигурации шаблона). Кнопка +? позволяет загружать произвольные файлы.
При удержании нажатой клавиши Alt в момент генерации документа без сохранения запускается режим отладки.