Перейти к основному содержимому

Кастомные поля

Кастомные (пользовательские) поля позволяют добавить свои текстовые поля к стандартным сущностям LogiFlow без участия разработчиков. Это удобно, когда бизнесу нужно хранить что-то специфическое: «номер договора», «номер пломбы», «таможенный код груза».

К каким сущностям можно добавлять поля​

Кастомные поля поддерживаются ровно для четырёх типов сущностей:

Тип сущностиЗначение в системеЧто это
ОтправлениеshipmentЛогистическое отправление груза
ЗаявкаrequestЗаявка на перевозку
СчётbillФинансовый документ — счёт
ПлатёжpaymentФинансовый документ — платёж
Других сущностей нет

Кастомные поля нельзя добавить к контрагентам, клиентам, услугам, статьям или «операциям» в общем виде. Доступны только четыре типа выше. Счёт (bill) и платёж (payment) — это финансовые документы.

Где настраиваются​

Раздел Настройки → Пользователи и система → Пользовательские поля.

Создавать, изменять и удалять кастомные поля могут администратор и руководитель (роли admin и boss), а также администратор платформы. Менеджер и склад видят значения полей в формах, но саму конфигурацию не меняют.

Клиенту кастомные поля не показываются вовсе — ни в заявке, ни в финансовом документе, ни на телефоне. Это сделано намеренно: поля заводят для внутреннего учёта, и их содержимое не предназначено заказчику. Если нужно, чтобы клиент что-то видел, используйте штатные поля заявки или комментарий.

Создание поля​

  1. Нажмите Новое поле.
  2. Заполните:
    • Тип сущности — отправление, заявка, счёт или платёж.
    • Название — то, как поле называется в интерфейсе. До 100 символов, HTML-теги запрещены.
    • Ключ поля — короткий идентификатор. Используется как имя переменной в печатных шаблонах. Требования:
      • только латинские буквы, цифры и подчёркивания;
      • должен начинаться с латинской буквы;
      • длина от 2 до 50 символов;
      • нельзя использовать зарезервированные слова (например, id, class, value, name, type, script).
    • Максимальная длина — лимит длины вводимого значения. По умолчанию 255 символов (в интерфейсе допускается до 1000).
    • Порядок — число для сортировки полей (чем меньше, тем выше). В интерфейсе поля можно также перетаскивать мышью.
    • Активно — снимите галочку, чтобы временно скрыть поле от пользователей без удаления.
  3. Сохраните.

Поле сразу появляется в формах создания/редактирования соответствующей сущности.

Хранилище значений — только текст

Все значения кастомных полей хранятся как текст. В системе нет понятия «тип поля» (число/дата/логический флаг) на уровне хранения и нет проверки типа. Если нужно число или дату — пользователи вводят их текстом. Ограничение применяется только по длине (поле «Максимальная длина»).

Уникальность ключа​

Тройка компания + ключ поля + тип сущности должна быть уникальной. То есть в одной компании нельзя создать два поля с одинаковым ключом для одной и той же сущности. При этом один и тот же ключ можно использовать для разных сущностей — например, contract_number отдельно для заявки и отдельно для счёта.

Редактирование​

Можно изменить название, ключ поля, максимальную длину, порядок и активность. Изменения применяются ко всем существующим записям сразу.

Осторожно с переименованием ключа

Ключ поля используется как имя переменной в печатных шаблонах. Если изменить ключ, переменная в уже настроенных шаблонах перестанет подставляться — обновите шаблоны.

Деактивация и удаление​

  • Деактивация — снимите галочку «Активно». Поле скрывается от пользователей, но значения сохраняются. Безопасный способ «отключить» поле, не теряя данные.
  • Удаление — необратимо вместе со всеми сохранёнными значениями. Перед удалением экспортируйте данные, если они могут понадобиться.

Варианты использования​

Заявки (request):

  • «Номер договора», «ИНН отправителя», «Особые условия».

Отправления (shipment):

  • «Номер пломбы», «Температурный режим», «Класс ADR» (для опасных грузов).

Счета и платежи (bill, payment):

  • «Номер платёжного поручения», «Период начисления», «Основание».

Использование в печатных шаблонах​

Значения кастомных полей доступны как переменные в печатных шаблонах. Поскольку шаблоны — это Excel-файлы, переменные пишутся в ячейках в формате {{...}}.

Кастомные поля доступны под префиксом:

  • custom — для отправлений и заявок;
  • custom_fields — для финансовых документов (счёт/платёж).

Примеры:

{{custom.items[0].name}}    — название первого кастомного поля
{{custom.items[0].value}}   — значение первого кастомного поля
{{custom.table}}            — динамическая таблица всех кастомных полей (Название, Значение)
{{custom.table:name,value}} — таблица с явным указанием колонок
Полный список переменных

В редакторе печатных шаблонов есть кнопка «Справка по переменным» — она показывает все доступные переменные для выбранной сущности, включая кастомные поля. Используйте её, чтобы не угадывать имена.

Ограничения​

  • На одну сущность не стоит создавать слишком много полей — формы становятся неудобными. Если полей много, подумайте, что можно объединить.
  • Все значения текстовые: проверки «это число / это дата» нет, есть только ограничение длины.
  • Кастомные поля не выгружаются во внешние системы автоматически. Если используете интеграции, согласуйте передачу полей с техподдержкой.

Что дальше​