Однострочный текст

Введение

В NocoBase однострочный текст (Single line text) — наиболее часто используемое текстовое поле. Оно подходит для хранения кратких текстовых данных длиной не более одной строки, например названия клиента, номера заказа, контактного лица, краткого адреса или идентификатора во внешней системе.

Поле однострочного текста по умолчанию использует Input поле ввода, а его Field type по умолчанию — string. Его можно использовать как поле заголовка, а также в фильтрах, сортировке, настройках доступа, условиях рабочих процессов и API-запросах.

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

Сценарии использования

Однострочный текст подходит для следующих бизнес-сценариев:

  • Название клиента, название компании, имя контактного лица
  • Номер заказа, номер договора, номер проекта
  • Заголовок задачи, заголовок обращения, заголовок статьи
  • ID внешней системы, номер синхронизации, бизнес-код
  • Город, краткий адрес, название магазина и другие краткие текстовые данные

Создание и настройка

На странице «Configure fields» таблицы данных нажмите «Add field» и выберите «Single line text», чтобы создать поле однострочного текста.

20240512163555

НастройкаОписание
Field interfaceТип интерфейса поля. Для однострочного текста соответствует input; на странице по умолчанию используется поле ввода для ввода и отображения данных.
Field display nameНазвание поля, отображаемое в интерфейсе, например «Название клиента», «Номер заказа» или «Заголовок задачи». Рекомендуется использовать название, понятное бизнес-пользователям.
Field nameИдентификатор поля, используемый для внутренних ссылок в API, полях связей, настройках доступа, рабочих процессах и т. д. После создания обычно не изменяется; поддерживаются только буквы, цифры и символы подчёркивания, при этом название должно начинаться с буквы.
Field typeТип поля на уровне данных. Для однострочного текста по умолчанию используется string; также можно выбрать uid. Для обычного краткого текста обычно достаточно string.
Automatically remove heading and tailing spacesАвтоматически удалять пробелы в начале и конце. Подходит для названий клиентов, номеров, заголовков и других данных, в которых не следует сохранять начальные и конечные пробелы.
Default valueЗначение по умолчанию. При создании записи, если пользователь ничего не ввёл, это значение будет подставлено автоматически.
PrimaryИспользовать поле в качестве первичного ключа. Доступно только при создании поля в основной базе данных; обычные бизнес-тексты не рекомендуется использовать как первичный ключ.
UniqueОграничение уникальности. Подходит для номеров заказов, договоров, ID внешних систем и других текстовых данных, которые не должны повторяться.
Validation rulesПравила проверки. Можно задать минимальную, максимальную или фиксированную длину, а также регулярное выражение.
DescriptionОписание поля. Здесь можно указать смысл поля, требования к заполнению, источник данных или ответственного за сопровождение.
Внимание

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

Характеристики поля

Поле однострочного текста по умолчанию ведёт себя следующим образом:

ХарактеристикаОписание
Field interface по умолчаниюinput.
Field type по умолчаниюstring.
Доступные Field typestringuid.
Компонент страницыВ режиме редактирования используется поле ввода Input.
Поле заголовкаПоддерживается использование в качестве поля заголовка таблицы данных. Подходит для назначения полями заголовка значений «Название клиента», «Номер заказа» и «Заголовок задачи».
СортировкаПоддерживается сортировка в блоках таблиц.
ФильтрацияПоддерживаются фильтры для текста, например «содержит», «не содержит», «равно», «не равно», «пусто», «не пусто» и другие.
ПроверкаПоддерживаются проверки минимальной, максимальной и фиксированной длины, регулярных выражений и другие проверки.

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

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

Если поле поступает из уже синхронизированной таблицы основной базы данных, при редактировании обычно выполняется сопоставление полей — поле базы данных сопоставляется с Field type и Field interface NocoBase. Например, короткие текстовые столбцы varcharchar и другие в базе данных можно сопоставить с полем однострочного текста.

НастройкаМожно редактироватьОписание
Field display nameДаИзменяет отображаемое в интерфейсе название поля, не изменяя его идентификатор.
Field nameНетИдентификатор поля обычно нельзя изменить в форме редактирования после создания.
Field interfaceВ зависимости от условийДля полей основной базы данных или синхронизированных полей можно изменить сопоставление. Это повлияет на способ ввода, отображения и проверки на страницах.
Field typeВ зависимости от условийДля полей основной базы данных или синхронизированных полей можно изменить сопоставление. Перед изменением необходимо проверить, смогут ли существующие данные использоваться с новым типом.
Automatically remove heading and tailing spacesДаОпределяет, будут ли при сохранении удаляться начальные и конечные пробелы.
Default valueДаИзменяет текст, подставляемый по умолчанию при создании новых записей.
UniqueВ зависимости от условийМожно настроить для нового поля основной базы данных. Если в существующих данных уже есть повторяющиеся значения, добавление ограничения уникальности может завершиться ошибкой.
Validation rulesДаИзменяет проверки длины, формата или регулярного выражения.
DescriptionДаДополняет сведения о смысле поля, требованиях к заполнению, источнике данных или ответственном за сопровождение.
Внимание

Переключение Field type или Field interface — это не простое изменение отображаемого названия. Оно влияет на способ хранения данных, компонент ввода, правила проверки, условия фильтрации и использование переменных в рабочих процессах. При большом объёме существующих данных сначала убедитесь, что их формат соответствует новому типу.

Удаление поля

Нажмите «Delete» справа от поля, чтобы удалить поле однострочного текста. В основной базе данных можно также выбрать несколько полей и удалить их одновременно.

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

Предупреждение

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

Использование в настройках страниц

Поле однострочного текста можно использовать в большинстве сценариев с блоками данных и формами.

СценарийНазначение
Блок формыВвод или редактирование кратких текстовых данных, например названия клиента, номера заказа или заголовка задачи.
Блок таблицыОтображение, сортировка и фильтрация кратких текстовых данных. Если содержимое длинное, в таблице оно будет сокращено в соответствии с настройками интерфейса.
Блок подробной информацииОтображение текстовой информации отдельной записи.
Блок фильтрацииИспользование в качестве условия запроса для фильтрации записей, например по названию клиента, номеру или заголовку.
Отображение поля связиЕсли поле однострочного текста задано как поле заголовка, при выборе записи в поле связи этот текст будет отображаться в первую очередь.
Рабочие процессы и настройки доступаИспользование в качестве поля условия, например для проверки, пуст ли номер заказа или содержит ли название клиента определённое ключевое слово.

Режим редактирования

В режиме редактирования поле однострочного текста использует поле ввода.

20240512164001

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

В режиме просмотра поле однострочного текста отображается как обычный текст.

20240512164138