Работа с доменами

Данный раздел описывает процесс работы с доменами в системе. Работа осуществляется в разделе Ресурсы → Домены веб-интерфейса системы.

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

О доменах

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

Работа с доменами осуществляется в разделе Ресурсы → Домены.

Описание интерфейса

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

  • Кнопка Зарегистрировать (plus) позволяет зарегистрировать новый домен.

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

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

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

  • Название — название домена (задается при регистрации домена).

  • Статус — статус регистрации домена:

    • Регистрация — в настоящий момент система регистрирует домен в системе и производит валидацию схемы домена.

    • Зарегистрирован — регистрация домена в системе завершена успешно.

    • Обновление — в настоящий момент система обновляет версию схемы домена.

    • Ошибка регистрации — регистрация домена завершена с ошибкой.

    • Ошибка обновления — обновление домена завершено с ошибкой.

  • Версия схемы — версия схемы домена, выбранной при создании домена.

  • Дата создания — дата создания домена.

  • Дата изменения — дата изменения домена.

  • Описание — краткое описание домена (задается опционально при регистрации домена).

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

  • Поиск доменов по полю Название.

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

  • Сортировка доменов по полям Название, Дата создания и Дата изменения.

Работа с доменом

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

Регистрация домена

Чтобы добавить домен:

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

  2. Нажмите на кнопку Зарегистрировать (plus). Отобразится окно регистрации домена.

  3. Введите название домена.

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

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

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

  6. Нажмите на кнопку Зарегистрировать. Домен отобразится в таблице раздела Домены со статусом Регистрация. Система начнет процесс регистрации домена, а затем отобразит уведомление об успешной регистрации.

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

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

    • кнопка Запустить регистрацию заново — повторно запустить процесс регистрации домена.

Просмотр домена

Зарегистрированный домен отображается:

  • В списке доменов раздела Домены. Здесь происходит управление доменом.

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

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

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

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

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

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

По умолчанию при выборе домена открывается вкладка Информация. На вкладке отображается общая информация о выбранном домене.

На вкладке Информация отображаются следующие поля записи:

  • Идентификатор домена.

  • Название домена.

  • Описание домена.

  • Статус регистрации домена.

  • Информация о схеме, по которой зарегистрирован домен:

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

    • идентификатор схемы.

    • версия схемы, по которой зарегистрирован домен.

    • автор схемы.

    • теги схемы.

  • Дата регистрации домена.

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

  • Дата изменения домена.

  • Идентификатор пользователя, изменившего домен.

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

Изменение домена

Чтобы изменить домен:

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

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

  3. Выберите опцию Изменить в выпадающем меню Действия в верхней части карточки домена. Отобразится окно изменения полей настроек домена.

  4. Внесите изменения в поля настроек домена.

  5. Нажмите на кнопку Сохранить. Измененные данные домена будут сохранены. Система отобразит уведомление об изменении данных.

Изменить название и описание домена можно также непосредственно из карточки домена:

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

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

  3. Нажмите на кнопку Редактировать (edit) рядом с названием или описанием домена в его карточке. Система отобразит поле ввода значения.

  4. Введите новое значение поля.

  5. Нажмите Сохранить. Измененные данные домена будут сохранены. Система отобразит уведомление об изменении данных.

Обновление домена

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

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

  • отображает для записи этого домена значок информации в столбце Версия схемы таблицы доменов.

  • отображает в карточке домена сообщение о выходе новой версии схемы домена.

  • делает активной команду Обновить в выпадающем меню Действия в верхней части карточки домена.

Домены со статусами Регистрация, Обновление, Ошибка регистрации, Ошибка обновления обновлять нельзя.

Чтобы обновить домен:

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

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

  3. Выберите опцию Обновить в выпадающем меню Действия в верхней части карточки домена. Отобразится окно обновления домена.

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

    • В поле Текущая версия схемы отображается номер текущей версии схемы домена.

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

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

  5. Нажмите на кнопку Обновить. Система начнет процесс обновления домена на более новую версию схемы. Статус домена в таблице во время процесса обновления изменится на Обновление. После обновления система отобразит соответствующее уведомление.

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

    • Кнопка Детали позволяет просмотреть подробную информацию об ошибке. (Ознакомьтесь со списком возможных ошибок валидации и с рекомендациями по их устранению.)

    • Кнопка Запустить обновление заново позволяет повторно запустить процесс обновления домена.

Удаление домена

Чтобы удалить домен:

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

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

  3. Выберите опцию Удалить в выпадающем меню Действия в верхней части карточки домена. Отобразится окно удаления домена.

  4. Нажмите на кнопку Удалить. Домен будет удален из системы. Система отобразит уведомление об удалении домена.

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

Интерфейс списка объектов в домене

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

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

Списочное представление с контекстом

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

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

Пример

Просмотр списочного представления: Оценка требований

Контекст: Аудит: на соответствие 307-ФЗ от 30.12.2008

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

Контекст можно определить для следующих видов списочного представления:

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

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

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

"Название сущности в схеме домена: Лейбл". Лейбл — это комбинация атрибутов сущности для отображения в представлении.

Для примера выше: "Аудит: на соответствие 307-ФЗ от 30.12.2008".

Если название контекста не умещается на ярлыке, для его отображения наведите курсор мыши на ярлык.

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

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

Особенности работы с контекстами для списочного представления с вкладками

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

Фильтрация в представлении с контекстом

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

Переход к представлению с контекстом

Чтобы перейти к представлению с контекстом:

  1. Нажмите в списочном представлении на строку экземпляра, связанного с представлением с контекстом. Компактное представление экземпляра отобразится в правой части экрана.

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

Фильтрация в списочном представлении

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

Добавление фильтра списка экземпляров сущностей

Чтобы добавить пользовательский фильтр экземпляров сущностей:

  1. Нажмите на кнопку Добавить фильтр. Отобразится окно добавления фильтра.

  2. Выберите из выпадающего списка поле, по которому будут фильтроваться экземпляры.

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

    • = — равно.

    • != — не равно.

    • In — совпадение с одним из перечисленных значений. Значения указываются через запятую.

    • Like — соответствие заданному шаблону.

    • > — больше.

    • < — меньше.

    • >= — больше или равно.

    • <= — меньше или равно.

    • Between — входит в заданный диапазон.

  4. Укажите значение поля. Для ввода нескольких значений укажите их через запятую.

  5. Если нужно инвертировать фильтр, включите переключатель Инвертировать (NOT).

  6. Если нужно указать название фильтра, включите переключатель Настроить заголовок и введите название.

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

Если задан хотя бы один фильтр, система отобразит кнопки:

  • Отключить все — отключение всех фильтров.

  • Включить все — включение всех фильтров.

  • Инвертировать (NOT) все — инвертирование всех фильтров.

  • Удалить все — удаление всех фильтров.

Изменение фильтра экземпляров сущностей

Чтобы изменить заданный пользовательский фильтр экземпляров сущностей:

  1. Нажмите на стрелку слева от названия фильтра. Отобразится выпадающее меню действий под фильтром.

  2. Выберите опцию Изменить в выпадающем меню. Откроется окно изменения фильтра.

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

  4. Нажмите на кнопку Сохранить. Измененные настройки фильтра будут сохранены.

Инвертирование фильтра экземпляров сущностей

Чтобы инвертировать условие пользовательского фильтра экземпляров сущностей, выберите опцию Инвертировать (NOT) в выпадающем меню. Условие фильтра будет заменено на противоположное.

Отключение фильтра экземпляров сущностей

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

Чтобы отключить фильтр, выберите опцию Отключить в выпадающем меню. Фильтр будет отключен и не будет использоваться для фильтрации.

Включение фильтра экземпляров сущностей

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

Удаление фильтра экземпляров сущностей

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

Работа с фильтрами значений атрибута Reference

В качестве критерия в пользовательском фильтре экземпляров сущностей можно использовать значения атрибута типа Reference (ссылка на другую сущность).

Способ создания фильтра такой же, как и при работе с другими полями. В окне добавления фильтра:

  1. Выберите из выпадающего списка поле компактного представления, в котором отображается ссылка.

  2. Укажите требуемый оператор. Доступные операторы:

    • = — равно.

    • != — не равно.

    • In — совпадение с перечисленными значениями.

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

Работа с фильтрами связей

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

В окне добавления фильтра:

  1. Выберите из выпадающего списка название связи (варьируется в зависимости от ее характеристик).

  2. Укажите требуемый оператор. Доступные операторы:

    • = — равно.

    • != — не равно.

    • In — совпадение с перечисленными значениями.

  3. Выберите лейбл или лейблы (в зависимости от оператора) из раскрывающегося списка.

Система отобразит в списочном представлении экземпляры сущностей, связанные с объектами, указанными в фильтре.

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

Примеры отображения названия связи
  • Связь асимметричная, то есть связанные сущности разные.

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

      Пример связи: Уязвимость порождает Задачу. В поле окна добавления фильтра отобразится название связи для стороны сущности Уязвимость, компактное представление которой открыто, то есть "Порождает". Связь направлена на сущность Задача.

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

      Пример связи: Пользователь связан с Задачей. В поле окна добавления фильтра отобразится название связи для стороны сущности Пользователь, компактное представление которого открыто, то есть "Связан с".

  • Связь симметричная, то есть связанные сущности одинаковые.

    • Связь направленная. Отобразится название связи для первой и второй сторон связи.

      Пример связи: Задача 1 блокирует Задачу 2. В поле окна добавления фильтра отобразится название связи для первой и второй сторон связи, то есть "Блокирует" и "Блокируется".

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

      Пример связи:

      Пользователь 1 работает в одной команде с Пользователем 2. В поле окна добавления фильтра отобразится название связи для первой стороны связи, т.е. "Работает в одной команде с".

Компактное представление сущности

Работа с таблицами

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

При нажатии на кнопку plus в таблицу добавляется новая пустая строка. Правила редактирования полей в строке определяются типом данных атрибута в поле. Введенные значения сохраняются в системе по кнопке Сохранить.

Если введенное в поле значение не проходит валидацию, система подсвечивает поле красной рамкой и отображает сообщение об ошибке, определенное в схеме домена.

При наведении курсора на поле появляется кнопка edit, при нажатии на которую поле можно отредактировать.

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

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

Управление тегами экземпляра

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

Кнопка Редактировать в поле Теги экземпляра позволяет:

  • удалить теги;

  • добавить теги из выпадающего списка тегов сущности.

Вы также можете создать новые теги и добавить их в список тегов сущности.

Вкладка Действия в компактном представлении

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

Колонки таблицы представлены следующим образом:

  • Название — название запускаемого скрипта или плейбука.

  • Время старта — дата и время запуска.

  • Статус — статус запуска.

    Доступные статусы:

    • Выполнен;

    • В процессе;

    • Ошибка.

Переход к связанному экземпляру сущности

Отображение атрибутов сущности в представлении задается в схеме домена с помощью виджетов атрибутов.

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

  • Просмотр объекта, на который дана ссылка.

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

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

  • Открытие ссылки в новой вкладке или окне.

    Для этого нажмите правой кнопкой мыши на лейбл объекта и в отобразившемся стандартном меню браузера выберите одно из следующих действий:

    • Открыть ссылку в новом окне.

    • Открыть ссылку в новой вкладке.

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

История операций над экземпляром сущности

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

Комментарии к экземпляру сущности

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

Комментарии к экземпляру сущности можно добавлять, изменять и удалять.

Добавление комментария

Чтобы добавить комментарий:

  1. Зайдите в зарегистрированный домен со списочным представлением.

  2. Выберите экземпляр сущности.

  3. Перейдите на вкладку Комментарии в компактном представлении сущности (в правой панели).

  4. Нажмите на кнопку Добавить.

  5. Введите данные в поле ввода комментария.

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

Изменение комментария

Чтобы изменить комментарий:

  1. Зайдите в зарегистрированный домен со списочным представлением.

  2. Выберите экземпляр сущности.

  3. Перейдите на вкладку Комментарии в компактном представлении сущности в правой панели.

  4. Наведите курсор на комментарий, который необходимо изменить. Отобразится кнопка Редактировать.

  5. Нажмите на кнопку Редактировать.

  6. Внесите изменения в комментарий.

  7. Нажмите на кнопку Отправить. Комментарий к экземпляру сущности будет изменен и отмечен меткой Изменено. Система отобразит уведомление об изменении комментария.

Удаление комментария

Чтобы удалить комментарий:

  1. Зайдите в зарегистрированный домен со списочным представлением.

  2. Выберите экземпляр сущности.

  3. Перейдите на вкладку Комментарии в компактном представлении сущности (в правой панели).

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

  5. Нажмите на кнопку Удалить. Комментарий к экземпляру сущности будет удален. Система отобразит уведомление об удалении комментария.

Настройка отображения легенды виджета визуализации

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

Легенда не отображается для виджетов с типом визуализации Таблица или Итоги.

Чтобы скрыть легенду, нажмите на кнопку действий (more vertical) в верхнем правом углу виджета и выберите опцию Скрыть легенду. Легенда перестанет отображаться на виджете, а диаграмма визуализации данных займет всю ширину виджета.

Чтобы отобразить скрытую легенду, нажмите на кнопку действий (more vertical) в верхнем правом углу виджета и выберите опцию Показать легенду. В правой части виджета отобразится его легенда, а диаграмма визуализации отмасштабируется по оставшемуся на виджете пространству.