Платформа 3V/Формы/Действия/Экспорт по шаблону

Действие, которое позволяет выгрузить документ word/pdf заполненный данными из формы по определенном шаблону.

Общая информация

 1  {
 2       "templateFilename": "https://.../filestorage/api/FileStorage/S3/get/Документ.docx",
 3       "filenameSettings": {
 4         "value": "Наименование выгружаемого документа.docx",
 5         "discriminator": "FixedTextSettings"
 6       },
 7       "format": "Docx",
 8       "discriminator": "ExportAction",
 9       "comment": null,
10       "enableExpressionId": null,
11       "id": 1,
12       "name": "Выгрузка документа по шаблону",
13       "code": null
14     },

Свойство	Описание
templateFilename	Ссылка на загруженный файл в Файловом хранилище
filenameSettings	Наименование документа, с которым он выгрузится на устройство
format	Формат выгружаемого документа (Docx или Pdf)
id	Идентификатор действия
comment	Описание действия
enableExpressionId	Условие выполнения действия
discriminator	ExportAction

Пример использования

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

Настроить в форме требуемые поля для выгрузки в документ

Настройки всех полей для выгрузки осуществляется в форме, из котороый и происходит выгрузка, в случае когда бОльшая часть необходимых полей должна отображаться на форме. Если для выгрузки требуются элементы, таблицы, диаграммы, бОльшая часть которых не используется для отображения в самой форме - для заполнения по шаблону настраивают отдельную форму, чтобы при открытии текущей не перегружать ее информацией, а подгружать требуемую информацию только в момент "печати" по шаблону.

Как настроить соответствующие поля (текстовые, числовые, даты, таблицы и прочее) см. статью "Настроить элементы формы".

Настроить в файле Word выгружаемые поля

Для выгрузки возможно использовать текстовые, числовые поля, даты, таблицы, ячейку таблицы, диаграммы.

На основании caption или id настроенных элементов возможно сформировать шаблон для выгрузки.

Подробнее о настройке требуемых полей в Word см. статью "Формирование шаблона для печати".

Добавить кнопку для выполнения печати из формы

Для выполнения действия выгрузки документа по шаблону необходимо настроить кнопку, по нажатию на которую будет происходить выгрузка

Подробнее о настройке кнопки см. статью "Настройка кнопки в форме".

Настроить действие на выгрузку

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

 1  {
 2       "templateFilename": "https://.../filestorage/api/FileStorage/S3/get/Документ.docx",
 3       "filenameSettings": {
 4         "value": "Наименование выгружаемого документа.docx",
 5         "discriminator": "FixedTextSettings"
 6       },
 7       "format": "Docx",
 8       "discriminator": "ExportAction",
 9       "comment": null,
10       "enableExpressionId": null,
11       "id": 1,
12       "name": "Выгрузка документа по шаблону",
13       "code": null
14     }

Подробнее про каждое свойство смотри выше.

Укажите ссылку на файловое хранилище

Необходимо указать URL файлового хранилища, где размещен файл (может быть сторонний открытый ресурс, а также сервис "Файловое хранилище" платформы 3V.

При использовании сервиса "Файловое хранилище" платформы 3V в следующей статье вы найдете как загрузить файл и получить соответствующий URL

Настройка наименования выгружаемого файла

• Фиксированное наименование файла

1  {
2      ...
3       "filenameSettings": {
4         "value": "Фиксированное наименование выгружаемого документа.docx",
5         "discriminator": "FixedTextSettings"
6       },
7       ...
8     }

• Расчетное наименование файла

1  {
2      ...
3       "filenameSettings": {
4         "expressionId": 100,
5         "discriminator": "ExpressionTextSettings"
6       },
7       ...
8     }

Где expressionId - Идентификатор выражения, в котором рассчитывается наименование - выражение должно "отдавать" строковый тип данных

Укажите формат выгружаемого файла

В качестве формата выгружаемого файла вы можете использовать Word или Pdf

1  {
2      ...
3       "format": "Docx",
4       ...
5     }

Укажите форму с данными (при необходимости)

При условии выгрузки данных из текущей открытой формы (на которой располагается кнопка "Печать") данное свойство можно не заполнять!

При выгрузке из иной формы, которую требуется "открыть" для выгрузки с точно такими же параметрами как текущую форму, необходимо указать свойство target с идентификатором серверной! части формы (объекта навигатора).

1  {
2      ....
3       "target": {
4         "id": 227
5       },
6      ...
7     }

При выгрузке из иной формы, которую требуется "открыть" для выгрузки с параметрами, отличными от параметров текущей форсы, необходимо указать свойство target с идентификатором серверной! части формы (объекта навигатора), а также прописать параметры открытия для выгрузки документа в свойство parameterValues

Где:

• id - идентификатор параметра формы, в которую передаем отметку
• value - фиксированное значение параметра для открытия формы
• expressionId- идентификатор выражения, с помощью которым рассчитываем значение параметра (при необходимости)

 1  {
 2      ....
 3       "target": {
 4         "id": 227,
 5         "parameterValues": [
 6           {
 7             "id": 1,
 8             "expressionId": 287,
 9             "value": null
10           }
11         ]
12       },
13      ...
14     }

Настроить условие выполнения действия (при необходимости)

При необходимости настроить особое условие при котором действие будет/не будет выполнятся, укажите соответствующие выражение в свойство enableExpressionId', которое будет "возвращать" true или false

true - действие будет выполнено, false - действие не будет выполнено

Если свойство не заполнено действие будет выполнятся при каждом нажатии на кнопку

1  {
2      ....
3       "enableExpressionId": 101,
4      ...
5     }

Основные проблемы и способы решения

1. Выгружается пустой файл:

• Настроены некорректно поля - загрузите файл без заполненных полей, но с простым текстом, чтобы исключить прочие проблемы и добавляйте поля для выгрузки по одному
• Файла по указанной ссылке нет в файловом хранилище - проверьте наличие файла по указанной ссылке

2. Выгружается файл с полями того вида, как они были настроены (Например: $params["Пользователь"]):

• В качестве target указана клиентская форма, а не серверная - исправьте ссылку на корректную

3. Падет ошибка 403 Forbidden

• Нет прав на объект (форму или элемент справочника) у пользователя для выгрузки по шаблону - проверьте права доступа пользователя/роли/группы на соответствующие объекты, которые указаны в логе (F12, ответ/Response упавшего запроса)