Инструкция по созданию шаблона печатной формы

Версия 1.5.5.
В системе «Ведок» шаблоны документов находятся в разделе «Отчеты» - «Печатные формы».
Для исходящего письма вы можете использовать встроенный шаблон, отредактировав его, или разработать собственный.
Данная инструкция содержит краткие сведения, более подробно о создании отчётов вы можете узнать по ссылке: Шаблоны DOCX, DOC и ODT - Платформа CUBA. Генератор отчётов (cuba-platform.com)
Работа со встроенным шаблоном
Встроенный шаблон исходящего письма содержит в себе следующие атрибуты:
Данные адресата (организации-получателя письма);
Дата и регистрационный номер документа;
Содержание письма.
Готовое исходящее по этому шаблону выглядит следующим образом:

Если вас устраивает такой шаблон, вы можете отредактировать его, подставив данные своей компании, логотип, ФИО директора, и использовать в работе.
Для этого в разделе «Отчеты» - «Печатные формы» выберите файл «Письмо», вызовите меню правой кнопкой и выберите «Копировать».

Откройте шаблон письма через редактор отчётов (нажмите «Изменить»). Скачайте шаблон документа.

Внесите изменения в шаблон, либо перенести метки на свой бланк. Одна из меток выделена на рисунке.

После изменённый бланк загрузите обратно в шаблон и сохраните.

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

Создание шаблона при помощи конструктора

Необходимо выбрать сущность, по которой нужен отчёт. Например: Договоры, документы, счета и т.д.
Выбрать тип шаблона, в каком виде будет выводиться отчёт. Например, файл word (.doc, .docx), файл excel (.xls, .xlsx).
Выбрать тип построения. При наведении на тип появится всплывающее окно с подсказкой, по которой можно выбрать нужный тип.

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

После нажимаем «ок».
Появится окно с выбранными атрибутами и указанием параметров отчёта.

Из данного окна можно сразу запустить отчёт и проверить, что будет выводиться.
Для запуска надо нажать кнопку «Выполнить», появится окно для выбора документа.

Необходимо нажать «выбрать», откроется окно документов, выбрать документ, по которому будет отчёт. Выбранный документ появится в окне. Далее нажимаем «Выполнить отчёт» и система выгружает сформированный документ в выбранном формате. Документ будет в папке «Загрузки».

Выгруженный документ будет в таком виде.

Выведены все указанные поля.
После проверки отчёта, возвращаемся к конструктору и нажимаем «Далее»

Появится окно третьего шага. Нажимаем «Сохранить».
Откроется окно «Редактор отчёта».

В данном окне можно отредактировать все параметры отчёта и отформатировать выводимые поля.
Для создания нужного документа необходимо отредактировать шаблон. Для этого необходимо скачать шаблон, нажав кнопку «Скачать шаблон».

Скачается шаблон документа в таком виде.

После вам необходимо взять свой шаблон документа и в нужных местах расставить метки, по которым будет подставлена информация из РК в шаблон документа.

Необходимо помнить, что метка выглядит следующим образом $ (Рисунок 10 и Рисунок 12) Band name -- имя полосы отчёта, field name -- имя выводимого поля. Отредактированный шаблон нужно загрузить обратно в отчёт, нажав кнопку «загрузить» в редакторе отчётов.

После нажимаем «сохранить». Отчёт сохранён.
Теперь из списка отчётов его можно запускать.

Готовый отчёт будет выглядеть так.

Его можно добавить в шаблоны в настройках групп документов, чтобы создавать документ сразу в РК, во вкладке «файлы».
Создание отчета вручную
При создании отчёта вручную. Откроется сразу окно «Редактор шаблона».

Имя отчёта прописывается вручную.
Полосы отчёта создаёте сами, нажав на «+» в области «Полосы отчёта»

В области «Свойства полосы» можете изменить её параметры. Например имя. В данной области, нажав «+», вы создадите набор данных внутри полосы, где необходимо написать имя (произвольное) и указать тип набора данных. Набором данных могут быть скрипты (Groovy, SQL, JPQL, JSON) либо сущность, либо список сущностей.
При выборе сущности или списка сущностей необходимо перейти во вкладку «Параметры и форматы».

В области Параметры нажать кнопку «Создать». В появившемся окне выбрать нужные настройки и заполнить обязательные поля (отмечены *).

Теперь в параметрах у нас указана сущность, по которой будет создаваться отчёт.

Далее во вкладке «Структура отчёта» в правой области выбираем сущность.

После этого нажимаем «Выбрать атрибуты сущности» и в появившемся окне выбираем необходимые атрибуты.

В структуре теперь указаны необходимые параметры. Теперь нужно загрузить размеченный шаблон, но для начала нужно задать основной шаблон. Это можно сделать двумя способами:

Перейдя во вкладку «Шаблоны» и нажав кнопку «Создать»

Во вкладке «Структура отчёта» нажать «+»
В открывшемся окне задать параметры шаблона и загрузить файл.

Для заполнения файла перейдите в меню «Модель данных»

Откроется страница с моделью данных. С этой страницы берутся имена выводимых в отчёте полей. Имя полосы (band name) указано в структуре отчёта.

В данном списке выбираем нужную сущность и переходим к данным нужной сущности.

Имя поля находится в колонке Property.
Теперь со всеми данными можно расставить метки в шаблоне документа и загрузить шаблон в отчёт.