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

Документация Corta

Справочник типов полей

Важно

Тип поля и тип рабочего процесса могут отличаться друг от друга

Примечание для разработчиков: добавьте дополнительное пояснение к значению.

Флажок (Да/Нет)

Поле типа «Флажок» используется для хранения логического значения «true/false».

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

При просмотре поле отображается в виде текста (метки), а при редактировании — в виде чекбокса.

  • True

    Метка для значения «true»
    Позволяет указать текст, который будет отображаться для значения «true» (например, «Да»).

  • False

    Метка для значения «false»
    Позволяет указать текст, который будет отображаться для значения «false» (например, «Нет»).

Проверка значений

Для значения «true» допустимы следующие форматы:

  • true
  • t
  • yes
  • y
  • 1

Любое значение, не соответствующее этим форматам, считается значением «false».

Дата и время

Поле типа «Дата и время» используется для хранения временных данных, таких как дата, время или их комбинация.

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

При просмотре поле отображается в виде отформатированной строки, а при редактировании — в виде ввода даты, времени или их комбинации (в зависимости от настроек)

Дополнительные настройки

  • Только дата

    При редактировании отображается только календарь для выбора даты.

  • Только время

    При редактировании отображается только поле для ввода времени.

  • Только прошедшие даты

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

  • Только будущие даты

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

  • Отображение относительного времени

    Показывает значение относительно текущего времени, например: «10 минут назад» или «в прошлом месяце».

  • Формат отображения

    Позволяет задать формат отображения даты и времени. Поддерживаются все параметры форматирования Moment.js.

Проверка значений

  • Поле поддерживает различные форматы даты и времени. Примеры:

    • Только дата: 2006-01-02, 02 Янв 06, Понедельник, 02-Янв-06.
    • Только время: 15:04:05, 15:04, 3:04PM.
    • Дата и время: 2006-01-02T15:04:05Z07:00.

    Обычно используется формат ISO 8601: YYYY-MM-DDTHH:MM:SSZ.

  • Будущие значения
    Если поле настроено для работы только с будущими значениями, оно отклоняет любые даты и время, которые предшествуют текущему моменту.

  • Прошедшие значения
    Если поле настроено для работы только с прошедшими значениями, оно отклоняет любые даты и время, которые наступают после текущего момента.

Электронная почта

Поле типа «Электронная почта» используется для хранения адреса электронной почты.

Это поле подходит для случаев, когда нужно сохранить email, например, основной адрес клиента.

При просмотре поле отображается как текст или кликабельная ссылка (в зависимости от настроек). При редактировании оно представлено в виде текстового поля для ввода email.

Внутри системы email хранится как обычный текст. Форматирование отображения выполняется на уровне интерфейса.

Дополнительные настройки

  • Не превращать email в ссылку

    Отображает email как обычный текст, а не как кликабельную ссылку.

Проверка значений

  • Формат
    Поле принимает адреса электронной почты, соответствующие стандарту RFC 5322. Пример: Адрес электронной почты защищен от спам-ботов. Для просмотра адреса в браузере должен быть включен Javascript..

Поле типа «Выпадающий список» используется для выбора значения из заранее заданного набора опций.

Это поле подходит для случаев, когда нужно ограничить выбор пользователя определёнными значениями, например, статусом заявки («новая», «в работе», «закрыта»).

При просмотре поле отображается как текст (метка), а при редактировании — в виде выпадающего списка.

Дополнительные настройки

  • Опции

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

    Важно: при использовании автоматизации или интеграции с внешними системами используйте значение, а не метку.

  • Множественный выбор

    Позволяет пользователю выбирать несколько значений из списка.

Проверка значений

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

Число

Поле типа «Число» используется для отображения числового значения.

Поле типа «Число» следует использовать, когда необходимо сохранить любое числовое значение. Например, стоимость подписки или стоимость лида.

При просмотре поле типа «Число» представлено в виде отформатированной метки. При редактировании поле отображается в виде поля ввода чисел.

Дополнительные настройки

  • Префикс

    Добавляет указанный префикс к числовому значению. Например, префикс $ и значение 1000приведут к отображению \$1000.

  • Суффикс

    Добавляет указанный суффикс к числовому значению. Например, суффикс USD/h и значение 1000приведут к отображению 1000USD/h.

  • Точность

    Определяет точность, с которой значение должно быть сохранено. Например, точность 3 позволит сохранять числа с тремя десятичными знаками.

    Максимальная точность ограничена шестью знаками после запятой.

  • Формат

    Определяет строку формата, которая используется для отображения чисел. Поле поддерживает все параметры форматирования библиотеки numeral.js.

Проверка значений

  • Значение
    Поле типа «Число» принимает только значения, которые могут быть представлены в виде 64-битного числа с плавающей точкой. Примеры: 1024 или 1024.256.

Запись

Поле типа «Запись» используется для хранения ссылки на другую запись.

Сохраняемое значение — это recordID (идентификатор записи), указывающий на связанную запись. Чтобы получить значения связанной записи, необходимо выполнить запрос через REST API.

Поле типа «Запись» следует использовать, когда нужно определить связь между двумя модулями. Например, родительская транзакция или владелец аккаунта.

Можно ссылаться только на записи в том же пространстве имен (namespace).

При просмотре поле типа «Запись» представлено в виде кликабельной ссылки на связанную запись. При редактировании поле отображается в виде выпадающего списка с поиском.

Дополнительные настройки

  • Модуль

    Определяет, с записями какого модуля связано поле.

  • Поле метки записи

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

  • Предварительный фильтр записей

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

  • Поля для поиска

    Определяет, по каким полям выполняется поиск при работе с связанными записями.

  • Множественный ввод значений

    Определяет, как будет представлена многозначная версия поля.

    Примечание для разработчиков: добавьте список и описание возможных вариантов.

Проверка значений

  • Значение
    Поле типа «Запись» принимает только идентификаторы записей (ссылки на другие записи), которые существуют в системе.

Строка

Поле типа «Строка» используется для отображения произвольного текстового значения.

Поле типа «Строка» следует использовать, когда необходимо сохранить текст. Например, имя контакта или текст условий использования (TOS), которые должны быть показаны клиенту.

При просмотре поле типа «Строка» представлено в виде текста. При редактировании отображается в виде текстового поля или редактора форматированного текста (в зависимости от настроек).

Дополнительные настройки

  • Многострочный ввод

    Преобразует простое текстовое поле в многострочную текстовую область.

  • Использовать редактор форматированного текста

    Преобразует ввод строки в многострочный редактор форматированного текста.

    Значение кодируется в виде стандартного HTML-документа, что позволяет использовать его в приложениях, поддерживающих HTML.

URL

Поле типа «URL» используется для хранения URL-адреса.

Поле типа «URL» следует использовать, когда необходимо сохранить URL-адрес. Например, ссылку на домашнюю страницу клиента.

При просмотре поле типа «URL» представлено в виде метки или кликабельной ссылки (в зависимости от настроек). При редактировании отображается в виде поля ввода URL.

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

Дополнительные настройки

  • Удалить # из URL

    Удаляет фрагмент URL (текст после символа #).

  • Удалить ? из URL

    Удаляет параметры запроса URL (текст после символа ?).

  • Разрешать только SSL (HTTPS) URL

    Разрешает только защищённые URL-адреса с протоколом HTTPS.

  • Не превращать URL в ссылку

    Отображает URL-адрес как обычный текст, а не как кликабельную ссылку.

Проверка значений

  • Формат
    Поле типа «URL» принимает только действительные строки URL, которые содержат схему и хост. Шаблон для URL: [scheme:][//[userinfo@]host][/]path[?query][#fragment].

  • SSL (HTTPS)
    Если поле настроено на разрешение только защищённых URL, схема должна быть равна https.

Пользователь

Поле типа «Пользователь» используется для отображения ссылки на системного пользователя.

Поле типа «Пользователь» следует использовать, когда нужно определить связь между записью и системным пользователем. Например, владелец записи или исполнитель задачи.

При просмотре поле типа «Пользователь» представлено в виде метки. При редактировании отображается в виде выпадающего списка с поиском.

Сохраняемое значение — это userID (идентификатор пользователя), указывающий на связанного пользователя. Чтобы получить значения связанного пользователя, необходимо выполнить запрос через REST API.

Дополнительные настройки

  • Предварительный фильтр пользователей

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

  • Заполнение текущим пользователем

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

  • Роли пользователей

    Фильтрует пользователей на основе их ролей.

  • Множественный ввод значений

    Определяет, как будет представлена многозначная версия поля.

Проверка значений

  • Значение
    Поле типа «Пользователь» принимает только идентификаторы пользователей (ссылки на пользователей), которые существуют в системе.

Загрузка файла

Поле типа «Загрузка файла» используется для хранения ссылки на загруженное вложение.

Поле типа «Загрузка файла» следует использовать, когда нужно прикрепить документ к записи. Например, коммерческое предложение клиента или юридический документ.

При просмотре поле типа «Загрузка файла» представлено в виде кликабельной ссылки на файл. При редактировании отображается в виде области для перетаскивания и загрузки файлов.

Сохраняемое значение — это attachmentID (идентификатор вложения), указывающий на загруженный файл. Чтобы получить данные о загруженном файле, необходимо выполнить запрос через REST API.

Дополнительные настройки

  • Режим просмотра

    Определяет, как файлы отображаются при просмотре.

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

Проверка значений

  • Значение
    Поле типа «Загрузка файла» принимает только идентификаторы файлов (ссылки на файлы), которые существуют в системе.

Локация

Поле типа «Локация» используется для хранения местоположения, которое можно выбрать и отобразить на карте.

Поле типа «Локация» следует использовать, когда необходимо сохранить информацию о местоположении. Например, геолокацию клиента.

При просмотре поле типа «Локация» представлено в виде точки на карте. При редактировании отображается в виде интерактивной карты с возможностью выбора местоположения.

Поле типа «Локация» не имеет специфических настроек конфигурации.

Навигация по документу