Платформа 3V/Аудит/Настройка аудита: различия между версиями

Материал из 3v-wiki
Перейти к навигации Перейти к поиску
 
(не показано 7 промежуточных версий этого же участника)
Строка 1: Строка 1:
−
Вы можете скачать уже настроенные объекты аудита или создать объекты аудита самостоятельно.  
+
Вы можете [https://drive.google.com/file/d/1EeD3x0UFAYExJIUi3eMajlICWyBUl74u/view?usp=sharing скачать] уже настроенные объекты аудита или создать объекты аудита самостоятельно.  
 
== Объекты аудита ==
 
== Объекты аудита ==
 
Аудит состоит из нескольких объектов:
 
Аудит состоит из нескольких объектов:
Строка 5: Строка 5:
 
# Внешние справочники
 
# Внешние справочники
 
# Отчет
 
# Отчет
−
Для настройки аудита необходимо создать и настроить каждый из этих объектов, если для настройки аудита вы используете уже настроенные объекты, то вам необходимо лишь изменить ссылку в соединении с источником.  
+
Для настройки аудита необходимо создать и настроить каждый из этих объектов.
 
== Настройка соединения с источником ==
 
== Настройка соединения с источником ==
 +
Создайте новое '''"Соединение с источником"''' для этого нажмите кнопку '''"Создать"''' и выберете пункт '''"Соединение с источником"'''.<br>
 +
Далее откройте '''"Редактор"''' в правой панели навигатора и добавьте JSON описание соединения:<br>
 +
* '''dbType''' - тип соединения для аудита используется "Web",
 +
* '''connectionString''' - адрес для подключения: "http://audit/api/AuditDataSource/",
 +
* '''id''' - идентификатор соединения '''(при создании нового Соединения его идентификатор отобразится в столбце "Идентификатор")'''
 +
* '''name''' - наименование соединения<br>
  
−
'''1. Создать или отредактировать соединение'''
+
<div class="toccolours mw-collapsible mw-collapsed" style="width:700px; overflow:auto;">
−
{| class="wikitable"
+
<div style="font-weight:bold;line-height:1.6;"> Пример описания соединения в формате JSON </div>
−
|-
+
<div class="mw-collapsible-content mw-collapsed-content">
−
! Соединение
+
<syntaxhighlight lang="JSON" line>
−
|-
 
−
| <syntaxhighlight lang="JSON" line>
 
 
{
 
{
 
   "dbType": "Web",
 
   "dbType": "Web",
−
   "connectionString": "https://hcs-data-test.mos.ru/audit/api/AuditDataSource/",
+
   "connectionString": "http://audit/api/AuditDataSource/",
 
   "id": 522,
 
   "id": 522,
 
   "name": "Соединение для Аудита"
 
   "name": "Соединение для Аудита"
 
}
 
}
 
</syntaxhighlight>
 
</syntaxhighlight>
−
|}
+
</div></div>
 +
Пример настройки соединения:
 +
[[Файл:1 Создание объекта Соединение.png|слева|750px|border]] <br clear="both" /><br>
 
== Настройка внешних справочников ==
 
== Настройка внешних справочников ==
−
'''2. Создать внешние справочники и настроить соединение'''
+
После настройки соединения с источником необходимо создать и настроить несколько внешних справочников. Для настройки аудита используются следующие справочники:
−
# Справочник сессий (Sessions)
+
# '''Справочник сессий (Sessions)''' - в нем содержится информация о сессии пользователей:
−
# Справочник действий (AuditingAction)
+
## Идентификатор сессии - атрибут справочника "ExternalId";
−
# Справочник сущностей (Entry)
+
## Дата начала сессии - атрибут справочника "StartTime";
 +
## Дата окончания сессии - атрибут справочника "EndTime";
 +
## Логин пользователя - атрибут справочника "UserLogin";
 +
## Имя пользователя - атрибут справочника "UserName";
 +
# '''Справочник список действий (AuditingAction)''' - в нем содержится перечень действий, которые используются в аудите.
 +
# '''Справочник взаимодействия с объектами (Entries)''' - в нем содержится информация о:<br>
 +
## Сессии - атрибут справочника "Сессия" (может быть связанным со справочником Sessions);
 +
## Дате выполнения действия - атрибут справочника "Дата действия";
 +
## Действие пользователя - атрибут справочника "Действие"(может быть связанным со справочником AuditingAction);
 +
## Идентификаторе объекта в 3V - атрибут справочника "Идентификатор объекта";
 +
## Наименование объекта в 3V- атрибут справочника "Наименование объекта";
 +
## Сообщении о действиях - атрибут справочника "Сообщение";
 +
## JSON - атрибут справочника "JSON";
 +
Для создания Внешнего справочника нажмите кнопку '''"Создать"''' и выберите '''"Внешний справочник"'''. Далее откройте созданный вами справочник и зайдите в '''"Конструктор"'''. <br>
 +
В '''"Конструкторе"''' в поле '''"Соединение"''' укажите созданное ранее соединение с источником, а в поле '''"Идентификатор объекта"''' выберете один из предложенных идентификаторов (для одного справочника можно добавить только один объект). После настройки соединения нажмите кнопку '''"Загрузить"''', отобразятся атрибуты справочника, вы можете дополнительно настроить их, более подробно о настройке справочника вы можете прочитать [[Платформа_3V/Внешний_справочник|здесь]]. После всех необходимых настроек нажмите на кнопку '''"Готово"'''.
 +
[[Файл:создание внешнего справочника аудита.gif|слева]]<br clear="both" /><br>
  
−
[[Файл:Аудит.png|слева|750px|border]] <br clear="both" /><br>
 
 
== Настройка отчета ==
 
== Настройка отчета ==
−
'''3. Создать отчет на справочнике''' <br>
+
После создания и настройки справочников следует создать отчет на справочнике. Для создания отчета нажмите на кнопку '''"Создать"''' и выберите '''"Отчет"'''.<br>
−
В отчете вы можете самостоятельно выбрать и настроить поля, а так же добавить собственные параметры
+
В отчете вы можете самостоятельно выбрать и настроить поля, а так же добавить собственные параметры. Узнать более подробную информацию о настройках отчета вы можете [[Платформа_3V/Отчет|здесь]].
−
[[Файл:Аудит отчет.png|слева|750px|border]] <br clear="both" /><br>
+
[[Файл:отчет по аудиту.png|слева|750px|border]]<br clear="both" /><br>

Текущая версия на 09:35, 28 января 2022

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

Объекты аудита

Аудит состоит из нескольких объектов:

  1. Соединение с источником
  2. Внешние справочники
  3. Отчет

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

Настройка соединения с источником

Создайте новое "Соединение с источником" для этого нажмите кнопку "Создать" и выберете пункт "Соединение с источником".
Далее откройте "Редактор" в правой панели навигатора и добавьте JSON описание соединения:

  • dbType - тип соединения для аудита используется "Web",
  • connectionString - адрес для подключения: "http://audit/api/AuditDataSource/",
  • id - идентификатор соединения (при создании нового Соединения его идентификатор отобразится в столбце "Идентификатор")
  • name - наименование соединения
Пример описания соединения в формате JSON 
1 {
2   "dbType": "Web",
3   "connectionString": "http://audit/api/AuditDataSource/",
4   "id": 522,
5   "name": "Соединение для Аудита"
6 }

Пример настройки соединения:

1 Создание объекта Соединение.png



Настройка внешних справочников

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

  1. Справочник сессий (Sessions) - в нем содержится информация о сессии пользователей:
    1. Идентификатор сессии - атрибут справочника "ExternalId";
    2. Дата начала сессии - атрибут справочника "StartTime";
    3. Дата окончания сессии - атрибут справочника "EndTime";
    4. Логин пользователя - атрибут справочника "UserLogin";
    5. Имя пользователя - атрибут справочника "UserName";
  2. Справочник список действий (AuditingAction) - в нем содержится перечень действий, которые используются в аудите.
  3. Справочник взаимодействия с объектами (Entries) - в нем содержится информация о:
    1. Сессии - атрибут справочника "Сессия" (может быть связанным со справочником Sessions);
    2. Дате выполнения действия - атрибут справочника "Дата действия";
    3. Действие пользователя - атрибут справочника "Действие"(может быть связанным со справочником AuditingAction);
    4. Идентификаторе объекта в 3V - атрибут справочника "Идентификатор объекта";
    5. Наименование объекта в 3V- атрибут справочника "Наименование объекта";
    6. Сообщении о действиях - атрибут справочника "Сообщение";
    7. JSON - атрибут справочника "JSON";

Для создания Внешнего справочника нажмите кнопку "Создать" и выберите "Внешний справочник". Далее откройте созданный вами справочник и зайдите в "Конструктор".
В "Конструкторе" в поле "Соединение" укажите созданное ранее соединение с источником, а в поле "Идентификатор объекта" выберете один из предложенных идентификаторов (для одного справочника можно добавить только один объект). После настройки соединения нажмите кнопку "Загрузить", отобразятся атрибуты справочника, вы можете дополнительно настроить их, более подробно о настройке справочника вы можете прочитать здесь. После всех необходимых настроек нажмите на кнопку "Готово".

создание внешнего справочника аудита.gif



Настройка отчета

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

отчет по аудиту.png



Источник — https://wiki.3v-group.net/index.php?title=Платформа_3V/Аудит/Настройка_аудита&oldid=5852