Атрибут типа "Строка"

Описание атрибута

Атрибут типа "Строка" предназначен для ввода и отображения небольшой строковой информации.

Значение атрибута типа "Строка" не может начинаться с пробела.

Настройки атрибута

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

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

Параметры атрибута

Название параметра Описание и возможные значения Зависимость от других параметров
Название Название атрибута на карточках объектов и формах, на которых размещен данный атрибут  
Скрывать название атрибута

Признак, управляющий отображением названия атрибута в интерфейсе.

  • флажок снят — название атрибута отображается.
  • флажок установлен:

    В интерфейсе оператора:

    • В контентах "Параметры объекта", "Параметры связанного объекта", блок Подробнее в "Комментарии": отображается значение атрибута (если оно заполнено) и пользовательская кнопка (если она настроена для атрибута).

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

    • В контенте "Параметры на форме" и других формах отображается только поле ввода значения. Если атрибут обязательный, то вместо заголовка отображается звездочка обязательности.
    • В контентах со списками, включая контент "Иерархическое дерево", название атрибута не отображается в названии колонки списка.

      Название атрибута отображается на форме настройки полей сложного списка и формах настройки фильтрации и сортировки списка.

    • На форме расширенного поиска (если атрибут выведен на нее) название отображается.

    В интерфейсе администратора название отображается серым цветом в контентах на вкладке "Карточка объекта", "Форма добавления", "Форма редактирования" и на форме просмотра настроек атрибута

 
Код

Идентификатор атрибута в системе.

Код должен быть уникален в рамках типа объектов, без учета регистра. Код может содержать от 1 до 14 символов, должен состоять только из символов латинского алфавита и цифр, начинаться с символа

 

Вычислимый

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

Устанавливается только на форме добавления атрибута.

  • Флажок установлен — значение атрибута автоматически вычисляется по определенному алгоритму, указанному в скрипте.

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

  • Флажок снят — значение атрибута устанавливается вручную.

Значение вычислимого атрибута:

  • заполняется автоматически и не редактируется в интерфейсе оператора;
  • не хранится в базе данных и не участвует в поиске;
  • не участвует в сортировке и фильтрации в сложных списках объектов.

Во вложенные типы объектов наследуется значение параметра "Вычислимый" вместе со значением параметра "Скрипт"

 

Скрипт для вычисления значения атрибута

В скрипте для вычисления значения атрибута не допустимо обращаться к внешнему источнику. Для взаимодействия с внешними системами необходимо использовать действие по событию типа "Скрипт" с признаком "Взаимодействие с внешней системой" или/и задачу планировщика.

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

Отображается, если установлен флажок "Вычислимый"

Составной

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

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

Какие атрибуты могут быть составными

Параметр "Составной" можно определить для любого системного или пользовательского атрибута типа "Строка", кроме следующих случаев:

  • системно нередактируемый атрибут, например, "Уникальный идентификатор" (UUID);
  • атрибут типа "Строка", код которого используется в шаблоне других составных атрибутов;
  • атрибут "Название" (title), который используется в шаблоне других составных атрибутов (в каком-либо классе/типе существует составной атрибут, в шаблоне которого присутствует атрибут типа "Ссылка на бизнес-объект", ссылающийся на класс с текущим атрибутом "Название" (title));
  • атрибут типа "Строка" в служебном классе.

Особенности составного атрибута

Значение составного атрибута:

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

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

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

Смотри также раздел Название и номер объектов

 

Шаблон

Шаблон составного атрибута может содержать:

  • Строковые константы — произвольные строковые константы: буквы, цифры, словосочетания и т.д.
  • Коды атрибутов — коды невычислимых и несоставных системных и пользовательских атрибутов текущего класса/типа.

    Код атрибута задается в виде: ${attr}, где attr — код атрибута.

    Например, шаблон: ${name} ${price} ${quantity}.

    Могут использоваться:

    • код атрибута типа: "Вещественное число", "Временной интервал", "Дата", "Дата/время", "Ссылка на бизнес-объект" (в том числе агрегируемые атрибуты); "Строка", "Целое число", "Элемент справочника";
    • код системного атрибута "Тип объекта" (metaclass);
    • код системного атрибута "Статус" (state).

    НЕ используются:

    • код системного атрибута "Пароль" (password) системного класса "Сотрудник" (employee);
    • код системного атрибута "Уникальный идентификатор" (UUID);
    • код текущего составного атрибута;
    • код другого составного атрибута;
    • код атрибута типа "Ссылка на бизнес-объект", ссылающийся на текущий класс/тип;
    • код атрибута типа "Ссылка на бизнес-объект", если в классе, на который ссылается данный атрибут, атрибут "Название" (title) является составным;
    • код атрибутов типа "Атрибут связанного объекта".

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

    В атрибутах типа "Дата" и "Дата/время" время отображается в часовом поясе сервера.

Наследование составного атрибута

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

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

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

Отображается, если установлен флажок "Составной"

Определяемый по правилу именования

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

  • Флажок установлен — значение атрибута заполняется автоматически, по указанному правилу, и не редактируется в интерфейсе оператора.
  • Флажок снят — значение атрибута заполняется вручную.

Правило именования определяется:

  • для системных атрибутов "Название" (title), определенных в системных и пользовательских классах и в служебном классе "Запись журнала обработки почты";
  • для пользовательских невычислимых атрибутов типа "Строка", определенных в системных и пользовательских классах.

Смотри также раздел Название и номер объектов

 

Правило именования со справкой (ссылка [Справка])

Правило представляет собой:

  • последовательность констант из предопределенного набора:

    1. Конструкция вида {HH} будет заменена системой на текущий час в 24-часовом формате
    2. Конструкция вида {YY} будет заменена системой на 2 последние цифры года
    3. Конструкция вида {MM} будет заменена системой на текущий месяц
    4. Конструкция вида {mm} будет заменена системой на минуты текущего времени
    5. Конструкция вида {YYYY} будет заменена системой на текущий год
    6. Конструкция вида {DD} будет заменена системой на текущий день месяца
    7. Конструкция вида {ND} будет заменена системой на уникальный номер в рамках дня
    8. Конструкция вида {RND} будет заменена системой на случайный уникальный идентификатор в рамках системы
    9. Конструкция вида {N} будет заменена системой на уникальный идентификатор в рамках системы
    10. Конструкция вида {?N}, где вместо "?" указано натуральное число, будет заменена системой на уникальный идентификатор в рамках системы, в котором "?" — длина, до которой будут добавлены ведущие нули. При использовании этой конструкции для атрибутов типа "Целое число" лидирующие нули будут проигнорированы, если в правиле именования перед {?N} не указать число, отличное от нуля
  • произвольные строковые константы;
  • целые числа.

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

Отображается, если установлен флажок "Определяемый по правилу именования"

Определяемый по таблице соответствий

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

  • Флажок установлен — значение атрибута автоматически вычисляется по таблице соответствий и не редактируется в интерфейсе оператора.

    Значение атрибута вычисляется при добавлении объекта. Для существующих объектов значение атрибута переопределяется при изменении хотя бы одного из определяющих атрибутов.

  • Флажок снят — значение атрибута редактируется в интерфейсе оператора.

 

Правило определения

Таблица соответствий, по которой вычисляется значение атрибута.

При добавлении атрибута в поле установлено значение [не указано].

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

Отображается, если установлен флажок

"Определяемый по таблице соответствий"

Редактируемый

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

  • Флажок установлен — значение атрибута можно изменять на формах добавления и редактирования объекта в интерфейсе оператора.
  • Флажок снят — значение атрибута не редактируется в интерфейсе оператора.

Редактируемость атрибута не влияет на выполнение специальных действий, например, "Смена ответственного", "Смена типа".

Для системных атрибутов значение параметра "Редактируемый" можно изменить, только если системное значение параметра "Редактируемый" = "Да".

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

 

Редактируемый в списках

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

  • Флажок установлен — значение атрибута можно изменять в списке объектов в интерфейсе оператора. При редактировании значения атрибута в ячейке списка будет использоваться представление для редактирования, указанное в параметре "Представление для редактирования".
  • Флажок снят (по умолчанию) — значение атрибута в списке объектов не изменяется.

Доступен, если установлен флажок "Редактируемый"

Обязательный

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

  • Флажок установлен — значение атрибута является обязательным для заполнения в системе.
  • Флажок снят — значение не обязательно для заполнения.

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

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

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

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

 

Обязательный для заполнения в интерфейсе

Признак, определяющий обязательность заполнения значения атрибута в интерфейсе оператора.

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

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

При переводе объекта в архив и любых действиях с архивными объектами заполнение значения атрибута не проверяется

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

Уникальный

Признак уникальности значения атрибута.

  • Флажок установлен — значение атрибута должно быть уникально в рамках класса (типа) объектов. Два объекта не могут иметь одинаковые значения уникального атрибута. Проверка уникальности значения атрибута выполняется при добавлении и редактировании объекта, при восстановлении объекта из архива. Проверка выполняется без учета архивных объектов, с учетом регистра.
  • Флажок снят — значение атрибута не уникально.

Уникальность системного атрибута можно изменить, если установлен флажок "Редактируемый" и системное значение параметра "Уникальный" = "нет".

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

Отображается, если установлен флажок "Редактируемый"

Вычисление значения при редактировании

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

  • Флажок установлен —значение атрибута автоматически заполняется (или перерасчитывается) на формах добавления и редактирования объекта. Для расчета значения атрибута используется скрипт.
  • Флажок снят — значение заполняется вручную

Параметр отображается, если установлен флажок "Редактируемый" и сняты флажки "Вычислимый", "Определяемый по таблице соответствий"

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

Скрипт возвращает значение атрибута.

Отображается, если установлен флажок "Вычисление значения при редактировании"

Представление для отображения

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

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

    Максимальное количество символов в значении атрибута равно 255.

    Исключения: Атрибут "Название" (title), количество символов в значение атрибута зависит от базы данных: PostgreSQL — 1500, Атрибут "URL" (url) класса "Подключение" (тип "HTTP-подключение") количество символов в значении атрибута равно 4000

  • Пароль — значение атрибута отображается как •••••••• (восемь точек), количество точек не зависит от длины введенного значения

 

Скрывать при отображении, если не заполнен

Признак, определяющий отображение атрибута, у которого не заполнено значение.

  • Флажок установлен — если значение атрибута не указано, то атрибут не отображается на карточке объекта в контентах "Параметры объекта", "Параметры связанного объекта", "Информация о пользователе".
  • Флажок снят — атрибут всегда отображается на карточке объекта

Отображается, если снят флажок "Обязательный"

Представление для редактирования

Вид поля выбора значения атрибута на формах добавления и редактирования объекта и вид поля значения атрибута по умолчанию на текущей форме.

  • Выбор из справочника — значение атрибута выбирается из определенного справочника или вводится произвольное значение.

    Дополнительные параметры для представления:

    • "Справочник" — системный или пользовательский справочник, элемент которого может являться значением данного атрибута.
    • "Сортировка списка" — сортировка списка элементов справочника: по коду или по названию элемента.

    Особенности работы с представлением "Выбор из справочника" в интерфейсе оператора см. Выбор значения или ввод произвольного значения.

  • Пароль — аналогично представлению "Поле ввода".

    Если значение уже заполнено, то в поле отображается •••••••• (восемь точек).

    При вводе нового значения, •••••••• исчезает и вводимые символы отображаются стандартным образом.

  • Поле ввода, см. Поле ввода.
  • Поле ввода с маской — поле ввода с маской для ввода значения.

    Дополнительные параметры для представления:

    • "Режим маски ввода" — один из режимов маски ввода: "Псевдоним", "Маска с сокращениями", "Регулярное выражение".
    • "Маска ввода" — конструкция маски ввода.

    Подробное описание настройки маски в полях ввода строковых атрибутов см. Маска в полях ввода строковых атрибутов.

    Особенности работы с представлением "Поле ввода с маской" в интерфейсе оператора см. Поле ввода с маской.

 

Описание

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

Для ввода описания используется поле ввода "Текст в формате RTF".

Отображение описания атрибута в интерфейсе оператора (всплывающая подсказка или информационное поле в контенте) настраивается при настройке контента, в котором отображается атрибут (параметр "Показывать описание атрибутов)

Отображение описания атрибута в интерфейсе оператора (всплывающая подсказка или информационное поле в контенте) настраивается при настройке пользовательских форм:

Описание атрибута может применяться в качестве контекстной справки по каждому атрибуту.

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

Пример. При реализации процесса проведения опросов, в атрибутах класса "Анкета" (questionary) описание атрибутов служит для расширенной формулировки вопросов.

 

Значение по умолчанию

Значение по умолчанию — используется для быстрого заполнения значений атрибутов при добавлении объекта в систему. В качестве значения по умолчанию рекомендуется выбирать наиболее вероятное значение атрибута.

Значение по умолчанию не устанавливается для системно нередактируемых атрибутов.

Виды значения по умолчанию: фиксированное или вычислимое.

Фиксированное значение по умолчанию (флажок "Вычислимое" снят):

  • указывается в поле "Значение", вид поля соответствует выбранному для атрибута представлению для редактирования;
  • отображается в списке атрибутов (столбец "По умолчанию") в выбранном для атрибута представлении для отображения;
  • отображается в контентах на карточке объекта или формах добавления и редактирования объекта (для пользовательских атрибутов).

Вычислимое значение по умолчанию (флажок "Вычислимое" установлен):

Правила использования значения по умолчанию:

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

    • для атрибута в выбранном типе указано значение по умолчанию;
    • до этого момента пользователь не изменял значение по умолчанию вручную на форме добавления.
  • Если параметр "Значение по умолчанию" устанавливается для существующего атрибута, то значение данного атрибута у существующих объектов не меняется.
  • Если параметр "Значение по умолчанию" устанавливается для нового атрибута, то во всех ранее созданных объектах значение атрибута остается пустым

Флажок "Вычислимое" (значение по умолчанию) отображается, если снят флажок "Вычислимый" (для атрибута)

Метки

Одна или несколько меток, определяющих процессы, в которых используется данный атрибут. Метка устанавливается для пользовательских атрибутов основных классов и типов объектов.

Подробное описание работы с метками см. Метки