Help:UI manual

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

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

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

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

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

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

Страница входа по протоколу LDAP

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

Описание настроек конфигурации сервера Svacer для поддержки аутентификации по LDAP протоколу приведено по ссылке.

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

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

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

1. Верхняя панель – отображается на всех страницах пользовательского интерфейса.
   Содержит:
   • логотип сервера Svacer;
   • кнопки меню:
     • Разметка – просмотр и разметка найденных маркеров, а также сравнение снимков или отдельных маркеров;
     • Код – просмотр снимков исходного кода, связанного с результатами анализатора Svace;
     • Проекты – управление проектами (режим доступен только пользователям с ролью admin);
     • Отчеты – формирование отчетов на основе хранимой информации;
     • Детекторы – просмотр списка детекторов;
     • Статистика – просмотр статистики разметки по всем проектам, веткам и снимкам, доступным пользователю;
     • Поиск – глобальный поиск снимков, маркеров и комментариев к ним;
   • – кнопка для перехода к настройке системы;
   • – переключатель языка пользовательского интерфейса;
   • – кнопка для перехода на страницу документации к системе;
   • – кнопка для перехода к уведомлениям;
   • – кнопка меню пользователя, которое предоставляет следующие функции:
     • переход к настройке профиля пользователя;
     • выход из системы;
     • просмотр информации о программе.
2. Рабочая область – область экрана для просмотра информации и ввода, которая соответствует выбранному режиму работы или странице настроек.

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

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

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

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

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

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

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

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

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

В правой части экрана отобразится панель Профиль, на которой можно изменить атрибуты своего профиля (ФИО, контакты), кроме логина, а также поменять пароль.

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

Пользователь LDAP может скорректировать только Организации. Остальные атрибуты (ФИО, E-mail), а также функция изменения пароля, недоступны.

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

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

1. Выберите пункт Профиль в меню пользователя.

2. В разделе Профиль пользователя нажмите на ссылку Изменить пароль:

Переход к изменению пароля в профиле пользователя

3. В открывшемся окне:

а) Введите текущий пароль.

б) Дважды введите новый пароль.

в) Нажмите кнопку Изменить.

Окно изменения пароля

Настройка интерфейса

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

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

1. Общие. Параметры этой группы позволяют:

а) Выбрать фильтры, которые будут по умолчанию применяться при повторном входе в систему:

• фильтры, установленные в предыдущей сессии (выбрано по умолчанию);
• сохраненный пользовательский фильтр.

б) Включить или выключить (выбрано по умолчанию) замену снимка на последний загруженный в БД Svacer снимок при открытии сохраненного контекста.

Если параметр в состоянии «Выключен», при выборе проекта и ветки открывается последний импортированный снимок.

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

г) Включить (выбрано по умолчанию) или выключить сохранение применённой сортировки значений в таблице маркеров при выходе из системы.

д) Включить или выключить (выбрано по умолчанию) механизм генерации PDF-файла на основе HTML при выгрузке отчета с информацией о маркерах.

Для использования генерации PDF на основе HTML на сервере Svacer должен быть установлен браузер Chromium или Google Chrome.

Настройки интерфейса. Группа параметров «Общие»

2. Навигационная панель. Параметры этой группы позволяют:

а) Выбрать отображение по умолчанию данных на вкладке Детекторы навигационной панели:

• группировка детекторов по уровням серьезности (выбрано по умолчанию);
• отображение детекторов в виде списка.

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

б) Выбрать отображение по умолчанию данных на вкладке Файлы навигационной панели:

• только имя файла (выбрано по умолчанию);
• полный путь к файлу.

в) Выбрать способ сортировки в колонке Маркеры на вкладке Файлы панели навигации:

• по общему количеству маркеров (выбрано по умолчанию);
• по количеству размеченных маркеров.

Настройки интерфейса. Группа параметров «Навигационная панель»

3. Просмотр кода. Параметры этой группы позволяют:

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

б) Включить или выключить (выбрано по умолчанию) переиспользование вкладки с исходным кодом в редакторе кода.

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

Если параметр находится в состоянии «Выключен», то будет отображаться только первый элемент трассы.

г) Выбрать отображение виджета относительно строки кода, с которой он связан:

• над строкой кода (выбрано по умолчанию);
• под строкой кода.

Настройки интерфейса. Группа параметров «Просмотр кода»

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

Чтобы сбросить параметры любой группы к значениям по умолчанию, нажмите на ссылку Сбросить настройки внизу панели Настройки интерфейса.

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

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

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

Откроется окно с информацией о программе

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

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

Нажмите на ссылку в строке Спецификация OpenAPI для открытия страницы Swagger с описанием API методов используемых в Svacer.

Нажмите на ссылку Telegram в строке Поддержка и Обратная связь для открытия чата с технической поддержкой.

Нажмите на ссылку Email в строке Поддержка и обратная связь для отправки сообщения в службу технической поддержки по электронной почте.

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

Для работы в режиме разметки или режиме просмотра кода требуется выбрать проект, ветку и снимок с результатами работы анализатора Svace, а в разделе Отчёты – проект и ветку.

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

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

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

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

1. Навигационная панель:

• вкладка Детекторы;
• вкладка Файлы.

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

2. Центральная панель:

• вкладка Информация о снимке – открывается по нажатию кнопки ;
• одна или несколько вкладок с исходным кодом (отображаются после выбора файлов в таблице маркеров или навигационной панели);
• таблица маркеров;

3. Правая панель с информацией о маркере.

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

Режим разметки. Набор элементов управления

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

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

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

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

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

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

1. Поиск по детекторам и файлам.

2. Выгрузка списка отображаемых на панели детекторов и маркеров в файл формата .csv – для этого нажмите кнопку

3. Отображение данных в виде списка – для этого нажмите кнопку .

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

• 

  Вкладка Детекторы с данными в виде списка

• 

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

5. Отображение списка маркеров в файлах, в которых сработал детектор – для этого нажмите кнопку в левой части его имени.

Список маркеров, найденных детектором

6. Блокировка всех маркеров, найденных детектором, для разметки другими пользователями – для этого нажмите кнопку справа от названия детектора (отображается при наведении курсора).

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

8. Применение фильтра по серьезности в таблице маркеров – для этого нажмите на название группы серьезности.

9. Отмена фильтров по серьезности, детекторам и файлам – для этого нажмите кнопку .

10. Отображение на вкладке исходного кода содержимого файла, места и содержания маркера, а также подробной информации о маркере на правой панели – для этого нажмите на маркер.

11. Просмотр фрагмента кода в режиме предпросмотра – для этого нажмите кнопку .

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

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

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

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

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

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

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

2. Применение фильтра по файлам в таблице маркеров – для этого нажмите кнопку в одной или нескольких строках.

Фильтр применится, кнопка в списке файлов поменяется на .

3. Исключение файла из фильтра по файлам в таблице маркеров – для этого нажмите кнопку в строке файла.

4. Отмена фильтрации в таблице маркеров для всех выбранных файлов – для этого нажмите кнопку или кнопку на вкладке Детекторы.

5. Блокировка всех маркеров в файле для разметки другими пользователями – для этого нажмите кнопку справа от названия файла (отображается при наведении курсора).

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

7. Сортировка файлов по количеству маркеров – для этого нажмите кнопку

8. Настройка отображения файлов и сортировки в колонке Маркеры на вкладке Файлы – для этого нажмите кнопку и поменяйте настройки.

9. Выгрузка списка отображаемых на панели файлов в файл формата .csv – для этого нажмите кнопку

Настройка отображения файлов и сортировки полей

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

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

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

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

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

1. Просмотр подробной информации о снимке во всплывающем окне – для этого нажмите кнопку Просмотреть JSON.

2. Переход к экспорту кода с разметкой – для этого нажмите кнопку Экспорт кода.

3. Экспорт снимка в формате .snap – для этого нажмите кнопку Экспорт снимка.

4. Переход к более продвинутой навигации по исходному коду с подсветкой маркеров во встроенном Web-IDE – для этого нажмите кнопку Открыть в IDE и в открывшемся списке (при его наличии) выберите IDE.

Функциональность является экспериментальной, доступна при наличии проектного доступа Экспорт снимков и запуске веб-приложения Svacer по протоколу HTTPS или на локальном хосте. Список доступных IDE определяется при инсталляции. Если доступна только одна IDE, то раскрывающийся список отсутствует, а IDE открывается сразу по нажатию кнопки Открыть в IDE. Если функциональность недоступна, кнопка Открыть в IDE неактивна и отображается иконка .

5. Просмотр списка приложенных файлов — доступен только при наличии приложенных файлов.

6. Скрытие списка приложенных файлов (возможно только при наличии приложенных файлов) – для этого нажмите на ссылку Скрыть.

7. Удаление приложенного файла (возможно только при наличии приложенных файлов) — для этого нажмите кнопку .

8. Просмотр пользовательских полей, которые пользователь указал при импорте – доступен только при наличии этих полей.

9. Просмотр параметров анализа во всплывающем окне – для этого нажмите кнопку Показать в строке Параметры анализа.

10. Экспорт параметров анализа в формате .txt – для этого нажмите кнопку Скачать в строке Параметры анализа.

11. Просмотр таблицы статистики – для этого нажмите кнопку Показать в строке Статистика.

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

Вкладка с исходным кодом

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

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

Полный путь к файлу и позиционирование курсора

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

1. Отображение кода на весь экран – для этого нажмите кнопку или дважды кликните на вкладку файла.

Для возврата к обычному отображению нажмите кнопку  или дважды кликните на вкладку файла.

2. Переход к предыдущей или следующей строке, в которую пользователь устанавливал курсор, – для этого используйте кнопки  и  или сочетания клавиш Ctrl + < и Ctrl + >.

3. Добавление комментария к строке кода – можно сделать двумя способами:

а) Нажмите кнопку в левой части строки, рядом с её номером (отображается только если в строке установлен курсор) и введите комментарий.

ИЛИ

б) Нажмите правой кнопкой мыши на строку и выберите пункт Добавить комментарий. Этим способом можно добавить несколько комментариев к одной строке.

4. Просмотр комментария к строке – можно сделать двумя способами:

а) Нажмите кнопку в левой части строки, рядом с её номером.

ИЛИ

б) Нажмите кнопку справа и выберите в списке строку комментария.

Отобразится виджет комментария, в котором доступны следующие функции:

• добавление дополнительного комментария к этой строке кода по нажатию кнопки ;
• редактирование текста комментария по нажатию кнопки ;
• удаление комментария по нажатию кнопки .

Виджет комментария к строке кода

5. Просмотр и открытие комментариев из списка всех комментариев в коде – для этого нажмите кнопку справа.

6. Отображение всех комментариев в коде – для этого нажмите кнопку справа.

7. Скрытие всех комментариев в коде – для этого нажмите кнопку справа.

8. Отображение всех маркеров – для этого нажмите кнопку .

9. Скрытие всех маркеров – для этого нажмите кнопку .

10. Просмотр и открытие маркеров из списка всех маркеров в данном файле – для этого нажмите кнопку .

Cписок маркеров в файле

11. Возврат к исходному маркеру (например, если был выбран другой связанный маркер на вкладке Трасса правой панели) – для этого нажмите кнопку в верхней части виджета элементов трассы.

12. Разметка маркера – установите Статус, Серьезность и Действия в верхней части блока с информацией о маркере.

13. Отображение виджетов элементов трассы для строки кода – нажмите ссылку Показать трассу (доступна, если все виджеты элементов трассы скрыты).

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

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

Виджет элемента трассы

14. Скрытие виджетов элементов трассы для строки кода – нажмите ссылку Скрыть трассу (доступна, если хотя бы один виджет элемента трассы отображается).

В этом случае все открытые виджеты элементов трассы маркера скрываются.

15. Переход к строке, в которой объявлена/определена переменная – нажмите правую кнопку мыши на строке исходного кода и выберите пункт Перейти к объявлению / Перейти к определению.

Если для выделенного элемента кода нет объявления или определения, то отобразится сообщение:  или .

16. Просмотр ссылок на панели внизу экрана – нажмите правую кнопку мыши на строке исходного кода и выберите пункт Найти ссылки. На этой панели отображается иерархический список файлов с номерами строк, в которых найдены ссылки:

Cписок файлов с номерами строк, в которых найдены ссылки

• Чтобы перейти к строке кода, на которую найдена ссылка, нажмите на ссылку с номером строки на панели [1].
• Чтобы посмотреть фрагмент кода, на который найдена ссылка, в режиме предпросмотра, нажмите кнопку [2].

Если для выделенного элемента кода нет ссылок, то отобразится сообщение: .

17. Переход к просмотру выбранного файла в режиме просмотра кода – нажмите правую кнопку мыши на строке исходного кода и выберите пункт Открыть в режиме Код.

18. Копирование ссылки на строку кода в буфер обмена – нажмите правую кнопку мыши на строке исходного кода и выберите пункт Копировать прямую ссылку.

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

19. Увеличение и уменьшение размера шрифта кода вместе с отображаемыми виджетами – нажмите правую кнопку мыши на любой строке исходного кода и выберите пункт Уменьшить или Увеличить, либо установите курсор в любую строку и нажмите сочетание клавиш Ctrl + Alt + - или Ctrl + Alt + =

20. Копирование строки кода – нажмите правую кнопку мыши на строке исходного кода и выберите пункт Copy.

21. Вызов командной строки – нажмите правую кнопку мыши на строке исходного кода и выберите пункт Command Palette.

Командная строка

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

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

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

• – поле с информацией о примененных фильтрах: как назначенных в навигационной панели, так и с помощью пользовательских фильтров и запросов;
• кнопка – выгрузка маркеров в файл формата .csv или .pdf: только для выбранных или всех отображаемых маркеров, если ничего не выбрано. Отчет в формате .pdf может быть сгенерирован на основе HTML, так и существующим (нативным) способом. В PDF-отчете, сгенерированном на основе HTML, усовершенствованы стили, доработан титульный лист, актуализирован набор параметров для выгружаемых маркеров и пр.;

Примечания:

• для использования механизма генерации PDF-отчёта на основе HTML должна быть включена одноименная настройка;
• генерация PDF-отчета на основе HTML может занимать больше времени, чем нативная генерация;
• спецсимволы (иконки), добавленные в комментариях к маркерам, не отображаются в выгруженном PDF-отчете.

• кнопка – переход к групповой разметке выбранных маркеров (доступна, если выбраны маркеры в таблице);
• кнопка – переход к добавлению общего комментария к нескольким выбранным маркерам.

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

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

1. Сортировка по значениям столбцов.

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

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

4. Копирование детальной информации о маркере в буфер обмена – для этого нажмите правой кнопкой мыши на маркер и выберите пункт Копировать.

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

5. Копирование ссылки на маркер в буфер обмена – для этого нажмите правой кнопкой мыши на маркер и выберите пункт Копировать ссылку на маркер.

6. Переход к сравнению одного маркера с другим – для этого нажмите правой кнопкой мыши на маркер и выберите пункт Сравнить с ...

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

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

• статус блокировки разметки;
• статус разметки, его серьезность и требуемое действие;
• автор последней разметки и прочее;

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

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

1. Копирование ссылки на маркер – для этого нажмите кнопку .

2. Блокировка маркера для разметки другими пользователями – для этого нажмите кнопку в верхней части правой панели.

3. Разметка маркера – для этого установите Статус, Серьезность и Действие в верхней части правой панели.

4. Просмотр истории разметки со связанными комментариями – для этого нажмите кнопку в верхней части правой панели.

Пример истории изменения разметки маркера

5. Отображение маркера на вкладке с исходным кодом нажмите кнопку с именем файла и номером строки в верхней части правой панели.

6. Отображение элемента трассы на вкладке с исходным кодом – для этого нажмите на ссылку с именем файла и номером строки на вкладке Трасса [1].

7. Отображение кода, который соответствует строке трассы, в отдельном окне в режиме предпросмотра – для этого на вкладке Трасса нажмите кнопку рядом с именем файла и номером строки [2].

Элементы управления для работы с элементом трассы

8. Просмотр и добавление комментариев к маркеру на вкладке Комментарии.

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

9. Редактирование и удаление комментариев на вкладке Комментарии с помощью кнопок и .

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

Вкладка Комментарии

Примечания:

• Пользователь может отредактировать и удалить только свои комментарии. Пользователю с доступом Изменение любых комментариев доступно редактирование и удаление комментариев всех пользователей. Если такой пользователь внёс изменения, то изначальный автор теряет возможность изменять свой комментарий (если у него нет доступа Изменение любых комментариев), так как авторство передаётся пользователю, который последним внёс изменения.
• Для отредактированного комментария отображается слово изменено, при наведении курсора на которое отображается сообщение с логином пользователя, изменившего комментарий, и датой редактирования. Текст несохраненного комментария в поле добавления комментария не пропадает при переключении на другой маркер.
• Если открыт режим редактирования комментария, то при переключении на другой маркер режим редактирования закрывается и изменения не сохраняются.

10. Ввод, просмотр и редактирования комментария в отдельном диалоговом окне – для этого нажмите кнопку рядом с полем ввода нового комментария или в поле существующего комментария.

Окно создания, просмотра и редактирования комментария в отдельном диалоговом окне

11. Просмотр подробной информации на вкладке Подробности. Содержит два блока:

• информация о сработавшем детекторе: серьезность и надежность, а также связанные с ним коды CWE, которые содержат ссылки на описание дефектов безопасности на сайте cwe.mitre.org;
• информацией о маркере: текстовые метки маркера, названия снимка и функции, инструмент, язык, текстовое описание и степень доверия, а также кнопки для перехода к просмотру истории маркера и запуску хуков.

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

По нажатию на иконку справа от названия детектора отображается дополнительная информация о нём. Иконка не отображается, если дополнительная информация отсутствует.

Вкладка Подробности

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

12. Просмотр истории обнаружения маркера в снимках данной ветки проекта – для этого на вкладке Подробности нажмите кнопку Показать в блоке информации о маркере в строке История.

В окне просмотра истории доступна сортировка записей.

Пример истории маркера

13. Запуск хуков (скриптов) – для этого нажмите кнопку Запустить на вкладке Подробности и в раскрывающемся списке доступных хуков выберите тот, который требуется запустить.

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

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

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

Существует пять видов фильтров:

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

Существующие фильтры

Увидеть примененные фильтры (кроме Доступные для разметки) и последовательность их применения можно в поле в верхней части таблицы маркеров.

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

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

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

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

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

1. Нажмите кнопку в правой части блока выбора контекста.

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

• Пользовательский – параметры фильтрации, которые разделены на три группы:

• параметры детекторов;
• параметры маркеров;
• файлы;

• Сохраненные – список сохраненных фильтров;
• Публичные – список фильтров, доступных всем пользователям.

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

3. Нажмите на кнопку справа от значения в списке, чтобы отменить его выбор.

4. Если параметры нужно исключить из поиска, нажмите на кнопку .

Кнопка поменяется на .

5. Если параметры нужно включить в поиск, нажмите на кнопку .

Кнопка поменяется на .

6. Нажмите кнопку , чтобы очистить все параметры фильтрации.

7. Нажмите кнопку , в открывшемся диалоге введите название и нажмите кнопку Сохранить.

Фильтр сохранится и отобразится на вкладке Сохраненные.

8. Нажмите кнопку , чтобы применить фильтр.

После применения кнопка фильтра станет зеленой, а ее название поменяется на название сохраненного фильтра.

Пользовательские фильтры. Вкладка Пользовательский

Работа с сохраненными фильтрами

На вкладке Сохраненные отображаются фильтры, сохраненные на вкладке Пользовательский, а также скопированные с вкладки Публичные.

Пользовательские фильтры. Вкладка Сохраненные

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

1. Для поиска фильтра введите его название в строке поиска.

2. Для сортировки фильтров по названию нажмите кнопку .

3. Для редактирования сохраненного фильтра нажмите кнопку и внесите изменения.

4. Создайте дубликат фильтра – нажмите кнопку .

5. Для публикации фильтра нажмите кнопку .

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

Функция доступна только пользователям с серверным доступом Управление публичными фильтрами.

6. Для удаления одного фильтра нажмите кнопку .

7. Для удаления нескольких фильтров:

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

б) Нажмите кнопку Удалить.

8. Примените фильтр – нажмите на его название и нажмите кнопку .

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

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

Работа с публичными фильтрами

Создание (публикация), изменение и удаление публичных фильтров доступны пользователям с серверным доступом Управление публичными фильтрами.

На вкладке Публичные отображаются фильтры, опубликованные на вкладке Сохраненные.

• 

  Пользовательские фильтры. Вкладка Публичные.
  Вид для пользователя без серверного доступа
  Управление публичными фильтрами

• 

  Пользовательские фильтры. Вкладка Публичные.
  Вид для пользователя с серверным доступом
  Управление публичными фильтрами

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

1. Для поиска фильтра введите его название в строке поиска.

2. Для сортировки фильтров по названию нажмите кнопку .

3. Чтобы посмотреть параметры фильтра, нажмите кнопку .

Функция доступна только пользователям БЕЗ серверного доступа Управление публичными фильтрами.

4. Для редактирования публичного фильтра нажмите кнопку и внесите изменения.

5. Скопируйте публичный фильтр – нажмите кнопку .

Фильтр сохранится и отобразится на вкладке Сохраненные.

6. Для удаления одного фильтра нажмите кнопку .

7. Для удаления нескольких фильтров:

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

б) Нажмите кнопку Удалить.

8. Примените фильтр – нажмите на его название и нажмите кнопку .

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

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

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

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

1. Выберите исходный контекст – проект, ветку, снимок.

2. В режиме разметки нажмите кнопку и в раскрывшемся списке выберите пункт Сравнить с….

3. В открывшемся окне выберите проект, ветку и снимок для сравнения; нажмите кнопку .

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

Результат сравнения отобразится в навигационной панели и центральной панели, причем:

• вкладка Информация о снимке поменяется на вкладку Информация о различиях с информацией о двух сравниваемых снимках;
• применится первый режим сравнения, в котором найдены результаты.

4. Выберите режим сравнения.

Выбор режима сравнения

В навигационной панели и центральной панели отобразятся только результаты выбранного режима сравнения. В режимах Сопоставленные и Одинаковые в таблице маркеров добавится столбец с номером версии: V1 – маркер в файле текущего снимка, V2 – маркер в файле целевого снимка.

Если при просмотре кода файла целевого снимка перейти к просмотру файла в режиме Код (команда Открыть в режиме код), то режим сравнения закроется, отобразится контекст целевого снимка.

• 

  Пример результатов сравнения в режиме Только в V1

• 

  Пример результатов сравнения в режиме Только в V2

• 

  Пример результатов сравнения в режиме Сопоставленные

• 

  Пример результатов сравнения в режиме Одинаковые

5. Посмотрите различия в параметрах анализа – нажмите кнопку Показать различия на вкладке Информация о различиях.

Сравнение настроек анализа

6. Посмотрите различия в статистике разметки – нажмите кнопку Различия разметок.

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

7. Нажмите кнопку или , чтобы скачать статистику в формате CSV или PDF.

8. Отмените сравнение – нажмите кнопку в блоке выбора проекта, ветки и снимка.

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

Функциональность доступна пользователям с проектным доступом Разметка маркеров и серверным доступом Администрирование сервера

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

Результат сопоставления, выполненного вручную, можно отменить.

Сопоставление маркеров вручную

Сопоставление маркеров вручную проводится в два этапа:

а) Выбор пар маркеров и их сопоставление, без сохранения в БД.

б) Просмотр выбранных пар и подтверждение операции.

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

1. Выберите исходный контекст.

2. В режиме разметки нажмите кнопку и в раскрывшемся списке выберите пункт Сопоставить маркеры.

Откроется окно Сопоставить маркеры.

3. Этап 1. На вкладке Сопоставление маркеров:

а) Выберите снимок, маркеры которого нужно сопоставить с исходным.

Отобразятся две таблицы маркеров: слева – для исходного снимка, а справа – для выбранного.

б) Выберите маркеры для сопоставления – по одному в каждой таблице и нажмите кнопку Сопоставить (расположена над таблицей). Если требуется, повторите операцию для других пар маркеров.

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

в) Для отмены сопоставления пары маркеров выберите любой сопоставленный маркер и нажмите Отменить сопоставление (расположена над таблицей). Если требуется, повторите операцию для других пар маркеров.

г) Для просмотра фрагмента кода, в котором находится маркер – нажмите кнопку .

д) Для отказа от дальнейшего сопоставления и отмены всех изменений нажмите кнопку Отмена.

е) Для перехода к подтверждению выбора нажмите кнопку Далее.

Окно «Сопоставить маркеры». Выбор снимка и сопоставление пар маркеров

4. Этап 2. В открывшейся форме:

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

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

в) Для отказа от дальнейшего сопоставления и отмены всех изменений нажмите кнопку Отмена.

г) Для запуска операции сопоставления нажмите кнопку Подтвердить.

Окно «Сопоставить маркеры». Подтверждение сопоставления

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

Сообщение об окончании операции сопоставления

При сопоставлении метки маркеров удаляются.

Отмена операций сопоставления

Отмена операций ручного сопоставления маркеров проводится в два этапа:

а) Выбор операций ручного сопоставления для отмены (отката).

б) Просмотр списка всех операций, которые будут отменены, и подтверждение отмены операций сопоставления.

Чтобы отменить (откатить) операции сопоставления:

1. Выберите исходный контекст.

2. В режиме разметки нажмите кнопку и в раскрывшемся списке выберите пункт Сопоставить маркеры.

Откроется окно Сопоставить маркеры.

3. Этап 1. На вкладке Отмена операций сопоставления:

а) Выберите операции сопоставления маркеров, которые нужно отменить.

В списке отображаются операции ручного сопоставления маркеров в исходной ветке проекта.

б) Для отказа от продолжения операции нажмите кнопку Отмена.

в) Для перехода к подтверждению выбора нажмите кнопку Далее.

Окно «Сопоставить маркеры». Выбор операций сопоставления маркеров для отмены

4. Этап 2. В открывшейся форме:

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

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

в) Для отказа от продолжения операции нажмите кнопку Отмена.

г) Для запуска операции отмены сопоставления маркеров нажмите кнопку Подтвердить.

Окно «Сопоставить маркеры». Подтверждение отмены операций сопоставления

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

Сообщение об окончании операции отмены сопоставления

При отмене операции сопоставления метки маркеров удаляются.

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

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

1. В режиме разметки выберите исходный контекст.

2. Раскройте таблицу маркеров.

3. Нажмите правой кнопкой мыши на строке маркера и выберите пункт Сравнить с ...

Переход к сравнению маркеров

Откроется окно выбора маркера для сравнения.

Окно выбора маркера для сравнения

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

4. Выберите проект, ветку и снимок.

Отобразится список маркеров в выбранном снимке, где можно ввести запрос для поиска маркеров.

Выбор маркера для сравнения

5. Дважды кликните на строке маркера или нажмите кнопку Сравнить, чтобы перейти в окно сравнения маркеров.

Окно сравнения маркеров

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

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

• 

  Выбор статуса разметки маркера

• 

  Выбор серьезности разметки маркера

• 

  Выбор действия разметки маркера

• 

  Кнопки разметки в виджете маркера на вкладке с исходным кодом

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

Окно разметки. Поле Комментарий – обязательное

Результаты разметки со связанными комментариями отображаются в правой панели на вкладке Комментарии. При этом можно поменять текст комментария, но не результат разметки. Для её изменения нужно заново установить статус, серьёзность и действие.

Правая панель. Комментарии, добавленные при разметке

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

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

1. В режиме разметки выберите исходные проект, ветку и снимок.

2. Включите отображение таблицы маркеров.

3. Выберите маркеры для разметки – установите флажки в строках таблицы.

4. Нажмите кнопку (доступна, если выбраны маркеры в таблице).

Выбор маркеров для групповой разметки

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

Окно групповой разметки

5. Разметьте выбранные маркеры: выберите статус разметки, а затем (опционально) статус серьезности (критичности) и требуемое действие – нажмите кнопки со значениями.

6. Добавьте общий комментарий для выбранных маркеров.

После того, как пользователь присвоил статусы и (или) написал комментарий, станет доступной кнопка Применить.

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

7. Если требуется отменить изменения, нажмите в правом верхнем углу окна или кнопку Отмена.
Диалоговое окно закроется, изменения не будут применены, выделение с выбранных для разметки маркеров не снимается.

9. Нажмите кнопку Применить, чтобы запустить процесс разметки.

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

• 

  Окно прогресса разметки

• 

  Пример таблицы маркеров после применения групповой разметки

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

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

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

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

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

3. В верхней части правой панели. В этом случае блокировка распространяется на все эквивалентные маркеры в открытом проекте и ветке, для всех снимков ветки.

• 

  Блокировка маркера на вкладке Детекторы

• 

  Блокировка маркера на вкладке Файлы

• 

  Блокировка маркера на правой панели

Если один пользователь заблокировал маркер, то другой пользователь не сможет заблокировать детектор, которому принадлежит этот маркер, и файл, в котором этот маркер найден.

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

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

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

Добавление комментария к нескольким маркерам

Для добавления комментария к нескольким маркерам одновременно:

1. В режиме разметки выберите исходный контекст – проект, ветку, снимок.

2. Включите отображение таблицы маркеров.

3. Выберите маркеры для разметки – установите флажки в строках таблицы.

4. Нажмите кнопку (доступна, если выбраны маркеры в таблице).

Выбор маркеров для добавления комментария к нескольким маркерам одновременно

5. Отобразится окно для добавления комментария к нескольким маркерам одновременно.

Окно добавления комментария к нескольким маркерам одновременно

6. Введите комментарий.

7. Нажмите кнопку Сохранить.

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

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

1. В режиме разметки выберите исходный контекст – проект, ветку и снимок.

2. На вкладке Информация о снимке в строке свойства ID нажмите кнопку Экспорт кода.

Переход к экспорту кода с разметкой

3. В открывшемся окне:

а) Если требуется экспортировать разметку, установите флажок параметра Шаблон разметки и выберите шаблон для экспорта в списке справа.

б) Опционально заполните поля для удаления префиксов и исключения путей.

в) Опционально включите или выключите очистку старых комментариев.

г) Опционально введите регулярные выражения для очистки дополнительных строк (доступен, если включена очистка старых комментариев).

Окно экспорта кода с разметкой

Пример удаления префиксов путей: /.build/

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

4. Нажмите кнопку Применить.

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

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

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

1. Выберите исходный контекст.

2. Перейдите в режим разметки.

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

Переход к просмотру статистики

Отобразится таблица статистики:

Таблица статистики

4. Нажмите кнопку или , чтобы выгрузить статистику в соответствующем формате.

5. Нажмите кнопку в строке статистики, чтобы применить пользовательский фильтр с параметрами, которые соответствуют выбранному значению.

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

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

Для этого:

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

2. Выберите исходный контекст.

По умолчанию выбран контекст (проект, ветка), заданный ранее в режиме Разметка или Отчеты. Если Пользователь перешел в раздел Кoд из режима сравнения снимков раздела Разметка, то для изменения контекста требуется отменить режим сравнения.

В левой части экрана отобразится иерархический список файлов снимка, а в правой – поле для отображения исходного кода файла.

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

3. Для поиска файла:

а) Кликните на поле поиска или нажмите комбинацию клавиш Ctrl+Shift+O.

б) В открывшемся окне введите поисковый запрос и выберите файл.

4. В левой части экрана раскройте группу файлов и нажмите на имя файла.

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

Пример одного открытого файла

5. Если требуется, откройте другие файлы.

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

Пример трёх открытых файлов

6. Для перехода к предыдущей или следующей строке, в которую пользователь устанавливал курсор, используйте кнопки и или сочетания клавиш Ctrl+< и Ctrl+>.

7. Вызовите функции, доступные по нажатию правой кнопки мыши на строке исходного кода

• Перейти к объявлению – для перехода к строке, в которой объявлена переменная;
• Перейти к определению – для перехода к строке, в которой определена переменная и функция;
• Найти ссылки – для просмотра ссылок в панели с иерархическим списком файлов, именами файлов и номерами строк, в которых найдены ссылки;

Если для выделенного элемента кода нет объявления, определения или ссылок, то отобразится сообщение: , или .

Cписок файлов с номерами строк, в которых найдены ссылки

• Копировать прямую ссылку – копирование ссылки на строку кода в буфер обмена.

При переходе по этой ссылке будет открываться файл в режиме просмотра кода с курсором на той строке кода, для которой была скопирована ссылка;

• Уменьшить и Увеличить – увеличение и уменьшение размера шрифта кода (эти функции также можно вызвать с помощью сочетаний клавиш Ctrl+Alt+- или Ctrl+Alt+=).
• Copy – для копирования строки в буфер обмена;
• Command Palette – для вызова командной строки.

6. Установите курсор в строке кода, чтобы отобразилось его позиционирование в правом нижнем углу.

Отображение позиционирования курсора в коде

7. Сравните файлы – для этого:

а) Нажмите правой кнопки мыши на имени файла и выберите пункт Сравнить с…

Переход к сравнению файлов

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

По умолчанию выбраны проект и ветка исходного контекста.

в) Нажмите кнопку Сравнить.

Откроется окно сравнения файлов.

Окно выбора файла для сравнения

Окно сравнения файлов

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

В разделе Проекты отображаются все проекты со всеми ветками и снимками. Для удобства работы проекты могут быть сгруппированы. Один проект может быть включен в несколько групп проектов.

Раздел Проекты

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

Список проектов отображается в левой части экрана и организован в виде иерархии. При этом:

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

В списке доступны:

• поиск по имени проекта;
• фильтрация списка по группам проектов;
• сортировка по названию или дате создания (по умолчанию – по названию).

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

1. Загрузка актуальных данных с сервера – для этого нажмите кнопку .

2. Просмотр списка веток – для этого нажмите на название проекта.

Ветки отобразятся в этом же списке проекта на втором уровне.

3. Просмотр списка снимков – для этого нажмите на название ветки.

Список снимков отобразится в виде таблицы в правой части экрана.

4. Группировка проектов.

5. Создание проекта:

а) Нажмите кнопку Создать проект.

Откроется окно создания проекта.

Окно создания проекта

б) Введите название проекта.

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

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

г) Для создания одной новой группы введите ее название и нажмите кнопку Создать в появившейся форме:

Окно создания проекта. Пример создания одной группы

д) Для создания нескольких новых групп введите их названия через запятую и нажмите кнопку Создать в появившейся форме:

Окно создания проекта. Пример создания двух групп

е) Установите флажок, если требуется при разметке маркеров обязательно добавлять комментарий.

ж) Нажмите кнопку Создать.

При создании проекта автоматически создается ветка master.

При импорте снимка в интерфейсе командной строки проект, при его отсутствии, добавляется автоматически.

6. Добавление ветки:

Окно добавления ветки в проект

а) Нажмите кнопку в строке проекта.

б) В меню выберите пункт Создать ветку.

в) В открывшемся окне введите название ветки и нажмите кнопку Создать.

При импорте снимка в интерфейсе командной строки ветка, при ее отсутствии, добавляется автоматически.

7. Клонирование проекта со всеми ветками и снимками:

Окно клонирования проекта

а) Нажмите кнопку в строке проекта.

б) В меню выберите пункт Клонировать.

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

9. Редактирование параметров проекта:

а) Нажмите кнопку в строке проекта.

б) В меню выберите пункт Редактировать.

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

10. Удаление одного проекта:

а) Нажмите кнопку в строке проекта.

б) В меню выберите пункт Удалить.

в) Подтвердите удаление.

11. Удаление нескольких проектов с ветками:

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

б) Нажмите кнопку Удалить в верхней части списка проектов и подтвердите удаление.

При удалении проекта удаляются все его ветки и снимки, разрывается связь проекта с группами.

Работа с группами проектов

Работа с группами проектов доступна на отдельной панели Группы проектов, которая отрывается по нажатию кнопки в списке проектов. При этом в нижней части списка отображается общее количество групп.

В списке групп доступны:

• поиск по названию группы;
• фильтрация списка по проектам.

Панель Группы проектов

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

1. Просмотр списка связанных с группой проектов – для этого нажмите на название группы.

Проекты отобразятся в этом же списке групп на втором уровне.

2. Добавление группы:

Окно Создать группу

а) Нажмите кнопку Создать группу.

б) В открывшемся окне введите название группы и выберите проекты, которые в неё войдут, нажмите кнопку Создать.

Созданная группа отобразится в списке на панели Группы проектов.

3. Редактирование параметров группы:

Окно Редактировать группу

а) Нажмите кнопку в строке группы.

б) В открывшемся окне измените название группы, скорректируйте состав включенных в группу проектов.

в) Нажмите на кнопку справа от названия проекта в списке, чтобы исключить его из группы.

г) Нажмите кнопку Сохранить.

4. Исключение одного проекта из группы – для этого нажмите кнопку в правой части списка проектов группы.

5. Удаление одной группы – для этого нажмите кнопку в правой части списка групп и подтвердите удаление.

6. Удаление нескольких групп:

а) Выберите группы для удаления – установите флажки в левой части названий групп или нажмите кнопку Выбрать всё.

б) Нажмите кнопку Удалить в верхней части списка групп проектов и подтвердите удаление.

При удалении группы разрывается связь проекта с группой. Сами проекты не удаляются.

Работа с ветками

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

1. Просмотр списка снимков – для этого нажмите на название ветки.

Список снимков отобразится в виде таблицы в правой части экрана.

2. Редактирование ветки:

Окно редактирования ветки

а) Нажмите кнопку в строке ветки.

б) В меню выберите пункт Редактировать.

в) В открывшемся окне измените название ветки и нажмите кнопку Сохранить.

3. Клонирование ветки проекта:

Окно клонирования ветки

а) Нажмите кнопку в строке ветки.

б) В меню выберите пункт Клонировать.

в) В открывшемся окне введите название новой ветки и нажмите кнопку Клонировать.

4. Удаление ветки:

а) Нажмите кнопку в строке ветки.

б) В меню выберите пункт Удалить.

в) Подтвердите удаление.

При удалении ветки удаляются все ее снимки.

5. Очистка разметки:

Окно очистки разметки

а) Нажмите кнопку в строке ветки.

б) В меню выберите пункт Очистить разметку.

в) В открывшемся окне выберите вариант очистки.

г) Нажмите кнопку Очистить.

Функциональность доступна пользователям с проектными доступами Управление ветками и снимками, Разметка маркеров и серверным доступом Администрирование сервера.

6. Копирование разметки в другой контейнер (проект и ветку):

Окно копирования разметки в другой контейнер

а) Нажмите кнопку в строке ветки и в меню выберите пункт Копировать разметку.

б) В открывшемся окне выберите проект и ветку, в которые нужно скопировать разметку, а также действия, которые нужно выполнить при наличии разметки.

в) Нажмите кнопку Копировать.

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

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

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

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

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

Пример

Есть несколько контейнеров:

• 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.

При выполнении копирования наличие маркера в ветке-приемнике не проверяется.

При успешном копировании выводится всплывающее сообщение с описанием выполненных операций:

Пример всплывающего сообщения об успешном копировании разметки

Работа со снимками

Список снимков отображается в правой части экрана в виде таблицы после выбора ветки проекта. При этом в нижней части списка отображается общее количество снимков в выбранной ветке и количество выбранных снимков. В списке доступны:

• поиск по названию снимка;
• сортировка по значениям столбцов (по умолчанию — по дате создания).

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

1. Импорт снимка из файла – для этого нажмите кнопку Импорт в верхней части табличного списка снимков и в открывшемся списке выберите один из вариантов импорта: Снимок (*.snap) или Архив .svace-dir.

После этого:

а) Если выбран импорт из файла в формате snap, то в открывшемся окне выберите файл в формате .snap, введите название снимка (опционально) и нажмите кнопку Импортировать.

Окно импорта снимка из файла в формате snap

Если при импорте снимка из snap-файла название не введено, то будет использовано название исходного снимка (параметр «name» в JSON с информацией о снимке).

б) Если выбран импорт архива .svace-dir, то в открывшемся окне:

• выберите архив .svace-dir;
• введите название снимка (опционально);
• выберите шаблон разметки (опционально);
• укажите правила префикса пути (опционально);
• введите расширенные настройки (опционально);
• нажмите кнопку Импортировать.

Окно импорта снимка из архива в формате svace-dir

Функциональность доступна пользователям с проектным доступом Импорт снимков и серверным доступом Public API

Примечание:

• для импорта поддерживаются архивы папки .svace-dir, заархивированные с помощью tar, gz, bz2 или zip (*.tar, *.tar.gz, *.tar.bz2, *.zip);
• если при импорте архива .svace-dir название снимка не введено, то оно будет соответствовать времени импорта результатов анализа из Svace;
• в поле Расширенные настройки поддерживается ввод дополнительных опций команды svacer import – как в интерфейсе командной строки (например, --attach value). В аргументах дополнительных опций требуется указывать пути относительно архивированной папки. Описание опций можно найти, запустив команду svacer import --help.
• для импорта снимка из snap-файла или .svace-dir может потребоваться много времени: как на загрузку, так и на обработку данных после загрузки. При работе сервера Svacer за reverse proxy их дефолтных значений таймаутов или ограничений на размер загружаемых данных может быть недостаточно, поэтому рекомендуется увеличить эти значения в конфигурационных файлах reverse proxy, см. пример для Nginx

2. Переход к разметке маркеров снимка:

а) Нажмите кнопку в крайнем правом столбце строки снимка.

б) В меню выберите пункт Разметить.

3. Редактирование снимка:

а) Нажмите кнопку в крайнем правом столбце строки снимка.

б) В меню выберите пункт Редактировать.

в) Поменяйте название и нажмите кнопку Сохранить.

Окно редактирования снимка

4. Экспорт снимка в файл формата .snap:

а) Нажмите кнопку в крайнем правом столбце строки снимка.

б) В меню выберите пункт Экспортировать.

5. Импорт разметки из комментариев исходного кода снимка в активную ветку проекта:

а) Нажмите кнопку в крайнем правом столбце строки снимка.

б) В меню выберите пункт Импорт разметки.

в) В открывшемся окне выберите шаблон разметки и нажмите кнопку Импортировать.

Окно импорта разметки

6. Просмотр информации о снимке в JSON-формате:

а) Нажмите кнопку в строке снимка крайнем правом столбце.

б) В меню выберите пункт Просмотреть JSON.

Окно просмотра информации о снимке в JSON-формате

7. Удаление одного снимка:

а) Нажмите кнопку в строке снимка крайнем правом столбце.

б) В меню выберите пункт Удалить.

в) Подтвердите удаление.

8. Удаление нескольких снимков:

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

б) Чтобы выбрать несколько снимков, установите флажки в крайнем правом столбце табличного списка.

в) Нажмите кнопку Удалить в верхней части табличного списка снимков и подтвердите удаление.

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

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

1. Выберите контекст.

По умолчанию выбран контекст (группа проектов, проект, ветка), заданный ранее в режиме Разметка или Код. Если Пользователь перешел в раздел Отчеты из режима сравнения снимков раздела Разметка, то для изменения контекста требуется отменить режим сравнения.

2. Перейдите в раздел Отчеты в верхней части экрана.

Отобразится форма формирования отчетов:

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

3. На панели слева выберите требуемый отчет: Общий отчет или Тренды.

4. Выберите текущий и целевой снимки:

Выбор снимков для формирования отчета

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

6. Нажмите кнопку для выгрузки отчета в формате .json.

• 

  Пример общего отчета. Часть 1

• 

  Пример общего отчета. Часть 1

• 

  Пример общего отчета. Часть 2

• 

  Пример общего отчета. Часть 3

• 

  Пример общего отчета. Часть 4

• 

  Пример общего отчета. Часть 5

Пример отчета Тренды

Просмотр детекторов

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

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

В разделе отображается список детекторов той версии, которая указана вверху раздела.

При обновлении списка детекторов и их параметров в Svace изменения попадают в Svacer при выпуске новой версии системы!

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

1. Поиск детектора по его названию, серьезности, надежности и коду дефекта безопасности CWE.

2. Сортировка по значениям столбцов (по умолчанию – по названию детектора).

3. Переход к просмотру описания дефекта безопасности на сайте cwe.mitre.org (открывается в отдельном окне) – для этого нажмите на ссылку в столбце CWE.

4. Просмотр дополнительной информации о детекторе при её наличии – для этого нажмите на иконку справа от названия детектора.

Раздел «Детекторы». Пример окна с дополнительной информацией о детекторе

5. Фильтрация списка – для этого:

а) Нажмите кнопку .

б) В открывшемся окне Фильтр настройте параметры фильтрации – выберите значения в списках полей или нажмите кнопки со значениями.

в) Нажмите кнопку , чтобы очистить все параметры фильтрации.

г) Нажмите кнопку , чтобы применить фильтр.

Раздел «детекторы». Окно «Фильтр»

6. Отмена примененных фильтров – для этого нажмите кнопку .

7. Выбор отображаемых столбцов – для этого нажмите на кнопку Столбцы и в открывшемся списке установите или снимите флажки рядом с названиями столбцов.

Для настройки скрытия или показа доступны все столбцы, кроме Детектор. Столбцы Статус и Инструменты по умолчанию скрыты.

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

Раздел «Детекторы». Выбор отображаемых столбцов

8. Экспорт списка детекторов в файл формата PDF – нажмите кнопку Экспорт в PDF.

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

Просмотр статистики

В разделе Статистика пользователь может посмотреть статистические данные о разметке по всем проектам, веткам и снимкам, доступным пользователю.

Раздел Статистика. Начальное состояние

Чтобы посмотреть информацию:

1. Выберите контекст (опционально).

2. Нажмите кнопку .

Если контекст не был выбран, отобразится статистика по всем проектам, веткам и снимкам, доступным пользователю.

Раздел Статистика. Контекст не выбран. Отображается статистика всех проектов, веток и снимков

Если контекст был выбран, то отобразится статистика за месяц только для выбранных проектов, веток и снимков.

Раздел Статистика. Контекст выбран. Отображается статистика только выбранных проектов, веток и снимков

Информация в разделе Статистика разделена на две части:

а) Информация о выбранном контексте, которая содержит:

• информацию о количестве проектов, веток и снимков [1];
• диаграмму Количество маркеров по серьезности [2];
• диаграмму Количество маркеров по статусу разметки [3];
• диаграмму Распределение маркеров по языкам [4];

Раздел Статистика. Информация о выбранном контексте

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

• диаграмма Активность по разметке, отражающая активность пользователей по разметке маркеров за выбранный месяц (по умолчанию – текущий месяц) – эта диаграмма отображается по умолчанию; если вид был переключен, то для возврата к этой диаграмме нажмите кнопку ;
• диаграмма Лидеры по разметке, отражающая количество действий пользователей при разметке за выбранный период (по умолчанию – период соответствует месяцу, указанному на диаграмме Активность по разметке) с сортировкой по лидерам – отображается по нажатии кнопки ;

Из диаграмм Активность по разметке и Лидеры по разметке можно открыть детализацию действий пользователей по разметке. Измененная (неактуальная) разметка будет отмечена иконкой . См. описание и рисунки ниже в этом разделе.

Раздел Статистика. Информация о действиях пользователей. Вид 1: диаграмма Активность по разметке

Раздел Статистика. Информация о действиях пользователей. Вид 1: диаграмма Лидеры по разметке

3. Наведите курсор на любой графический элемент любой диаграммы, чтобы посмотреть информацию о соответствующем ему значении.

4. Нажмите кнопку в любой диаграмме, чтобы выгрузить её данные в файл формата .csv.

5. В диаграмме Активность по разметке:

а) Чтобы найти конкретного пользователя, введите фрагмент его логина в поле поиска.

б) Чтобы посмотреть статистику за любой другой месяц, выберите год и месяц в раскрывающихся списках вверху диаграммы.

в) Чтобы посмотреть активность конкретного пользователя за выбранный месяц, нажмите на его логин.

Ниже диаграммы Активность по разметке отобразится список действий по разметке выбранного пользователя.

Раздел Статистика. Диаграмма Активность по разметке и список действий по разметке выбранного пользователя

г) Чтобы посмотреть активность пользователей в конкретный день месяца, нажмите на число.

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

Раздел Статистика. Диаграмма Активность по разметке и список действий по разметке пользователей за выбранную дату

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

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

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

е) В списке действий нажмите на ссылку с именем файла и номером строки, чтобы перейти к просмотру маркера в режиме разметки.

6. В диаграмме Лидеры по разметке:

а) Чтобы найти конкретного пользователя, введите фрагмент его логина в поле поиска.

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

Раздел Статистика. Диаграмма Лидеры по разметке. Выбор диапазона дат

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

Ниже диаграммы Лидеры по разметке отобразится список действий по разметке выбранного пользователя.

Раздел Статистика. Диаграмма Лидеры по разметке и список действий по разметке выбранного пользователя

г) В списке действий нажмите на ссылку с именем файла и номером строки, чтобы перейти к просмотру маркера в режиме разметки.

Глобальный поиск

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

• Маркеры;
• Комментарии к маркерам;
• Снимки.

Чтобы воспользоваться глобальным поиском, перейдите в раздел Поиск.

Раздел Поиск. Начальное состояние

Для каждой категории реализованы два независимых способа поиска в виде вкладок:

• Базовый поиск – единый поисковый запрос по всем атрибутам категории одновременно, с указанием контекста;
• Поиск по полям – позволяет задать значения поиска по каждому атрибуту категории в отдельности и указать контекст.

Поиск маркеров

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

1. Выберите категорию Маркеры раздела Поиск (выбран по умолчанию).

2. Для базового поиска:

а) Перейдите на вкладку Базовый поиск (открыта по умолчанию).

Раздел Поиск. Категория Маркеры. Базовый поиск

б) Введите фрагмент названия маркера, детектора, функции или файла.

в) Выберите (опционально) группу проектов, проект, ветку и снимок, в которых нужно найти маркеры.

По умолчанию выбраны все группы, проекты, ветки и снимки.

г) Нажмите кнопку Поиск.

Отобразятся результаты поиска.

Раздел Поиск. Пример результатов поиска в категории Маркеры

3. Для поиска по полям:

а) Перейдите на вкладку Поиск по полям.

Раздел Поиск. Категория Маркеры. Поиск по полям

б) Заполните поля поиска.

в) Выберите (опционально) группу проектов, проект, ветку и снимок, в которых нужно найти маркеры.

По умолчанию выбраны все группы, проекты, ветки и снимки.

г) Нажмите кнопку Поиск.

Отобразятся результаты поиска.

Раздел Поиск. Пример результатов поиска по полям в категории Маркеры

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

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

Найденный маркер откроется в режиме разметки.

Поиск комментариев к маркерам

Чтобы воспользоваться поиском по комментариям к маркерам:

1. Выберите категорию Комментарии к маркерам раздела Поиск.

2. Для базового поиска:

а) Перейдите на вкладку Базовый поиск (открыта по умолчанию).

Раздел Поиск. Категория Комментарии к маркерам. Базовый поиск

б) Введите фрагмент комментария или логина его автора.

в) Выберите (опционально) группу проектов, проект, ветку и снимок, в которых нужно найти комментарии.

По умолчанию выбраны все группы, проекты, ветки и снимки.

г) Нажмите кнопку Поиск.

Отобразятся результаты поиска.

Раздел Поиск. Пример результатов поиска в категории Комментарии к маркерам

3. Для поиска по полям:

а) Перейдите на вкладку Поиск по полям.

Раздел Поиск. Категория Комментарии к маркерам. Поиск по полям

б) Заполните поля поиска.

в) Выберите (опционально) группу проектов, проект, ветку и снимок, в которых нужно найти комментарии.

По умолчанию выбраны все группы, проекты, ветки и снимки.

г) Нажмите кнопку Поиск.

Отобразятся результаты поиска.

Раздел Поиск. Пример результатов поиска по полям в категории Комментарии к маркерам

4. Для очистки поискового запроса нажмите кнопку Очистить.

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

Найденный маркер с комментарием откроется в режиме разметки.

Поиск снимков

Чтобы воспользоваться поиском по снимкам:

1. Выберите категорию Снимки раздела Поиск.

2. Для базового поиска:

а) Перейдите на вкладку Базовый поиск (открыта по умолчанию).

Раздел Поиск. Категория Снимки. Базовый поиск

б) Введите фрагмент названия снимка, пользовательского поля снимка (названия или его значения) или логина пользователя, который импортировал снимок.

в) Выберите (опционально) группу проектов, проект, ветку и снимок, в которых нужно найти снимки.

По умолчанию выбраны все группы, проекты, ветки и снимки.

г) Нажмите кнопку Поиск.

Отобразятся результаты поиска.

Раздел Поиск. Пример результатов поиска в категории Снимки

3. Для поиска по полям:

а) Перейдите на вкладку Поиск по полям.

Раздел Поиск. Категория Снимки. Поиск по полям

б) Заполните поля поиска.

в) Выберите (опционально) группу проектов, проект, ветку и снимок, в которых нужно найти снимки.

По умолчанию выбраны все группы, проекты, ветки и снимки.

г) Нажмите кнопку Поиск.

Отобразятся результаты поиска.

Раздел Поиск. Пример результатов поиска по полям в категории Снимки

4. Для очистки поискового запроса нажмите кнопку Очистить.

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

Найденный снимок откроется в режиме разметки со всеми его маркерами.

Просмотр истории поиска

Чтобы посмотреть историю поиска, нажмите кнопку История поиска в разделе Поиск.

В истории отображаются 100 последних поисковых запросов пользователя.

Раздел Поиск. Пример истории поиска

Чтобы повторить поиск из истории, кликните на ссылку с поисковым запросом.

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

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

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

• управление пользователями, ролями и организациями;
• настройка глобальных фильтров;
• управление блокировками;
• управление шаблонами разметки;
• просмотр информации о сервере;
• управление клиентами OAuth.

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

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

Реестром учетных записей пользователей можно управлять на вкладке Пользователи в разделе Управление пользователями страницы Настройки.
Для учетных записей с доступом по LDAP рядом с логином отображается индикатор , для учетных записей с доступом по OIDC рядом с логином отображается индикатор , а для учетных записей с признаком Мастер разметки – индикатор .
В разделе доступны:

• поиск по атрибутам учётной записи пользователя;
• фильтрация списка по типам учётных записей:

• все;
• системные;
• LDAP;
• OIDC;
• заблокированные;
• активные;
• по ролям;
• по организациям.

• сортировка по колонкам Логин, ФИО и Дата создания (по умолчанию).

Вкладка Пользователи в разделе Управление пользователями страницы Настройки

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

1. Создайте учетную запись пользователя:

а) Нажмите кнопку Создать.

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

Окно Создать пользователя

б) Заполните поля:

• Логин;
• Пароль;
• e-mail;
• ФИО.

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

г) Включите опции Изменить пароль при первом входе в систему и Мастер разметки.

Если для учётной записи активирована опция Мастер разметки, есть разрешение на разметку и этот пользователь разметил маркер в каком-либо снимке, то изменить его разметку может только пользователь, в учётной записи которого также активирована опция Мастер разметки или которому предоставлен серверный доступ Изменение любой разметки.

д) Нажмите кнопку Создать.

В таблице со списком пользователей добавится новая запись.

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

• Редактировать – для перехода к редактированию данных профиля;
• Изменить пароль – для перехода к изменению пароля;
• Сбросить настройки пользователя – для возврата пользовательских настроек к их значениям по умолчанию;
• Заблокировать – для блокировки учетной записи. В этом случае для учетной записи пользователя блокируется доступ к системе, а в списке рядом с логином учетной записи отображается индикатор ;
• Разблокировать – для восстановления доступа пользователя к системе;
• Удалить – для удаления учётной записи пользователя;
• Показать доступы пользователя – для отображения списка объединенных доступов всех ролей, назначенных пользователю:

Список доступов пользователя

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

3. Воспользуйтесь функциями управления несколькими учётными записями одновременно:

а) Чтобы выбрать несколько записей, установите флажки в первом столбце списка пользователей.

б) Чтобы выбрать все отображаемые учётные записи, установите один флажок в заголовке столбцов в первом столбце списка.

в) Нажмите кнопку Действия в верхней части списка пользователей и выберите пункт: Сбросить настройки пользователя, Заблокировать, Разблокировать или Удалить. В списке активны только действия, доступные всем выбранным учетным записям.

4. Для учетной записи с доступом по LDAP обновите данные – в окне редактирования данных профиля пользователя нажмите кнопку Загрузить из LDAP.

Загрузятся параметры профиля пользователя и его контакты из профиля в службе каталогов, если они там указаны.

Загрузка данных из LDAP

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

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

Вкладка Роли в разделе Управление пользователями страницы Настройки

Роли admin, filter_master и importer являются встроенными с особым значением. Их нельзя удалить или изменить.

Доступен поиск по названию роли и сортировка по колонкам Название (по умолчанию) и Пользователи.
Для управления ролями доступны следующие функции:

1. Создание новой роли:

а) Нажмите кнопку Создать.

Окно добавления роли

б) Заполните поля появившейся формы:

• введите название роли;
• в блоке Серверные доступы выберите доступы – нажмите кнопку Выбрать всё или установите флажки для активации доступов.

При наведении курсора на иконку отображается пояснение к доступу.

• в блоке Проектные доступы выберите тип доступа: группа проектов или определённый проект или его ветка;
• если выбран тип Группа проектов, выберите название группы и установите флажки для активации доступов;
• если выбран тип Проект / Ветка, выберите название проекта или ветки проекта, установите флажки для активации доступов.

Если выбрано значение Все, то доступы будут предоставлены для всех проектов;

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

в) Нажмите кнопку Создать.

2. Просмотр доступов роли, нажмите на ссылку Показать доступы в столбце Доступы.

Список доступов роли

3. Редактирование роли:

а) Нажмите кнопку в строке роли в крайнем правом столбце.

б) В меню выберите пункт Редактировать и внесите изменения.

4. Создание копии роли:

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

б) В меню выберите пункт Создать копию.

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

5. Просмотр информации о роли в JSON-формате:

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

б) В меню выберите пункт Просмотреть JSON.

6. Удаление роли:

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

б) В меню выберите пункт Удалить.

в) Подтвердите удаление.

7. Удаление несколько ролей одновременно:

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

б) Чтобы выбрать все записи, установите один флажок в заголовке столбцов в первом столбце списка ролей.

в) Нажмите кнопку Удалить и подтвердите удаление.

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

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

Вкладка Организации в разделе Управление пользователями страницы Настройки

Доступен поиск по названию и сокращенному названию организации и сортировка по колонкам Название (по умолчанию), Сокращенное название и Пользователи. Для управления организациями, доступны следующие функции:

1. Создание организации:

а) Нажмите кнопку Создать.

б) Заполните поля появившейся формы.

в) Нажмите кнопку Создать.

Окно добавления организации в реестр

2. Редактирование организации:

а) Нажмите кнопку в крайнем правом столбце.

б) В появившейся форме отредактируйте данные организации.

в) Нажмите кнопку Сохранить.

3. Удаление организации:

а) Нажмите кнопку в крайнем правом столбце.

б) В появившемся диалоге подтвердите удаление, нажав на кнопку Удалить.

4. Удаление несколько организаций одновременно:

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

б) Чтобы выбрать все организации, установите один флажок в заголовке столбцов в первом столбце списка.

в) Нажмите кнопку Удалить и подтвердите удаление.

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

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

По умолчанию выбран контекст (проект, ветка), заданный ранее в режиме Разметка, Код или Отчеты.

Раздел Глобальные фильтры на странице Настройки

В разделе доступен поиск по названию фильтра.

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

1. Выберите проект и ветку в верхней строке раздела. По умолчанию указаны проект и ветка, выбранные в разделе Разметка.

2. Чтобы добавить фильтр, нажмите кнопку Создать.

Отобразится новая строка:

Новая строка с фильтром

3. Чтобы изменить настройки фильтров:

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

б) Включите или выключите фильтр – нажмите на значение в столбце Статус, чтобы отобразилась иконка (по умолчанию) или .

в) Выберите область применения фильтра – нажмите на значение в столбце Область один или два раза, чтобы отобразилось значение ветка или проект.

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

Шаблоны регулярных выражений не зависят от регистра и поддерживают следующий синтаксис:

• ; – для разделения списков значений;
• * – любое количество символов;
• ? – один произвольный символ;
• re: – включая значения, определяемые регулярным выражением;
• re!: – исключая значения, определяемые регулярным выражением (только для столбца Детекторы).

д) Выберите уровни серьезности (критичности) и надежности:

• – уровень выбран;
• – уровень не выбран.

Для изменения выбора нажмите на название уровня.

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

5. Чтобы удалить несколько фильтров:

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

б) Чтобы выбрать все записи, установите один флажок в заголовке столбцов в первом столбце списка фильтров.

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

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

Если не применить изменения, то при переходе в другой раздел системы отобразится сообщение о том, что изменения не применены:

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

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

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

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

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

Доступен поиск по контейнерам, заблокированным сущностям и пользователям, сортировка по всем колонкам (по умолчанию – сортировка по дате).

Для удаления одной блокировки:

1. Нажмите кнопку в строке проекта в крайнем правом столбце.

2. Подтвердите удаление.

Для удаления нескольких блокировок:

1. Чтобы выбрать для удаления все блокировки, установите флажок в заголовке табличного списка.

2. Чтобы выбрать несколько блокировок, установите флажки в крайнем правом столбце табличного списка.

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

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

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

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

Шаблоны разметки нужны для импорта/экспорта разметки. С их помощью комментарии в исходном коде будут преобразовываться в разметку на сервере истории и обратно.

Шаблон с именем DEFAULT есть всегда, его нельзя отредактировать или удалить.

Для корректного создания или изменения шаблонов разметки следует обратиться к разработчикам Svacer.

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

1. Нажмите кнопку Создать.

Откроется окно создания шаблона.

Окно создания шаблона разметки

2. Введите название шаблона.

3. Нажмите кнопку Создать.

Шаблон появится в списке шаблонов для разметки в правой панели формы

4. Отредактируйте поля шаблона разметки:

Редактирование шаблона разметки

5. Нажмите Сохранить.

6. Чтобы клонировать существующий шаблон разметки, нажмите кнопку в правой части строки шаблона в списке.

7. Для удаления одного шаблона:

а) Нажмите кнопку в правой части строки шаблона в списке.

б) Подтвердите удаление.

8. Для удаления нескольких шаблонов:

а) Выберите шаблоны для удаления – установите флажки в левой части названий шаблонов или нажмите кнопку Выбрать всё.

б) Нажмите кнопку Удалить в верхней части списка шаблонов и подтвердите удаление.

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

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

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

Раздел Клиенты OAuth на странице Настройки

Доступен поиск по имени и домену клиента OAuth, сортировка по колонкам Название (по умолчанию) и Домен.

Для управления клиентами OAuth:

1. Создайте клиента OAuth:

а) Нажмите кнопку Создать.

б) В окне Создание клиента OAuth введите название и домен.

в) Нажмите кнопку Создать.

Окно Создание клиента OAuth

Отобразится окно с секретом клиента.

Секрет отображается только один раз – при создании клиента

г) Нажмите кнопку Скопировать в буфер обмена и сохраните секрет в надежном месте.

2. Чтобы скопировать ID клиента OAuth, нажмите кнопку .

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

4. Для удаления одного клиента OAuth:

а) Нажмите кнопку в крайнем правом столбце.

б) Подтвердите удаление.

5. Для удаления нескольких клиентов OAuth:

а) Чтобы выбрать для удаления все клиенты, установите флажок в заголовке табличного списка.

б) Чтобы выбрать несколько клиентов, установите флажки в крайнем правом столбце табличного списка.

в) Нажмите кнопку Удалить в верхней части табличного списка клиентов и подтвердите удаление.

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

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

• параметры, с которыми запущен сервер;
• логи сервера;
• журнал базы данных.

Раздел Информация о сервере на странице Настройки

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

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

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

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

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

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

Регулярные выражения можно использовать:

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

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

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

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

3. Поиск не зависит от регистра символов (case insensitive) и поддерживает следующий синтаксис:

• ; – для разделения списков значений;
• * – любое количество символов;
• ? – один произвольный символ.

В окне настройки пользовательских фильтров в блоке Файлы можно применить фильтр как для отображения только маркеров из файлов, которые подходят под паттерн, так и для скрытия таких маркеров. Для переключения между этими режимами используйте кнопки и , которые расположены рядом с полем ввода. В остальных частях интерфейса следует использовать теги re: и re!:

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

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}[^/]*$

где [^/]*$ означает, что после трех цифр и до конца строки может встречаться любой символ, кроме /. Это позволяет исключить директории, имеющие три цифры в названии.

Описание ролевой модели

Серверные доступы

Полномочие (доступ)	Описание	Влияние на графический интерфейс	admin	filter_master	importer
Создание проектов	Создание и клонирование проектов. Пользователь, создавший проект, имеет полный доступ к управлению этим проектом	Наличие полномочия делает доступным: раздел Проекты; кнопку Создать проект; форму создания, клонирования и редактирования проекта. Наличие доступа предоставляет автору проекта полные права на управление своими проектами, включая разметку (даже при отсутствии у него соответствующего проектного доступа), а также позволяет удалять приложения к снимкам в созданных проектах	+	–	–
Настройка групп проектов	Создание, редактирование и удаление групп проектов	Наличие полномочия делает доступным: раздел Проекты с кнопкой для перехода к настройке групп; панель Группы проектов с полным списком проектов в группах. Наличие доступа предоставляет права на просмотр маркеров во всех проектах	+	–	–
Управление пользователями	Создание, редактирование и удаление пользователей	Наличие полномочия делает доступной вкладку Пользователи в разделе Настройки – Управление пользователями со всеми функциями управления учетными записями пользователей	+	–	–
Управление ролями	Создание, редактирование и удаление ролей	Наличие полномочия делает доступной вкладку Роли в разделе Настройки – Управление пользователями со всеми функциями управления ролями	+	–	–
Управление организациями	Создание, редактирование и удаление организаций	Наличие полномочия делает доступной вкладку Организации в разделе Настройки – Управление пользователями со всеми функциями управления организациями	+	–	–
Управление шаблонами разметки	Создание, редактирование и удаление шаблонов разметки	Наличие полномочия делает доступным раздел Настройки – Шаблоны разметки со всеми функциями управления учетными записями шаблонами	+	–	–
Удаление блокировок	Просмотр и удаление блокировок всех пользователей	Наличие полномочия позволяет просматривать и удалять блокировки всех пользователей в разделе Настройки – Блокировки	+	–	–
Управление клиентами OAuth	Создание, редактирование и удаление клиентов OAuth	Наличие полномочия делает доступным раздел Настройки – Клиенты OAuth со всеми функциями управления клиентами OAuth	+	+	+
Администрирование сервера	Просмотр настроек сервера, системных лог-файлов и выполнение операций по администрированию сервера Svacer	Наличие полномочия делает доступным раздел Настройки – Информация о сервере Совместно с проектными доступами Управление ветками и снимками и Разметка маркеров становится доступна функция очистки разметки и комментариев в ветке	+	–	–
Управление публичными фильтрами	Публикация, редактирование и удаление публичных фильтров	Наличие полномочия позволяет публиковать сохраненные фильтры, а также редактировать и удалять публичные фильтры	+	–	–
Изменение любой разметки	Изменение любой разметки маркеров, включая выполненную пользователями с признаком Мастер разметки	Доступ позволяет переразмечать маркеры (добавлять новую разметку), которые разметили любые пользователи, в том числе те, для которых активирована опция Мастер разметки. При этом: Полномочие не предоставляет доступ ко всем проектам. Т. е. пользователь с таким полномочием может изменять разметку только в проектах, к которым у него имеется доступ. Для переразметки маркеров пользователю должен быть предоставлен проектный доступ Разметка маркеров. Чтобы переразметить заблокированный маркер, сначала нужно снять его блокировку	+	–	–
Изменение любых комментариев	Редактирование и удаление любых пользовательских комментариев к маркерам	Доступ позволяет изменять/удалять комментарии, которые создали любые пользователи, в том числе те, для которых активирована опция Мастер разметки. При этом: Полномочие не предоставляет доступ ко всем проектам. Т. е. пользователь с таким полномочием может изменять разметку только в проектах, к которым у него имеется доступ. Для добавления комментариев пользователю должно быть предоставлено проектное полномочие Разметка маркеров. Чтобы поменять комментарий к заблокированному маркеру, сначала нужно снять его блокировку	+	–	–
Создание резервных копий	Создание, просмотр и восстановление резервных копий в интерфейсе командной строки	–	+	–	–
Запуск скриптов	Запуск скриптов (hooks) по кнопке, расположенной на вкладке Подробности в правой панели, содержащей информацию о маркере	Наличие полномочия добавляет строку Хуки на вкладке Подробности правой панели с возможностью запуска скриптов	+	–	–
Использование Public API	Использование REST API для интеграции с внешними системами	–	+	–	–

Проектные доступы

Полномочие (доступ)	Описание	Влияние на графический интерфейс	admin	filter_master	importer
Управление проектом и его ветками	Редактирование и удаление проекта, включая операции по управлению ветками и снимками проекта, настройке глобальных фильтров, импорту/экспорту разметки и просмотру маркеров	Наличие полномочия делает доступным: раздел Проекты; все функции управления проектом (проектами в группе) и его содержимым (за исключением разметки маркеров) – т. е. все операции с проектом, ветками и снимками. Наличие полномочия позволяет удалять приложения к снимкам и экспортировать разметку с исходным кодом	+	–	–
Управление ветками и снимками	Редактирование и удаление ветки проекта, включая операции по управлению снимками, настройке глобальных фильтров, импорту/экспорту разметки и просмотру маркеров	Наличие полномочия делает доступным: раздел Проекты; все функции управления веткой и снимками проекта (за исключением разметки маркеров) – т. е. доступны все операции с веткой и снимками, но не операции управления проектом. Наличие полномочия позволяет удалять приложения к снимкам и экспортировать разметку с исходным кодом. Запрещено клонировать ветку при наличии доступа только к этой ветке	+	–	–
Настройка глобальных фильтров	Создание, редактирование и удаление глобальных фильтров	Наличие полномочия делает доступным раздел Настройки – Глобальные фильтры. Список проектов и веток в разделе определяется полномочиями к этим проектам и веткам	+	+	–
Импорт снимков	Загрузка, редактирование названия и удаление снимков	Наличие полномочия делает доступным: раздел Проекты; функции просмотра проекта и ветки, управления снимками в указанной ветке, просмотра маркеров в снимке	+	–	+
Импорт разметки	Импорт разметки из комментариев в исходном коде	Наличие полномочия делает доступным импорт разметки из снимка и просмотр маркеров в указанном контейнере	+	–	+
Экспорт снимков	Экспорт данных снимков с разметкой и их открытие в IDE	Наличие полномочия позволяет: экспортировать разметку с исходными кодами; экспортировать снимки; просматривать код с маркерами в Web-IDE. Т. е. полномочие определяет доступность кнопок Экспорт кода, Экспорт снимка и Открыть в IDE	+	–	+
Просмотр маркеров	Просмотр маркеров и кода снимков, просмотр блокировок маркеров	Наличие полномочия предоставляет доступ к следующим функциям в режиме разметки: просмотр и выбор снимков в указанном контейнере; просмотр содержимого снимков и маркеров (без возможности разметки). Также наличие полномочия предоставляет доступ к разделу Настройки – Блокировки, но только в части просмотра блокировок в доступных контейнерах, без возможности их удаления	+	+	+
Разметка маркеров	Просмотр и разметка маркеров в снимках, включая добавление комментариев, управление списком блокировок	Наличие полномочия позволяет пользователю размечать маркеры в указанном контейнере, добавлять комментарии, управлять своими блокировками, т. е. для собственных блокировок доступны кнопки удаления, а блокировки других пользователей доступны только для просмотра. При отсутствии полномочия в таблице маркеров недоступны поля для установки флажков, а кнопка групповой разметки – неактивна	+	–	–
Report API	Использование Report API для получения статистических показателей	–	+	–	–

Известные ограничения

• Управление своими проектами для пользователей только c серверной ролью "Create Projects" без дополнительных прав может не работать для проектов, созданных до Release 7-0-0.

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