Работа с отчетами
Данный раздел описывает процесс работы с отчетами и шаблонами в системе R-Vision SIEM. Работа осуществляется в разделе Отчеты веб-интерфейса системы.
Раздел доступен администраторам, пользователям, которые имеют соответствующее разрешение в составе своих ролей, а также учетным записям со статусом Суперадминистратор. |
Об отчетах
Отчеты в R-Vision SIEM создаются для сбора, анализа и представления данных, собранных системой.
Пользователи могут создавать, просматривать и управлять отчетами, что включает в себя настройку параметров отчета, его создание на основе предопределенных шаблонов, отправку во внешние системы, а также экспорт в файл. Отчеты могут быть настроены для автоматической публикации по расписанию.
Интерфейс раздела
Интерфейс раздела зависит от открытой вкладки. Доступные вкладки:
-
Сформированные — вкладка для работы со сформированными отчетами.
-
Шаблоны — вкладка для работы с шаблонами отчетов.
Интерфейс вкладки Сформированные
Панель инструментов вкладки содержит следующие элементы:
-
Поле Поиск предназначено для быстрого поиска отчетов по их названию.
-
Кнопка Фильтр (
) позволяет открыть в правой части рабочей области панель для настройки фильтрации списка отчетов.
В рабочей области вкладки отображается таблица имеющихся отчетов. Таблица содержит следующие столбцы:
-
Название — имя отчета, используемое для его идентификации в системе.
-
Теги — теги, ассоциированные с отчетом.
-
Дата публикации — дата и время публикации отчета в системе.
При работе с таблицей отчетов доступны следующие операции:
-
Поиск отчетов по полю Название.
-
Фильтрация отчетов по полю Теги. Теги вводятся вручную и применяются по клавише ENTER.
-
Сортировка отчетов по полям Название и Дата публикации.
-
Настройка отображения таблицы.
При выборе конкретного отчета в правой части рабочей области отображается его карточка с детальной информацией.
Интерфейс вкладки Шаблоны
Панель инструментов вкладки содержит следующие элементы:
-
Кнопка Создать (
) позволяет создать новый шаблон отчета.
-
Кнопка Создать из схемы (
) позволяет создать новый шаблон отчета на основе схемы.
-
Поле Поиск предназначено для быстрого поиска шаблонов по их названию.
-
Кнопка Фильтр (
) позволяет открыть в правой части рабочей области панель для настройки фильтрации списка шаблонов.
В рабочей области вкладки отображается таблица имеющихся шаблонов отчетов. Таблица содержит следующие столбцы:
-
Название — имя шаблона отчета, используемое для его идентификации в системе.
-
Расписание — индикатор автоматического создания отчетов на основе этого шаблона по расписанию: Включено или Выключено.
-
Теги — список связанных с шаблоном тегов, используемых для его поиска и классификации.
-
Дата изменения — дата и время последнего изменения шаблона отчета.
-
Дата последнего отчета — дата и время последней публикации отчета на основе текущего шаблона.
При работе с таблицей шаблонов отчетов доступны следующие операции:
-
Поиск шаблонов по полю Название.
-
Фильтрация шаблонов по полям Теги и Расписание:
-
Теги вводятся вручную и применяются по клавише ENTER.
-
Индикатор расписания выбирается из выпадающего списка.
-
-
Сортировка шаблонов по полям Название и Дата изменения.
-
Настройка отображения таблицы.
При выборе конкретного шаблона отчета в правой части рабочей области отображается его карточка с детальной информацией.
Работа с шаблоном отчета
Шаблоны отчетов являются инструментом для определения структуры и периодичности публикации отчетов. Они позволяют выбирать аналитические данные для включения в отчеты и поддерживают функции автоматического создания и отправки отчетов по расписанию.
Доступные операции над шаблоном отчета:
Создание шаблона отчета
Создать шаблон отчета можно следующими способами:
Создание шаблона отчета вручную
Чтобы создать шаблон отчета вручную:
-
Перейдите на вкладку Шаблоны раздела Отчеты. Система отобразит список имеющихся шаблонов отчетов.
-
Нажмите на кнопку Создать (
) на панели инструментов. Система отобразит структуру шаблона в рабочей области и боковую панель с его текущими настройками.
-
Введите название шаблона отчета.
-
При необходимости введите описание шаблона отчета.
-
При необходимости добавьте теги для классификации и поиска шаблона в системе.
-
При необходимости выберите интеграцию для отправки отчета во внешние системы. Для этого выберите из выпадающего списка Отправить одну из доступных почтовых интеграций.
-
При необходимости выберите из выпадающего списка Шаблон дашборда дашборд, который определит структуру текущего шаблона отчета.
Пользователю доступны общие дашборды и созданные им персональные дашборды. -
Добавьте отдельные виджеты в шаблон с помощью кнопки Добавить виджет. Если вы выбрали дашборд как основу для шаблона, вы можете удалить ненужные виджеты.
Шаблон отчета должен содержать хотя бы один виджет. -
Настройте виджеты, как описано в разделе Работа с дашбордами. Период, за который собраны данные в отчете, определяется настройками виджетов, добавленных в него.
Изменения настроек не повлияют на исходный дашборд.
При экспорте отчета система может изменить его внешний вид для лучшего отображения данных.
-
Задайте период хранения. Выберите единицы измерения и их количество, чтобы определить срок, по истечении которого отчет будет удален из системы.
-
Задайте параметры публикации.
Для публикации отчета по расписанию переведите переключатель Расписание в активное положение и задайте настройки публикации:
-
Период — выберите из выпадающего списка период публикации:
-
Каждый день — для публикации отчетов ежедневно.
-
По дням — для публикации отчетов в конкретные дни недели. При выборе этого периода необходимо указать дни недели для публикации.
-
-
Время — укажите время, в которое должен быть сформирован отчет.
-
-
Нажмите Сохранить. Система создаст шаблон отчета и отобразит соответствующее уведомление. Новый шаблон появится в разделе Отчеты на вкладке Шаблоны.
Создание шаблона отчета из схемы
Чтобы создать шаблон отчета из схемы:
-
Перейдите на вкладку Шаблоны раздела Отчеты. Система отобразит список имеющихся шаблонов отчетов.
-
Нажмите на кнопку Создать из схемы в левой части панели инструментов. Откроется окно создания шаблона.
-
Выберите схему из выпадающего списка.
-
Сопоставьте переменные виджетов с источниками данных — хранилищем событий или активным списком в зависимости от типа виджетов.
-
Нажмите на кнопку Продолжить. Система отобразит структуру шаблона в рабочей области и боковую панель с его текущими настройками.
-
При необходимости внесите изменения в настройки, как при создании шаблона вручную.
Если при настройке вы выберете дашборд в выпадающем списке Шаблон дашборда, виджеты текущей схемы будут заменены на виджеты этого дашборда. -
Нажмите Сохранить. Система создаст шаблон отчета и отобразит соответствующее уведомление. Новый шаблон появится в разделе Отчеты на вкладке Шаблоны.
Просмотр карточки шаблона отчета
Чтобы просмотреть карточку шаблона отчета:
-
Перейдите на вкладку Шаблоны раздела Отчеты. Система отобразит сведения об имеющихся шаблонах отчетов.
-
Нажмите на строку шаблона в списке. Система отобразит в правой части экрана карточку этого отчета с базовой информацией о нем.
В верхней части карточки отображается название шаблона отчета. Справа от названия расположена кнопка , по которой открывается выпадающее меню с действиями, доступными для выбранного шаблона.
Карточка содержит основные сведения о шаблоне отчета:
-
ID — уникальный идентификатор шаблона отчета.
-
Название — имя шаблона отчета.
-
Описание — дополнительная информация о шаблоне.
-
ID тенанта — уникальный идентификационный код тенанта, к которому относится шаблон.
-
Теги — список связанных с шаблоном тегов, используемых для его поиска и классификации.
-
Расписание — индикатор автоматического создания отчетов на основе этого шаблона по расписанию: Включено или Выключено.
-
Дата последнего отчета — дата и время создания последнего отчета по текущему шаблону. Если отчет не создавался, значение в поле отсутствует.
-
Дата следующего отчета — дата и время создания следующего отчета по настроенному расписанию. Если расписание не задано, значение в поле отсутствует.
-
Дата создания — дата и время создания шаблона отчета.
-
Создал — пользователь, инициировавший создание шаблона отчета.
-
Дата изменения — дата и время последнего изменения шаблона отчета.
-
Изменил — пользователь, выполнивший последнее изменение шаблона отчета.
В нижней части карточки расположена кнопка Сформировать, позволяющая создать версию отчета по выбранному шаблону на текущий момент.
Изменение шаблона
Чтобы изменить шаблон отчета:
-
Перейдите на вкладку Шаблоны раздела Отчеты. Система отобразит сведения об имеющихся шаблонах отчетов.
-
Нажмите на строку шаблона в списке. Система отобразит в правой части экрана карточку этого отчета с базовой информацией о нем.
-
Нажмите на кнопку действий (
) в верхнем правом углу карточки и выберите опцию Изменить. Отобразится окно настроек.
-
Внесите изменения в настройки шаблона.
-
Нажмите на кнопку Сохранить. Система сохранит изменения и отобразит соответствующее уведомление. Обновленная информация отобразится в карточке шаблона и в списке раздела Отчеты на вкладке Шаблоны.
Название, описание и теги шаблона отчета можно также изменить из его карточки. Для этого:
|
Создание копии
Чтобы создать копию шаблона:
-
Перейдите на вкладку Шаблоны раздела Отчеты. Система отобразит сведения об имеющихся шаблонах отчетов.
-
Нажмите на строку шаблона в списке. Система отобразит в правой части экрана карточку этого отчета с базовой информацией о нем.
-
Нажмите на кнопку действий (
) в верхнем правом углу карточки и выберите опцию Создать копию. Система отобразит окно настроек шаблона.
-
Внесите требуемые изменения в настройки шаблона.
-
Нажмите на кнопку Создать. Система создаст шаблон отчета и отобразит соответствующее уведомление. Новый шаблон появится в разделе Отчеты на вкладке Шаблоны.
Удаление шаблона
Чтобы удалить шаблон отчета:
-
Перейдите на вкладку Шаблоны раздела Отчеты. Система отобразит сведения об имеющихся шаблонах отчетов.
-
Нажмите на строку шаблона в списке. Система отобразит в правой части экрана карточку этого отчета с базовой информацией о нем.
-
Нажмите на кнопку действий (
) в верхнем правом углу карточки и выберите опцию Удалить. Отобразится окно подтверждения удаления шаблона.
-
Нажмите на кнопку Удалить. Система удалит шаблон отчета и отобразит соответствующее уведомление. Удаленный шаблон будет исключен из списка шаблонов в разделе Отчеты на вкладке Шаблоны системы.
Сохранение шаблона отчета как схемы
Чтобы сохранить шаблон отчета как схему:
-
Перейдите на вкладку Шаблоны раздела Отчеты. Система отобразит сведения об имеющихся шаблонах отчетов.
-
Нажмите на строку шаблона в списке. Система отобразит в правой части экрана карточку этого отчета с базовой информацией о нем.
-
Нажмите на кнопку действий (
) в верхнем правом углу карточки и выберите опцию Создать схему. Отобразится окно создания схемы.
-
По умолчанию название и описание создаваемой схемы идентичны названию и описанию шаблона. При необходимости измените название и описание схемы.
-
Выберите из выпадающего списка каталог экспертизы, в котором будет создана схема.
-
Для виджетов событий и активных списков автоматически генерируются переменные, которые при создании шаблона отчета из схемы нужно связать с источниками данных. При необходимости измените переменные виджетов.
Чтобы при создании шаблона отчета несколько виджетов получали данные из одного источника, задайте для них одинаковые переменные. -
Нажмите на кнопку Далее. Откроется окно создания RObject-конфигурации схемы с заполненными данными.
-
Задайте идентификатор схемы шаблона отчета в поле
id
. -
При необходимости внесите изменения в поля схемы.
-
Нажмите на кнопку Опубликовать версию. Система создаст схему шаблона отчета и отобразит соответствующее уведомление. Новая схема появится в таблице раздела Экспертиза.
Чтобы схема стала доступной для создания шаблонов отчета, ее необходимо включить. Вы можете создать черновик схемы шаблона без публикации с помощью кнопки Сохранить черновик. Система создаст черновик схемы и отобразит соответствующее уведомление. Новый черновик появится в таблице раздела Экспертиза.
Работа со сформированным отчетом
Все отчеты в системе формируются на основе шаблонов отчетов.
Доступные операции над отчетом:
Создание отчета
Создание отчета начинается с выбора и настройки шаблона. Вы можете добавить различные виджеты и задать параметры отчета. Отчет можно создать вручную или настроить расписание, чтобы отчеты создавались автоматически.
Чтобы создать отчет из существующего шаблона:
-
Перейдите на вкладку Шаблоны раздела Отчеты. Система отобразит сведения об имеющихся шаблонах отчетов.
-
Нажмите на строку шаблона в списке. Система отобразит в правой части экрана карточку этого отчета с базовой информацией о нем.
-
Нажмите Сформировать в нижней части карточки. Система создаст по шаблону версию отчета на текущий момент и отобразит соответствующее уведомление. Новый отчет появится в разделе Отчеты на вкладке Сформированные.
Просмотр карточки отчета
Чтобы просмотреть карточку отчета:
-
Перейдите на вкладку Сформированные раздела Отчеты. Система отобразит сведения об имеющихся отчетах.
-
Нажмите на строку отчета в списке. Система отобразит в правой части экрана карточку этого отчета с базовой информацией о нем.
В верхней части карточки отображается название отчета. Справа от названия расположена кнопка для удаления отчета.
Карточка содержит сведения, сгруппированные по следующим секциям:
-
Основная информация об отчете:
-
ID — уникальный идентификатор отчета.
-
Название — имя отчета, используемое для идентификации в системе.
-
ID тенанта — уникальный идентификационный код тенанта, к которому относится отчет.
-
Теги — список тегов, связанных с отчетом.
-
Шаблон — шаблон, по которому был создан отчет.
-
Дата публикации — дата и время публикации отчета.
-
Срок хранения --- срок хранения отчета, по истечении которого он будет удален из системы.
-
Сформировал — имя пользователя, сформировавшего отчет.
-
Запуск — каким образом был сформирован отчет: Автоматически или Вручную.
-
-
Получатели отчета:
-
Название — название интеграции для отправки отчета, добавленной при создании шаблона.
-
Статус — состояние отправки: Успешно или Ошибка.
-
Ошибка (при наличии ошибок отправки) — текст ошибки.
-
В нижней части карточки расположены кнопки:
-
Смотреть отчет — позволяет просмотреть содержимое отчета.
-
Экспорт в файл — позволяет экспортировать отчет.
Просмотр содержимого отчета
Чтобы просмотреть содержимое отчета в формате HTML:
-
Перейдите на вкладку Сформированные раздела Отчеты. Система отобразит сведения об имеющихся отчетах.
-
Нажмите на строку отчета в списке. Система отобразит в правой части экрана карточку этого отчета с базовой информацией о нем.
-
Нажмите на кнопку Смотреть отчет в нижней части карточки шаблона. Система отобразит содержимое отчета в отдельной вкладке браузера в формате HTML.
Экспорт отчета
Чтобы выгрузить отчет:
-
Перейдите на вкладку Сформированные раздела Отчеты. Система отобразит сведения об имеющихся отчетах.
-
Нажмите на строку отчета в списке. Система отобразит в правой части экрана карточку этого отчета с базовой информацией о нем.
-
Нажмите на кнопку Экспорт в файл в нижней части карточки. Система отобразит окно экспорта.
-
Выберите формат экспорта из выпадающего списка: HTML, PDF, CSV.
Для формата CSV отчет выгружается в виде ZIP-архива. -
Нажмите на кнопку Экспорт. Система выгрузит отчет на устройство пользователя в выбранном формате и отобразит соответствующее уведомление.
При экспорте отчетов их внешний вид может измениться для удобства отображения данных:
|
Удаление отчета
Чтобы удалить отчет:
-
Перейдите на вкладку Сформированные раздела Отчеты. Система отобразит сведения об имеющихся отчетах.
-
Нажмите на строку отчета в списке. Система отобразит в правой части экрана карточку этого отчета с базовой информацией о нем.
-
Нажмите на кнопку
в верхнем правом углу карточки. Отобразится окно подтверждения удаления отчета.
-
Нажмите на кнопку Удалить. Система удалит отчет и отобразит соответствующее уведомление. Удаленный отчет будет исключен из списка раздела Отчеты на вкладке Сформированные.