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

Просмотр списка шаблонов документов и шаблонов счета

Какие типы шаблонов есть в Case.one?

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


По каждому шаблону отображается следующая информация в списке шаблонов:

  1. Название — в колонке отображаются тип (для счета или для документа) в виде иконки и название шаблона. При нажатии на название откроется форма просмотра шаблона.
  2. Тикет Doc.one — специальный ярлык, который отображается только для шаблонов, полученных из Doc.one.
  3. Статус — отображается статус шаблона (опубликован или не опубликован) в Doc.one, изменение статуса недоступно:
    • Активный — статус автоматически присваивается шаблонам документов, которые были созданы не в Doc.one и всем шаблонам для счета;
    • Неактивный — статус отображается для неопубликованных шаблонов документов.
  4. Название файла — название файла, который прикреплен к шаблону:
    • Если вы нажмете на название файла шаблона, полученного из Doc.one, выполняется переход в редактор шаблона Doc.one;
    • Если вы нажмете на название файла шаблона, созданного в Case.one, выполнится скачивание файла.

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

Шаблоны документов, полученные из Doc.one, недоступны для удаления.

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


Чтобы посмотреть или отредактировать шаблон документа нажмите на его название.

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


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

Какие теги можно использовать для шаблона документа? Как создать файл шаблона документа?

Чтобы подготовить файл шаблона, вам нужно создать документ в Word с необходимыми вам элементами: шапкой и футером, а также прописать нужные теги полей, которые вы хотите отображать в документе. 

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


Для создания файла шаблона:

  1. Создайте документ в Word и напишите текст шаблона.
  2. Пропишите теги полей, которые вы хотите отображать в документе:
    • Для системных полей используйте системные теги (например: название проекта — ProjectGroup_Name, название участника — Project_Participant_Name);
    • Для обычных полей пропишите теги вручную.

Помните, что при использовании тегов регистр не учитывается.



Вы можете указать следующие типы полей:

  1. Одиночное поле. Для одиночного поля используйте конструкцию <#field Название тега #>. Конструкция должна быть одним элементом управления содержимым «форматированный текст» или элементом управления содержимым «обычный текст».
  2. Список полей. Для списка полей используйте конструкцию <#list Название тега 1, Название тега 2, Название тега 3 #>. В конструкции каждый элемент должен быть отдельным элементом управления содержимым «форматированный текст» или элементом управления содержимом «обычный текст»:
    • #list
    • Название тега 1
    • Название тега 2
    • Название тега 3
    • #>

Для тегов по мультиблокам обязательно указывайте у тега номер блока в [ ], например: <#field tag_for_multiblok[1] #>.

При необходимости вывести дополнительный атрибут объекта из поля, который находится в мультиблоке, используйте конструкцию <#field tag_for_multiblok[2].tag_dopatributa #>.

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


Теги по делу

НазваниеТег
Project_Email_IdProject_Email_Id
Project_TimeLog_IdProject_TimeLog_Id
Тип активностиProject_TimeLog_ActivityType
Пользователь в активностиProject_TimeLog_User
Дата активностиProject_TimeLog_LogDate
Время активностиProject_TimeLog_Time
Статус активностиProject_TimeLog_Status
Тип активности в таймлоге по задачеProject_Task_TimeLog_ActivityType
Пользователь в таймлоге по задачеProject_Task_TimeLog_User
Дата в таймлоге по задачеProject_Task_TimeLog_LogDate
Время в таймлоге по задачеProject_Task_TimeLog_Time
Тип активностиProject_Event_TimeLog_ActivityType
ПользовательProject_Event_TimeLog_User
ДатаProject_Event_TimeLog_LogDate
ВремяProject_Event_TimeLog_Time
Тип активностиProject_Document_TimeLog_ActivityType
ПользовательProject_Document_TimeLog_User
ДатаProject_Document_TimeLog_LogDate
ВремяProject_Document_TimeLog_Time
Тип активностиProject_Email_TimeLog_ActivityType
ПользовательProject_Email_TimeLog_User
ДатаProject_Email_TimeLog_LogDate
ВремяProject_Email_TimeLog_Time
Документ в деле
id документаProject_Document_Id
Автор документаProject_Document_Author
Дата создания документаProject_Document_CreationDate
Тип документаProject_Document_DocumentType_Name
Наименование документаProject_Document_Name
Название прикрепленного файлаProject_Document_DocumentFile_Name
Статусность документаProject_Document_IsFavorite
Дата получения документаProject_Document_ReceivedDate
Событие в деле
Дата создания событияProject_Event_CreationDate
Тип событияProject_Event_EventType_Name
ОписаниеProject_Event_Description
Потраченное времяProject_Event_TimeSpent
Дата начала событияProject_Event_StartDate_Date
Время началаProject_Event_StartDate_Time
Статусность событияProject_Event_IsFavorite
Событие произошлоProject_Event_Occurred
Автор событияProject_Event_Author
Дата и время началаProject_Event_StartDate
id СобытияProject_Event_Id
Название событияProject_Event_Name
Дата окончания событияProject_Event_EndDate_Date
Время окончания событияProject_Event_EndDate_Time
Гость событияProject_Event_Attendee_Email
Место событияProject_Event_Place
Дата и время окончанияProject_Event_EndDate
Затрата в деле
id ЗатратыProject_Expense_Id
Название затратыProject_Expense_Code
Дата в затратеProject_Expense_Date
Сумма затратыProject_Expense_Total
Статус затратыProject_Expense_Status
Проект дела
Наименование проектаProjectGroup_Name
Статус проектаProjectGroup_IsArchive
Дата создания проектаProjectGroup_CreationDate
id проектаProjectGroup_Id
Автор проектаProjectGroup_Author
Папка дела
id папкиProjectFolder_Id
Дело
Project_Client_IdProject_Client_Id
id делаProject_Id
Номер делаProject_FullNumber
Project_HasProjectGroupProject_HasProjectGroup
Автор делаProject_Author
Ответственный в делеProject_Responsible
Описание делаProject_Description
Наименование делаProject_Name
Тип делаProject_ProjectType_Name
Дата создания делаProject_CreationDate
Статус делаProject_IsArchive
Id пользователя, ответственного по делуProject_Responsible_Id
Заказчик в делеProject_Client
Задача в деле
Дата создания задачиProject_Task_CreationDate
Название задачиProject_Task_Name
Описание задачиProject_Task_Description
Дата исполненияProject_Task_EndDate_Date
Время исполненияProject_Task_EndDate_Time
Приоритет задачиProject_Task_Priority
СтатусProject_Task_Status
СтатусностьProject_Task_IsFavorite
Название родительской задачиProject_Task_ParentTask_Name
Дата и время исполненияProject_Task_EndDate
АвторProject_Task_Author
ОтветственныйProject_Task_Responsible
Прикрепленный файлProject_Task_TaskFile_Name
Project_Task_IdProject_Task_Id
Project_Participant_IdProject_Participant_Id
Участник в деле
АвторProject_Participant_Author
Адрес заказчика в делеProject_Client_Address
НаименованиеProject_Participant_Name
Тип участникаProject_Participant_Type_Name
Роль в деле участникаProject_ParticipantProject_Role_Name
Дата созданияProject_Participant_CreationDate
ФамилияProject_Participant_Individual_LastName
ИмяProject_Participant_Individual_FirstName
ОтчествоProject_Participant_Individual_MiddleName
Дата рожденияProject_Participant_Individual_DateOfBirth
ОрганизацияProject_Participant_Individual_Organization
ТелефонProject_Participant_Individual_ContactDetail_Phone
Электронная почтаProject_Participant_Individual_ContactDetail_Email
ИНН физ. лицаProject_Participant_Individual_INN
ИНН организацииProject_Participant_Company_INN
Организационно-правовая формаProject_Participant_Company_LegalForm_Name
НазваниеProject_Participant_Company_Organization
ТелефонProject_Participant_Company_ContactDetail_Phone
Электронная почтаProject_Participant_Company_ContactDetail_Email
СайтProject_Participant_Company_ContactDetail_Site
Адрес физ лицаProject_Participant_Individual_ContactDetail_Address
Адрес организацииProject_Participant_Company_ContactDetail_Address
КППProject_Participant_Company_KPP
ОГРНProject_Participant_Company_OGRN
ОКПОProject_Participant_Company_OKPO

Создание и добавление шаблона документа

Как создать шаблон документа в Case.one? Как добавить шаблон документа? Как подготовить файл шаблона документа?

Шаблоны документов позволяют вам автоматически заполнять печатные формы (документы и счета) данными из карточки дела.

Настраивать шаблоны документов вы можете в разделе Администрирование —Шаблоны документов.


Для добавления шаблона документа:

  1. Выберите в разделе Администрирование раздел Шаблоны документов.
  2. Нажмите кнопку в правом нижнем углу страницы и выберите пункт Шаблон документа.
  3. Заполните поля формы создания шаблона документа:
    • Введите название шаблона;
    • Прикрепите подготовленный файл шаблона;
    • Выберите из списка типы объектов, для которых будет доступен текущий шаблон.
  4. Нажмите кнопку Добавить. Шаблон будет добавлен в список.

Чтобы подготовить файл шаблона, вам нужно создать документ в Word с необходимыми вам элементами: шапкой и футером, а также прописать теги полей, которые вы хотите отображать в документе.
Например, название проекта (ProjectGroup_Name) и участника (Project_Participant_Name).


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

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

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

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

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

  1. Нажмите кнопку перехода по ссылке на форме просмотра шаблона Doc.one.
  2. Укажите данные вашей учетной записи Doc.one и нажмите кнопку Начать работу.

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

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

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

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

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

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

Это изображение имеет пустой атрибут alt; его имя файла - image.png

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


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

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

Поскольку связь полей осуществляется с помощью указания тега поля в 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

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

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

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

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

  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, необходимо добавлять префикс «__». Благодаря префиксу поля будут добавлены в таблицу один раз.

Это изображение имеет пустой атрибут alt; его имя файла - image.png

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

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


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

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

Это изображение имеет пустой атрибут alt; его имя файла - image.png

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

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

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

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

Создание файла шаблона счета и описание тегов, которые можно использовать

Какие теги можно использовать для шаблона счета? Как создать файл шаблона счета?

Чтобы подготовить файл шаблона, вам нужно создать документ в Word с необходимыми вам элементами: шапкой и футером, а также прописать нужные теги полей, которые вы хотите отображать в готовом счете.
Например, название заказчика (Bill_Client_Name) и сумма затрат (Bill_SubTota).


Файл шаблона для счета создается так же, как и файл шаблона для документа.


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

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


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


Общие теги по счетам

Эти теги вы можете использовать как в таблице, так и вне ее.

Название тегаЧто определяет
Bill_Client_NameНазвание заказчика
Bill_Client_INNИНН заказчика
Bill_Client_OpfОрганизационно-правовая форма
Bill_Client_phoneТелефон заказчика
Bill_Client_siteСайт заказчика
Bill_Client_emailПочта заказчика
Bill_DatePaidСчет – Дата оплаты до
Bill_Client_AddressКлиент – Адрес
Bill_Client_CompanyКлиент – Компания
Bill_Client_JobTitleКлиент – Должность
Bill_Activity_TotalВсего по активностям с налогами и скидками
Bill_Expenses_TotalВсего по затратам с налогами и скидками
Bill_AmountВсего без налогов и скидок
Bill_Activity_AmountВсего без налогов и скидок
по всем активностям
Bill_Expenses_AmountВсего без налогов и скидок
по всем затратам
Bill_SubTotalСумма затрат
Bill_Activity_TaxНалоги по всем активностям
Bill_Expenses_TaxНалоги по всем затратам
Bill_Tax1Общая сумма налогов по tax 1
Bill_Activity_Tax1Налоги по tax 1 по всем активностям
Bill_Expenses_Tax1Налоги по tax 1 по всем затратам
Bill_Tax2Общая сумма налогов по tax 2
Bill_Activity_Tax2Налоги по tax 2 по всем активностям
Bill_Expenses_Tax2Налоги по tax 2 по всем затратам
Bill_TotalК оплате
Bill_CreateDateДата создания
Bill_NumberНомер счета
Bill_DatePaidДата оплаты
Project_Bill_Rate_ItemСтавка в строке счета
Project_Bill_Amount_ItemСумма в строке счета
Project_Bill_Tax_1_ItemНалог 1
Project_Bill_StatusСтатус счета
Project_Bill_Date_ItemДата включения затраты или активности в счет
Project_Bill_SubtotalПодытог счета
Project_Bill_DescriptionОписание в счете
Bill_DiscountСкидка
Project_Bill_Total_ItemК оплате
Project_Bill_Time_ItemВремя
Project_Bill_Due_DateСрок оплаты
Project_Bill_Discount_ItemСкидка
Project_Bill_Description_ItemОписание в строке счета
Bill_TaxНалог итого
Project_Bill_Tax_2_ItemНалог 2
Bill_TableТабличная часть счета
Project_Client_AddressАдрес заказчика в деле
Bill_StartDateВозвращает дату начала периода, за который выставлен счет.Дата отображается с учетом НЛ.Если выбрано За все время, то указывается самая ранняя дата активности или затраты, включенных в счет.
Bill_EndDateВозвращает дату окончания периода, за который выставлен счет.Дата отображается с учетом НЛ.Если выбрано За все время, то указывается самая поздняя дата активности или затраты, включенных в счет.
Bill_StartDate_Long
Bill_EndDate_Long
Bill_DatePaid_LongДата погашения счета

С полным списком тегов, которые могут быть использованы для создания шаблона счета, вы можете ознакомиться в руководстве администратора Case.one.


Создание и добавление шаблона счета

Как создать шаблон счета? Как добавить шаблон счета?

Шаблоны позволяют вам автоматически заполнять печатные формы (документы и счета) данными из карточки дела.

Настраивать шаблоны документов и счетов вы можете в разделе Администрирование — Шаблоны документов.


Для добавления шаблона счета:

  1. Выберите в разделе Администрирование раздел Шаблоны документов.
  2. Нажмите кнопку в правом нижнем углу страницы и выберите пункт Шаблон счета.
  3. Заполните поля формы создания шаблона счета:
    • Введите название шаблона;
    • Прикрепите подготовленный файл шаблона.
  4. Нажмите кнопку Добавить. Шаблон будет добавлен в список.


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


Чтобы подготовить файл шаблона, вам нужно создать документ в Word с необходимыми вам элементами: шапкой и футером, а также прописать нужные теги полей, которые вы хотите отображать в готовом счете.
Например, название заказчика (Bill_Client_Name) и сумма затрат (Bill_SubTotal).


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