Skip to content

docs: Add property history #211

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
oashnic wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: Add property history #211

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions content/documentation/release-notes/v1.6.0.ru.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,10 @@ description: Заметки о выпуске v1.6.0 — выгрузка ауд

Добавлена функция шаблонизации [«toSlug»](../../user/templating/#toslug).

### Каталог

Добавлена история изменений свойств сущностей и просмотр «Свойства на момент времени». Подробнее — в разделе [«История свойств»](../../user/catalog/#история-свойств).

### Виджеты

Добавлен виджет [«DefectDojo. Продукт»](../../admin/widgets/types/#defectdojo-продукт) для просмотра уязвимостей продукта в DefectDojo с разбивкой по engagement и уровням критичности.
Expand Down
31 changes: 31 additions & 0 deletions content/documentation/user/catalog.ru.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,7 @@ weight: 30
- «Запуски действий» — содержит список действий, которые запускались для данной сущности.
- «Запуски процессов» — содержит список процессов, которые запускались для данной сущности.
- «События» — содержит список событий, сгенерированных для данной сущности.
- «История свойств» — содержит список изменений свойств сущности.

Вкладки с дашбордами из поля «Дополнительные вкладки с дашбордами» в настройках ресурса отображаются на странице сущности рядом со встроенными панелями; порядок вкладок соответствует порядку в настройках ресурса.

Expand All @@ -115,6 +116,36 @@ weight: 30

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

### История свойств

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

Просмотр истории доступен на странице сущности:

1. Вкладка «История свойств» — полный список изменений всех свойств сущности.

1. Иконка часов рядом с названием свойства — история изменений выбранного свойства в диалоговом окне.

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

В таблице «История свойств» отображаются столбцы «Идентификатор свойства», «Источник», «Кем изменено» и «Дата изменения». Кнопка «Показать изменения» открывает сравнение прежнего и нового значения свойства.

В столбце «Источник» возможны значения:

- «Вручную» — изменение пользователем в интерфейсе.
- «Действие» — изменение при выполнении действия.
- «Источник данных» — изменение при синхронизации источника данных.
- «Вебхук» — изменение при обработке вебхука.
- «Система» — автоматическое изменение платформой.

На вкладке «История свойств» поле «Поиск» фильтрует записи по «Идентификатору свойства». Для фильтрации введите идентификатор свойства целиком.

В диалоге «Свойства на момент времени» выберите «Дату и время» и нажмите «Показать». Нельзя выбрать дату в будущем. Если на выбранный момент свойств нет, отображается сообщение «Нет данных на выбранный момент».

{{< alert level="info" >}}
Для просмотра истории свойств требуется право на просмотр сущности: глобальное разрешение `read:entities`, разрешение `read:entities` для ресурса или разрешение `read:entity` для сущности. Подробнее о правах доступа — в разделе [«Ролевая модель»](../../admin/security/rbac/).
{{< /alert >}}

### Избранное

Пользователь может добавить любую сущность в избранное. Для этого на странице сущности нажмите на круглую кнопку со всплывающей подсказкой «Добавить в избранное» рядом с названием сущности. Посмотреть добавленные в избранное сущности можно в разделе каталога «Избранное».
Expand Down