Help:UI manual: Difference between revisions

Revision as of 00:42, 24 April 2023

На этой странице приведена инструкция по работе в пользовательском интерфейсе сервера Svacer.

Авторизация в пользовательском интерфейсе сервера Svacer

Для авторизации в пользовательском интерфейс сервера Svacer введите логин и пароль на странице ввода учетных данных. Учётные данные по умолчанию — admin / admin.

Если на сервере настроена поддержка протокола LDAP, то войти на можно с помощью внешних серверов. Для этого:

На странице ввода учетных данных перейдите на вкладку LDAP.
Выберите LDAP-сервер в списке, если настроено больше одного сервера авторизации.
Введите логин и пароль.

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

Описание основных элементов пользовательского интерфейса

Все страницы пользовательского интерфейса сервера Svacer устроены единообразно и состоят из двух частей:

Верхняя панель – отображается на всех страницах пользовательского интерфейса.
Содержит:
- логотип сервера Svacer;
- – кнопки для переключения режимов работы:
  - Разметка – просмотр и разметка найденных маркеров, а также сравнение снимков или отдельных маркеров;
  - Код – просмотр снимков исходного кода, связанного с результатами анализатора Svace;
  - Отчеты – формирование отчетов на основе хранимой информации.
- – кнопка для перехода к настройке системы;
- – переключатель языка пользовательского интерфейса;
- – кнопка для перехода на страницу документации к системе;
- – кнопка для перехода к уведомлениям;
- – кнопка меню пользователя, которое предоставляет следующие функции:
  - переход к настройке профиля пользователя;
  - выход из системы;
  - скачивание расширения для VSCode;
  - просмотр информации о программе.
Рабочая область – область экрана для просмотра информации и ввода, которая соответствует выбранному режиму работы или странице настроек.

тут неправильно вставлдяется рисунок_позже посмотреть

Базовые функции системы

Просмотр уведомлений

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

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

Нажмите кнопку для удаления уведомления.

Нажмите кнопку Очистить для удаления всех уведомлений.

Настройка профиля пользователя

Для перехода в профиль выберите пункт Профиль в меню пользователя в правом верхнем углу экрана.

В правой части экрана отобразится панель Профиль, которая состоит из трех разделов:

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

Эти настройки сохраняются для учетной записи пользователя и не сбрасываются при новой сессии.

Временное отображение файлов [#Функции левой навигационной панели|на панели навигации]] и их сортировки можно настроить по нажатии иконки на панели навигации.

Профиль пользователя
Общие настройки интерфейса
Настройки панели навигации

Изменение пароля

Для изменения пароля:

Выберите пункт Профиль в меню пользователя.
В разделе Профиль пользователя нажмите на ссылку Изменить пароль.
В открывшемся окне:
1. Введите текущий пароль.
2. Дважды введите новый пароль.
3. Нажмите кнопку Изменить.

Просмотр информации о программе

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

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

Для просмотра информации об изменениях нажмите кнопку Показать Журнал изменений.

Выбор проекта, ветки и снимка

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

По умолчанию после выбора проекта автоматически выбирается ветка master и последний снимок. Если ветка master отсутствует, её нужно выбрать вручную.

Работа в режиме разметки

Режим разметки предоставляет следующий набор элементов управления:

Левая навигационная панель:
- вкладка Детекторы;
- вкладка Файлы.
Центральная панель:
Правая панель.

Функции левой навигационной панели

Вкладка «Детекторы»

На этой вкладке отображается список детекторов Svace, которые сработали в выбранном снимке.

Серьезность (критичность) детектора обозначена цветом:

красный – наивысшая серьезность (CRITICAL);
желтый – высокая серьезность (MAJOR);
белый – обычная серьезность (NORMAL, MINOR, UNDEFINED).

Пример вкладки Детекторы со сгруппированными данными (в виде дерева) и с данными в виде списка
Пример вкладки Детекторы с данными в виде списка

На вкладке Детекторы пользователю доступны следующие функции:

Отображение данных в виде списка – для этого нажмите кнопку .
Группировка детекторов по уровням серьезности – для этого нажмите кнопку .
По умолчанию детекторы сгруппированы.
Отображение списка маркеров в файлах, в которых сработал детектор, – для этого нажмите кнопку в левой части его имени.
Блокировка всех маркеров, найденных детектором, для разметки другими пользователями – для этого нажмите кнопку справа от названия детектора (отображается при наведении курсора).
Применение фильтра по детектору в таблице маркеров – для этого нажмите на имя детектора.
Применение фильтра по серьезности в таблице маркеров – для этого нажмите название группы серьезности.
Отмена фильтрации – для этого нажмите кнопку .
Отображение на вкладке Исходный код содержимого файла, места и содержания маркера, а также подробной информации о маркере на правой панели – для этого нажмите на маркер.

Вкладка «Файлы»

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

Для каждого файла отображаются:

имя;
количество найденных маркеров (предупреждений);
количество размеченных маркеров;
кнопки и .

На вкладке Файлы пользователю доступны следующие функции:

Применение фильтра по файлу в таблице маркеров – для этого:
1. Нажмите на имя файла.
  В этом случае содержимое файла отобразится на вкладке Исходный код.
  или
2. Нажмите кнопку в одной или нескольких строках.
  В этом случае содержимое файла (файлов) не отобразится.
Отмена фильтрации по одному файлу в таблице маркеров – для этого нажмите кнопку в строке файла.
Отмена фильтрации в таблице маркеров для всех выбранных файлов – для этого нажмите кнопку или кнопку на вкладке Детекторы.
Блокировка всех маркеров в файле для разметки другими пользователями – для этого нажмите кнопку справа от названия файла (отображается при наведении курсора).
Отображение на вкладке Исходный код содержимого файла, места и содержания маркера, а также подробной информации о маркере на правой панели – для этого нажмите на имя файла.
Фильтрация по имени/пути файла в поле Отфильтровать файлы по полному пути. Поддерживается фильтрация с использованием регулярных выражений.
Временная настройка отображения файлов и сортировки полей на вкладке Файлы – для этого нажмите кнопку и поменяйте настройки.

Эта настройка будет действовать до конца сессии пользователя или до повторного изменения отображения.

Функции центральной панели

Вкладка «Информация о снимке»

Вкладка «Исходный код»

Таблица маркеров

Функции правой панели

Использование фильтров

Общая информация

Настройка и использование пользовательских фильтров

Сравнение снимков и маркеров

Сравнение маркеров

Разметка маркера

Групповая разметка маркеров

Блокировка разметки

Экспорт кода с разметкой

Работа с таблицей статистики

Работа в режиме просмотра кода

Режим формирования отчетов

Настройка сервера Svacer

А!!!Управление учетными записями пользователей

Управление профилями пользователей

Управление ролями

А!!!Настройка глобальных фильтров

А!!!Управление шаблонами разметки

А!!!Управление проектами

Просмотр списка всех детекторов и его выгрузка в формате PDF

Управление блокировками разметки

А!!!Просмотр информации о сервере

А!!!Управление клиентами OAuth

А!!!Управление организациями

Выход из системы

Использование регулярных выражений

@@ Line 59: / Line 59: @@
 #* сохранение примененной сортировки значений [[#Таблица маркеров|в таблице маркеров]] при выходе из системы;
 #* использование темной темы (темный фон, светлый текст) при просмотре файлов с исходным кодом;
-#* открытие нескольких вкладок с исходным кодом [[#Работа в режиме просмотра кода|в режиме просмотра кода]]. <br>
+#* открытие нескольких вкладок с исходным кодом [[#Работа в режиме просмотра кода|в режиме просмотра кода]]. <br> Эти настройки сохраняются для учетной записи пользователя и не сбрасываются при новой сессии.
-Эти настройки сохраняются для учетной записи пользователя и не сбрасываются при новой сессии.
 # '''Настройки панели навигации''' – в этом разделе можно настроить отображение по умолчанию для детекторов и файлов [[#Функции левой навигационной панели|на панели навигации]], а также для сортировки значений на вкладке '''Файлы'''.<br>
 Эти настройки сохраняются для учетной записи пользователя и не сбрасываются при новой сессии.
@@ Line 108: / Line 107: @@
 === Функции левой навигационной панели ===
+==== Вкладка «Детекторы» ====
 На этой вкладке отображается список детекторов Svace, которые сработали в выбранном снимке.
@@ Line 122: / Line 122: @@
 # Отображение данных в виде списка – для этого нажмите кнопку [[File:icon_list.png|x25px]].
-# Группировка детекторов по уровням серьезности – для этого нажмите кнопку [[File:icon_tree.png|x25px]]. <br>
+# Группировка детекторов по уровням серьезности – для этого нажмите кнопку [[File:icon_tree.png|x25px]]. <br> По умолчанию детекторы сгруппированы.
-По умолчанию детекторы сгруппированы.
 # Отображение списка маркеров в файлах, в которых сработал детектор, – для этого нажмите кнопку [[File:icon_uncover.png|x15px]] в левой части его имени.
 # Блокировка всех маркеров, найденных детектором, для разметки другими пользователями – для этого нажмите кнопку [[File:icon_unlocked.png|x25px]] справа от названия детектора (отображается при наведении курсора).
@@ Line 130: / Line 129: @@
 # Отмена фильтрации – для этого нажмите кнопку [[File:icon_return.png|x25px]] .
 # Отображение [[#Вкладка «Исходный код»|на вкладке '''Исходный код''']] содержимого файла, места и содержания маркера, а также подробной информации о маркере [[#Функции правой панели|на правой панели]] – для этого нажмите на маркер.
-==== Вкладка «Детекторы» ====
+==== Вкладка «Файлы» ====
+[[File:17 Файлы.png|250px|right]]
+На этой вкладке отображается список файлов, в которых найдены маркеры.
+Для каждого файла отображаются:
+* имя;
+* количество найденных маркеров (предупреждений);
+* количество размеченных маркеров;
+* кнопки [[File:Icon plus.png|x25px]] и [[File:Icon minus.png|x25px]].
+На вкладке '''Файлы''' пользователю доступны следующие функции:
+# Применение фильтра по файлу в таблице маркеров – для этого:
+## Нажмите на имя файла. <br>В этом случае содержимое файла отобразится на вкладке '''Исходный код'''. <br> или
+## Нажмите кнопку [[File:Icon plus.png|x25px]] в одной или нескольких строках. <br>В этом случае содержимое файла (файлов) не отобразится.
+# Отмена фильтрации по одному файлу в таблице маркеров – для этого нажмите кнопку [[File:Icon minus.png|x25px]] в строке файла.
+# Отмена фильтрации в таблице маркеров для всех выбранных файлов – для этого нажмите кнопку [[File:Icon minus 2.png|x25px]] или кнопку [[File:icon_return.png|x25px]] на вкладке '''Детекторы'''.
+# Блокировка всех маркеров в файле для разметки другими пользователями – для этого нажмите кнопку [[File:icon_unlocked.png|x25px]] справа от названия файла (отображается при наведении курсора).
+# Отображение на вкладке '''Исходный код''' содержимого файла, места и содержания маркера, а также подробной информации о маркере на правой панели – для этого нажмите на имя файла.
+# Фильтрация по имени/пути файла в поле '''Отфильтровать файлы по полному пути'''. Поддерживается фильтрация с использованием регулярных выражений.
+# Временная настройка отображения файлов и сортировки полей на вкладке Файлы – для этого нажмите кнопку [[File:icon_wrench.png|x25px]] и поменяйте настройки.
+Эта настройка будет действовать до конца сессии пользователя или до повторного изменения отображения.
+[[File:18 Временная настройка панели навигации.png|1024px]]
-==== Вкладка «Файлы» ====