Разработка VM-шаблонов PDF

VM-шаблон PDF — это шаблон, написанный на языке Velocity Template Language (VTL). С помощью этого шаблона создается PDF документ, содержащий ответы, которые пользователь дал в процессе прохождения сценария

Шаблон необходимо назвать «pdf_xxxxxxxx_Applicant.vm», где xxxxxxxx – код услуги

Другое наименование VM-шаблона не допускается

Составление VM-шаблона PDF

Целью данного блока работ является заполнение всех необходимых полей будущего PDF документа

Для начала необходимо подготовить черновик пройденной услуги. Подробнее в статье ЕСКС в блоке «Подготовительные действия»

Поля PDF документа заполняются из черновика заявления с помощью конструкции $имя_атрибута_черновика

Например: $pd1_persData['storedValues']['middleName']

Шаблон PDF документа строится из четырех инструкций: Form, FieldText, Panel, FormStep

Конструкции pdf заявления

№	Конструкция	Описание
1	{"className":"Form","label": "ЗАЯВЛЕНИЕ О КОРРЕКТИРОВКЕ СВЕДЕНИЙ ИНДИВИДУАЛЬНОГО (ПЕРСОНИФИЦИРОВАННОГО) УЧЕТА И ВНЕСЕНИИ УТОЧНЕНИЙ (ДОПОЛНЕНИЙ) В ИНДИВИДУАЛЬНЫЙ ЛИЦЕВОЙ СЧЕТ","value": ""}	Заголовок заявления
5	{"className":"Panel", "label": "Данные пользователя для подтверждения", "value": ""}	Подзаголовок заявления
6.1, 7.1	{"className":"FormStep", "label": "Документ удостоверяющий личность", "value": ""}	Нумерованный подзаголовок
2, 3, 4 .. n	{"className":"FieldText", "label": "Тип документа", "value": "Паспорт России"}	Вывод текстового поля в заявлении
7.2	{"className":"FieldText", "label": "Имя", "value": "$имя_атрибута_черновика"}	Вывод значения из черновика заявления

Пример шаблона

На примерах ниже показано соответствие конструкций в VM-шаблоне и их отображения в заявлении pdf

Загрузка VM-шаблонов

Составленные на предыдущем шаге файлы необходимо загрузить в конструктор в виде файлов или вставить в инструмент визуального редактирования. Для этого:

• Необходимо открыть страницу услуги и во вкладке разделы перейти в раздел раздел «VM шаблоны»



• В открывшемся разделе добавить шаблон по кнопке «Добавить шаблон» или через «Действия»-«Добавить шаблон»



• В открывшемся окне указать название шаблона и добавить его описание
  Допустимый формат имени для VM шаблонов PDF заявления: «pdf_xxxxxxxx_Applicant.vm», где xxxxxxxx — код услуги

Другое наименование VM шаблонов не допускается

Описание можно вставить из текстового редактора или загрузить из файла по соответствующей кнопке «Загрузить из файла»

Проверка VM шаблонов

Сразу после добавления VM шаблон приобретает статус «Не проверен». Шаблон будет автоматически проверен на ошибки при воспроизведении  услуги, но проверить синтаксические ошибки можно без воспроизведения по действию «Проверить на ошибки»

В ходе проверки могут быть найдены критичные и некритичные ошибки. Места кода, в которых найдены ошибки, подсвечиваются на скролле. Чтобы увидеть текст ошибки, необходимо навести курсор на подсвеченную курсивом область

Пример некритичной ошибки, для исправления которой нужно добавить пустой объект {} в конце шаблона перед закрывающей квадратной скобкой. Для внесения правок нужно открыть шаблон в режиме редактирования («карандаш» рядом с наименованием шаблона)

После загрузки и проверки шаблона можно воспроизвести услугу в тестовой среде ЕПГУ

Тестирование и отладка VM шаблонов

Для тестирования и отладки формирования VM шаблонов разработчикам доступна соответствующая функциональность. Подробнее об инструменте отладки читайте в статье Инструмент отладки VM-шаблонов