Шаблоны
Шаблон — это файл, который задаёт макет формируемого документа. В нём есть плейсхолдеры — метки, которые система заменяет реальными данными при формировании документа.
Администраторы загружают шаблоны и привязывают их к типам сущностей. Когда пользователь формирует документ из записи, система подставляет в плейсхолдеры шаблона значения полей этой записи и возвращает готовый файл.
| Шаблон и тип документа — разные понятия. Тип документа — это тип сущности, который определяет вид записи (её поля и поведение). Шаблон — это файл с плейсхолдерами, который задаёт макет результата, формируемого из такой записи. У одного типа сущности может быть несколько шаблонов; каждый можно включать и отключать по отдельности. |
|
Эта страница описывает механизм. Конкретные виды — типы документов, поля, статусы — определяются для вашей организации и могут отличаться. См. систему сущностей. |
Что делают шаблоны
Шаблоны превращают структурированные данные в оформленный результат. Вместо того чтобы вручную копировать значения в договор, счёт или отчёт, вы один раз загружаете шаблон и каждый раз формируете готовый файл.
Один шаблон может дать:
-
одностраничный счёт с логотипом компании,
-
многостраничный договор с таблицей позиций предложения,
-
книгу Excel, в которую вместе с данными сделки подтягивается актуальный прайс-лист,
-
презентацию, где на каждую конструкцию кампании приходится один слайд.
Форматы загрузки и результата
Шаблоны загружаются как обычные офисные файлы в одном из трёх форматов:
-
DOCX (Word) — договоры, счета, письма и любые документы с одним сплошным текстом.
-
XLSX (Excel) — отчёты, прайс-листы, сверки и любые документы, где нужны табличные расчёты или несколько источников данных.
-
PPTX (PowerPoint) — медиакиты, сводки по кампаниям и любые документы, где каждому элементу отведён отдельный слайд.
PDF — формат только для результата: загрузить PDF как шаблон нельзя. При формировании документа вы выбираете, получить результат в родном формате шаблона или в PDF, конвертированном из него.
Как работают плейсхолдеры
Каждый шаблон содержит плейсхолдеры, записанные в синтаксисе с двойными фигурными скобками: {{fieldName}}.
При формировании документа каждый плейсхолдер заменяется значением соответствующего поля записи.
Поля указываются по их машинным именам — идентификаторам, заданным в системе типов сущностей.
Например, у поля, которое отображается как «Имя клиента», может быть машинное имя customerName, и тогда плейсхолдер выглядит так: {{customerName}}.
Кроме простой подстановки значений система плейсхолдеров поддерживает:
-
Повторяющиеся разделы — блок, который повторяется для каждого элемента коллекции и даёт строки таблицы, слайды или абзацы.
-
Плейсхолдеры-выражения — встроенные выражения JavaScript, которые вычисляют значения; для чисел, дат и сумм есть вспомогательные функции форматирования.
-
Плейсхолдеры-изображения — фигуры, которые заменяются изображениями из данных записи.
-
Инвертированные разделы — блок, который выводится, только когда поле пусто; он служит запасным вариантом.
Каждый из этих приёмов описан на отдельной странице ниже.
Шаблоны привязаны к типам сущностей
Шаблоны — возможность платформы, а не только раздела «Документы». Шаблон можно привязать к любому типу сущности: сделкам, контрагентам, записям справочников, единицам инвентаря или пользовательским типам, которые создал администратор.
Тип сущности определяет, какие поля доступны как плейсхолдеры.
Если вы пишете {{contractNumber}} в шаблоне, привязанном к типу сущности «договор», система берёт значение из записи договора, для которой запущено формирование.
Страницы этого раздела
- Плейсхолдеры
-
Синтаксис плейсхолдеров: простые значения, вложенные пути, доступ к корневому контексту и инвертированные разделы.
- Повторяющиеся разделы
-
Как повторять строки таблицы, слайды и абзацы для каждого элемента коллекции.
- Выражения и форматирование
-
Плейсхолдеры-выражения, функции
fmt.number,fmt.dateиfmt.currencyи автоформатирование. - Плейсхолдеры-изображения
-
Замена фигур изображениями в шаблонах DOCX, XLSX и PPTX.
- Шаблоны Excel
-
Возможности, которые есть только у XLSX: типизированные значения ячеек, автоформат дат, живые формулы, DATEDIF, разделение ячеек, книги из нескольких листов и устойчивость к ошибкам.
- Лист _data
-
Подключение дополнительных источников данных в книгу XLSX через зарезервированный лист
_data. - Диагностика проблем
-
Что проверить, если сформированный результат пустой, неполный или в нём не хватает значений.
Связанные страницы
-
Экспорт записи — действие «Экспортировать» и форматы результата
-
Пакетные отчёты — массовое формирование документов
-
Типы данных — типы полей, доступные в шаблонах
-
Выражения — как работают вычисляемые поля в системе сущностей
-
Типы сущностей — как определяются типы сущностей и их поля