Настройка шаблона документа в Doc.one

Как создать шаблон документа в Doc.one для Case.one? Как добавить шаблон Doc.one?

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


При подключении интеграции с Doc.one список шаблонов обновляется автоматически — если вы создали шаблон документа в Doc.one, он сразу станет доступным в Case.one.


Подготовка шаблона Doc.one

Для настройки шаблона, полученного из Doc.one, выполните следующие действия:

  1. Выберите шаблон с тикетом Doc.one из списка. Откроется форма просмотра шаблона.
  2. Установите флаг Открыть шаблон перед созданием документа, если хотите предоставить возможность редактирования шаблона при формировании документа по шаблону.
  3. Проверьте список типов объектов в блоке Типы объектов, для которых разрешено использование этого шаблона, или добавьте нужный тип объекта. Также вы можете настроить доступность шаблона в конструкторе типа объекта на вкладке Настройки в блоке Шаблоны документов.
  4. Перейдите в раздел Администрирование — Объекты и выберите тип объекта или дела, в котором можно использовать этот шаблон из Doc.one. Откроется конструктор типа объекта.
  5. В настройках поля укажите или проверьте тег поля и нажмите кнопку .
  6. Перейдите в раздел Шаблоны документов и вновь откройте форму просмотра шаблона из Doc.one.
  7. Нажмите кнопку перехода по ссылке  на форме просмотра шаблона Doc.one. Отобразится страница авторизации в Doc.one.
  8. Укажите данные вашей учетной записи и нажмите кнопку Начать работу. Откроется форма редактирования шаблона.

Настройка полей шаблона Doc.one

Форма настройки шаблона содержит следующие вкладки:

  • Шаблон — основная вкладка для работы с шаблоном.
  • Предпросмотр — на вкладке доступен просмотр настроенного шаблона.
  • История — на вкладке можно посмотреть историю изменений шаблона по версиям.
  • Настройки — на вкладке можно указать свойства шаблона.

На вкладке Шаблон:

  • В верхней области расположена панель инструментов, которая содержит кнопки для форматирования и редактирования текста шаблона, добавления таблиц, рисунков, а также полей, блоков и тегов.
  • В правой части формы отображается боковая панель, позволяющая на отдельных вкладках изменить параметры полей и блоков:
    • Вопросы — позволяет добавить условия/вопросы (по И/ИЛИ) к полю или блоку
    • Поля — на вкладке отображается список полей шаблона, где можно настроить основные параметры поля (обязательность, формат, видимость, внешний идентификатор)
    • Блоки — содержит список типовых блоков, которые можно добавить в шаблон

Подробную информацию о создании и настройке шаблона в Doc.one см. в Справочном центре Doc.one.


Чтобы настроить поля шаблона Doc.one:

  1. Нажмите на поле шаблона. В правой части формы отобразятся параметры поля.
  2. Обязательно присвойте такой внешний идентификатору полю, который указан в качестве тега в настройках поля в Case.one.
  3. Укажите значение параметра Внешний идентификатор соответствующими значениями тегов из Case.one в остальных полях шаблона. Теги для документов, доступные для шаблонов документов Case.one, также могут быть использованы в шаблоне Doc.one.
  4. Проверьте форматы полей в выбранном типе объекта в Case.one и определите соответствующие форматы полей в шаблоне — шаблоны Doc.one размечаются с использованием типов полей, которые доступны для добавления в редакторе Doc.one, и соотносятся с типами полей Case.one.

В шаблоне Doc.one вы можете использовать как собственные теги, так и системные.


Описание соотношения типов полей

Поле в Case.oneПоле в Doc.one
Встраиваемый код
ГиперссылкаТекст, QR-код
ДанныеТекст, QR-код
ДатаДата, Текст, QR-код
ЛогическийТекст (Да/Нет), QR-код
Сообщение
Справочник (Значение)Текст, QR-код
ТекстТекст, QR-код
Текстовое расширяемоеТекст, QR-код
Формула расчетаЧисло, Текст, QR-код. Если в Doc.one выбран тип поля Целое число или Валюта (округленно), то дробное число из Case.one округляется до ближайшего четного целого (банковское округление).
ЧекбоксТекст (Да/Нет), QR-код
ЧислоЧисло, Текст, QR-код. Если в Doc.one выбран тип поля Целое число или Валюта (округленно), то дробное число из Case.one округляется до ближайшего четного целого (банковское округление).
Шаблон номера делаТекст, QR-код
Объект (Название)Текст, QR-код

Поскольку связь полей осуществляется с помощью указания тега поля в Case.one, в параметре Внешний идентификатор поля Doc.one:

  • Если формат поля не совпадает с форматом, описанным в таблице выше, такие значения игнорируются в получаемом документе (остаются пустыми).
  • Если в Doc.one указан не корректный тег, и документ не получается сгенерировать, отображается ошибка генерации документа по шаблону.

Не забудьте перейти на вкладку Настройки и выбрать формат, в котором будет создан файл документа в Case.one на основе этого шаблона.

Описание соотношения форматов шаблона

Настройка в Doc.oneФормат файла в Case.one
docxdocx
pdfpdf
docx, pdfdocx

После всех настроек шаблона:

  1. Нажмите кнопку Опубликовать. Шаблон будет сохранен и опубликован в Doc.one, а в Case.one данные шаблона обновятся после синхронизации.
  2. Откройте карточку дела или объекта в Case.one и на вкладке Документы сформируйте документ по шаблону из Doc.one.

При формировании документа по шаблону в карточке объекта, полученному из Doc.one, предусмотрены следующие ограничения:

  • Формат итогового документа зависит от настроек этого шаблона в Doc.one.
  • Документ формируется из шаблона, если заполнены все поля отмеченные как обязательные в Doc.one.

Настройка вопроса в шаблоне Doc.one

При редактировании шаблона на боковой панели на вкладке Вопросы вы можете добавить условия/вопросы (по И/ИЛИ) к полю или блоку.

Если вопрос настроен для поля, при определенном ответе в документе будет отображаться соответствующий текст.

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

Чтобы добавить вопрос к полю выполните следующие действия:

  1. Добавьте нужный тип поля и пропишите все варианты текста в шаблоне, которые при различных обстоятельствах могут появляться в документе. 
  2. Выделите фрагмент текста и нажмите кнопку Добавить условие. Отобразится параметры условия. 
  3. Укажите настройки
    • В поле Название введите вопрос к выделенному тексту и нажмите клавишу ENTER (доступен выбор вопросов из списка вопросов этого шаблона)
    • В поле Ответ — ответ на него, при выборе которого выделенный текст будет появляться в документе
  4. Выделите следующий фрагмент текста и нажмите кнопку Добавить условие. Отобразится параметры условия. 
  5. Укажите настройки:
    • В поле Название введите вопрос к выделенному тексту и нажмите клавишу ENTER (доступен выбор вопросов из списка вопросов этого шаблона)
    • В поле Ответ — ответ на него, при выборе которого выделенный текст будет появляться в документе
  6. Перейдите в настройки поля и укажите разные теги для разных вариантов. 

Работа с мультиблоками и мультистроками в шаблоне Doc.one

При работе с мультиблоками и мультистроками в шаблоне Doc.one табличные данные будут заполняться из:

  • Простого блока Case.one с мультистроками — в Case.one по тегу поля будет собран массив всех значений (количество значений равно количеству строк в блоке). Если значение в строке не заполнено, в качестве элемента в этом месте массива будет передано null.
  • Мультиблока Case.one c простыми строками — в Case.one по тегу поля будет собран массив всех значений (количество значений равно количеству строк в блоке). Если значение в строке не заполнено, в качестве элемента в этом месте массива будет передано null.
  • Мультиблока Case.one с мультистроками — по каждому добавленному мультиблоку будут собраны массивы с данными по мультистрокам:
    • Если значение в строке не заполнено, в качестве элемента в этом месте массива будет передано null
    • Если в шаблоне в таблице первого уровня полей для заполнения больше 1, для предотвращения созданий копий мультистроки ко всем тегам, используемым в Doc.one и Case.one, необходимо добавлять префикс «__». Благодаря префиксу поля будут добавлены в таблицу один раз

Связь полей также осуществляется с помощью указания тега поля в Case.one в параметре Внешний идентификатор поля Doc.one

Для использования мультистрок и мультиблоков предварительно подготовьте шаблон в Doc.one с учетом ограничений использования массивов для формирования мультистрок (подробнее узнать об ограничениях вы можете в справке Doc.one).


При работе с массивами в Doc.one предусмотрены следующие ограничения:

  • Если массив передается в простое поле, все значения будут записаны через разделитель — «,».
  • Если массив передается в строку таблицы, отмеченную как мультистрока, будут созданы дополнительные строки (количество строк зависит от длины массива).
  • Массив может передаваться в условия с единичным и множественным выбором.
  • Теперь при работе с вопросами с мультивыбором, если передать пустой массив в ответ на такой вопрос, то выбор по умолчанию будет автоматически сброшен (особенность работы API v3 Doc.one).
  • При работе с повторяющимися полями разных типов (разные поля с одним тегом) — ответ будет применяться с тем типом, в поле какого типа он попал первым.

Например, в шаблоне присутствует два числовых поля (целое и дробное число) с одним тегом. В Case.one поле с этим тегом заполнено числом с дробной частью:

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

Обратите внимание, при создании документа через API v3 Doc.one предусмотрены следующие ограничения на вложенные мультистроки:

  • Передавать одинаковые значения для полей внешней мультистроки нельзя во вложенном массиве — данные будут перезаписываться (разрешается использовать для внутренних полей).
  • Если в мультистроках больше двух полей, и два из них заполняются вложенным массивом, документ не будет создан, пока не будут переданы данные (хотя бы пустые строки).
  • При передаче данных для нескольких полей с одинаковым названием и внешним идентификатором (Title и ExternalID), возможно некорректное отображение данных, особенно при наличии таких полей до таблицы с мультистроками.
  • При заполнении поля вложенным массивом функция заполнения полей при одновременном выборе условий недоступна.
  • Создать документ с переиспользованными полями и заполнением вложенным массивом можно в двух случаях:
    • Если в мультистроках переиспользуется блок с полем
    • Если таблица с мультистроками и переиспользованными полями находится в блоке, помещенном в шаблон

Детальное описание настроек шаблона Doc.one вы можете посмотреть в отдельной инструкции.