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

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

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

О доменах

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

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

Область видимости

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

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

Доступ пользователя к каждой организации назначается отдельно:

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

  • Доступ к дочерней организации не дает доступа к родительской.

Привязка объекта к организации определяется при его создании через значение поля organizationId.

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

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

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

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

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

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

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

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

  • Статус — статус домена.

  • Версия схемы — последняя версия схемы, с которой произошла попытка регистрации или успешное обновление домена.

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

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

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

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

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

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

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

Статусы домена

Домен может находиться в одном из следующих статусов:

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

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

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

  • Миграция данных — при обновлении домена система приводит данных и структуры к состоянию, описанному в целевой версии схемы.

  • Удаление — происходит удаление структур и данных объектов домена из базы данных.

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

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

  • Ошибка удаления — произошла ошибка при удалении данных домена.

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

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

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

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

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

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

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

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

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

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

    • схема опубликована и находится в статусе Включен;

    • схема относится к области видимости;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Вкладка Информация

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

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

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

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

  • Статус домена.

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

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

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

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

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

    • теги схемы.

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

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

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

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

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

Вкладка Обновления

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

  • Статус валидации схемы домена при последней проверке;

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

  • Сведения об успешных обновлениях домена в виде таблицы.

Таблица состоит из следующих столбцов:

  • Операция — тип обновления:

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

    • Миграция — изменения в структуре схемы потребовали удалить или преобразовать данные объектов.

      Миграция требуется, если в новой версии домена есть следующие отличия по сравнению с предыдущей:

      • Удалены сущности, атрибуты, связи или действия.

      • Изменены идентификаторы сущностей, атрибутов, связей или действий.

      • Изменены типы данных атрибутов.

      • Изменены типы или стороны связей.

  • Дата запуска — дата и время завершения успешного обновления домена.

  • Запустил — имя пользователя, запустившего обновление.

  • Предыдущая версия — версия схемы до обновления домена.

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

  • Целевая версия — версия схемы, на которую был обновлен домен.

  • Скрипты — SQL-скрипты, выполненные при данном обновлении.

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

Просмотр логов и скриптов миграции

Чтобы просмотреть логи последней миграции:

  1. Нажмите на кнопку more vertical в правом верхнем углу карточки домена.

  2. Выберите опцию Посмотреть логи. Откроется окно просмотра логов с событиями, отсортированными от старых к новым.

  3. Чтобы скопировать логи в буфер обмена, нажмите на кнопку Скопировать под списком событий.

Чтобы просмотреть SQL-скрипты, выполненные при обновлении:

  1. Откройте карточку домена и перейдите на вкладку Обновления.

  2. Найдите нужное обновление в таблице и нажмите на кнопку file text в столбце Скрипты. Откроется окно для просмотра SQL-скриптов.

  3. Чтобы скопировать скрипты в буфер обмена, нажмите на кнопку Скопировать под списком скриптов.

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

    Вы также можете скачать скрипты нескольких обновлений сразу. Для этого установите флажки напротив нужных обновлений в таблице и нажмите на кнопку download.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

В зависимости от изменений в схеме обновление может выполняться:

  • без миграции данных, если структура схемы совместима с текущими данными;

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

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

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

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

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

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

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

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

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

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

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

    • Если в схеме не произошло существенных изменений, система начнет процесс обновления домена на более новую версию схемы. Статус домена изменится на Обновление. После завершения процесса система отобразит уведомления об этом.

    • Если по итогам проверки обнаружились существенные изменения, в поле SQL-запросы отобразятся запросы, которые будут выполнены при обновлении. Если изменения могут привести к потере данных, отобразится предупреждение об этом.

    Обновление невозможно, если произошли следующие изменения:

    • Атрибуту присвоен один следующих типов, либо его тип изменен с одного из них на другой: Array, Table, Enum, Workflow, URL, Attachment, Reference, Counter.

    • Тип атрибута Timestamp был изменен на Time.

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

  5. Внесите при необходимости изменения в SQL-запросы и нажмите на кнопку Выполнить (play). Система начнет процесс обновления домена. Статус домена изменится на Обновление или Миграция данных в зависимости от типа операции. В поле Результат отобразится информация о ходе обновления.

    • Чтобы заново сформировать SQL-запросы для приведения структуры данных к целевому виду, нажмите на кнопку Отменить изменения (restore).

    • Чтобы просмотреть список успешно выполненных скриптов, начиная от текущей версии домена, нажмите на кнопку История изменений (history).

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

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

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

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

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

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

Домены со статусами Обновление, Удаление и Ошибка удаления удалить невозможно.

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

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

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

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

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

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

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

+7 (499) 755 55 70 sales@rvision.ru

О компании Пользовательское соглашение Политика cookies

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