Сущности

На вкладке Сущности вы можете добавлять и редактировать сущности, сведения о которых будут отображаться в интерфейсе домена.

Интерфейс раздела

Левая панель Сущности включает в себя следующие компоненты:

  • Значок question при наведении курсора отображает подсказку с определением сущностей.

  • Кнопка plus позволяет создать новую сущность.

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

  • Кнопка Свернуть (arrow left) позволяет свернуть панель.

  • Кнопка arrow right позволяет вернуть панель в исходное состояние, если она была свернута.

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

  • Атрибуты — содержит список атрибутов сущности в виде таблицы.

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

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

Работа с сущностью

Доступные операции над сущностью:

Создание сущности

Чтобы создать сущность:

  1. Перейдите в раздел Сущности. Система отобразит сведения об имеющихся сущностях.

  2. Нажмите на кнопку plus. Отобразится окно создания сущности.

  3. Введите ID сущности. Допустимые символы: прописные и строчные латинские буквы.

  4. При необходимости введите название сущности.

  5. При необходимости введите описание сущности.

  6. Нажмите на кнопку Создать. Новая сущность отобразится в списке.

Просмотр сущности

Чтобы просмотреть сущность:

  1. Перейдите в раздел Сущности. Система отобразит сведения об имеющихся сущностях.

  2. Нажмите на строку сущности в списке. Система отобразит в правой части экрана карточку этой сущности с подробной информацией о ней.

В верхней части карточки отображается название сущности. Справа от названия расположены кнопки редактирования (edit) и удаления (trash) сущности.

В карточке содержатся основные сведения о сущности:

  • ID — уникальный идентификационный код сущности.

  • Название — имя сущности, используемое для ее идентификации в системе.

  • Описание — краткое описание функциональности сущности.

  • Лейбл — название экземпляра сущности, отображаемое в заголовке его карточки.

Изменение сущности

Чтобы изменить сущность:

  1. Перейдите в раздел Сущности. Система отобразит сведения об имеющихся сущностях.

  2. Наведите курсор на строку сущности в списке и нажмите на появившуюся кнопку edit в правой части строки. Отобразится окно настроек сущности.

  3. Внесите изменения в требуемые поля сущности.

  4. Нажмите на кнопку Сохранить. Система сохранит измененные настройки сущности.

Вы также можете изменить сущность из ее карточки. Для этого:

  1. Перейдите в раздел Сущности. Система отобразит сведения об имеющихся сущностях.

  2. Нажмите на строку сущности в списке. Система отобразит в правой части экрана карточку этой сущности с подробной информацией о ней.

  3. Нажмите на кнопку edit в верхней части карточки. Отобразится окно настроек сущности.

  4. Внесите изменения в требуемые поля сущности.

  5. Нажмите на кнопку Сохранить. Система сохранит измененные настройки сущности.

Удаление сущности

Чтобы удалить сущность:

  1. Перейдите в раздел Сущности. Система отобразит сведения об имеющихся сущностях.

  2. Наведите курсор на строку сущности в списке и нажмите на появившуюся кнопку trash в правой части строки. Отобразится окно подтверждения удаления.

  3. Нажмите на кнопку Удалить. Система удалит выбранную сущность. Удаленная сущность будет исключена из списка.

Вы также можете удалить сущность из ее карточки. Для этого:

  1. Перейдите в раздел Сущности. Система отобразит сведения об имеющихся сущностях.

  2. Нажмите на строку сущности в списке. Система отобразит в правой части экрана карточку этой сущности с подробной информацией о ней.

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

  4. Нажмите на кнопку Удалить. Удаленная сущность будет исключена из списка.

Работа с атрибутами

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

Интерфейс раздела

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

  • Кнопка plus позволяет создать новый атрибут.

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

  • Кнопка trash позволяет удалить выбранные в таблице атрибуты. Кнопка становится доступной после выбора хотя бы одного поля из списка.

В рабочей области раздела отображается таблица имеющихся атрибутов. Таблица содержит следующие столбцы:

  • Название — название атрибута, используемое для его идентификации в системе.

  • ID — уникальный идентификатор атрибута.

  • Тип — тип данных атрибута.

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

При работе с таблицей атрибутов доступны следующие операции:

Работа с атрибутом

Доступные операции над атрибутом:

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

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

  1. Перейдите на вкладку Атрибуты выбранной сущности. Система отобразит сведения об имеющихся атрибутах.

  2. Нажмите на кнопку plus. Отобразится окно создания атрибута.

  3. Введите идентификатор атрибута. Допустимые символы: прописные и строчные латинские буквы.

  4. При необходимости введите название атрибута.

  5. Выберите из выпадающего списка тип атрибута.

    Допустимые типы атрибутов
    • Дата и время;

    • Дата;

    • Время;

    • Временной промежуток;

    • MAC-адрес;

    • IP-адрес;

    • CIDR;

    • Булево;

    • UUID;

    • Текст;

    • Целое число;

    • Число с плавающей точкой;

    • Число с плавающей точкой повышенной точности;

    • Файл;

    • Референс;

    • Массив;

    • Таблица;

    • Перечисление;

    • Рабочий процесс.

  6. Установите флажок Только для чтения, если атрибут не должен редактироваться.

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

    Чтобы указать пользовательский текст ошибки при незаполненном атрибуте, нажмите на кнопку message circle и введите текст.

  8. При необходимости введите описание атрибута.

  9. Задайте дополнительные параметры атрибута. Набор параметров атрибута зависит от выбранного типа.

    Для типов Uuid, String, Integer, Reference отметьте флажком опцию Уникальное значение, если значения атрибута в объектах должны быть уникальны.

  10. Нажмите на кнопку Создать. Новый атрибут отобразится в списке.

Вы можете добавить атрибут из таблицы атрибутов:

  1. Нажмите на кнопку plus, расположенную под последним элементом в таблице. Добавится строка настройки атрибута.

  2. При необходимости введите название атрибута.

  3. Введите идентификатор атрибута. Допустимые символы: прописные и строчные латинские буквы.

  4. Выберите из выпадающего списка тип атрибута.

  5. Нажмите на кнопку Сохранить (check).

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

Просмотр атрибута

Чтобы просмотреть атрибут:

  1. Перейдите на вкладку Атрибуты выбранной сущности. Система отобразит сведения об имеющихся атрибутах.

  2. Нажмите на строку атрибута в списке. Система отобразит в правой части экрана карточку этого атрибута с подробной информацией о нем.

В верхней части карточки отображается название атрибута. Справа от названия расположены кнопки редактирования (edit) и удаления (trash) атрибута.

Карточка содержит основные сведения об атрибуте:

  • ID — уникальный идентификационный код атрибута.

  • Название — название атрибута, используемое для его идентификации в системе.

  • Тип — тип данных атрибута.

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

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

  • Текст ошибки (Обязательно) — текст ошибки, который будет отображаться, если обязательное поле не заполнено.

  • Описание — краткое описание функциональности атрибута.

  • Дополнительные данные в зависимости от выбранного типа.

Изменение атрибута

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

Удаление атрибута

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

Дополнительные параметры валидации атрибутов

В зависимости от типа атрибута он может иметь дополнительные параметры, а также правила валидации. Чтобы задать пользовательский текст при ошибке валидации, нажмите на кнопку message circle у соответствующего правила и введите нужный текст.

Текст

Чтобы настроить атрибут типа Текст, дополнительно укажите следующие параметры:

  • Ограничения длины:

    • Минимальное кол-во символов — минимальное возможное количество символов в атрибуте.

    • Максимальное кол-во символов — максимальное возможное количество символов в атрибуте.

  • Regexp — регулярное выражение, которому должна соответствовать строка.

Числовые типы

Чтобы настроить атрибут типа Целое число, Число с плавающей точкой или Число с плавающей точкой повышенной точности дополнительно укажите границы диапазона значений:

  • Минимальное значение — минимальное возможное значение числа.

  • Максимальное значение — максимальное возможное значение числа.

Файл

Чтобы настроить атрибут типа Файл, дополнительно укажите следующие параметры:

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

  • MIME-типы — перечень допустимых типов:

    • application/java-archive;

    • application/json;

    • application/pdf;

    • application/zip;

    • text/csv;

    • text/html.

Референс

Чтобы настроить атрибут типа Референс, дополнительно выберите Сущность, на которую будет ссылаться данный атрибут.

Чтобы создать новую сущность, нажмите на кнопку plus в выпадающем списке.

Расширенные типы атрибутов

Чтобы настроить атрибут типа Перечисление, Рабочий процесс или Таблица дополнительно выберите расширенный атрибут соответствующего типа.

Чтобы создать новый расширенный атрибут, нажмите на кнопку plus в выпадающем списке.

Массив

Чтобы настроить атрибут типа Массив, дополнительно укажите следующие параметры:

  • Ограничения длины массива:

    • Минимальное количество элементов — минимальное возможное количество элементов массива.

    • Максимальное количество элементов — максимальное возможное количество элементов массива.

  • Тип вложенных элементов — тип данных, который должны иметь элементы массива:

    • Дата и время;

    • Дата;

    • Время;

    • Временной промежуток;

    • MAC-адрес;

    • IP-адрес;

    • CIDR;

    • Булево;

    • UUID;

    • Текст;

    • Целое число;

    • Число с плавающей точкой;

    • Число с плавающей точкой повышенной точности;

    • Файл;

    • Референс;

    • Перечисление;

    • Рабочий процесс.

  • Дополнительные настройки в зависимости от выбранного типа элементов.

Работа с правилами сортировки

На вкладке Правила сортировки вы можете добавить правила, которые определяют, по каким атрибутам будет сортироваться список объектов.

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

  • Кнопка plus позволяет создать новое правило.

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

В рабочей области раздела отображается таблица имеющихся правил сортировки. Таблица содержит следующие столбцы:

  • Название — отображаемое название правила.

  • ID — уникальный идентификатор правила.

  • Атрибуты — список названий атрибутов, по которым будет производиться сортировка списка объектов, с указанием направления:

    • sort up — по возрастанию;

    • sort down — по убыванию.

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

При работе с таблицей правил доступны следующие операции:

Создание правила

Чтобы создать правило:

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

  2. Нажмите на кнопку plus. Отобразится окно создания правила.

  3. Введите идентификатор правила. Допустимые символы: прописные и строчные латинские буквы.

  4. При необходимости введите название правила.

  5. Если перечисленные в правиле атрибуты должны индексироваться, установите флажок Создать индекс.

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

  7. Укажите направление сортировки по выбранным атрибутам: по возрастанию (sort up) или по убыванию (sort down).

  8. Нажмите на кнопку Сохранить. Новое правило отобразится в списке.

Просмотр правила

Чтобы просмотреть правило:

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

  2. Нажмите на строку правила в списке. Система отобразит в правой части экрана карточку этого правила с подробной информацией о нем.

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

  • edit — редактирование правила;

  • trash — удаление правила.

Карточка содержит основные сведения о правиле:

  • ID — уникальный идентификатор правила.

  • Название — отображаемое название правила.

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

  • Атрибуты — список названий атрибутов, по которым будет производиться сортировка списка объектов, с указанием направления:

    • sort up — по возрастанию;

    • sort down — по убыванию.

Изменение правила

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

Удаление правила

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

Была ли полезна эта страница?

Обратная связь