> ## Documentation Index
> Fetch the complete documentation index at: https://docs.yume.cloud/llms.txt
> Use this file to discover all available pages before exploring further.

# Глоссарий: Дополнительные поля

> Справочник дополнительных полей: описание поля, разделы и типы значений, кэш списка и старый формат настройки одним объектом.

Справочник к странице [«Дополнительные поля»](/ru/logic/settings/custom-fields).

## Понятия

| Понятие                                | Значение                                                                                                                                                      |
| -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Дополнительное поле                    | Описание пользовательского поля, которое компания добавляет к карточке справочника или аренды. Пустая привязка к компании означает глобальное поле платформы. |
| Кэш списка дополнительных полей        | Механизм выдачи и кэширования списка дополнительных полей компании: поля компании вместе с глобальными полями платформы.                                      |
| Описание поля в старом формате         | Одно дополнительное поле в старом виде — как элемент списка внутри настройки «Дополнительные поля», без собственного идентификатора.                          |
| Набор дополнительных полей по разделам | Старый способ настройки: все дополнительные поля компании передаются одним объектом, сгруппированным по разделам.                                             |
| Раздел дополнительного поля            | Перечень сущностей, к карточкам которых можно добавлять дополнительные поля.                                                                                  |
| Тип дополнительного поля               | Перечень типов значений, которые может принимать дополнительное поле.                                                                                         |

## Модели и поля

### Дополнительное поле

*Описание пользовательского поля, которое компания добавляет к карточке справочника или аренды. Пустая привязка к компании = глобальное
поле платформы; имя уникально в рамках пары «компания + раздел»; список полей кэшируется на сутки и сбрасывается при сохранении или
удалении записи.*

**Привязка**

| Поле          | Тип    | Описание                                                                                                                                                          |
| ------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Идентификатор | число  | Номер записи; по нему работает новый способ управления полями (в старом формате внутри настройки у полей номера не было).                                         |
| Компания      | связь  | Владелец поля. Если не заполнено — поле глобальное и попадает в список всех компаний.                                                                             |
| Раздел        | список | К какой сущности относится поле: клиент, инвентарь, авто, комплект, продукт, точка, категория, аренда, позиция аренды, услуга, лид, мастерская, документ, шаблон. |

**Название и подсказки**

| Поле      | Тип   | Описание                                                                                                           |
| --------- | ----- | ------------------------------------------------------------------------------------------------------------------ |
| Имя поля  | текст | Техническое имя, по которому значение сохраняется в карточке; не может повторяться внутри одного раздела компании. |
| Подпись   | текст | Название поля, которое видит пользователь в интерфейсе.                                                            |
| Подсказка | текст | Текст-заполнитель внутри пустого поля.                                                                             |

**Поведение в интерфейсе**

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

**Тип значения**

| Поле              | Тип    | Описание                                                                                                       |
| ----------------- | ------ | -------------------------------------------------------------------------------------------------------------- |
| Тип значения      | список | Как заполняется поле: текст, число, дата, флажок, цвет или ссылка на другую сущность.                          |
| Варианты значений | список | Заранее заданный набор вариантов для выбора; по умолчанию пустой список. Значение обязано быть именно списком. |

### Кэш списка дополнительных полей

*Механизм выдачи и кэширования списка дополнительных полей компании. В список попадают поля компании вместе с глобальными полями
платформы; вне контекста компании возвращается пустой список.*

| Поле            | Тип             | Описание                                                                                                                      |
| --------------- | --------------- | ----------------------------------------------------------------------------------------------------------------------------- |
| Ключ кэша       | текст           | Отдельный ключ кэша на каждую компанию.                                                                                       |
| Срок жизни кэша | число (секунды) | Сутки: список полей перечитывается из базы не чаще раза в день.                                                               |
| Сброс кэша      | обработчик      | Кэш компании очищается при сохранении и удалении дополнительного поля; изменение глобального поля кэш компаний не сбрасывает. |

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

*Одно дополнительное поле в старом виде — как элемент списка внутри настройки «Дополнительные поля». У поля нет идентификатора: список
раздела всегда перезаписывается целиком. Набор типов здесь свой и отличается от общего: продукт и комплект обозначаются по-своему,
а ссылок на ремонт, документ и шаблон нет.*

| Поле                 | Тип    | Описание                                         |
| -------------------- | ------ | ------------------------------------------------ |
| Имя поля             | текст  | Обязательное техническое имя поля.               |
| Подпись              | текст  | Название поля в интерфейсе; по умолчанию пустое. |
| Подсказка            | текст  | Текст-заполнитель; допускается пустое значение.  |
| Обязательное         | флаг   | По умолчанию выключено.                          |
| Показывать в таблице | флаг   | По умолчанию выключено.                          |
| Доступно в фильтрах  | флаг   | По умолчанию выключено.                          |
| Тип значения         | список | По умолчанию строка.                             |
| Варианты значений    | список | Список текстовых вариантов; по умолчанию пустой. |

### Набор дополнительных полей по разделам

*Старый способ настройки: все дополнительные поля компании передаются одним объектом, сгруппированным по разделам. Сохраняется целиком
в настройку компании «Дополнительные поля» и не создаёт отдельных записей; раздел «документ клиента» существует только здесь, а разделов
мастерской, документа и шаблона в нём нет.*

**Каталог**

| Поле               | Тип    | Описание                                        |
| ------------------ | ------ | ----------------------------------------------- |
| Поля продукта      | список | Дополнительные поля карточки продукта.          |
| Поля комплекта     | список | Дополнительные поля карточки комплекта.         |
| Поля инвентаря     | список | Дополнительные поля карточки единицы инвентаря. |
| Поля услуги        | список | Дополнительные поля карточки услуги.            |
| Поля категории     | список | Дополнительные поля карточки категории.         |
| Поля точки проката | список | Дополнительные поля карточки точки.             |

**Клиенты**

| Поле                   | Тип    | Описание                                                                                      |
| ---------------------- | ------ | --------------------------------------------------------------------------------------------- |
| Поля клиента           | список | Дополнительные поля карточки клиента.                                                         |
| Поля документа клиента | список | Дополнительные поля документа клиента; отдельного раздела в новом наборе разделов у него нет. |
| Поля лида              | список | Дополнительные поля карточки лида воронки.                                                    |

**Аренда**

| Поле                            | Тип    | Описание                                        |
| ------------------------------- | ------ | ----------------------------------------------- |
| Поля аренды                     | список | Дополнительные поля карточки аренды.            |
| Поля позиции аренды (инвентарь) | список | Дополнительные поля строки аренды с инвентарём. |
| Поля позиции аренды (услуга)    | список | Дополнительные поля строки аренды с услугой.    |

## Статусы и справочники

### Раздел дополнительного поля

*Перечень сущностей, к карточкам которых можно добавлять дополнительные поля. Разделы «мастерская», «документ» и «шаблон» есть только
в новом наборе разделов.*

* Клиент
* Услуга
* Инвентарь
* Автомобиль
* Самокат
* Мотоцикл
* Комплект
* Продукт
* Точка проката
* Категория
* Аренда
* Позиция аренды (инвентарь)
* Позиция аренды (услуга)
* Лид
* Мастерская
* Документ
* Шаблон документа

### Тип дополнительного поля

*Перечень типов значений, которые может принимать дополнительное поле. Последние типы — ссылочные: вместо ввода значения пользователь
выбирает существующую запись.*

* Строка
* Форматированный текст
* Целое число
* Дробное число
* Да / нет
* Дата
* Дата и время
* Цвет
* Ссылка на клиента
* Ссылка на инвентарь
* Ссылка на продукт
* Ссылка на комплект
* Ссылка на услугу
* Ссылка на ремонт
* Ссылка на документ
* Ссылка на шаблон
