Help:UI manual: Difference between revisions

From Svacer Wiki
Jump to navigation Jump to search
m (minor markup fixes)
Line 8: Line 8:
Если на сервере настроена поддержка протокола LDAP, то войти можно с помощью внешних серверов. Для этого:
Если на сервере настроена поддержка протокола LDAP, то войти можно с помощью внешних серверов. Для этого:


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


[[File:Авторизация LDAP 02.png|thumb|none|x300px|alt=AutorizationLDAP|Страница входа по протоколу LDAP]]
[[File:Авторизация LDAP 02.png|thumb|none|x300px|alt=AutorizationLDAP|Страница входа по протоколу LDAP]]
Line 20: Line 20:
== Описание основных элементов пользовательского интерфейса ==
== Описание основных элементов пользовательского интерфейса ==
Все страницы пользовательского интерфейса сервера Svacer устроены единообразно и состоят из двух частей:
Все страницы пользовательского интерфейса сервера Svacer устроены единообразно и состоят из двух частей:
# Верхняя панель – отображается на всех страницах пользовательского интерфейса. <br />Содержит:
# Верхняя панель – отображается на всех страницах пользовательского интерфейса<br />Содержит:
#* логотип сервера Svacer;
#* логотип сервера Svacer
#* [[File:04 Кнопки для переключения режимов работы.png|x25px]] – кнопки для переключения режимов работы:
#* [[File:04 Кнопки для переключения режимов работы.png|x25px]] – кнопки для переключения режимов работы:
#** '''Разметка''' – [[#Работа в режиме просмотра кода|просмотр и разметка найденных маркеров]], а также [[#Сравнение снимков и маркеров|сравнение снимков или отдельных маркеров]];
#** '''Разметка''' – [[#Работа в режиме просмотра кода|просмотр и разметка найденных маркеров]], а также [[#Сравнение снимков и маркеров|сравнение снимков или отдельных маркеров]]
#** '''Код''' – [[#Работа в режиме разметки|просмотр снимков исходного кода]], связанного с результатами анализатора Svace;
#** '''Код''' – [[#Работа в режиме разметки|просмотр снимков исходного кода]], связанного с результатами анализатора Svace
#** '''Отчеты''' – [[#Режим формирования отчетов|формирование отчетов]] на основе хранимой информации.
#** '''Отчеты''' – [[#Режим формирования отчетов|формирование отчетов]] на основе хранимой информации
#* [[File:Icon settings.png|x25px]] – кнопка для перехода к [[#Настройка сервера Svacer|настройке системы]];
#* [[File:Icon settings.png|x25px]] – кнопка для перехода к [[#Настройка сервера Svacer|настройке системы]]
#* [[File:Icon RuEng.png|x25px]] – переключатель языка пользовательского интерфейса;
#* [[File:Icon RuEng.png|x25px]] – переключатель языка пользовательского интерфейса
#* [[File:Icon question mark.png|x25px]] – кнопка для перехода на страницу документации к системе;
#* [[File:Icon question mark.png|x25px]] – кнопка для перехода на страницу документации к системе
#* [[File:Icon bell.png|25px]] – кнопка для перехода к [[#Просмотр уведомлений|уведомлениям]];
#* [[File:Icon bell.png|25px]] – кнопка для перехода к [[#Просмотр уведомлений|уведомлениям]]
#* [[File:Icon profile.png|x25px]] – кнопка меню пользователя, которое предоставляет следующие функции:
#* [[File:Icon profile.png|x25px]] – кнопка меню пользователя, которое предоставляет следующие функции:
#** переход к [[#Настройка профиля пользователя|настройке профиля пользователя]];
#** переход к [[#Настройка профиля пользователя|настройке профиля пользователя]]
#** [[#Выход из системы|выход из системы]];
#** [[#Выход из системы|выход из системы]]
#** скачивание расширения для VSCode;
#** скачивание расширения для VSCode
#** [[#Просмотр информации о программе|просмотр информации о программе]].
#** [[#Просмотр информации о программе|просмотр информации о программе]]
# Рабочая область – область экрана для просмотра информации и ввода, которая соответствует выбранному режиму работы или странице настроек.
# Рабочая область – область экрана для просмотра информации и ввода, которая соответствует выбранному режиму работы или странице настроек


:[[File:03 Элементы интерфейса.png|800px]]
:[[File:03 Элементы интерфейса.png|800px]]
Line 55: Line 55:


В правой части экрана отобразится панель '''Профиль''', которая состоит из трех разделов:
В правой части экрана отобразится панель '''Профиль''', которая состоит из трех разделов:
:1. '''Профиль пользователя''' – в этом разделе можно изменить атрибуты своего профиля (ФИО, контакты), кроме логина, а также [[#Изменение пароля|поменять пароль]].
:1. '''Профиль пользователя''' – в этом разделе можно изменить атрибуты своего профиля (ФИО, контакты), кроме логина, а также [[#Изменение пароля|поменять пароль]]
:[[File: 07 Профиль основные параметры.png|thumb|none|x400px|alt=ProfileSetting|Настройки профиля пользователя]]
:[[File: 07 Профиль основные параметры.png|thumb|none|x400px|alt=ProfileSetting|Настройки профиля пользователя]]


:2. '''Общие настройки интерфейса''' – в этом разделе можно включить или выключить следующие функции:
:2. '''Общие настройки интерфейса''' – в этом разделе можно включить или выключить следующие функции:
:* сохранение примененной сортировки значений [[#Таблица маркеров|в таблице маркеров]] при [[#Выход из системы|выходе из системы]];
:* сохранение примененной сортировки значений [[#Таблица маркеров|в таблице маркеров]] при [[#Выход из системы|выходе из системы]]
:* использование темной темы (темный фон, светлый текст) при просмотре файлов с исходным кодом;
:* использование темной темы (темный фон, светлый текст) при просмотре файлов с исходным кодом
:* открытие нескольких вкладок с исходным кодом [[#Работа в режиме просмотра кода|в режиме просмотра кода]].
:* открытие нескольких вкладок с исходным кодом [[#Работа в режиме просмотра кода|в режиме просмотра кода]]
:Эти настройки сохраняются для учетной записи пользователя и не сбрасываются при новой сессии.
:Эти настройки сохраняются для учетной записи пользователя и не сбрасываются при новой сессии.
:[[File:08 Профиль общие настройки интерфейса.png|thumb|none|x400px|alt=UserInterfaceSettings|Общие настройки интерфейса]]
:[[File:08 Профиль общие настройки интерфейса.png|thumb|none|x400px|alt=UserInterfaceSettings|Общие настройки интерфейса]]


:3. '''Настройки панели навигации''' – в этом разделе можно настроить отображение по умолчанию для детекторов и файлов [[#Функции левой навигационной панели|на панели навигации]], а также для сортировки значений [[#Вкладка «Файлы»|на вкладке '''Файлы''']].
:3. '''Настройки панели навигации''' – в этом разделе можно настроить отображение по умолчанию для детекторов и файлов [[#Функции левой навигационной панели|на панели навигации]], а также для сортировки значений [[#Вкладка «Файлы»|на вкладке '''Файлы''']]
:Эти настройки сохраняются для учетной записи пользователя и не сбрасываются при новой сессии.
:Эти настройки сохраняются для учетной записи пользователя и не сбрасываются при новой сессии.
:Временное отображение файлов [[#Функции левой навигационной панели|на панели навигации]] и их сортировку можно настроить по нажатии иконки [[File:Icon wrench.png|x15px]] на панели навигации.
:Временное отображение файлов [[#Функции левой навигационной панели|на панели навигации]] и их сортировку можно настроить по нажатии иконки [[File:Icon wrench.png|x15px]] на панели навигации.
Line 72: Line 72:
=== Изменение пароля ===
=== Изменение пароля ===
Для изменения пароля:
Для изменения пароля:
:1. Выберите пункт '''Профиль''' в меню пользователя.
:1. Выберите пункт '''Профиль''' в меню пользователя
:2. В разделе '''Профиль пользователя''' нажмите на ссылку '''Изменить пароль''':
:2. В разделе '''Профиль пользователя''' нажмите на ссылку '''Изменить пароль''':
:[[File:10_Профиль_изменение пароля.png|thumb|none|450px|Переход к изменению пароля в профиле пользователя]]
:[[File:10_Профиль_изменение пароля.png|thumb|none|450px|Переход к изменению пароля в профиле пользователя]]
:3. В открывшемся окне:
:3. В открывшемся окне:
::а) Введите текущий пароль.
::а) Введите текущий пароль
::б) Дважды введите новый пароль.
::б) Дважды введите новый пароль
::в) Нажмите кнопку '''Изменить'''.
::в) Нажмите кнопку '''Изменить'''
::[[File:11_Профиль_ввод нового пароля.png|thumb|none|350px|Окно изменения пароля]]
::[[File:11_Профиль_ввод нового пароля.png|thumb|none|350px|Окно изменения пароля]]


Line 100: Line 100:
Режим разметки предоставляет следующий набор элементов управления:
Режим разметки предоставляет следующий набор элементов управления:
# Левая навигационная панель:
# Левая навигационная панель:
#* [[#Вкладка «Детекторы»|вкладка '''Детекторы''']];
#* [[#Вкладка «Детекторы»|вкладка '''Детекторы''']]
#* [[#Вкладка «Файлы»|вкладка '''Файлы''']].
#* [[#Вкладка «Файлы»|вкладка '''Файлы''']]
# Центральная панель:
# Центральная панель:
#* [[#Вкладка «Информация о снимке»|вкладка '''Информация о снимке''']];
#* [[#Вкладка «Информация о снимке»|вкладка '''Информация о снимке''']]
#* [[#Вкладка «Исходный код»|вкладка '''Исходный код''']];
#* [[#Вкладка «Исходный код»|вкладка '''Исходный код''']]
#* [[#Таблица маркеров|таблица маркеров]].
#* [[#Таблица маркеров|таблица маркеров]]
# [[#Функции правой панели|Правая панель]].
# [[#Функции правой панели|Правая панель]]


=== Функции левой навигационной панели ===
=== Функции левой навигационной панели ===
Line 113: Line 113:


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


На вкладке '''Детекторы''' пользователю доступны следующие функции:
На вкладке '''Детекторы''' пользователю доступны следующие функции:
:1. Отображение данных в виде списка – для этого нажмите кнопку [[File:icon_list.png|x25px]].
:1. Отображение данных в виде списка – для этого нажмите кнопку [[File:icon_list.png|x25px]]
:2. Группировка детекторов по уровням серьезности (по умолчанию) – для этого нажмите кнопку [[File:icon_tree.png|x25px]].
:2. Группировка детекторов по уровням серьезности (по умолчанию) – для этого нажмите кнопку [[File:icon_tree.png|x25px]]
<gallery mode=packed heights="250px" style="float:left; clear:right; margin-right:1em; margin-left:1em">
<gallery mode=packed heights="250px" style="float:left; clear:right; margin-right:1em; margin-left:1em">
   16_Детекторы_список.png|Вкладка '''Детекторы''' с данными в виде списка
   16_Детекторы_список.png|Вкладка '''Детекторы''' с данными в виде списка
Line 125: Line 125:
</gallery>
</gallery>
<br clear=all />
<br clear=all />
:3. Отображение списка маркеров в файлах, в которых сработал детектор, – для этого нажмите кнопку [[File:icon_uncover.png|x15px]] в левой части его имени.
:3. Отображение списка маркеров в файлах, в которых сработал детектор – для этого нажмите кнопку [[File:icon_uncover.png|x15px]] в левой части его имени
:[[File:checker_uncover.png|thumb|none|320px|Список маркеров, найденных детектором]]
:[[File:checker_uncover.png|thumb|none|320px|Список маркеров, найденных детектором]]
:4. [[#Блокировка разметки|Блокировка всех маркеров]], найденных детектором, для разметки другими пользователями – для этого нажмите кнопку [[File:icon_unlocked.png|x25px]] справа от названия детектора (отображается при наведении курсора).
:4. [[#Блокировка разметки|Блокировка всех маркеров]], найденных детектором, для разметки другими пользователями – для этого нажмите кнопку [[File:icon_unlocked.png|x25px]] справа от названия детектора (отображается при наведении курсора)
:5. Применение фильтра по детектору [[#Таблица маркеров|в таблице маркеров]] – для этого нажмите на имя детектора.
:5. Применение фильтра по детектору [[#Таблица маркеров|в таблице маркеров]] – для этого нажмите на имя детектора
:6. Применение фильтра по серьезности [[#Таблица маркеров|в таблице маркеров]] – для этого нажмите название группы серьезности.
:6. Применение фильтра по серьезности [[#Таблица маркеров|в таблице маркеров]] – для этого нажмите название группы серьезности
:7. Отмена фильтрации – для этого нажмите кнопку [[File:icon_return.png|x25px]] .
:7. Отмена фильтрации – для этого нажмите кнопку [[File:icon_return.png|x25px]]
:8. Отображение [[#Вкладка «Исходный код»|на вкладке '''Исходный код''']] содержимого файла, места и содержания маркера, а также подробной информации о маркере [[#Функции правой панели|на правой панели]] – для этого нажмите на маркер.
:8. Отображение [[#Вкладка «Исходный код»|на вкладке '''Исходный код''']] содержимого файла, места и содержания маркера, а также подробной информации о маркере [[#Функции правой панели|на правой панели]] – для этого нажмите на маркер


==== Вкладка «Файлы» ====
==== Вкладка «Файлы» ====
На этой вкладке отображается список файлов, в которых найдены маркеры.
На этой вкладке отображается список файлов, в которых найдены маркеры.
[[File:17 Файлы.png|thumb|none|300px|Вкладка '''Файлы''']]


Для каждого файла отображаются:  
Для каждого файла отображаются:  
* имя;
* имя
* количество найденных маркеров (предупреждений);
* количество найденных маркеров (предупреждений)
* количество размеченных маркеров;
* количество размеченных маркеров
* кнопки [[File:Icon plus.png|x25px]] и [[File:Icon minus.png|x25px]].
* кнопки [[File:Icon plus.png|x25px]] и [[File:Icon minus.png|x25px]]
[[File:17 Файлы.png|thumb|none|300px|Вкладка '''Файлы''']]


На вкладке '''Файлы''' пользователю доступны следующие функции:
На вкладке '''Файлы''' пользователю доступны следующие функции:
:1. Применение фильтра по файлу [[#Таблица маркеров|в таблице маркеров]] – для этого:
:1. Применение фильтра по файлу [[#Таблица маркеров|в таблице маркеров]] – для этого:
::а) Нажмите на имя файла. <br />В этом случае содержимое файла отобразится [[#Вкладка «Исходный код»|на вкладке '''Исходный код''']]. <br /> или
::а) Нажмите на имя файла. В этом случае содержимое файла отобразится [[#Вкладка «Исходный код»|на вкладке '''Исходный код''']]<br />или
::б) Нажмите кнопку [[File:Icon plus.png|x25px]] в одной или нескольких строках. <br />В этом случае содержимое файла (файлов) не отобразится.
::б) Нажмите кнопку [[File:Icon plus.png|x25px]] в одной или нескольких строках. В этом случае содержимое файла (файлов) не отобразится
:2. Исключение файла из фильтра по файлам [[#Таблица маркеров|в таблице маркеров]] – для этого нажмите кнопку [[File:Icon minus.png|x25px]] в строке файла.
:2. Исключение файла из фильтра по файлам [[#Таблица маркеров|в таблице маркеров]] – для этого нажмите кнопку [[File:Icon minus.png|x25px]] в строке файла
:3. Отмена фильтрации [[#Таблица маркеров|в таблице маркеров]] для всех выбранных файлов – для этого нажмите кнопку [[File:Icon minus 2.png|x25px]] или кнопку [[File:icon_return.png|x25px]] [[#Вкладка «Детекторы»|на вкладке '''Детекторы''']].
:3. Отмена фильтрации [[#Таблица маркеров|в таблице маркеров]] для всех выбранных файлов – для этого нажмите кнопку [[File:Icon minus 2.png|x25px]] или кнопку [[File:icon_return.png|x25px]] [[#Вкладка «Детекторы»|на вкладке '''Детекторы''']]
:4. [[#Блокировка разметки|Блокировка всех маркеров]] в файле для разметки другими пользователями – для этого нажмите кнопку [[File:icon_unlocked.png|x25px]] справа от названия файла (отображается при наведении курсора).
:4. [[#Блокировка разметки|Блокировка всех маркеров]] в файле для разметки другими пользователями – для этого нажмите кнопку [[File:icon_unlocked.png|x25px]] справа от названия файла (отображается при наведении курсора)
:5. Отображение [[#Вкладка «Исходный код»|на вкладке '''Исходный код''']] содержимого файла, места и содержания маркера, а также подробной информации о маркере [[#Функции правой панели|на правой панели]] – для этого нажмите на имя файла.
:5. Отображение [[#Вкладка «Исходный код»|на вкладке '''Исходный код''']] содержимого файла, места и содержания маркера, а также подробной информации о маркере [[#Функции правой панели|на правой панели]] – для этого нажмите на имя файла
:6. Фильтрация по имени/пути файла в поле '''Отфильтровать файлы по полному пути'''. Поддерживается фильтрация с использованием [[#Использование регулярных выражений|регулярных выражений]].
:6. Фильтрация по имени/пути файла в поле '''Отфильтровать файлы по полному пути'''. Поддерживается фильтрация с использованием [[#Использование регулярных выражений|регулярных выражений]]
:7. Временная настройка отображения файлов и сортировки полей на вкладке '''Файлы''' – для этого нажмите кнопку [[File:icon_wrench.png|x25px]] и поменяйте настройки.
:7. Временная настройка отображения файлов и сортировки полей на вкладке '''Файлы''' – для этого нажмите кнопку [[File:icon_wrench.png|x25px]] и поменяйте настройки
:Эти настройки будут действовать до конца сессии пользователя или до повторного изменения.
:Эти настройки будут действовать до конца сессии пользователя или до повторного изменения.


Line 164: Line 165:
<br clear=all />
<br clear=all />
На вкладке '''Информация о снимке''' пользователю доступны следующие функции:
На вкладке '''Информация о снимке''' пользователю доступны следующие функции:
# Просмотр подробной информации о снимке во всплывающем окне – для этого нажмите кнопку [[File:Icon info.png|x25px]].
# Просмотр подробной информации о снимке во всплывающем окне – для этого нажмите кнопку [[File:Icon info.png|x25px]]
# Переход к [[#Экспорт кода с разметкой|экспорту кода с разметкой]] – для этого нажмите кнопку [[File:Icon book.png|x25px]].
# Переход к [[#Экспорт кода с разметкой|экспорту кода с разметкой]] – для этого нажмите кнопку [[File:Icon book.png|x25px]]
# Экспорт снимка в формате .snap. – для этого нажмите кнопку [[File:Icon export.png|x25px]].
# Экспорт снимка в формате .snap. – для этого нажмите кнопку [[File:Icon export.png|x25px]]
# Просмотр параметров анализа во всплывающем окне – для этого нажмите кнопку [[File:Button Показать.png|x25px]] в строке '''Параметры анализа'''.
# Просмотр параметров анализа во всплывающем окне – для этого нажмите кнопку [[File:Button Показать.png|x25px]] в строке '''Параметры анализа'''
# Экспорт параметров анализа в формате .txt – для этого нажмите кнопку [[File:Button Скачать.png|x25px]] в строке '''Параметры анализа'''.
# Экспорт параметров анализа в формате .txt – для этого нажмите кнопку [[File:Button Скачать.png|x25px]] в строке '''Параметры анализа'''
# [[#Работа с таблицей статистики|Просмотр таблицы статистики]] – для этого нажмите кнопку [[File:Button Показать 2.png|x25px]] в строке '''Статистика'''. <br />Информация в таблице сгруппирована по параметрам детекторов, найденным маркерам и статусу их разметки.
# [[#Работа с таблицей статистики|Просмотр таблицы статистики]] – для этого нажмите кнопку [[File:Button Показать 2.png|x25px]] в строке '''Статистика'''. Информация в таблице сгруппирована по параметрам детекторов, найденным маркерам и статусу их разметки
# Просмотр списка приложенных файлов для этого нажмите кнопку [[File:Button Показать.png|x25px]] в строке '''Приложенные файлы'''.<br />Для скрытия списка нажмите кнопку [[File:Hide.png|x25px]].
# Просмотр списка приложенных файлов для этого нажмите кнопку [[File:Button Показать.png|x25px]] в строке '''Приложенные файлы'''. Для скрытия списка нажмите кнопку [[File:Hide.png|x25px]]


==== Вкладка «Исходный код» ====
==== Вкладка «Исходный код» ====
Line 179: Line 180:


На вкладке '''Исходный код''' пользователю доступны следующие функции:
На вкладке '''Исходный код''' пользователю доступны следующие функции:
:1. Отображение кода на весь экран – для этого нажмите кнопку [[File:Icon expand.png|x25px]].
:1. Отображение кода на весь экран – для этого нажмите кнопку [[File:Icon expand.png|x25px]]
:2. Отображение всех маркеров – для этого нажмите кнопку [[File:Icon view marks.png|x25px]].
:2. Отображение всех маркеров – для этого нажмите кнопку [[File:Icon view marks.png|x25px]]
:3. Скрытие всех маркеров – для этого нажмите кнопку [[File:Icon hide marks.png|x25px]].
:3. Скрытие всех маркеров – для этого нажмите кнопку [[File:Icon hide marks.png|x25px]]
:4. Отображение списка маркеров в этом файле – для этого нажмите кнопку [[File:Icon list 2.png|x25px]]:
:4. Отображение списка маркеров в этом файле – для этого нажмите кнопку [[File:Icon list 2.png|x25px]]


:[[File:21 Исходный код Отображение списка маркеров.png|thumb|none|300px|right|Cписок маркеров в файле]]
:[[File:21 Исходный код Отображение списка маркеров.png|thumb|none|300px|right|Cписок маркеров в файле]]


:5. Выбор отображения информации о маркере и его разметки относительно строки кода, в которой он найден:
:5. Выбор отображения информации о маркере и его разметки относительно строки кода, в которой он найден:
:* выше строки кода – нажмите кнопку [[File:Icon above.png|x25px]];
:* выше строки кода – нажмите кнопку [[File:Icon above.png|x25px]]
:* ниже строки кода – нажмите кнопку [[File:Icon below.png|x25px]].
:* ниже строки кода – нажмите кнопку [[File:Icon below.png|x25px]]
<gallery mode=packed heights="200px" style="float:left; clear:right; margin-right:1em; margin-left:2em">
<gallery mode=packed heights="200px" style="float:left; clear:right; margin-right:1em; margin-left:2em">
   File:above_marker_info.png|Пример отображения информации о маркере над строкой кода
   File:above_marker_info.png|Пример отображения информации о маркере над строкой кода
Line 194: Line 195:
</gallery>
</gallery>
<br clear=all />
<br clear=all />
:6. Возврат к исходному маркеру (например, если был выбран другой связанный маркер на вкладке '''Трасса''' [[#Функции правой панели|правой панели]]) – для этого нажмите кнопку [[File:Icon target.png|x25px]] в верхней части блока с информацией о маркере.
:6. Возврат к исходному маркеру (например, если был выбран другой связанный маркер на вкладке '''Трасса''' [[#Функции правой панели|правой панели]]) – для этого нажмите кнопку [[File:Icon target.png|x25px]] в верхней части блока с информацией о маркере
:7. [[#Разметка маркера|Разметка маркера]] – нажмите кнопки [[File:Button Статусы.png|x25px]] в верхней части блока с информацией о маркере для установки '''Статуса''', '''Серьезности''' и '''Действия'''.
:7. [[#Разметка маркера|Разметка маркера]] – нажмите кнопки [[File:Button Статусы.png|x25px]] в верхней части блока с информацией о маркере для установки '''Статуса''', '''Серьезности''' и '''Действия'''
:8. Переход к строке, в которой определена переменная – нажмите правую кнопку мыши на строке исходного кода и выберите пункт '''Перейти к определению'''.
:8. Переход к строке, в которой определена переменная – нажмите правую кнопку мыши на строке исходного кода и выберите пункт '''Перейти к определению'''
:9. Просмотр ссылок на панели внизу экрана – нажмите правую кнопку мыши на строке исходного кода и выберите пункт '''Найти ссылки'''. <br />На этой панели отображается иерархический список файлов с номерами строк, в которых найдены ссылки.
:9. Просмотр ссылок на панели внизу экрана – нажмите правую кнопку мыши на строке исходного кода и выберите пункт '''Найти ссылки'''. На этой панели отображается иерархический список файлов с номерами строк, в которых найдены ссылки
:[[File:Исходный_код_Референсы.png|thumb|none|600px|Cписок файлов с номерами строк, в которых найдены ссылки]]
:[[File:Исходный_код_Референсы.png|thumb|none|600px|Cписок файлов с номерами строк, в которых найдены ссылки]]
:Чтобы перейти на вкладку '''Исходный код''' с фрагментом кода, на который найдена ссылка, нажмите на имя файла.
:* Чтобы перейти на вкладку '''Исходный код''' с фрагментом кода, на который найдена ссылка, нажмите на имя файла
:Чтобы посмотреть фрагмента кода, на который найдена ссылка, в режиме предпросмотра, нажмите кнопку  [[File:icon_preview_code.png|x25px]].
:* Чтобы посмотреть фрагмента кода, на который найдена ссылка, в режиме предпросмотра, нажмите кнопку  [[File:icon_preview_code.png|x25px]]
:10. Копирование строки кода – нажмите правую кнопку мыши на строке исходного кода и выберите пункт '''Copy'''.
:10. Копирование строки кода – нажмите правую кнопку мыши на строке исходного кода и выберите пункт '''Copy'''
:11. Вызов командной строки – нажмите правую кнопку мыши на строке исходного кода и выберите пункт '''Command Pallette'''.
:11. Вызов командной строки – нажмите правую кнопку мыши на строке исходного кода и выберите пункт '''Command Pallette'''
   
   
:[[File:25 Исходный код Вызов командной строки.png|thumb|none|600px|Командная строка]]
:[[File:25 Исходный код Вызов командной строки.png|thumb|none|600px|Командная строка]]
Line 210: Line 211:


В верхней части таблицы находится панель, которая содержит:
В верхней части таблицы находится панель, которая содержит:
* [[File:Field Детектор.png|x25px]] – поле с информацией [[#Использование фильтров|о примененных фильтрах]]: как назначенных [[#Функции левой навигационной панели|в навигационной панели]], так и с помощью [[#Настройка и использование пользовательских фильтров|пользовательских фильтров]] и запросов;
* [[File:Field Детектор.png|x25px]] – поле с информацией [[#Использование фильтров|о примененных фильтрах]]: как назначенных [[#Функции левой навигационной панели|в навигационной панели]], так и с помощью [[#Настройка и использование пользовательских фильтров|пользовательских фильтров]] и запросов
* поле запроса для фильтрации данных;
* поле запроса для фильтрации данных
* кнопка [[File:Icon download.png|x25px]] – выгрузка отображаемых маркеров в формате .csv и выгрузка отчета отображаемых маркеров в формате .pdf;
* кнопка [[File:Icon download.png|x25px]] – выгрузка отображаемых маркеров в формате .csv и выгрузка отчета отображаемых маркеров в формате .pdf
* кнопка [[File:Icon edit.png|x25px]] – переход [[#Групповая разметка маркеров|к групповой разметке]] выбранных маркеров (доступна, если выбраны маркеры в таблице).
* кнопка [[File:Icon edit.png|x25px]] – переход [[#Групповая разметка маркеров|к групповой разметке]] выбранных маркеров (доступна, если выбраны маркеры в таблице)


:[[File:26 Таблица маркеров.png|thumb|none|600px|Таблица маркеров с примененными фильтрами]]
:[[File:26 Таблица маркеров.png|thumb|none|600px|Таблица маркеров с примененными фильтрами]]


В таблице маркеров пользователю доступны следующие функции:
В таблице маркеров пользователю доступны следующие функции:
# Выбор маркеров для [[#Групповая разметка маркеров|групповой разметки]] – для этого установите флажок в строке маркера.
# Выбор маркеров для [[#Групповая разметка маркеров|групповой разметки]] – для этого установите флажок в строке маркера
# Просмотр подробной информации о маркере [[#Функции правой панели|в правой панели]] и его места и содержания [[#Вкладка «Исходный код»|на вкладке '''Исходный код''']] – для этого дважды кликните на строку маркера или нажмите на имя файла в столбце '''Файл'''. <br />Также для выбора можно использовать клавиши ↑ и ↓ – для перемещения по строкам, и Enter – для подтверждения выбора.
# Просмотр подробной информации о маркере [[#Функции правой панели|в правой панели]] и его места и содержания [[#Вкладка «Исходный код»|на вкладке '''Исходный код''']] – для этого дважды кликните на строку маркера или нажмите на имя файла в столбце '''Файл'''. Также для выбора можно использовать клавиши ↑ и ↓ – для перемещения по строкам, и Enter – для подтверждения выбора
# Копирование детальной информации о маркере в буфер обмена – для этого нажмите правой кнопкой мыши на маркер и выберите пункт '''Копировать'''.
# Копирование детальной информации о маркере в буфер обмена – для этого нажмите правой кнопкой мыши на маркер и выберите пункт '''Копировать'''
# Копирование ссылки на маркер в буфер обмена – для этого нажмите правой кнопкой мыши на маркер и выберите пункт '''Скопировать ссылку на предупреждение'''.
# Копирование ссылки на маркер в буфер обмена – для этого нажмите правой кнопкой мыши на маркер и выберите пункт '''Скопировать ссылку на предупреждение'''
# Переход к [[#Сравнение маркеров|сравнению одного маркера с другим]] – для этого нажмите правой кнопкой мыши на маркер и выберите пункт '''Сравнить с…'''
# Переход к [[#Сравнение маркеров|сравнению одного маркера с другим]] – для этого нажмите правой кнопкой мыши на маркер и выберите пункт '''Сравнить с ...'''


=== Функции правой панели ===
=== Функции правой панели ===
Эта панель предоставляет подробную информацию о маркере и его [[#Разметка маркера|разметке]]:
Эта панель предоставляет подробную информацию о маркере и его [[#Разметка маркера|разметке]]:
* статус [[#Блокировка разметки|блокировки]];
* статус [[#Блокировка разметки|блокировки]]
* статус [[#Разметка маркера|разметки, его серьезность и требуемое действие]];
* статус [[#Разметка маркера|разметки, его серьезность и требуемое действие]]
* автор последней разметки и пр.
* автор последней разметки и пр
[[File:27 Правая панель.png|thumb|none|800px|Правая панель]]
[[File:27 Правая панель.png|thumb|none|800px|Правая панель]]


На правой панели пользователю доступны следующие функции:
На правой панели пользователю доступны следующие функции:
:1. Просмотр истории разметки – для этого нажмите кнопку [[File:Icon history.png|x25px]] в верхней части правой панели.
:1. Просмотр истории разметки – для этого нажмите кнопку [[File:Icon history.png|x25px]] в верхней части правой панели
:[[File:28 История изменения маркера.png|thumb|none|600px|Пример истории изменения разметки маркера]]
:[[File:28 История изменения маркера.png|thumb|none|600px|Пример истории изменения разметки маркера]]


:2. [[#Блокировка разметки|Блокировка маркера]] для разметки другими пользователями – для этого нажмите кнопку [[File:icon_unlocked.png|x25px]] в верхней части правой панели.
:2. [[#Блокировка разметки|Блокировка маркера]] для разметки другими пользователями – для этого нажмите кнопку [[File:icon_unlocked.png|x25px]] в верхней части правой панели
:3. [[#Разметка маркера|Разметка маркера]] – для этого нажмите кнопки [[File:button_Статусы.png|x25px]] в верхней части правой панели.
:3. [[#Разметка маркера|Разметка маркера]] – для этого нажмите кнопки [[File:button_Статусы.png|x25px]] в верхней части правой панели
:4. Копирование ссылки на маркер – для этого нажмите кнопку [[File:Icon chain.png|x25px]] в верхней части правой панели.
:4. Копирование ссылки на маркер – для этого нажмите кнопку [[File:Icon chain.png|x25px]] в верхней части правой панели
:5. Отображение маркера [[#Вкладка «Исходный код»|на вкладке '''Исходный код''']] одним из трех способов:
:5. Отображение маркера [[#Вкладка «Исходный код»|на вкладке '''Исходный код''']] одним из трех способов:
::а) Нажмите кнопку с именем файла и номером строки в верхней части правой панели [1].
::а) Нажмите кнопку с именем файла и номером строки в верхней части правой панели [1]
::б) Нажмите на ссылку с именем файла и номером строки на вкладке '''Трасса''' [2].
::б) Нажмите на ссылку с именем файла и номером строки на вкладке '''Трасса''' [2]
::в) Нажмите кнопку '''Найти в коде''' на вкладке '''Подробности''' [3]. <br />Это позволяет всегда вернуться к нужной точке при навигации по коду.
::в) Нажмите кнопку '''Найти в коде''' на вкладке '''Подробности''' [3]. Это позволяет всегда вернуться к нужной точке при навигации по коду
<gallery widths="300px" heights="290px" style="float:left; clear:right; margin-right:1em; margin-left:3em">
<gallery widths="300px" heights="290px" style="float:left; clear:right; margin-right:1em; margin-left:3em">
29 Отображение маркера в коде 1.png
29 Отображение маркера в коде 1.png
30 Отображение маркера в коде 2.png
30 Отображение маркера в коде 2.png
</gallery><br clear=all />
</gallery><br clear=all />
:6. Отображение кода, который соответствует строке трассы, в отдельном окне в режиме предпросмотра – для этого на вкладке '''Трасса''' нажмите кнопку [[File:Icon goto.png|x25px]] рядом с именем файла и номером строки.
:6. Отображение кода, который соответствует строке трассы, в отдельном окне в режиме предпросмотра – для этого на вкладке '''Трасса''' нажмите кнопку [[File:Icon goto.png|x25px]] рядом с именем файла и номером строки
:[[File:31 Предпросмотр кода.png|thumb|500px|none|Предпросмотр кода]]
:[[File:31 Предпросмотр кода.png|thumb|500px|none|Предпросмотр кода]]
:7. Просмотр и добавление комментариев к маркеру на вкладке '''Комментарии'''. <br />Комментарии для каждого маркера уникальны. Добавление одинаковых комментариев недоступно.
:7. Просмотр и добавление комментариев к маркеру на вкладке '''Комментарии'''. Комментарии для каждого маркера уникальны. Добавление одинаковых комментариев недоступно
:8. Редактирование и удаление комментариев на вкладке '''Комментарии''' с помощью кнопок [[File:Icon edit2.png|x25px]] и [[File:Icon delete.png|x25px]].
:8. Редактирование и удаление комментариев на вкладке '''Комментарии''' с помощью кнопок [[File:Icon edit2.png|x25px]] и [[File:Icon delete.png|x25px]]
:[[File:32 Комментарии.png|thumb|none|250px|Вкладка '''Комментарии''']]
:[[File:32 Комментарии.png|thumb|none|250px|Вкладка '''Комментарии''']]
:'''Примечание:''' ''Пользователь может отредактировать и удалить только свои комментарии. Пользователю с [[#Управление ролями|ролью '''admin''']] доступно редактирование и удаление комментариев всех пользователей.''
:'''Примечание:''' ''Пользователь может отредактировать и удалить только свои комментарии. Пользователю с [[#Управление ролями|ролью '''admin''']] доступно редактирование и удаление комментариев всех пользователей.''
:9. Просмотр подробной информации на вкладке '''Подробности'''.
:9. Просмотр подробной информации на вкладке '''Подробности'''
:[[File:33 Подробная информация о маркере.png|thumb|none|x290px|Вкладка '''Подробности''']]
:[[File:33 Подробная информация о маркере.png|thumb|none|x290px|Вкладка '''Подробности''']]
:10. Просмотр информации о детекторе, который обнаружил маркер – для этого нажмите на его имя на вкладке '''Подробности'''.
:10. Просмотр информации о детекторе, который обнаружил маркер – для этого нажмите на его имя на вкладке '''Подробности'''
:[[File:34 Информация о детекторе.png|thumb|none|600px|Пример информации о детекторе]]
:[[File:34 Информация о детекторе.png|thumb|none|600px|Пример информации о детекторе]]
:11. Просмотр истории обнаружения маркера в снимках – для этого нажмите кнопку [[File:Icon history.png|x25px]] слева от названия снимка на вкладке '''Подробности'''.
:11. Просмотр истории обнаружения маркера в снимках – для этого нажмите кнопку [[File:Icon history.png|x25px]] слева от названия снимка на вкладке '''Подробности'''
:[[File:35 История маркера.png|thumb|none|600px|Пример истории маркера]]
:[[File:35 История маркера.png|thumb|none|600px|Пример истории маркера]]
:12. Запуск хуков (скриптов) – для этого нажмите кнопку '''Запустить''' на вкладке '''Подробности'''.
:12. Запуск хуков (скриптов) – для этого нажмите кнопку '''Запустить''' на вкладке '''Подробности'''
<br />
<br />


Line 267: Line 268:
Существует четыре вида фильтров:
Существует четыре вида фильтров:


# Фильтры [[#Функции левой навигационной панели|левой навигационной панели]] [1]: детекторы, файлы или серьезность.
# Фильтры [[#Функции левой навигационной панели|левой навигационной панели]] [1]: детекторы, файлы или серьезность
# Размеченный – позволяют отобразить только размеченные маркеры. Фильтр применяется по нажатии кнопки [[File:Icon view.png|x25px]] в правой части блока [[#Выбор проекта, ветки и снимка|выбора проекта, ветки и снимка]] [2].
# Размеченный – позволяют отобразить только размеченные маркеры. Фильтр применяется по нажатии кнопки [[File:Icon view.png|x25px]] в правой части блока [[#Выбор проекта, ветки и снимка|выбора проекта, ветки и снимка]] [2]
# [[#Настройка и использование пользовательских фильтров|Пользовательские фильтры]] – доступны по нажатии кнопки [[File:Button Фильтры.png|x25px]] в правой части блока [[#Выбор проекта, ветки и снимка|выбора проекта, ветки и снимка]] [3].
# [[#Настройка и использование пользовательских фильтров|Пользовательские фильтры]] – доступны по нажатии кнопки [[File:Button Фильтры.png|x25px]] в правой части блока [[#Выбор проекта, ветки и снимка|выбора проекта, ветки и снимка]] [3]
# Запрос – фильтр, указанный в поле в верхней части [[#Таблица маркеров|таблицы маркеров]] [4].
# Запрос – фильтр, указанный в поле в верхней части [[#Таблица маркеров|таблицы маркеров]] [4]
   
   
:[[File:36 Фильтры.png||thumb|none|left|600px|Существующие фильтры]]
:[[File:36 Фильтры.png||thumb|none|left|600px|Существующие фильтры]]
Line 277: Line 278:


Все виды фильтров можно использовать одновременно, но при определенном порядке применения фильтры могут быть сброшены:
Все виды фильтров можно использовать одновременно, но при определенном порядке применения фильтры могут быть сброшены:
* запрос сбрасывается после применения любого другого фильтра;
* запрос сбрасывается после применения любого другого фильтра
* фильтры [[#Функции левой навигационной панели|левой навигационной панели]] сбрасываются после применения [[#Настройка и использование пользовательских фильтров|пользовательских фильтров]] и других фильтров [[#Функции левой навигационной панели|на левой навигационной панели]];
* фильтры [[#Функции левой навигационной панели|левой навигационной панели]] сбрасываются после применения [[#Настройка и использование пользовательских фильтров|пользовательских фильтров]] и других фильтров [[#Функции левой навигационной панели|на левой навигационной панели]]
* [[#Настройка и использование пользовательских фильтров|пользовательские фильтры]] и фильтры [[#Функции левой навигационной панели|левой навигационной панели]] не сбрасываются при применении фильтра '''Размеченный'''.
* [[#Настройка и использование пользовательских фильтров|пользовательские фильтры]] и фильтры [[#Функции левой навигационной панели|левой навигационной панели]] не сбрасываются при применении фильтра '''Размеченный'''
* при переключении на другой [[#Выбор проекта, ветки и снимка|проект, ветку или снимок]] примененные фильтры '''Размеченный''' и  [[#Настройка и использование пользовательских фильтров|'''Пользовательский''']] не сбрасываются и применяются к выбранному снимку.
* при переключении на другой [[#Выбор проекта, ветки и снимка|проект, ветку или снимок]] примененные фильтры '''Размеченный''' и  [[#Настройка и использование пользовательских фильтров|'''Пользовательский''']] не сбрасываются и применяются к выбранному снимку


По нажатии кнопки [[File:Button Фильтры 2.png|x25px]] в правой части блока [[#Выбор проекта, ветки и снимка|выбора проекта, ветки и снимка]] можно отменить примененные фильтры: пользовательский или все.
По нажатии кнопки [[File:Button Фильтры 2.png|x25px]] в правой части блока [[#Выбор проекта, ветки и снимка|выбора проекта, ветки и снимка]] можно отменить примененные фильтры: пользовательский или все.
Line 286: Line 287:
==== Настройка и использование пользовательских фильтров ====
==== Настройка и использование пользовательских фильтров ====
Настроить пользовательские фильтры можно [[#Работа в режиме разметки|в режиме разметки]]. Для этого:
Настроить пользовательские фильтры можно [[#Работа в режиме разметки|в режиме разметки]]. Для этого:
:1. Нажмите кнопку [[file:button Фильтры.png|x25px]] в правой части блока [[#Выбор проекта, ветки и снимка|выбора проекта, ветки и снимка]].<br />В правой части экрана отобразится панель пользовательских фильтров, которые разделены на три группы:
:1. Нажмите кнопку [[file:button Фильтры.png|x25px]] в правой части блока [[#Выбор проекта, ветки и снимка|выбора проекта, ветки и снимка]]. В правой части экрана отобразится панель пользовательских фильтров, которые разделены на три группы:
:* параметры детекторов;
:* параметры детекторов
:* параметры разметки маркеров;
:* параметры разметки маркеров
:* файлы.
:* файлы
:2. На вкладке '''Пользовательский''':
:2. На вкладке '''Пользовательский''':
::а) Настройте параметры фильтрации – выберите значения в списках полей или нажмите кнопки со значениями.
::а) Настройте параметры фильтрации – выберите значения в списках полей или нажмите кнопки со значениями
::б) Нажмите на кнопку [[File:Icon cancel.png|x15px]] справа от значения в списке, чтобы отменить его выбор.
::б) Нажмите на кнопку [[File:Icon cancel.png|x15px]] справа от значения в списке, чтобы отменить его выбор
::в) Если параметры нужно исключить из поиска, нажмите на кнопку [[File:Icon plus 2.png|x25px]]. Кнопка поменяется на [[File:Icon minus 3.png|x25px]].
::в) Если параметры нужно исключить из поиска, нажмите на кнопку [[File:Icon plus 2.png|x25px]]. Кнопка поменяется на [[File:Icon minus 3.png|x25px]]
::г) Если параметры нужно включить в поиск, нажмите на кнопку [[File:Icon minus 3.png|x25px]]. Кнопка поменяется на [[File:Icon plus 2.png|x25px]].
::г) Если параметры нужно включить в поиск, нажмите на кнопку [[File:Icon minus 3.png|x25px]]. Кнопка поменяется на [[File:Icon plus 2.png|x25px]]
::д) Нажмите кнопку [[File:Button Очистить.png|x25px]], чтобы очистить все параметры фильтрации.
::д) Нажмите кнопку [[File:Button Очистить.png|x25px]], чтобы очистить все параметры фильтрации
::е) Нажмите кнопку [[File:Button Сохранить как.png|x25px]], в открывшемся диалоге введите название и нажмите кнопку '''Сохранить'''.
::е) Нажмите кнопку [[File:Button Сохранить как.png|x25px]], в открывшемся диалоге введите название и нажмите кнопку '''Сохранить'''
::ж) Нажмите кнопку [[File:Button Применить.png|x25px]], чтобы применить фильтр. <br />После применения кнопка фильтра станет зеленой, а ее название поменяется на '''Пользовательский'''.
::ж) Нажмите кнопку [[File:Button Применить.png|x25px]], чтобы применить фильтр. После применения кнопка фильтра станет зеленой, а ее название поменяется на '''Пользовательский'''
::[[File:36 Пользовательские фильтры.png|400px|thumb|none|Пользовательские фильтры. Вкладка '''Пользовательский''']]
::[[File:36 Пользовательские фильтры.png|400px|thumb|none|Пользовательские фильтры. Вкладка '''Пользовательский''']]
:3. На вкладке '''Сохраненные''':
:3. На вкладке '''Сохраненные''':
::а) Для редактирования сохраненного фильтра нажмите кнопку [[File:Icon edit3.png|x25px]].
::а) Для редактирования сохраненного фильтра нажмите кнопку [[File:Icon edit3.png|x25px]]
::б) Создайте дубликат фильтра – нажмите кнопку [[File:Icon duplicate.png|x25px]].
::б) Создайте дубликат фильтра – нажмите кнопку [[File:Icon duplicate.png|x25px]]
::в) Удалите фильтр – нажмите кнопку [[File:Icon delete 2.png|x25px]].
::в) Удалите фильтр – нажмите кнопку [[File:Icon delete 2.png|x25px]]
::г) Примените фильтр – нажмите на его название и нажмите кнопку [[File:Button Применить.png|x25px]].
::г) Примените фильтр – нажмите на его название и нажмите кнопку [[File:Button Применить.png|x25px]]
::[[File:37 Фильтры сохраненные.png|thumb|none|400px|Пользовательские фильтры. Вкладка '''Сохраненные''']]
::[[File:37 Фильтры сохраненные.png|thumb|none|400px|Пользовательские фильтры. Вкладка '''Сохраненные''']]
После применения:
После применения:
* примененный фильтр будет отмечен [[File:Icon check.png|x25px]].
* примененный фильтр будет отмечен [[File:Icon check.png|x25px]]
* кнопка фильтра станет зеленой, а ее название поменяется на '''Название сохраненного фильтра'''.
* кнопка фильтра станет зеленой, а ее название поменяется на '''Название сохраненного фильтра'''


=== Сравнение снимков и маркеров ===
=== Сравнение снимков и маркеров ===
Чтобы сравнить снимки и маркеры в них:
Чтобы сравнить снимки и маркеры в них:
:1. [[#Выбор проекта, ветки и снимка|Выберите исходные проект, ветку и снимок]].
:1. [[#Выбор проекта, ветки и снимка|Выберите исходные проект, ветку и снимок]]
:2. [[#Работа в режиме разметки|В режиме разметки]] нажмите кнопку [[File:Button Сравнить с.png|x25px]].
:2. [[#Работа в режиме разметки|В режиме разметки]] нажмите кнопку [[File:Button Сравнить с.png|x25px]]
:3. В открывшемся окне выберите проект, ветку и снимок для сравнения; нажмите кнопку [[File:Button Применить.png|x25px]].
:3. В открывшемся окне выберите проект, ветку и снимок для сравнения; нажмите кнопку [[File:Button Применить.png|x25px]]
:Результат сравнения отобразится [[#Функции левой навигационной панели|в левой навигационной панели]] и [[#Функции центральной панели|центральной панели]], причем:
:Результат сравнения отобразится [[#Функции левой навигационной панели|в левой навигационной панели]] и [[#Функции центральной панели|центральной панели]], причем:
:* вкладка '''Информация о снимке''' поменяется на вкладку '''Информация о различиях''' с информацией о двух сравниваемых снимках;
:* вкладка '''Информация о снимке''' поменяется на вкладку '''Информация о различиях''' с информацией о двух сравниваемых снимках
:* применится первый режим сравнения, в котором найдены результаты.
:* применится первый режим сравнения, в котором найдены результаты
:[[File:38 Выбор снимка для сравнения.png|300px|thumb|none|Выбор проекта, ветки и снимка для сравнения]]
:[[File:38 Выбор снимка для сравнения.png|300px|thumb|none|Выбор проекта, ветки и снимка для сравнения]]
:4. Выберите режим сравнения.
:4. Выберите режим сравнения
:[[File:39 Выбор режима сравнения.png|800px|thumb|none|Выбор режима сравнения]]
:[[File:39 Выбор режима сравнения.png|800px|thumb|none|Выбор режима сравнения]]
:[[#Функции левой навигационной панели|В левой навигационной панели]] и [[#Функции центральной панели|центральной панели]] отобразятся только результаты выбранного режима сравнения.  
:[[#Функции левой навигационной панели|В левой навигационной панели]] и [[#Функции центральной панели|центральной панели]] отобразятся только результаты выбранного режима сравнения.  
Line 329: Line 330:
</gallery>
</gallery>
<br clear=all />
<br clear=all />
:5. Посмотрите различия в параметрах анализа – нажмите кнопку '''Показать различия''' на вкладке '''Информация о различиях'''.
:5. Посмотрите различия в параметрах анализа – нажмите кнопку '''Показать различия''' на вкладке '''Информация о различиях'''
:[[File:44 Различия в результатах анализа.png|800px|thumb|none|Сравнение настроек анализа]]
:[[File:44 Различия в результатах анализа.png|800px|thumb|none|Сравнение настроек анализа]]
:6. Посмотрите различия в статистике разметки – нажмите кнопку '''Различия разметок'''.
:6. Посмотрите различия в статистике разметки – нажмите кнопку '''Различия разметок'''
:[[File:45 Различия в статистике по детекторам.png|thumb|none|800px|Сравнение статистики разметок]]
:[[File:45 Различия в статистике по детекторам.png|thumb|none|800px|Сравнение статистики разметок]]
:7. Нажмите кнопку [[File:Icon download CSV.png|x25px]] или [[File:Icon download PDF.png|x25px]], чтобы скачать статистику в формате CSV или PDF.
:7. Нажмите кнопку [[File:Icon download CSV.png|x25px]] или [[File:Icon download PDF.png|x25px]], чтобы скачать статистику в формате CSV или PDF
:8. Отмените сравнение – нажмите кнопку [[File:Icon cancel 2.png|x15px]] в блоке выбора проекта, ветки и снимка.
:8. Отмените сравнение – нажмите кнопку [[File:Icon cancel 2.png|x15px]] в блоке выбора проекта, ветки и снимка
<br />
<br />


=== Сравнение маркеров ===
=== Сравнение маркеров ===
Чтобы сравнить два маркера:
Чтобы сравнить два маркера:
:1. [[#Работа в режиме разметки|В режиме разметки]] [[#Выбор проекта, ветки и снимка|выберите исходные проект, ветку и снимок]].
:1. [[#Работа в режиме разметки|В режиме разметки]] [[#Выбор проекта, ветки и снимка|выберите исходные проект, ветку и снимок]]
:2. Раскройте [[#Таблица маркеров|таблицу маркеров]].
:2. Раскройте [[#Таблица маркеров|таблицу маркеров]]
:3. Нажмите правой кнопкой мыши на строке маркера и выберите пункт '''Сравнить с...''' <br /> Откроется окно выбора маркера для сравнения.
:3. Нажмите правой кнопкой мыши на строке маркера и выберите пункт '''Сравнить с ...''' <br /> Откроется окно выбора маркера для сравнения
:[[File:46 Выбор маркера для сравнения.png|500px|thumb|none|Окно выбора маркера для сравнения]]
:[[File:46 Выбор маркера для сравнения.png|500px|thumb|none|Окно выбора маркера для сравнения]]
:4. Выберите проект, ветку и снимок. Отобразится список маркеров в выбранном снимке, где можно ввести запрос для поиска маркеров.
:4. Выберите проект, ветку и снимок. Отобразится список маркеров в выбранном снимке, где можно ввести запрос для поиска маркеров
:[[File:47 Результат сравнения маркеров.png|500px|thumb|none|Выбор маркера для сравнения]]
:[[File:47 Результат сравнения маркеров.png|500px|thumb|none|Выбор маркера для сравнения]]
:5. Дважды кликните на  строке маркера, чтобы перейти в окно сравнения маркеров.
:5. Дважды кликните на  строке маркера, чтобы перейти в окно сравнения маркеров
:[[File:48 Различия исходного кода.png|500px|thumb|none|Окно сравнения маркеров]]
:[[File:48 Различия исходного кода.png|500px|thumb|none|Окно сравнения маркеров]]


Line 361: Line 362:
=== Групповая разметка маркеров ===
=== Групповая разметка маркеров ===
Для групповой разметки:
Для групповой разметки:
:1. [[#Работа в режиме разметки|В режиме разметки]] [[#Выбор проекта, ветки и снимка|выберите исходные проект, ветку и снимок]].
:1. [[#Работа в режиме разметки|В режиме разметки]] [[#Выбор проекта, ветки и снимка|выберите исходные проект, ветку и снимок]]
:2. Включите отображение [[#Таблица маркеров|таблицы маркеров]].
:2. Включите отображение [[#Таблица маркеров|таблицы маркеров]]
:3. Выберите маркеры для разметки – установите флажки в строках таблицы.
:3. Выберите маркеры для разметки – установите флажки в строках таблицы
:[[File:53 Выбор маркеров для группразметки.png|400px|thumb|none|Выбор маркеров для групповой разметки]]
:[[File:53 Выбор маркеров для группразметки.png|400px|thumb|none|Выбор маркеров для групповой разметки]]
:4. Нажмите кнопку [[File:icon edit.png|x25px]] (доступна, если выбраны маркеры в таблице). <br /> Отобразится окно для групповой разметки.
:4. Нажмите кнопку [[File:icon edit.png|x25px]] (доступна, если выбраны маркеры в таблице)<br />Отобразится окно для групповой разметки
:[[File:54 Окно групповой разметки.png|600px|thumb|none|Окно групповой разметки]]
:[[File:54 Окно групповой разметки.png|600px|thumb|none|Окно групповой разметки]]
:5. Разметьте выбранные маркеры – с помощью кнопок [[File:button Статусы.png|x25px]] в верхней части окна выберите статус разметки, а затем (опционально) статус серьезности (критичности) и требуемое действие. <br />Отображаемые в окне маркеры окрасятся в соответствующий цвет. Например, если пользователь поставил статус проверки '''Confirmed''', то все маркеры окрасятся в красный цвет:
:5. Разметьте выбранные маркеры – с помощью кнопок [[File:button Статусы.png|x25px]] в верхней части окна выберите статус разметки, а затем (опционально) статус серьезности (критичности) и требуемое действие<br />Отображаемые в окне маркеры окрасятся в соответствующий цвет. Например, если пользователь поставил статус проверки '''Confirmed''', то все маркеры окрасятся в красный цвет:
:[[File:55 Маркеры окрашены.png|600px|thumb|none|Окно групповой разметки после выбора статуса, серьезности и действия]]
:[[File:55 Маркеры окрашены.png|600px|thumb|none|Окно групповой разметки после выбора статуса, серьезности и действия]]
:6. Добавьте общий комментарий для выбранных маркеров. <br /> После того, как пользователь присвоил статусы и (или) написал комментарий, станут доступными кнопки '''Сбросить''' и '''Применить'''.
:6. Добавьте общий комментарий для выбранных маркеров<br />После того, как пользователь присвоил статусы и (или) написал комментарий, станут доступными кнопки '''Сбросить''' и '''Применить'''
:7. Если требуется отменить изменения, нажмите [[File:icon cross 01.png|x15px]] в правом верхнем углу окна или кнопку '''Отмена'''. <br />Диалоговое окно закроется, изменения не будут применены, выделение с выбранных для разметки маркеров не снимается.
:7. Если требуется отменить изменения, нажмите [[File:icon cross 01.png|x15px]] в правом верхнем углу окна или кнопку '''Отмена'''<br />Диалоговое окно закроется, изменения не будут применены, выделение с выбранных для разметки маркеров не снимается
:8. Если требуется сбросить все изменения, нажмите кнопку '''Сбросить'''. <br />Данные в окне вернутся в первоначальное состояние, а кнопки '''Сбросить''' и '''Применить''' станут неактивными.
:8. Если требуется сбросить все изменения, нажмите кнопку '''Сбросить'''<br />Данные в окне вернутся в первоначальное состояние, а кнопки '''Сбросить''' и '''Применить''' станут неактивными
:9. Нажмите кнопку '''Применить''', чтобы запустить процесс разметки.
:9. Нажмите кнопку '''Применить''', чтобы запустить процесс разметки
Прогресс разметки отображается в соответствующем окне. Запущенный процесс можно полностью отменить нажатием кнопки '''Отмена'''.
Прогресс разметки отображается в соответствующем окне. Запущенный процесс можно полностью отменить нажатием кнопки '''Отмена'''.


Line 387: Line 388:


Для блокировки разметки используйте кнопку [[File:icon unlocked.png|x25px]] в следующих частях пользовательского интерфейса:
Для блокировки разметки используйте кнопку [[File:icon unlocked.png|x25px]] в следующих частях пользовательского интерфейса:
:1. [[#Вкладка «Детекторы»|На вкладке '''Детекторы''']].<br />В этом случае блокировка распространяется на все маркеры выбранного детектора в открытом проекте и ветке, для всех снимков ветки.
:1. [[#Вкладка «Детекторы»|На вкладке '''Детекторы''']]. В этом случае блокировка распространяется на все маркеры выбранного детектора в открытом проекте и ветке, для всех снимков ветки
:2. [[#Вкладка «Файлы»|На вкладке '''Файлы''']].<br />В этом случае блокировка распространяется на все маркеры в выбранном файле в открытом проекте и ветке, для всех снимков ветки.
:2. [[#Вкладка «Файлы»|На вкладке '''Файлы''']]. В этом случае блокировка распространяется на все маркеры в выбранном файле в открытом проекте и ветке, для всех снимков ветки
:3. В верхней части [[#Функции правой панели|правой панели]].<br />В этом случае блокировка распространяется на все эквивалентные маркеры в открытом проекте и ветке, для всех снимков ветки.
:3. В верхней части [[#Функции правой панели|правой панели]]. В этом случае блокировка распространяется на все эквивалентные маркеры в открытом проекте и ветке, для всех снимков ветки


<gallery mode=packed heights="250px" style="float:left; clear:right; margin-right:1em; margin-left:1em">
<gallery mode=packed heights="250px" style="float:left; clear:right; margin-right:1em; margin-left:1em">
Line 398: Line 399:
<br clear=all />
<br clear=all />


Если один пользователь заблокировал маркер, то другой пользователь не сможет заблокировать детектор, которому принадлежит этот маркер, и файл, в котором этот маркер найден. <br />
Если один пользователь заблокировал маркер, то другой пользователь не сможет заблокировать детектор, которому принадлежит этот маркер, и файл, в котором этот маркер найден.<br />
В этом случае при наведении курсора на [[File:icon unlocked.png|x25px]] в строке файла отобразится сообщение: ''Невозможно заблокировать файл, так как один или несколько его маркеров заблокированы другим пользователем''.
В этом случае при наведении курсора на [[File:icon unlocked.png|x25px]] в строке файла отобразится сообщение: ''Невозможно заблокировать файл, так как один или несколько его маркеров заблокированы другим пользователем''.


Line 413: Line 414:


Для этого:
Для этого:
:1. [[#Работа в режиме разметки|В режиме разметки]] [[#Выбор проекта, ветки и снимка|выберите исходные проект, ветку и снимок]].
:1. [[#Работа в режиме разметки|В режиме разметки]] [[#Выбор проекта, ветки и снимка|выберите исходные проект, ветку и снимок]]
:2. На вкладке '''Информация о снимке''' в строке свойства '''ID''' нажмите кнопку [[File:Icon book.png|x25px]]:
:2. На вкладке '''Информация о снимке''' в строке свойства '''ID''' нажмите кнопку [[File:Icon book.png|x25px]]
:[[File:62 Переход к экспорту кода с разметкой.png|600px|thumb|none|Переход к экспорту кода с разметкой]]
:[[File:62 Переход к экспорту кода с разметкой.png|600px|thumb|none|Переход к экспорту кода с разметкой]]
:3. В открывшемся окне выберите шаблон для экспорта в списке справа (по умолчанию '''Нет''', т. е. разметка экспортироваться не будет) и опционально заполните поля для удаления префиксов и исключения путей:
:3. В открывшемся окне выберите шаблон для экспорта в списке справа (по умолчанию '''Нет''', т.е. разметка экспортироваться не будет) и опционально заполните поля для удаления префиксов и исключения путей:
:[[File:63 Окно экспорта кода с разметкой.png|600px|thumb|none|Окно экспорта кода с разметкой]]
:[[File:63 Окно экспорта кода с разметкой.png|600px|thumb|none|Окно экспорта кода с разметкой]]


Пример удаления префиксов путей: <code>/.build/</code> –  чтобы убрать папку '''.build''' при экспорте.
Пример удаления префиксов путей: <code>/.build/</code> –  чтобы убрать папку '''.build''' при экспорте.
Line 429: Line 429:
<pre>svacer markup --user <user> --password <password> --project <project id or name> --branch <branch id or name> --snapshot <snapshot id or name> export [--stripPrefixes <prefix1, prefix2, … , prefixN> --excludePaths <path1, path2, … ,pathN> --template <name>]</pre>
<pre>svacer markup --user <user> --password <password> --project <project id or name> --branch <branch id or name> --snapshot <snapshot id or name> export [--stripPrefixes <prefix1, prefix2, … , prefixN> --excludePaths <path1, path2, … ,pathN> --template <name>]</pre>
Где:
Где:
* <code>user</code>, <code>password</code> — имя пользователя и пароль учетной записи на сервере истории;
* <code>user</code>, <code>password</code> — имя пользователя и пароль учетной записи на сервере истории
* <code>project</code> — проект на сервере истории, из которого будет экспортирован код;
* <code>project</code> — проект на сервере истории, из которого будет экспортирован код
* <code>branch</code> — ветка в проекте, выбранном выше (по умолчанию '''master'''), из которой будет экспортирован код;
* <code>branch</code> — ветка в проекте, выбранном выше (по умолчанию '''master'''), из которой будет экспортирован код
* <code>snapshot</code> — снимок в выбранных проекте и ветке (по умолчанию последний загруженный), из которого будет экспортирован код;
* <code>snapshot</code> — снимок в выбранных проекте и ветке (по умолчанию последний загруженный), из которого будет экспортирован код
* <code>stripPrefixes</code>, <code>excludePaths</code> — аналогичны полям '''Удалить префиксы''' и '''Исключить пути''' в форме экспорта разметки в пользовательском интерфейсе, описанной выше;
* <code>stripPrefixes</code>, <code>excludePaths</code> — аналогичны полям '''Удалить префиксы''' и '''Исключить пути''' в форме экспорта разметки в пользовательском интерфейсе, описанной выше
* <code>template</code> — определяет имя шаблона для экспорта разметки. Если имя не указано, разметка не экспортируется.
* <code>template</code> — определяет имя шаблона для экспорта разметки. Если имя не указано, разметка не экспортируется
 
В результате либо будут созданы на сервере истории директория и файлы, соответствующие выбранному проекту и наполненные исходным кодом, либо, если директории и файлы уже существуют, они будут перезаписаны.
В результате либо будут созданы на сервере истории директория и файлы, соответствующие выбранному проекту и наполненные исходным кодом, либо, если директории и файлы уже существуют, они будут перезаписаны.


Line 441: Line 442:
=== Работа с таблицей статистики ===
=== Работа с таблицей статистики ===
Чтобы посмотреть краткую статистику о разметке маркеров:
Чтобы посмотреть краткую статистику о разметке маркеров:
:1. [[#Выбор проекта, ветки и снимка|Выберите исходные проект, ветку и снимок]].
:1. [[#Выбор проекта, ветки и снимка|Выберите исходные проект, ветку и снимок]]
:2. Перейдите [[#Работа в режиме разметки|в режим разметки]].
:2. Перейдите [[#Работа в режиме разметки|в режим разметки]]
:3. На вкладке '''Информация о снимке''' в строке свойства '''Статистика''' нажмите кнопку [[File:Button Показать 2.png|x25px]]:
:3. На вкладке '''Информация о снимке''' в строке свойства '''Статистика''' нажмите кнопку [[File:Button Показать 2.png|x25px]]
 
:[[File:64 Переход к просмотру статистики.png|600px|thumb|none|Переход к просмотру статистики]]
:[[File:64 Переход к просмотру статистики.png|600px|thumb|none|Переход к просмотру статистики]]
:Отобразится таблица статистики:
:Отобразится таблица статистики:
:[[File:65 Таблица статистики.png|600px|thumb|none|Таблица статистики]]
:[[File:65 Таблица статистики.png|600px|thumb|none|Таблица статистики]]
:4. Нажмите кнопку [[File:Icon download CSV.png|x20px]] или [[File:Icon download PDF.png|x20px]],чтобы выгрузить статистику в соответствующем формате.
:4. Нажмите кнопку [[File:Icon download CSV.png|x20px]] или [[File:Icon download PDF.png|x20px]],чтобы выгрузить статистику в соответствующем формате
:5. Нажмите кнопку [[File:Icon filter.png|x20px]] в строке статистики, чтобы применить [[#Настройка и использование пользовательских фильтров|пользовательский фильтр]] с параметрами, которые соответствуют выбранному значению.
:5. Нажмите кнопку [[File:Icon filter.png|x20px]] в строке статистики, чтобы применить [[#Настройка и использование пользовательских фильтров|пользовательский фильтр]] с параметрами, которые соответствуют выбранному значению


== Работа в режиме просмотра кода ==
== Работа в режиме просмотра кода ==
Line 454: Line 457:


Для этого:
Для этого:
:1. [[#Выбор проекта, ветки и снимка|Выберите исходные проект, ветку и снимок]].
:1. [[#Выбор проекта, ветки и снимка|Выберите исходные проект, ветку и снимок]]
:2. Перейдите в режим просмотра кода с помощью переключателя [[File:Button Код.png|x25px]] в верхней части экрана.
:2. Перейдите в режим просмотра кода с помощью переключателя [[File:Button Код.png|x25px]] в верхней части экрана
:В левой части экрана отобразится иерархический список файлов снимка, а в правой – поле для отображения исходного кода файла.
:В левой части экрана отобразится иерархический список файлов снимка, а в правой – поле для отображения исходного кода файла
:[[File:67 Режим просмотра кода.png|600px|thumb|none|Режим просмотра кода]]
:[[File:67 Режим просмотра кода.png|600px|thumb|none|Режим просмотра кода]]
:3. В левой части экрана раскройте группу файлов и нажмите на имя файла.<br />Также доступен поиск файлов, для этого кликните на поле поиска, в открывшемся окне введите поисковый запрос и выберите файл. В правой части отобразится исходный код файла.
:3. В левой части экрана раскройте группу файлов и нажмите на имя файла<br />Также доступен поиск файлов, для этого кликните на поле поиска, в открывшемся окне введите поисковый запрос и выберите файл. В правой части отобразится исходный код файла
:[[File:68 Режим просмотра кода открыт один файл.png|600px|thumb|none|Пример одного открытого файла]]
:[[File:68 Режим просмотра кода открыт один файл.png|600px|thumb|none|Пример одного открытого файла]]
:4. Если требуется, откройте другие файлы.
:4. Если требуется, откройте другие файлы
:Они отобразятся на отдельных вкладках.
:Они отобразятся на отдельных вкладках
:[[File:69 Режим просмотра кода открыто три файла.png|600px|thumb|none|Пример трёх открытых файлов]]
:[[File:69 Режим просмотра кода открыто три файла.png|600px|thumb|none|Пример трёх открытых файлов]]
:5. Вызовите функции, доступные по нажатию правой кнопки мыши на строке исходного кода.
:5. Вызовите функции, доступные по нажатию правой кнопки мыши на строке исходного кода
:* '''Перейти к определению''' – для перехода к строке, в которой определена переменная и функция;
:* '''Перейти к определению''' – для перехода к строке, в которой определена переменная и функция
:* '''Найти ссылки''' – для просмотра ссылок в панели с иерархическим списком файлов, именами файлов и номерами строк, в которых найдены ссылки;
:* '''Найти ссылки''' – для просмотра ссылок в панели с иерархическим списком файлов, именами файлов и номерами строк, в которых найдены ссылки
::[[File:24 Исходный код Cписок файлов со ссылками.png|thumb|none|600px|Cписок файлов с номерами строк, в которых найдены ссылки]]
::[[File:24 Исходный код Cписок файлов со ссылками.png|thumb|none|600px|Cписок файлов с номерами строк, в которых найдены ссылки]]
:* '''Copy''' – для копирования строки в буфер обмена;
:* '''Copy''' – для копирования строки в буфер обмена
:* '''Command Pallette''' – для вызова командной строки.
:* '''Command Pallette''' – для вызова командной строки
::[[File:25 Исходный код Вызов командной строки.png|thumb|none|600px|Командная строка]]
::[[File:25 Исходный код Вызов командной строки.png|thumb|none|600px|Командная строка]]


== Режим формирования отчетов ==
== Режим формирования отчетов ==
Режим позволяет сформировать отчеты на основе хранимой информации, посмотреть их в пользовательском интерфейсе и выгрузить в формате .json. Для этого:
Режим позволяет сформировать отчеты на основе хранимой информации, посмотреть их в пользовательском интерфейсе и выгрузить в формате .json. Для этого:
:1. [[#Выбор проекта, ветки и снимка|Выберите исходные проект и ветку]].
:1. [[#Выбор проекта, ветки и снимка|Выберите исходные проект и ветку]]
:2. Перейдите в режим формирования отчетов с помощью переключателя [[File:Button Отчеты.png|x25px]] в верхней части экрана.
:2. Перейдите в режим формирования отчетов с помощью переключателя [[File:Button Отчеты.png|x25px]] в верхней части экрана
:Отобразится форма формирования отчетов:
:Отобразится форма формирования отчетов:
:[[File:70 Форма формирования отчетов.png|800px|thumb|none|Форма формирования отчетов]]
:[[File:70 Форма формирования отчетов.png|800px|thumb|none|Форма формирования отчетов]]
:3. На панели слева выберите требуемый отчет: '''Общий отчет''' или '''Тренды'''.
:3. На панели слева выберите требуемый отчет: '''Общий отчет''' или '''Тренды'''
:4. Выберите текущий и целевой снимки:
:4. Выберите текущий и целевой снимки:
:[[File:71 Выбор снимков для формирования отчета.png|800px|thumb|none|Выбор снимков для формирования отчета]]
:[[File:71 Выбор снимков для формирования отчета.png|800px|thumb|none|Выбор снимков для формирования отчета]]
:5. Нажмите кнопку [[File:Button Play.png|x25px]] для запуска формирования отчета и его отображения в пользовательском интерфейсе.
:5. Нажмите кнопку [[File:Button Play.png|x25px]] для запуска формирования отчета и его отображения в пользовательском интерфейсе
:6. Нажмите кнопку [[File:Icon download.png|x25px]] для выгрузки отчета в формате .json.
:6. Нажмите кнопку [[File:Icon download.png|x25px]] для выгрузки отчета в формате .json
[[File:72 Пример общего отчета.png|800px|thumb|none|Пример общего отчета]]
[[File:72 Пример общего отчета.png|800px|thumb|none|Пример общего отчета]]
[[File:73 Пример отчета Тренды.png|800px|thumb|none|Пример отчета '''Тренды''']]
[[File:73 Пример отчета Тренды.png|800px|thumb|none|Пример отчета '''Тренды''']]
Line 489: Line 492:


В этом разделе пользователю, в зависимости от роли, доступны следующие функции:
В этом разделе пользователю, в зависимости от роли, доступны следующие функции:
* [[#Управление пользователями и ролями|управление пользователями и ролями]];
* [[#Управление пользователями и ролями|управление пользователями и ролями]]
* [[#Настройка глобальных фильтров|настройка глобальных фильтров]];
* [[#Настройка глобальных фильтров|настройка глобальных фильтров]]
* [[#Управление шаблонами разметки|управление шаблонами разметки]];
* [[#Управление шаблонами разметки|управление шаблонами разметки]]
* [[#Управление проектами|управление проектами]];
* [[#Управление проектами|управление проектами]]
* [[#Просмотр списка всех детекторов и его выгрузка в формате PDF|просмотр и выгрузка списка детекторов]];
* [[#Просмотр списка всех детекторов и его выгрузка в формате PDF|просмотр и выгрузка списка детекторов]]
* [[#Управление блокировками разметки|управление блокировками]];
* [[#Управление блокировками разметки|управление блокировками]]
* [[#Просмотр информации о сервере|просмотр информации о сервере]];
* [[#Просмотр информации о сервере|просмотр информации о сервере]]
* [[#Управление клиентами OAuth|управление клиентами OAuth]];
* [[#Управление клиентами OAuth|управление клиентами OAuth]]
* [[#Управление организациями|управление организациями]].
* [[#Управление организациями|управление организациями]]


=== Управление пользователями и ролями===
=== Управление пользователями и ролями===
Line 504: Line 507:
Чтобы посмотреть список и настройки учетных записей пользователей, перейдите на вкладку '''Пользователи''' на странице '''Настройки''':
Чтобы посмотреть список и настройки учетных записей пользователей, перейдите на вкладку '''Пользователи''' на странице '''Настройки''':
[[File:74 Вкладка Пользователи на странице Настройки.png|800px|thumb|none|Вкладка '''Пользователи''' на странице '''Настройки''']]
[[File:74 Вкладка Пользователи на странице Настройки.png|800px|thumb|none|Вкладка '''Пользователи''' на странице '''Настройки''']]
Для [[#Управление клиентами OAuth|учетных записей с доступом по LDAP]], над логином учетной записи отображается индикатор [[File:Icon LDAP.png|x25px]].
Для [[#Управление клиентами OAuth|учетных записей с доступом по LDAP]], над логином учетной записи отображается индикатор [[File:Icon LDAP.png|x25px]]


==== Управление пользователями ====
==== Управление пользователями ====
Для управления пользователями:
Для управления пользователями:
:1. Создайте учетную запись пользователя:
:1. Создайте учетную запись пользователя:
::а) Нажмите кнопку '''Добавить пользователя''':
::а) Нажмите кнопку '''Добавить пользователя'''
::[[File:75 Переход к добавлению учетной записи пользователя.png|800px|thumb|none|Переход к добавлению учетной записи пользователя]]
::[[File:75 Переход к добавлению учетной записи пользователя.png|800px|thumb|none|Переход к добавлению учетной записи пользователя]]
:Откроется окно добавления учетной записи пользователя.
:Откроется окно добавления учетной записи пользователя
::б) Заполните поля:
::б) Заполните поля:
::* Логин;
::* Логин
::* Пароль;
::* Пароль
::* e-mail;
::* e-mail
::* ФИО;
::* ФИО
::* [[#Управление организациями|Организации]].
::* [[#Управление организациями|Организации]]
::в) Включите опцию '''Изменить пароль при первом входе в систему''' (опционально).
::в) Включите опцию '''Изменить пароль при первом входе в систему''' (опционально)
::г) Нажмите кнопку '''Добавить'''.
::г) Нажмите кнопку '''Добавить'''
::[[File:76 Окно Добавить пользователя.png|400px|thumb|none|Окно '''Добавить пользователя''']]  
::[[File:76 Окно Добавить пользователя.png|400px|thumb|none|Окно '''Добавить пользователя''']]  
В таблице со списком пользователей добавится новая запись.
: В таблице со списком пользователей добавится новая запись.
:2. Чтобы назначить пользователю [[#Управление ролями|роли]], выберите значения в выпадающем списке поля в столбце '''Роли''':
:2. Чтобы назначить пользователю [[#Управление ролями|роли]], выберите значения в выпадающем списке поля в столбце '''Роли''':
:[[File:77 Назначение роли.png|400px|thumb|none|Назначение ролей пользователю]]
:[[File:77 Назначение роли.png|400px|thumb|none|Назначение ролей пользователю]]
:3. Нажмите на кнопку [[File:Icon cancel.png|x20px]] справа от значения, чтобы отменить его выбор.
:3. Нажмите на кнопку [[File:Icon cancel.png|x20px]] справа от значения, чтобы отменить его выбор
:4. Воспользуйтесь функциями в строке профиля в столбце '''Действия''':
:4. Воспользуйтесь функциями в строке профиля в столбце '''Действия''':
:* [[File:Icon edit4.png|x20px]] – для перехода к редактированию данных профиля;
:* [[File:Icon edit4.png|x20px]] – для перехода к редактированию данных профиля
:* [[File:Icon key.png|x20px]] – для перехода к изменению пароля;
:* [[File:Icon key.png|x20px]] – для перехода к изменению пароля
:* [[File:Icon eraser.png|x20px]] – для отчистки пользовательских настроек;
:* [[File:Icon eraser.png|x20px]] – для отчистки пользовательских настроек
:* [[File:Icon zip.png|x20px]] – для архивирования учетной записи пользователя;
:* [[File:Icon zip.png|x20px]] – для архивирования учетной записи пользователя
: При архивировании учетной записи пользователя блокируется доступ к системе, над логином учетной записи отображается индикатор [[File:Icon_Archived.png|x25px]].
: При архивировании учетной записи пользователя блокируется доступ к системе, над логином учетной записи отображается индикатор [[File:Icon_Archived.png|x25px]]
:* [[File:Icon unzip.png|x20px]] – для восстановления учетной записи пользователя из архива;
:* [[File:Icon unzip.png|x20px]] – для восстановления учетной записи пользователя из архива
:* [[File:Icon delete2.png|x20px]] – для удаления учетной записи пользователя.
:* [[File:Icon delete2.png|x20px]] – для удаления учетной записи пользователя
: Для [[#Управление клиентами OAuth|учетной записи с доступом по LDAP]] обновите данные – нажмите кнопку [[File:Icon edit4.png|x20px]] в столбце '''Действия''' и в окне изменения профиля пользователя нажмите кнопку '''Загрузить из LDAP'''.
: Для [[#Управление клиентами OAuth|учетной записи с доступом по LDAP]] обновите данные – нажмите кнопку [[File:Icon edit4.png|x20px]] в столбце '''Действия''' и в окне изменения профиля пользователя нажмите кнопку '''Загрузить из LDAP'''
:Загрузятся параметры профиля пользователя и его контакты из профиля в службе каталогов, если они там указаны. Пользователь может изменить эти параметры.
:Загрузятся параметры профиля пользователя и его контакты из профиля в службе каталогов, если они там указаны. Пользователь может изменить эти параметры
:[[File:78 Загрузка данных из LDAP.png|400px|thumb|none|Загрузка данных из LDAP]]
:[[File:78 Загрузка данных из LDAP.png|400px|thumb|none|Загрузка данных из LDAP]]


Line 557: Line 560:
|}
|}


:2. Включите опцию '''Показать столбец "ID роли"''', если требуется.
:2. Включите опцию '''Показать столбец "ID роли"''', если требуется
:3. Чтобы добавить роль:
:3. Чтобы добавить роль:
::а) Нажмите кнопку '''Добавить роль'''.
::а) Нажмите кнопку '''Добавить роль'''
::Откроется окно добавления роли.
::Откроется окно добавления роли


::б) Введите название роли.
::б) Введите название роли
::в) Добавьте разрешения для создаваемой роли, для этого:
::в) Добавьте разрешения для создаваемой роли, для этого:
:::*Нажмите кнопку '''Добавить еще'''.
:::*Нажмите кнопку '''Добавить еще'''
:::*Выберите проект или ветку и разрешение.
:::*Выберите проект или ветку и разрешение
::г) Нажмите кнопку '''Добавить'''.
::г) Нажмите кнопку '''Добавить'''
::[[File:81 Окно добавления роли.png|400px|thumb|none|Окно добавления роли]]
::[[File:81 Окно добавления роли.png|400px|thumb|none|Окно добавления роли]]
:В таблице со списком ролей добавится новая запись.
:В таблице со списком ролей добавится новая запись.
Line 574: Line 577:
! Действие !! Область !! Эффект
! Действие !! Область !! Эффект
|-
|-
| Чтение || Проект || Получение списка веток проекта. <br />Получение списка маркеров любой ветки проекта. <br />Экспорт данных из веток проекта
| Чтение || Проект || Получение списка веток проекта<br />Получение списка маркеров любой ветки проекта<br />Экспорт данных из веток проекта
|-
|-
| Чтение || Ветка || Получение списка маркеров из ветки проекта. <br />Экспорт данных из ветки проекта
| Чтение || Ветка || Получение списка маркеров из ветки проекта<br />Экспорт данных из ветки проекта
|-
|-
| Запись || Проект || Импорт данных в любую ветку проекта
| Запись || Проект || Импорт данных в любую ветку проекта
Line 588: Line 591:


:Также существует:
:Также существует:
::* специальная область '''ALL''', которая означает все проекты и ветки.
::* специальная область '''ALL''', которая означает все проекты и ветки
::* действие '''ALL''', которая означает все доступные действия чтение, запись и разметка.
::* действие '''ALL''', которая означает все доступные действия чтение, запись и разметка
:4. Чтобы изменить настройки роли, нажмите кнопку [[File:Icon edit4.png|x20px]] в строке роли в столбце '''Действия''' (недоступно для встроенных ролей) и внесите изменения.
:4. Чтобы изменить настройки роли, нажмите кнопку [[File:Icon edit4.png|x20px]] в строке роли в столбце '''Действия''' (недоступно для встроенных ролей) и внесите изменения
:5. Чтобы удалить роль, нажмите кнопку [[File:Icon delete2.png|x20px]] в строке роли в столбце '''Действия''' (недоступно для встроенных ролей).
:5. Чтобы удалить роль, нажмите кнопку [[File:Icon delete2.png|x20px]] в строке роли в столбце '''Действия''' (недоступно для встроенных ролей)


=== Настройка глобальных фильтров ===
=== Настройка глобальных фильтров ===
Line 600: Line 603:


Для настройки фильтров:
Для настройки фильтров:
:1. Чтобы добавить фильтр, нажмите кнопку '''Добавить фильтр'''.
:1. Чтобы добавить фильтр, нажмите кнопку '''Добавить фильтр'''
:Отобразится новая строка:
:Отобразится новая строка:
:[[File:83 Новая строка с фильтром.png|800px|thumb|none|Новая строка с фильтром]]
:[[File:83 Новая строка с фильтром.png|800px|thumb|none|Новая строка с фильтром]]


:2. Чтобы изменить настройки фильтров:
:2. Чтобы изменить настройки фильтров:
::а) Введите или поменяйте название фильтра.
::а) Введите или поменяйте название фильтра
::б) Деактивируйте или активируйте фильтр – нажмите на значение в столбце '''Активные''' один или два раза, чтобы отобразилась иконка [[File:Icon check2.png|x15px]] или [[File:Icon cross 01.png|x15px]].
::б) Деактивируйте или активируйте фильтр – нажмите на значение в столбце '''Активные''' один или два раза, чтобы отобразилась иконка [[File:Icon check2.png|x15px]] или [[File:Icon cross 01.png|x15px]]
::в) Выберите область применения фильтра – нажмите на значение в столбце '''Область''' один или два раза, чтобы отобразилось значение '''ветка''' или '''проект'''.
::в) Выберите область применения фильтра – нажмите на значение в столбце '''Область''' один или два раза, чтобы отобразилось значение '''ветка''' или '''проект'''
::г) Укажите [[#Использование регулярных выражений|регулярное выражение]] или загрузите файл шаблона в столбцах '''Включить пути по шаблону''', '''Исключить пути по шаблону''' и '''Шаблоны детекторов'''.
::г) Укажите [[#Использование регулярных выражений|регулярное выражение]] или загрузите файл шаблона в столбцах '''Включить пути по шаблону''', '''Исключить пути по шаблону''' и '''Шаблоны детекторов'''
::д) Выберите уровни серьезности (критичности) и надежности:
::д) Выберите уровни серьезности (критичности) и надежности:
::* [[File:Icon check2.png|x15px]] – уровень выбран;
::* [[File:Icon check2.png|x15px]] – уровень выбран
::* [[File:Icon cancel 2.png|x15px]] – уровень не выбран.
::* [[File:Icon cancel 2.png|x15px]] – уровень не выбран
:Для изменения выбора нажмите на название уровня.
:Для изменения выбора нажмите на название уровня
:3. Нажмите кнопку [[File:Icon delete.png|x25px]] в столбце '''Действия''', чтобы удалить фильтр.
:3. Нажмите кнопку [[File:Icon delete.png|x25px]] в столбце '''Действия''', чтобы удалить фильтр
:4. Для завершения работы с фильтрами без сохранения нажмите кнопку '''Сброс'''.
:4. Для завершения работы с фильтрами без сохранения нажмите кнопку '''Сброс'''
:5. Для завершения работы с фильтрами и применения изменений нажмите кнопку '''Применить изменения'''.
:5. Для завершения работы с фильтрами и применения изменений нажмите кнопку '''Применить изменения'''.
:6. После применения изменений нажмите кнопку '''Принудительно применить изменения''', чтобы ускорить применение фильтров на стороне сервера.
:6. После применения изменений нажмите кнопку '''Принудительно применить изменения''', чтобы ускорить применение фильтров на стороне сервера.
Line 634: Line 637:
:2. Введите название шаблона.
:2. Введите название шаблона.
:3. Нажмите кнопку '''Добавить'''
:3. Нажмите кнопку '''Добавить'''
:Шаблон появится в списке шаблонов для разметки в правой панели формы.
:Шаблон появится в списке шаблонов для разметки в правой панели формы
:4. Отредактируйте поля шаблона разметки:
:4. Отредактируйте поля шаблона разметки:
:[[File:85 Поля шаблона, доступные для редактирования.png|500px|thumb|none|Редактирование шаблона разметки]]
:[[File:85 Поля шаблона, доступные для редактирования.png|500px|thumb|none|Редактирование шаблона разметки]]
:5. Нажмите '''Сохранить'''
:5. Нажмите '''Сохранить'''
:6. Чтобы клонировать существующий шаблон разметки, нажмите кнопку [[File:Icon_clone.png|x20px]] в столбце '''Действия'''.
:6. Чтобы клонировать существующий шаблон разметки, нажмите кнопку [[File:Icon_clone.png|x20px]] в столбце '''Действия'''
:7. Чтобы удалить шаблон разметки, нажмите кнопку [[File:Icon delete2.png|x20px]] в столбце '''Действия'''.
:7. Чтобы удалить шаблон разметки, нажмите кнопку [[File:Icon delete2.png|x20px]] в столбце '''Действия'''


=== Управление проектами ===
=== Управление проектами ===
Line 648: Line 651:


Для управления проектами пользователей:
Для управления проектами пользователей:
:1. Добавьте проект – нажмите кнопку '''Создать новый проект''' и введите его имя.
:1. Добавьте проект – нажмите кнопку '''Создать новый проект''' и введите его имя
:При импорте проект добавляется автоматически.
:При импорте проект добавляется автоматически
:2. Добавьте ветку – нажмите кнопку [[File:Icon 3 Dots.png|x25px]] в строке проекта, в открывшемся меню выберите пункт '''Добавить новую ветку''' и введите её имя.
:2. Добавьте ветку – нажмите кнопку [[File:Icon 3 Dots.png|x25px]] в строке проекта, в открывшемся меню выберите пункт '''Добавить новую ветку''' и введите её имя
:При импорте ветка добавляется автоматически.
:При импорте ветка добавляется автоматически
:3. Измените название проекта/ветки – нажмите кнопку [[File:Icon 3 Dots.png|x25px]] в строке проекта/ветки, в открывшемся меню выберите пункт '''Изменить имя проекта'''/'''Изменить имя ветки''' и измените имя.
:3. Измените название проекта/ветки – нажмите кнопку [[File:Icon 3 Dots.png|x25px]] в строке проекта/ветки, в открывшемся меню выберите пункт '''Изменить имя проекта''' / '''Изменить имя ветки''' и измените имя
:4. Удалите проект/ветку/снимок – нажмите кнопку [[File:Icon delete2.png|x25px]] в списке проектов/веток/снимков.
:4. Удалите проект/ветку/снимок – нажмите кнопку [[File:Icon delete2.png|x25px]] в списке проектов/веток/снимков
:5. Клонируйте ветку проекта – нажмите кнопку [[File:Icon 3 Dots.png|x25px]] в строке ветки и в открывшемся меню выберите пункт '''Клонировать'''.
:5. Клонируйте ветку проекта – нажмите кнопку [[File:Icon 3 Dots.png|x25px]] в строке ветки и в открывшемся меню выберите пункт '''Клонировать'''
:6. Экспортируйте снимок с сервера в файл для дальнейшего его импорта на другой сервер или в другой проект/ветку на этом же сервере – нажмите кнопку [[File:Icon export.png|x25px]] в строке снимка.
:6. Экспортируйте снимок с сервера в файл для дальнейшего его импорта на другой сервер или в другой проект/ветку на этом же сервере – нажмите кнопку [[File:Icon export.png|x25px]] в строке снимка
:7. Импортируйте снимок из файла – нажмите кнопку [[File:Icon 3 Dots.png|x25px]] в строке ветки, в открывшемся меню выберите пункт '''Импортировать снимок''', выберите файл в формате .snap.
:7. Импортируйте снимок из файла – нажмите кнопку [[File:Icon 3 Dots.png|x25px]] в строке ветки, в открывшемся меню выберите пункт '''Импортировать снимок''', выберите файл в формате .snap
:8. Скопируйте разметку в другой контейнер (проект и ветку):
:8. Скопируйте разметку в другой контейнер (проект и ветку):
::а) Нажмите кнопку [[File:Icon 3 Dots.png|x25px]] в строке ветки и в открывшемся меню выберите пункт '''Копировать разметку'''.
::а) Нажмите кнопку [[File:Icon 3 Dots.png|x25px]] в строке ветки и в открывшемся меню выберите пункт '''Копировать разметку'''
::б) В открывшемся окне выберите проект и ветку, в которые нужно скопировать разметку, а также действия, которые нужно выполнить при наличии разметки.
::б) В открывшемся окне выберите проект и ветку, в которые нужно скопировать разметку, а также действия, которые нужно выполнить при наличии разметки
::в) Нажмите кнопку '''Копировать'''.
::в) Нажмите кнопку '''Копировать'''
::[[File:Копирование разметки.png|400px|thumb|none|Окно копирования разметки в другой контейнер]]
::[[File:Копирование разметки.png|400px|thumb|none|Окно копирования разметки в другой контейнер]]
Разметка в контейнере состоит из множества размеченных маркеров. В целевой ветке уже может находиться разметка. Все множество маркеров в исходной ветке можно разбить на два:
Разметка в контейнере состоит из множества размеченных маркеров. В целевой ветке уже может находиться разметка. Все множество маркеров в исходной ветке можно разбить на два:
* «Уникальные» – маркеры, которые есть только в исходной ветке;
* «Уникальные» – маркеры, которые есть только в исходной ветке
* «Общие» – маркеры, которые есть как в ветке источнике, так и в ветке-приемнике.
* «Общие» – маркеры, которые есть как в ветке-источнике, так и в ветке-приемнике


При выполнении операции копирования разметка в уникальных маркерах всегда копируется в ветку-приемник. Для «Общих» маркеров возможны несколько вариантов продолжения копирования, но по умолчанию выбран пункт '''Не копировать''' – в этом случае разметка в «Общих» маркерах в ветке-приемнике не изменяется.
При выполнении операции копирования разметка в уникальных маркерах всегда копируется в ветку-приемник. Для «Общих» маркеров возможны несколько вариантов продолжения копирования, но по умолчанию выбран пункт '''Не копировать''' – в этом случае разметка в «Общих» маркерах в ветке-приемнике не изменяется.
Line 670: Line 673:
Если выбрано действие '''Перезаписать''', разметка на «Общих» маркерах в целевом контейнере будет заменена разметкой из ветки-источника.
Если выбрано действие '''Перезаписать''', разметка на «Общих» маркерах в целевом контейнере будет заменена разметкой из ветки-источника.


При выборе действия '''Заменить, если новее''' разметка из ветки-источника копируется в том случае, если ее метка времени более поздняя, чем та, которая указана в ветке-приемнике на данном маркере.<br />
При выборе действия '''Заменить, если новее''' разметка из ветки-источника копируется в том случае, если ее метка времени более поздняя, чем та, которая указана в ветке-приемнике на данном маркере.
 
Пример:
Пример:
:Есть несколько контейнеров:
:Есть несколько контейнеров:
:* A с разметкой {(M1,D1),(M2,D2), (M3,D3)}
:* A с разметкой {(M1, D1), (M2, D2), (M3, D3)}
:* B с разметкой {(M4,D4), (M2,D5), (M3,D6)},
:* B с разметкой {(M4, D4), (M2, D5), (M3, D6)}
:где M — это маркер, а D — разметка (включая метку времени).
:где M — это маркер, а D — разметка (включая метку времени).
:Операцию сравнения на разметке обозначим как >. Если метка времени в D1 больше, чем в D2, то D1>D2.
:Операцию сравнения на разметке обозначим как >. Если метка времени в D1 больше, чем в D2, то D1 > D2
:Пусть D2>D5, а D3<D6. Тогда операция копирования всегда скопирует разметку D1 (но не сам маркер), так как маркер M1 новый для контейнера B.
:Пусть D2 > D5, а D3 < D6. Тогда операция копирования всегда скопирует разметку D1 (но не сам маркер), так как маркер M1 новый для контейнера B
:Маркеры M2, M3 — общие для двух контейнеров, поэтому то, какая разметка будет в контейнере-приемнике, будет зависеть от выбранного варианта разрешения конфликта:
:Маркеры M2, M3 — общие для двух контейнеров, поэтому то, какая разметка будет в контейнере-приемнике, будет зависеть от выбранного варианта разрешения конфликта:
:* если выбран пункт '''Не копировать''', то в контейнере B на маркерах M2,M3 будет разметка D5,D6 соответственно;
:* если выбран пункт '''Не копировать''', то в контейнере B на маркерах M2, M3 будет разметка D5, D6 соответственно
:* если выбран пункт '''Перезаписать''', то на M2,M3 будет разметка D2,D3;
:* если выбран пункт '''Перезаписать''', то на M2, M3 будет разметка D2, D3
:* если выбран пункт '''Заменить, если новее''', то на M2, M3 разметка будет: D2,D6, так как D2>D5 и D6>D3.
:* если выбран пункт '''Заменить, если новее''', то на M2, M3 разметка будет: D2, D6, так как D2 > D5 и D6 > D3
:При выполнении копирования наличие маркера в ветке-приемнике не проверяется.
:При выполнении копирования наличие маркера в ветке-приемнике не проверяется
При успешном копировании выводится всплывающее сообщение вида: ''Выполнено успешно. Всего: Х, Заменено: Y'' <br />
При успешном копировании выводится всплывающее сообщение вида: ''Выполнено успешно. Всего: Х, Заменено: Y'' <br />
Это сообщение означает, что всего было скопировано X инвариантов вместе с разметкой и среди скопированных инвариантов Y штук было скопировано с заменой.
Это сообщение означает, что всего было скопировано X инвариантов вместе с разметкой и среди скопированных инвариантов Y штук было скопировано с заменой.
Line 707: Line 711:


На вкладке '''Информация о сервере''' на странице '''Настройки''' отображаются:
На вкладке '''Информация о сервере''' на странице '''Настройки''' отображаются:
* параметры, с которыми запущен сервер;
* параметры, с которыми запущен сервер
* логи сервера;
* логи сервера
* журнал базы данных.
* журнал базы данных
[[File:90 Вкладка Информация о сервере на странице Настройки.png|800px|thumb|none|Вкладка '''Информация о сервере''' на странице '''Настройки''']]
[[File:90 Вкладка Информация о сервере на странице Настройки.png|800px|thumb|none|Вкладка '''Информация о сервере''' на странице '''Настройки''']]
Доступны функции:
Доступны функции:
* копирование записей в системном логе и журнале;
* копирование записей в системном логе и журнале
* выгрузка системного лога и журнала в файлы в формате .log.
* выгрузка системного лога и журнала в файлы в формате .log


=== Управление клиентами OAuth ===
=== Управление клиентами OAuth ===
Line 719: Line 723:


API-вызовы для управления клиентами:
API-вызовы для управления клиентами:
* <code>GET /api/oauth/clients</code> — получение всех клиентов для текущего пользователя или всех клиентов текущего сервера для админа;
* <code>GET /api/oauth/clients</code> — получение всех клиентов для текущего пользователя или всех клиентов текущего сервера для админа
* <code>GET /api/oauth/client?client_id={client_id}</code> — получение клиента по id;
* <code>GET /api/oauth/client?client_id={client_id}</code> — получение клиента по id
* <code>POST /api/oauth/client</code> — создание нового клиента;
* <code>POST /api/oauth/client</code> — создание нового клиента
* <code>PUT /api/oauth/client</code> — изменение данных клиента;
* <code>PUT /api/oauth/client</code> — изменение данных клиента
* <code>DELETE /api/oauth/client/{client_id}</code> — удаление клиента.
* <code>DELETE /api/oauth/client/{client_id}</code> — удаление клиента


Управление клиентами доступно на вкладке '''Клиенты OAuth''' на странице '''Настройки''':
Управление клиентами доступно на вкладке '''Клиенты OAuth''' на странице '''Настройки''':
[[File:91 Вкладка Клиенты OAuth на странице Настройки.png|800px|thumb|none|Вкладка '''Клиенты OAuth''' на странице '''Настройки''']]
[[File:91 Вкладка Клиенты OAuth на странице Настройки.png|800px|thumb|none|Вкладка '''Клиенты OAuth''' на странице '''Настройки''']]
* Для создания клиента OAuth нажмите кнопку '''Добавить клиента''', введите его имя и домен.
* Для создания клиента OAuth нажмите кнопку '''Добавить клиента''', введите его имя и домен
:После создания OAuth клиента скопируйте '''Секрет клиента''' из поля в колонке '''Секрет''' и сохраните его в надежном месте. После обновления страницы скопировать секрет будет невозможно.
* После создания OAuth клиента скопируйте '''Секрет клиента''' из поля в колонке '''Секрет''' и сохраните его в надежном месте. После обновления страницы скопировать секрет будет невозможно.
* Для перехода к изменению имени и домена клиента OAuth нажмите кнопку [[File:Icon edit4.png|x20px]] в столбце '''Действия'''.
* Для перехода к изменению имени и домена клиента OAuth нажмите кнопку [[File:Icon edit4.png|x20px]] в столбце '''Действия'''
* Для удаления клиента OAuth нажмите кнопку [[File:Icon cancel 2.png|x20px]] в столбце '''Действия'''.
* Для удаления клиента OAuth нажмите кнопку [[File:Icon cancel 2.png|x20px]] в столбце '''Действия'''


'''Примечание''': ''Пользователь с [[#Управление ролями|ролью '''admin''']] может просматривать и управлять OAuth клиентами всех пользователей, пользователям с другими ролями доступен просмотр и управление только своими OAuth клиентами.''
'''Примечание''': ''Пользователь с [[#Управление ролями|ролью '''admin''']] может просматривать и управлять OAuth клиентами всех пользователей, пользователям с другими ролями доступен просмотр и управление только своими OAuth клиентами.''
Line 745: Line 749:


Чтобы добавить новую организацию в реестр:
Чтобы добавить новую организацию в реестр:
# Нажмите кнопку '''Добавить организацию'''.
# Нажмите кнопку '''Добавить организацию'''
# Заполните поля появившейся формы.
# Заполните поля появившейся формы
# Нажмите кнопку '''Добавить'''.
# Нажмите кнопку '''Добавить'''
:[[File:93 Окно добавления организации в реестр.png|500px|thumb|none|Окно добавления организации в реестр]]
:[[File:93 Окно добавления организации в реестр.png|500px|thumb|none|Окно добавления организации в реестр]]
Чтобы изменить данные существующей организации:
Чтобы изменить данные существующей организации:
# Нажмите кнопку [[File:Icon edit4.png|x20px]] в столбце '''Действия'''.
# Нажмите кнопку [[File:Icon edit4.png|x20px]] в столбце '''Действия'''
# В появившейся форме отредактируйте данные организации.
# В появившейся форме отредактируйте данные организации
# Нажмите кнопку '''Сохранить'''.
# Нажмите кнопку '''Сохранить'''


Чтобы удалить организацию из реестра:
Чтобы удалить организацию из реестра:
# Нажмите кнопку [[File:Icon delete2.png|x20px]] в столбце '''Действия'''.
# Нажмите кнопку [[File:Icon delete2.png|x20px]] в столбце '''Действия'''
# В появившемся диалоге подтвердите удаление, нажав на кнопку '''Удалить'''.
# В появившемся диалоге подтвердите удаление, нажав на кнопку '''Удалить'''
:[[File:94 Окно удаления организации из реестра.png|350px|thumb|none|Окно удаления организации из реестра]]
:[[File:94 Окно удаления организации из реестра.png|350px|thumb|none|Окно удаления организации из реестра]]


Line 769: Line 773:
:1. Поиск происходит только по регулярному выражению. Если требуется найти специальный символ в качестве обычного символа, его нужно экранировать (например, точку: «\.»)
:1. Поиск происходит только по регулярному выражению. Если требуется найти специальный символ в качестве обычного символа, его нужно экранировать (например, точку: «\.»)
:2. При поиске находятся вхождения подстроки в полном пути к файлу (аналогично grep). Если требуется найти по полной строке, используйте символы начала и конца строки: ^ и $
:2. При поиске находятся вхождения подстроки в полном пути к файлу (аналогично grep). Если требуется найти по полной строке, используйте символы начала и конца строки: ^ и $
:3. Поиск не зависит от регистра символов (case insensitive).
:3. Поиск не зависит от регистра символов (case insensitive)
:В окне настройки [[#Настройка и использование пользовательских фильтров|пользовательских фильтров]]  в блоке '''Файлы''' можно применить фильтр как для отображения только маркеров из файлов, которые подходят под паттерн, так и для скрытия таких маркеров. Для переключения между этими режимами используйте кнопки [[File:Icon plus 2.png|x20px]] и [[File:Icon minus 3.png|x20px]], которые расположены рядом с полем ввода.
:В окне настройки [[#Настройка и использование пользовательских фильтров|пользовательских фильтров]]  в блоке '''Файлы''' можно применить фильтр как для отображения только маркеров из файлов, которые подходят под паттерн, так и для скрытия таких маркеров. Для переключения между этими режимами используйте кнопки [[File:Icon plus 2.png|x20px]] и [[File:Icon minus 3.png|x20px]], которые расположены рядом с полем ввода.


Line 779: Line 783:
:3. Скрытие маркеров из файлов, имя которых начинается с символа <code>q</code> и которые имеют расширения .с или .сс:
:3. Скрытие маркеров из файлов, имя которых начинается с символа <code>q</code> и которые имеют расширения .с или .сс:
::а) Используйте выражение <code>/q[^/]*\.c$|/q[^/]*\.cc$</code>
::а) Используйте выражение <code>/q[^/]*\.c$|/q[^/]*\.cc$</code>
::б) Нажмите кнопку [[File:Icon plus 2.png|x20px]] рядом с полем ввода, чтобы она поменялась на [[File:Icon minus 3.png|x20px]].
::б) Нажмите кнопку [[File:Icon plus 2.png|x20px]] рядом с полем ввода, чтобы она поменялась на [[File:Icon minus 3.png|x20px]]
:4. Отображение только маркеров из файлов, которые имеют текст <code>string</code> в конце имени файла и с расширением из одного символа:
:4. Отображение только маркеров из файлов, которые имеют текст <code>string</code> в конце имени файла и с расширением из одного символа:
:<pre>/.*string\..$</pre>
:<pre>/.*string\..$</pre>
:5. Скрытие маркеров из файлов в директориях <code>asn1</code> и <code>pem</code>:
:5. Скрытие маркеров из файлов в директориях <code>asn1</code> и <code>pem</code>:
::а) Используйте выражение <code>/asn1/|/pem/</code>
::а) Используйте выражение <code>/asn1/|/pem/</code>
::б) Нажмите кнопку [[File:Icon plus 2.png|x20px]] рядом с полем ввода, чтобы она поменялась на [[File:Icon minus 3.png|x20px]].
::б) Нажмите кнопку [[File:Icon plus 2.png|x20px]] рядом с полем ввода, чтобы она поменялась на [[File:Icon minus 3.png|x20px]]
:6. Отображение только маркеров из файлов, которые имеют в имени три цифры подряд:
:6. Отображение только маркеров из файлов, которые имеют в имени три цифры подряд:
:<pre>.*/.*[0-9]{3}[^/]*$</pre>
:<pre>.*/.*[0-9]{3}[^/]*$</pre>
:где <code>[^/]*$</code> означает, что после трех цифр и до конца строки может встречаться любой символ, кроме прямого слеша. Это позволяет исключить директории, имеющие три цифры в названии.
:где <code>[^/]*$</code> означает, что после трех цифр и до конца строки может встречаться любой символ, кроме прямого слеша. Это позволяет исключить директории, имеющие три цифры в названии

Revision as of 17:39, 25 May 2023

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

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

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

AutorizationMain
Страница ввода учетных данных

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

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

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

Примечание: чтобы после обновления системы в пользовательском веб-интерфейсе корректно отображались изменения, после авторизации обновите страницу в браузере – нажмите клавишу F5.

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

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

  1. Верхняя панель – отображается на всех страницах пользовательского интерфейса
    Содержит:
  2. Рабочая область – область экрана для просмотра информации и ввода, которая соответствует выбранному режиму работы или странице настроек

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

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

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

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

NotificationList
Панель уведомлений

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

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

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

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

UserMenu
Меню пользователя

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

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

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

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

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

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

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

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

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

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

Информация о программе

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

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

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

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

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

  1. Левая навигационная панель:
  2. Центральная панель:
  3. Правая панель

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

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

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

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

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

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

1. Отображение данных в виде списка – для этого нажмите кнопку
2. Группировка детекторов по уровням серьезности (по умолчанию) – для этого нажмите кнопку


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

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

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

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

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

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

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

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

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

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

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

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


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

  1. Просмотр подробной информации о снимке во всплывающем окне – для этого нажмите кнопку
  2. Переход к экспорту кода с разметкой – для этого нажмите кнопку
  3. Экспорт снимка в формате .snap. – для этого нажмите кнопку
  4. Просмотр параметров анализа во всплывающем окне – для этого нажмите кнопку в строке Параметры анализа
  5. Экспорт параметров анализа в формате .txt – для этого нажмите кнопку в строке Параметры анализа
  6. Просмотр таблицы статистики – для этого нажмите кнопку в строке Статистика. Информация в таблице сгруппирована по параметрам детекторов, найденным маркерам и статусу их разметки
  7. Просмотр списка приложенных файлов для этого нажмите кнопку в строке Приложенные файлы. Для скрытия списка нажмите кнопку

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

Информация на этой вкладке отображается только после выбора файла на вкладке Детекторы или Файлы, или в таблице маркеров.

В верхней части вкладки отображается полный путь к файлу.

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

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

1. Отображение кода на весь экран – для этого нажмите кнопку
2. Отображение всех маркеров – для этого нажмите кнопку
3. Скрытие всех маркеров – для этого нажмите кнопку
4. Отображение списка маркеров в этом файле – для этого нажмите кнопку
Cписок маркеров в файле
5. Выбор отображения информации о маркере и его разметки относительно строки кода, в которой он найден:
  • выше строки кода – нажмите кнопку
  • ниже строки кода – нажмите кнопку


6. Возврат к исходному маркеру (например, если был выбран другой связанный маркер на вкладке Трасса правой панели) – для этого нажмите кнопку в верхней части блока с информацией о маркере
7. Разметка маркера – нажмите кнопки в верхней части блока с информацией о маркере для установки Статуса, Серьезности и Действия
8. Переход к строке, в которой определена переменная – нажмите правую кнопку мыши на строке исходного кода и выберите пункт Перейти к определению
9. Просмотр ссылок на панели внизу экрана – нажмите правую кнопку мыши на строке исходного кода и выберите пункт Найти ссылки. На этой панели отображается иерархический список файлов с номерами строк, в которых найдены ссылки
Cписок файлов с номерами строк, в которых найдены ссылки
  • Чтобы перейти на вкладку Исходный код с фрагментом кода, на который найдена ссылка, нажмите на имя файла
  • Чтобы посмотреть фрагмента кода, на который найдена ссылка, в режиме предпросмотра, нажмите кнопку
10. Копирование строки кода – нажмите правую кнопку мыши на строке исходного кода и выберите пункт Copy
11. Вызов командной строки – нажмите правую кнопку мыши на строке исходного кода и выберите пункт Command Pallette
Командная строка

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

Если таблица маркеров не отображается, нажмите кнопку , а для её скрытия – .

В верхней части таблицы находится панель, которая содержит:

Таблица маркеров с примененными фильтрами

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

  1. Выбор маркеров для групповой разметки – для этого установите флажок в строке маркера
  2. Просмотр подробной информации о маркере в правой панели и его места и содержания на вкладке Исходный код – для этого дважды кликните на строку маркера или нажмите на имя файла в столбце Файл. Также для выбора можно использовать клавиши ↑ и ↓ – для перемещения по строкам, и Enter – для подтверждения выбора
  3. Копирование детальной информации о маркере в буфер обмена – для этого нажмите правой кнопкой мыши на маркер и выберите пункт Копировать
  4. Копирование ссылки на маркер в буфер обмена – для этого нажмите правой кнопкой мыши на маркер и выберите пункт Скопировать ссылку на предупреждение
  5. Переход к сравнению одного маркера с другим – для этого нажмите правой кнопкой мыши на маркер и выберите пункт Сравнить с ...

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

Эта панель предоставляет подробную информацию о маркере и его разметке:

Правая панель

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

1. Просмотр истории разметки – для этого нажмите кнопку в верхней части правой панели
Пример истории изменения разметки маркера
2. Блокировка маркера для разметки другими пользователями – для этого нажмите кнопку в верхней части правой панели
3. Разметка маркера – для этого нажмите кнопки в верхней части правой панели
4. Копирование ссылки на маркер – для этого нажмите кнопку в верхней части правой панели
5. Отображение маркера на вкладке Исходный код одним из трех способов:
а) Нажмите кнопку с именем файла и номером строки в верхней части правой панели [1]
б) Нажмите на ссылку с именем файла и номером строки на вкладке Трасса [2]
в) Нажмите кнопку Найти в коде на вкладке Подробности [3]. Это позволяет всегда вернуться к нужной точке при навигации по коду


6. Отображение кода, который соответствует строке трассы, в отдельном окне в режиме предпросмотра – для этого на вкладке Трасса нажмите кнопку рядом с именем файла и номером строки
Предпросмотр кода
7. Просмотр и добавление комментариев к маркеру на вкладке Комментарии. Комментарии для каждого маркера уникальны. Добавление одинаковых комментариев недоступно
8. Редактирование и удаление комментариев на вкладке Комментарии с помощью кнопок и
Вкладка Комментарии
Примечание: Пользователь может отредактировать и удалить только свои комментарии. Пользователю с ролью admin доступно редактирование и удаление комментариев всех пользователей.
9. Просмотр подробной информации на вкладке Подробности
Вкладка Подробности
10. Просмотр информации о детекторе, который обнаружил маркер – для этого нажмите на его имя на вкладке Подробности
Пример информации о детекторе
11. Просмотр истории обнаружения маркера в снимках – для этого нажмите кнопку слева от названия снимка на вкладке Подробности
Пример истории маркера
12. Запуск хуков (скриптов) – для этого нажмите кнопку Запустить на вкладке Подробности


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

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

Настроить и использовать фильтры можно только в режиме разметки.

Существует четыре вида фильтров:

  1. Фильтры левой навигационной панели [1]: детекторы, файлы или серьезность
  2. Размеченный – позволяют отобразить только размеченные маркеры. Фильтр применяется по нажатии кнопки в правой части блока выбора проекта, ветки и снимка [2]
  3. Пользовательские фильтры – доступны по нажатии кнопки в правой части блока выбора проекта, ветки и снимка [3]
  4. Запрос – фильтр, указанный в поле в верхней части таблицы маркеров [4]
Существующие фильтры

Посмотреть примененные фильтры и последовательность их применения можно в поле в верхней части таблицы маркеров.

Все виды фильтров можно использовать одновременно, но при определенном порядке применения фильтры могут быть сброшены:

По нажатии кнопки в правой части блока выбора проекта, ветки и снимка можно отменить примененные фильтры: пользовательский или все.

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

Настроить пользовательские фильтры можно в режиме разметки. Для этого:

1. Нажмите кнопку в правой части блока выбора проекта, ветки и снимка. В правой части экрана отобразится панель пользовательских фильтров, которые разделены на три группы:
  • параметры детекторов
  • параметры разметки маркеров
  • файлы
2. На вкладке Пользовательский:
а) Настройте параметры фильтрации – выберите значения в списках полей или нажмите кнопки со значениями
б) Нажмите на кнопку справа от значения в списке, чтобы отменить его выбор
в) Если параметры нужно исключить из поиска, нажмите на кнопку . Кнопка поменяется на
г) Если параметры нужно включить в поиск, нажмите на кнопку . Кнопка поменяется на
д) Нажмите кнопку , чтобы очистить все параметры фильтрации
е) Нажмите кнопку , в открывшемся диалоге введите название и нажмите кнопку Сохранить
ж) Нажмите кнопку , чтобы применить фильтр. После применения кнопка фильтра станет зеленой, а ее название поменяется на Пользовательский
Пользовательские фильтры. Вкладка Пользовательский
3. На вкладке Сохраненные:
а) Для редактирования сохраненного фильтра нажмите кнопку
б) Создайте дубликат фильтра – нажмите кнопку
в) Удалите фильтр – нажмите кнопку
г) Примените фильтр – нажмите на его название и нажмите кнопку
Пользовательские фильтры. Вкладка Сохраненные

После применения:

  • примененный фильтр будет отмечен
  • кнопка фильтра станет зеленой, а ее название поменяется на Название сохраненного фильтра

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

Чтобы сравнить снимки и маркеры в них:

1. Выберите исходные проект, ветку и снимок
2. В режиме разметки нажмите кнопку
3. В открывшемся окне выберите проект, ветку и снимок для сравнения; нажмите кнопку
Результат сравнения отобразится в левой навигационной панели и центральной панели, причем:
  • вкладка Информация о снимке поменяется на вкладку Информация о различиях с информацией о двух сравниваемых снимках
  • применится первый режим сравнения, в котором найдены результаты
Выбор проекта, ветки и снимка для сравнения
4. Выберите режим сравнения
Выбор режима сравнения
В левой навигационной панели и центральной панели отобразятся только результаты выбранного режима сравнения.
В режимах Сопоставленные и Одинаковые в таблице маркеров добавляется столбец с номером версии.


5. Посмотрите различия в параметрах анализа – нажмите кнопку Показать различия на вкладке Информация о различиях
Сравнение настроек анализа
6. Посмотрите различия в статистике разметки – нажмите кнопку Различия разметок
Сравнение статистики разметок
7. Нажмите кнопку или , чтобы скачать статистику в формате CSV или PDF
8. Отмените сравнение – нажмите кнопку в блоке выбора проекта, ветки и снимка


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

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

1. В режиме разметки выберите исходные проект, ветку и снимок
2. Раскройте таблицу маркеров
3. Нажмите правой кнопкой мыши на строке маркера и выберите пункт Сравнить с ...
Откроется окно выбора маркера для сравнения
Окно выбора маркера для сравнения
4. Выберите проект, ветку и снимок. Отобразится список маркеров в выбранном снимке, где можно ввести запрос для поиска маркеров
Выбор маркера для сравнения
5. Дважды кликните на строке маркера, чтобы перейти в окно сравнения маркеров
Окно сравнения маркеров

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

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


Примечание: после изменения статуса (сброса разметки) на Undecided, уровень серьезности и требуемое действие будут автоматически изменены на Unspecified и Undecided соответственно.

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

Для групповой разметки:

1. В режиме разметки выберите исходные проект, ветку и снимок
2. Включите отображение таблицы маркеров
3. Выберите маркеры для разметки – установите флажки в строках таблицы
Выбор маркеров для групповой разметки
4. Нажмите кнопку (доступна, если выбраны маркеры в таблице)
Отобразится окно для групповой разметки
Окно групповой разметки
5. Разметьте выбранные маркеры – с помощью кнопок в верхней части окна выберите статус разметки, а затем (опционально) статус серьезности (критичности) и требуемое действие
Отображаемые в окне маркеры окрасятся в соответствующий цвет. Например, если пользователь поставил статус проверки Confirmed, то все маркеры окрасятся в красный цвет:
Окно групповой разметки после выбора статуса, серьезности и действия
6. Добавьте общий комментарий для выбранных маркеров
После того, как пользователь присвоил статусы и (или) написал комментарий, станут доступными кнопки Сбросить и Применить
7. Если требуется отменить изменения, нажмите в правом верхнем углу окна или кнопку Отмена
Диалоговое окно закроется, изменения не будут применены, выделение с выбранных для разметки маркеров не снимается
8. Если требуется сбросить все изменения, нажмите кнопку Сбросить
Данные в окне вернутся в первоначальное состояние, а кнопки Сбросить и Применить станут неактивными
9. Нажмите кнопку Применить, чтобы запустить процесс разметки

Прогресс разметки отображается в соответствующем окне. Запущенный процесс можно полностью отменить нажатием кнопки Отмена.

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


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

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

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

1. На вкладке Детекторы. В этом случае блокировка распространяется на все маркеры выбранного детектора в открытом проекте и ветке, для всех снимков ветки
2. На вкладке Файлы. В этом случае блокировка распространяется на все маркеры в выбранном файле в открытом проекте и ветке, для всех снимков ветки
3. В верхней части правой панели. В этом случае блокировка распространяется на все эквивалентные маркеры в открытом проекте и ветке, для всех снимков ветки


Если один пользователь заблокировал маркер, то другой пользователь не сможет заблокировать детектор, которому принадлежит этот маркер, и файл, в котором этот маркер найден.
В этом случае при наведении курсора на в строке файла отобразится сообщение: Невозможно заблокировать файл, так как один или несколько его маркеров заблокированы другим пользователем.

Чтобы посмотреть все блокировки, перейдите в раздел Настройки на вкладку Блокировки:

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

В этом разделе можно удалить только свои блокировки. Пользователь admin может удалить любые блокировки.

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

Пользователь может экспортировать с сервера исходный код с разметкой (опционально) из снимка двумя способами:

Способ 1 – в пользовательском интерфейсе сервера Svacer

Для этого:

1. В режиме разметки выберите исходные проект, ветку и снимок
2. На вкладке Информация о снимке в строке свойства ID нажмите кнопку
Переход к экспорту кода с разметкой
3. В открывшемся окне выберите шаблон для экспорта в списке справа (по умолчанию Нет, т.е. разметка экспортироваться не будет) и опционально заполните поля для удаления префиксов и исключения путей:
Окно экспорта кода с разметкой

Пример удаления префиксов путей: /.build/ – чтобы убрать папку .build при экспорте.

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

Способ 2 – через консольную команду svacer markup export

Синтаксис команды:

svacer markup --user <user> --password <password> --project <project id or name> --branch <branch id or name> --snapshot <snapshot id or name> export [--stripPrefixes <prefix1, prefix2, … , prefixN> --excludePaths <path1, path2, … ,pathN> --template <name>]

Где:

  • user, password — имя пользователя и пароль учетной записи на сервере истории
  • project — проект на сервере истории, из которого будет экспортирован код
  • branch — ветка в проекте, выбранном выше (по умолчанию master), из которой будет экспортирован код
  • snapshot — снимок в выбранных проекте и ветке (по умолчанию последний загруженный), из которого будет экспортирован код
  • stripPrefixes, excludePaths — аналогичны полям Удалить префиксы и Исключить пути в форме экспорта разметки в пользовательском интерфейсе, описанной выше
  • template — определяет имя шаблона для экспорта разметки. Если имя не указано, разметка не экспортируется

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

Наличие в файлах комментариев зависит от того, был ли выбран шаблон разметки.

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

Чтобы посмотреть краткую статистику о разметке маркеров:

1. Выберите исходные проект, ветку и снимок
2. Перейдите в режим разметки
3. На вкладке Информация о снимке в строке свойства Статистика нажмите кнопку
Переход к просмотру статистики
Отобразится таблица статистики:
Таблица статистики
4. Нажмите кнопку или ,чтобы выгрузить статистику в соответствующем формате
5. Нажмите кнопку в строке статистики, чтобы применить пользовательский фильтр с параметрами, которые соответствуют выбранному значению

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

Режим позволяет посмотреть снимки исходного кода, связанного с результатами анализатора Svace.

Для этого:

1. Выберите исходные проект, ветку и снимок
2. Перейдите в режим просмотра кода с помощью переключателя в верхней части экрана
В левой части экрана отобразится иерархический список файлов снимка, а в правой – поле для отображения исходного кода файла
Режим просмотра кода
3. В левой части экрана раскройте группу файлов и нажмите на имя файла
Также доступен поиск файлов, для этого кликните на поле поиска, в открывшемся окне введите поисковый запрос и выберите файл. В правой части отобразится исходный код файла
Пример одного открытого файла
4. Если требуется, откройте другие файлы
Они отобразятся на отдельных вкладках
Пример трёх открытых файлов
5. Вызовите функции, доступные по нажатию правой кнопки мыши на строке исходного кода
  • Перейти к определению – для перехода к строке, в которой определена переменная и функция
  • Найти ссылки – для просмотра ссылок в панели с иерархическим списком файлов, именами файлов и номерами строк, в которых найдены ссылки
Cписок файлов с номерами строк, в которых найдены ссылки
  • Copy – для копирования строки в буфер обмена
  • Command Pallette – для вызова командной строки
Командная строка

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

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

1. Выберите исходные проект и ветку
2. Перейдите в режим формирования отчетов с помощью переключателя в верхней части экрана
Отобразится форма формирования отчетов:
Форма формирования отчетов
3. На панели слева выберите требуемый отчет: Общий отчет или Тренды
4. Выберите текущий и целевой снимки:
Выбор снимков для формирования отчета
5. Нажмите кнопку для запуска формирования отчета и его отображения в пользовательском интерфейсе
6. Нажмите кнопку для выгрузки отчета в формате .json
Пример общего отчета
Пример отчета Тренды

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

Перейти в раздел Настройки можно по нажатии кнопки в верхней правой части экрана.

В этом разделе пользователю, в зависимости от роли, доступны следующие функции:

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

Примечание: функции, описанные в этом разделе, доступны только пользователю с ролью admin.

Чтобы посмотреть список и настройки учетных записей пользователей, перейдите на вкладку Пользователи на странице Настройки:

Вкладка Пользователи на странице Настройки

Для учетных записей с доступом по LDAP, над логином учетной записи отображается индикатор

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

Для управления пользователями:

1. Создайте учетную запись пользователя:
а) Нажмите кнопку Добавить пользователя
Переход к добавлению учетной записи пользователя
Откроется окно добавления учетной записи пользователя
б) Заполните поля:
в) Включите опцию Изменить пароль при первом входе в систему (опционально)
г) Нажмите кнопку Добавить
Окно Добавить пользователя
В таблице со списком пользователей добавится новая запись.
2. Чтобы назначить пользователю роли, выберите значения в выпадающем списке поля в столбце Роли:
Назначение ролей пользователю
3. Нажмите на кнопку справа от значения, чтобы отменить его выбор
4. Воспользуйтесь функциями в строке профиля в столбце Действия:
  • – для перехода к редактированию данных профиля
  • – для перехода к изменению пароля
  • – для отчистки пользовательских настроек
  • – для архивирования учетной записи пользователя
При архивировании учетной записи пользователя блокируется доступ к системе, над логином учетной записи отображается индикатор
  • – для восстановления учетной записи пользователя из архива
  • – для удаления учетной записи пользователя
Для учетной записи с доступом по LDAP обновите данные – нажмите кнопку в столбце Действия и в окне изменения профиля пользователя нажмите кнопку Загрузить из LDAP
Загрузятся параметры профиля пользователя и его контакты из профиля в службе каталогов, если они там указаны. Пользователь может изменить эти параметры
Загрузка данных из LDAP

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

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

1. Нажмите кнопку Роли:
Переход к управлению ролями
В правой части экрана отобразится панель со списком ролей:
Панель со списком ролей
Следующие роли являются встроенными с особым значением, их нельзя удалить или изменить:
Роль Полномочия/особенности
importer Загрузка данных анализа посредством команды в CLI svacer upload
review_master Разметка, выполненная пользователем с этой ролью, не может быть переопределена пользователем без этой роли
admin Дает полномочия администратора сервера
filter_master Дает возможность настраивать глобальные фильтры для проектов и веток проектов
2. Включите опцию Показать столбец "ID роли", если требуется
3. Чтобы добавить роль:
а) Нажмите кнопку Добавить роль
Откроется окно добавления роли
б) Введите название роли
в) Добавьте разрешения для создаваемой роли, для этого:
  • Нажмите кнопку Добавить еще
  • Выберите проект или ветку и разрешение
г) Нажмите кнопку Добавить
Окно добавления роли
В таблице со списком ролей добавится новая запись.
Роль пользователя определяет доступные пользователю действия со следующими объектами сервера: проектами, ветками, маркерами, снимками:
Действие Область Эффект
Чтение Проект Получение списка веток проекта
Получение списка маркеров любой ветки проекта
Экспорт данных из веток проекта
Чтение Ветка Получение списка маркеров из ветки проекта
Экспорт данных из ветки проекта
Запись Проект Импорт данных в любую ветку проекта
Запись Ветка Импорт данных в конкретную ветку проекта
Разметка Проект Возможность менять разметку и добавлять/менять комментарии к маркерам во всех ветках проекта
Разметка Ветка Возможность менять разметку и добавлять/менять комментарии к маркерам в конкретной ветке проекта
Также существует:
  • специальная область ALL, которая означает все проекты и ветки
  • действие ALL, которая означает все доступные действия чтение, запись и разметка
4. Чтобы изменить настройки роли, нажмите кнопку в строке роли в столбце Действия (недоступно для встроенных ролей) и внесите изменения
5. Чтобы удалить роль, нажмите кнопку в строке роли в столбце Действия (недоступно для встроенных ролей)

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

Примечание: функции, описанные в этом разделе, доступны только пользователю с ролью admin или Filter_master. Пользователям с другими ролями доступен только просмотр.

На вкладке Фильтры страницы Настройки можно настроить глобальные фильтры, применительно к выбранным проекту или ветке проекта:

Вкладка Фильтры на странице Настройки

Для настройки фильтров:

1. Чтобы добавить фильтр, нажмите кнопку Добавить фильтр
Отобразится новая строка:
Новая строка с фильтром
2. Чтобы изменить настройки фильтров:
а) Введите или поменяйте название фильтра
б) Деактивируйте или активируйте фильтр – нажмите на значение в столбце Активные один или два раза, чтобы отобразилась иконка или
в) Выберите область применения фильтра – нажмите на значение в столбце Область один или два раза, чтобы отобразилось значение ветка или проект
г) Укажите регулярное выражение или загрузите файл шаблона в столбцах Включить пути по шаблону, Исключить пути по шаблону и Шаблоны детекторов
д) Выберите уровни серьезности (критичности) и надежности:
  • – уровень выбран
  • – уровень не выбран
Для изменения выбора нажмите на название уровня
3. Нажмите кнопку в столбце Действия, чтобы удалить фильтр
4. Для завершения работы с фильтрами без сохранения нажмите кнопку Сброс
5. Для завершения работы с фильтрами и применения изменений нажмите кнопку Применить изменения.
6. После применения изменений нажмите кнопку Принудительно применить изменения, чтобы ускорить применение фильтров на стороне сервера.

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

Примечание: функции, описанные в этом разделе, доступны только пользователю с ролью admin.

Управление шаблонами разметки доступно на вкладке Шаблоны страницы Настройки:

Вкладка Шаблоны на странице Настройки

Шаблоны разметки нужны для импорта/экспорта разметки. С их помощью комментарии в исходном коде будут преобразовываться в разметку на сервере истории и обратно.
Шаблон с именем DEFAULT есть всегда, его нельзя отредактировать или удалить.
Примечание: для корректного создания или изменения шаблонов разметки следует обратиться к разработчикам Svacer.

Для управления шаблонами:

1. Нажмите кнопку Добавить шаблон.
Откроется окно добавления шаблона
Окно добавления шаблона разметки
2. Введите название шаблона.
3. Нажмите кнопку Добавить
Шаблон появится в списке шаблонов для разметки в правой панели формы
4. Отредактируйте поля шаблона разметки:
Редактирование шаблона разметки
5. Нажмите Сохранить
6. Чтобы клонировать существующий шаблон разметки, нажмите кнопку в столбце Действия
7. Чтобы удалить шаблон разметки, нажмите кнопку в столбце Действия

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

Примечание: функции, описанные в этом разделе, доступны только пользователю с ролью admin.

На вкладке Проекты страницы Настройки отображаются все проекты со всеми ветками и снимками.

Вкладка Проекты страницы Настройки

Для управления проектами пользователей:

1. Добавьте проект – нажмите кнопку Создать новый проект и введите его имя
При импорте проект добавляется автоматически
2. Добавьте ветку – нажмите кнопку в строке проекта, в открывшемся меню выберите пункт Добавить новую ветку и введите её имя
При импорте ветка добавляется автоматически
3. Измените название проекта/ветки – нажмите кнопку в строке проекта/ветки, в открывшемся меню выберите пункт Изменить имя проекта / Изменить имя ветки и измените имя
4. Удалите проект/ветку/снимок – нажмите кнопку в списке проектов/веток/снимков
5. Клонируйте ветку проекта – нажмите кнопку в строке ветки и в открывшемся меню выберите пункт Клонировать
6. Экспортируйте снимок с сервера в файл для дальнейшего его импорта на другой сервер или в другой проект/ветку на этом же сервере – нажмите кнопку в строке снимка
7. Импортируйте снимок из файла – нажмите кнопку в строке ветки, в открывшемся меню выберите пункт Импортировать снимок, выберите файл в формате .snap
8. Скопируйте разметку в другой контейнер (проект и ветку):
а) Нажмите кнопку в строке ветки и в открывшемся меню выберите пункт Копировать разметку
б) В открывшемся окне выберите проект и ветку, в которые нужно скопировать разметку, а также действия, которые нужно выполнить при наличии разметки
в) Нажмите кнопку Копировать
Окно копирования разметки в другой контейнер

Разметка в контейнере состоит из множества размеченных маркеров. В целевой ветке уже может находиться разметка. Все множество маркеров в исходной ветке можно разбить на два:

  • «Уникальные» – маркеры, которые есть только в исходной ветке
  • «Общие» – маркеры, которые есть как в ветке-источнике, так и в ветке-приемнике

При выполнении операции копирования разметка в уникальных маркерах всегда копируется в ветку-приемник. Для «Общих» маркеров возможны несколько вариантов продолжения копирования, но по умолчанию выбран пункт Не копировать – в этом случае разметка в «Общих» маркерах в ветке-приемнике не изменяется.

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

При выборе действия Заменить, если новее разметка из ветки-источника копируется в том случае, если ее метка времени более поздняя, чем та, которая указана в ветке-приемнике на данном маркере.

Пример:

Есть несколько контейнеров:
  • A с разметкой {(M1, D1), (M2, D2), (M3, D3)}
  • B с разметкой {(M4, D4), (M2, D5), (M3, D6)}
где M — это маркер, а D — разметка (включая метку времени).
Операцию сравнения на разметке обозначим как >. Если метка времени в D1 больше, чем в D2, то D1 > D2
Пусть D2 > D5, а D3 < D6. Тогда операция копирования всегда скопирует разметку D1 (но не сам маркер), так как маркер M1 новый для контейнера B
Маркеры M2, M3 — общие для двух контейнеров, поэтому то, какая разметка будет в контейнере-приемнике, будет зависеть от выбранного варианта разрешения конфликта:
  • если выбран пункт Не копировать, то в контейнере B на маркерах M2, M3 будет разметка D5, D6 соответственно
  • если выбран пункт Перезаписать, то на M2, M3 будет разметка D2, D3
  • если выбран пункт Заменить, если новее, то на M2, M3 разметка будет: D2, D6, так как D2 > D5 и D6 > D3
При выполнении копирования наличие маркера в ветке-приемнике не проверяется

При успешном копировании выводится всплывающее сообщение вида: Выполнено успешно. Всего: Х, Заменено: Y
Это сообщение означает, что всего было скопировано X инвариантов вместе с разметкой и среди скопированных инвариантов Y штук было скопировано с заменой.

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

Чтобы посмотреть список всех детекторов, перейдите на вкладку Детекторы страницы Настройки:

Вкладка Детекторы страницы Настройки

Нажмите кнопку в строке детектора, чтобы посмотреть подробную информацию:

Окно с информацией о детекторе

Нажмите кнопку Экспорт в PDF, чтобы выгрузить список детекторов в формате .pdf.

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

Чтобы посмотреть список всех блокировок, перейдите на вкладку Блокировки страницы Настройки:

Вкладка Блокировки страницы Настройки

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

Примечание: Пользователь с ролью admin может удалять блокировки всех пользователей, пользователи с другими ролями могут удалять только свои блокировки.

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

Примечание: функции, описанные в этом разделе, доступны только пользователю с ролью admin.

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

  • параметры, с которыми запущен сервер
  • логи сервера
  • журнал базы данных
Вкладка Информация о сервере на странице Настройки

Доступны функции:

  • копирование записей в системном логе и журнале
  • выгрузка системного лога и журнала в файлы в формате .log

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

Svacer поддерживает авторизацию по протоколу OAuth. Для авторизации используются запросы GET /api/oauth/authorize и POST /api/oauth/token в соответствии со стандартом.

API-вызовы для управления клиентами:

  • GET /api/oauth/clients — получение всех клиентов для текущего пользователя или всех клиентов текущего сервера для админа
  • GET /api/oauth/client?client_id={client_id} — получение клиента по id
  • POST /api/oauth/client — создание нового клиента
  • PUT /api/oauth/client — изменение данных клиента
  • DELETE /api/oauth/client/{client_id} — удаление клиента

Управление клиентами доступно на вкладке Клиенты OAuth на странице Настройки:

Вкладка Клиенты OAuth на странице Настройки
  • Для создания клиента OAuth нажмите кнопку Добавить клиента, введите его имя и домен
  • После создания OAuth клиента скопируйте Секрет клиента из поля в колонке Секрет и сохраните его в надежном месте. После обновления страницы скопировать секрет будет невозможно.
  • Для перехода к изменению имени и домена клиента OAuth нажмите кнопку в столбце Действия
  • Для удаления клиента OAuth нажмите кнопку в столбце Действия

Примечание: Пользователь с ролью admin может просматривать и управлять OAuth клиентами всех пользователей, пользователям с другими ролями доступен просмотр и управление только своими OAuth клиентами.

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

Примечание: функции, описанные в этом разделе, доступны только пользователю с ролью admin.

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

Реестром организаций можно управлять на вкладке Организации страницы Настройки.

Вкладка Организации страницы Настройки

Доступен поиск по имени организации и сортировка по колонкам Название и Сокращенное название.

Чтобы добавить новую организацию в реестр:

  1. Нажмите кнопку Добавить организацию
  2. Заполните поля появившейся формы
  3. Нажмите кнопку Добавить
Окно добавления организации в реестр

Чтобы изменить данные существующей организации:

  1. Нажмите кнопку в столбце Действия
  2. В появившейся форме отредактируйте данные организации
  3. Нажмите кнопку Сохранить

Чтобы удалить организацию из реестра:

  1. Нажмите кнопку в столбце Действия
  2. В появившемся диалоге подтвердите удаление, нажав на кнопку Удалить
Окно удаления организации из реестра

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

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

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

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

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

Особенности реализации:

1. Поиск происходит только по регулярному выражению. Если требуется найти специальный символ в качестве обычного символа, его нужно экранировать (например, точку: «\.»)
2. При поиске находятся вхождения подстроки в полном пути к файлу (аналогично grep). Если требуется найти по полной строке, используйте символы начала и конца строки: ^ и $
3. Поиск не зависит от регистра символов (case insensitive)
В окне настройки пользовательских фильтров в блоке Файлы можно применить фильтр как для отображения только маркеров из файлов, которые подходят под паттерн, так и для скрытия таких маркеров. Для переключения между этими режимами используйте кнопки и , которые расположены рядом с полем ввода.

Примеры регулярных выражений:

1. Поиск файлов с текстом sha или md5 в любом месте пути или имени файла:
sha|md5
2. Отображение только маркеров из файлов с расширением .c:
.*\.c$
3. Скрытие маркеров из файлов, имя которых начинается с символа q и которые имеют расширения .с или .сс:
а) Используйте выражение /q[^/]*\.c$|/q[^/]*\.cc$
б) Нажмите кнопку рядом с полем ввода, чтобы она поменялась на
4. Отображение только маркеров из файлов, которые имеют текст string в конце имени файла и с расширением из одного символа:
/.*string\..$
5. Скрытие маркеров из файлов в директориях asn1 и pem:
а) Используйте выражение /asn1/|/pem/
б) Нажмите кнопку рядом с полем ввода, чтобы она поменялась на
6. Отображение только маркеров из файлов, которые имеют в имени три цифры подряд:
.*/.*[0-9]{3}[^/]*$
где [^/]*$ означает, что после трех цифр и до конца строки может встречаться любой символ, кроме прямого слеша. Это позволяет исключить директории, имеющие три цифры в названии