Создание и настройка атрибутов справочника

Создание и настройка атрибутов справочника осуществляется во вкладке "Атрибуты".

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

• Кодовый. Атрибут, который содержит значение кода справочника.

  • Создается автоматически при создании нового справочника.

  • Имеет предустановленные параметры, недоступные для редактирования.

  • Используется для идентификации записи в справочнике.

  • Должен быть уникальным.

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

• Простой. Атрибут, который содержит в себе одно значение. Может иметь разный тип: строковый, дата, перечисление и т.д.

• Массив. Атрибут, который содержит в себе несколько значений. Может иметь разный тип: строковый, дата, локальное перечисление и т.д.

Справочник должен содержать:

• Минимум 1 атрибут типа "кодовый".

• Главный отображаемый атрибут.

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

Создание атрибутов

Чтобы создать атрибут:

1. Нажмите кнопку "Добавить атрибут" и в открывшемся списке выберите пункт Простой атрибут, Массив-атрибут или Альтернативный кодовый атрибут.

2. Заполните основные поля атрибута:

   • Имя. Системное имя атрибута. Может содержать только латинские буквы и цифры, так же доступны символы "-", "_", должно начинаться с буквы. Недоступно для редактирования после первого сохранения. В рамках одного справочника имена всех атрибутов должны быть уникальными.

   • Отображаемое имя. Имя атрибута для отображения в интерфейсе. Отображаемое имя атрибута можно редактировать после сохранения.

   • Описание. Дополнительная текстовая информация об атрибуте.

   • Тип атрибута. Выбор типа атрибута. В зависимости от выбранного типа атрибута ниже появятся поля дополнительных параметров для выбора (например, выбор типа значения). Недоступен для редактирования, если справочник уже содержит записи. Для массив-атрибута доступны типы: Простой тип, Ссылка на справочник, Локальное перечисление.

3. При необходимости включите флаги:

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

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

4. Заполните параметры атрибута:

   • Отображаемый. Если параметр выключен, атрибут не будет отображаться в поисковой выдаче. При включении: параметр Скрытый будет автоматически недоступен для включения.

   • Главный отображаемый. Если параметр включен, то параметры Скрытый и Только для чтения будут недоступны для включения; параметры Отображаемый и Обязательный будут автоматически включены. После этого изменение перечисленных параметров будет недоступно.

   • Обязательный. Если параметр включен, то атрибут будет являться обязательным для заполнения оператором данных, а параметры Скрытый и Только для чтения будут недоступны для включения.

   • Поисковый. Если параметр включен, то поле участвует в поиске по параметрам, и в панели поиска по справочнику появится поле(-я) для поиска по атрибуту.

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

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

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

   • Доп.параметры. Перечень параметров (пара "имя" – "значение"), которые содержат дополнительную информацию, в т.ч. нестандартную информацию из внешних систем. На параметры могут ссылаться пользовательские расширения.

   • Вид. Выбор представления атрибута. Подробнее о параметре "Вид" см. в пп. 2 описания дополнительных полей.

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

   • Выбрать стратегию. Параметр позволяет указать стратегию генерации значения атрибута. Параметр доступен только для простого строкового атрибута, а также для кодового атрибута (для альтернативного кодового - недоступен).

   • Режим просмотра. Выбор режима просмотра содержимого массив-атрибута:

     • "По умолчанию" отображает значения массив-атрибута в одном поле, разделяя их визуально.

     • "С разделителем" отображает значения в виде строки, разделяя значения символом-разделителем, заданным в свойстве "Разделитель".

     • "Таблица" отображает значения в виде таблицы (каждое новое значение: строка в одноколоночной таблице).

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

Чтобы отредактировать атрибут:

1. Выберите необходимый атрибут из списка существующих.

2. Внесите требуемые изменения. Имя, Тип атрибута и Тип значения недоступны для редактирования.

3. Сохраните изменения с помощью кнопки "Сохранить" в правом верхнем углу экрана.

Чтобы скопировать атрибут:

1. В списке атрибутов нажмите на "Добавить атрибут" и выберите "Скопировать из...".

2. В открывшемся окне, выберите атрибут для копирования и нажмите кнопку "Продолжить".

Чтобы удалить атрибут:

1. Наведите курсор на необходимый атрибут в списке существующих.

2. Нажмите кнопку "Удалить", которая отобразится в правом конце строки при наведении.

Стратегии генерации значений атрибутов

Флаг "Только для чтения" не только блокирует редактирование через интерфейс, но и влияет на обработку значений при интеграциях и автоматической генерации. Значение атрибута нельзя изменить при обычных вызовах API (например, через DataRecordsService.upsertRecord), если не использовать специальный флаг readOnlyUpdate = true. Этот флаг применяется в интеграционных сценариях и при публикации черновика, чтобы обеспечить точное соответствие данных.

Для атрибутов, у которых установлен флаг "Только для чтения" и выбрана одна из стратегий автогенерации (GUID, объединение, пользовательская), доступна дополнительная настройка - "Cтабильность генерации".

1. Автогенерация (GUID). Значение атрибута генерируется для записей автоматически. Длина ограничена 512 символами.

2. Объединение. Значение атрибута генерируется путем соединения в единую строку заданных в конфигурации атрибутов. Также необходимо заполнить следующие параметры:

   • Показывать названия атрибутов. Необходимо выбрать атрибуты, которые будут объединены в одну строку.

   • Разделитель. Необходимо ввести знак или набор знаков, которые будут разграничивать атрибуты в генерируемой строке.

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

   • Имя пользовательского способа генерации.

   • Библиотека. Выбор .jar-файла библиотеки из списка ранее загруженных.

   • Java класс. Выбор класса, который содержится в файле библиотеки.

Примечания:

• Для атрибутов типа Дата используется фиксированный формат yyyy-mm-dd. Другие форматы даты не поддерживаются при генерации внешнего ключа.

Стабильность генерации

Для атрибутов, у которых установлен флаг "Только для чтения" и выбрана одна из стратегий автогенерации, доступна дополнительная настройка "Стабильность генерации". Эта настройка определяет, будет ли сгенерированное значение сохраняться при последующих обновлениях записи или пересчитываться.

Доступны три варианта:

• Не использовать (нестабильная генерация) - значение генерируется заново при каждом сохранении (редактировании) записи. Поведение аналогично обычной автогенерации без флага read-only.

• Единожды - значение генерируется один раз для данной записи (в разрезе внешнего ключа: система-источник + имя сущности + ключ записи). При последующих обновлениях записи сохраненное значение не меняется, даже если меняются исходные данные для генерации.

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

Примечания:

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

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