Документация для разработчиков
Темная тема

documentgenerator.document.add

Scope: documentgenerator Права на выполнение: для всех

documentgenerator.document.add(templateId, value, values = [], stampsEnabled = 0, fields = [])

Метод создает новый документ на основании шаблона. В случае успешного выполнения в результате придёт структура, аналогичная методу documentgenerator.document.get() на новом документе.

Параметры

Параметр Описание
templateIdID шаблона.
valueВнешний идентификатор. Параметр value нужен только для интерфейса приложения, как идентификатор внешнего источника. Это строковый параметр, в него можно передать полноценный внешний код. Например, "PARTNER_APP_10_BILL_133”.
valuesНабор значений полей документа. В простом случае это одномерный массив, где ключ - название поля, а значение - строка для вставки в документ.
stampsEnabled1 (поставить), 0 (убрать) печати и подписи.
fieldsОписание полей документа. Данный параметр - массив, где ключ - название поля, а значение - описание.

Коды типов простых полей:

  • TYPE — тип поля;
  • FORMAT — формат;
  • PROVIDER — провайдер;
  • TITLE — заголовок;
  • IMAGE — изображение;
  • STAMP — печать / подпись;
  • DATE — дата / время;
  • NAME — имя;
  • PHONE — номер телефона.


Примеры

Здесь можно посмотреть пример генерации документа.



Почему в результате document.add нет ссылки на pdf?

Конвертация в pdf - операция асинхронная. На момент окончания генерации документа ещё нет pdf-файла.

Если для документа очень нужен pdf, то сейчас единственный вариант - сделать повторный запрос documentgenerator.document.get через 20-30 секунд, чтобы считать ссылку на pdf. Если она там не появилась - попробовать повторить.



© «Битрикс», 2001-2024, «1С-Битрикс», 2024