Svacer Wiki - User contributions [en]

Help:Import from Svace

2026-02-10T11:48:09Z

Akuzmin: /* Флаг --baseline-check */ minor fixes

== CLI команды ==
svacer import --svace <path-to-svace>
svacer upload

Эти две команды импортируют результаты анализа из '''.svace-dir''' в текущей директории и загрузят их на сервер Svacer по адресу '''localhost:8080'''.

== Процесс импорта ==
Процесс импорта результатов работы статического анализатора Svace состоит из двух шагов:
# Дедупликация данных, предобработка, конвертирование во внутренний формат и сохранение результатов в промежуточном хранилище (svacer import).
# Загрузка данных из промежуточного хранилища на сервер (svacer upload).

Можно импортировать результаты и из других статических анализаторов, поддерживающих [[Help:Sarif#Загрузка на сервер из SARIF|формат SARIF]].

=== Промежуточное хранилище ===
Промежуточное хранилище используется для хранения результатов, подготовленных для загрузки на сервер. При импорте данных в промежуточное хранилище снимкам назначается уникальный ID, задается имя проекта и ветки.
Промежуточное хранилище можно использовать для аккумулирования результатов нескольких запусков анализатора, в том числе для различных проектов.
По умолчанию, промежуточное хранилище создается в директории '''.svacer-dir''' рядом с директорией '''.svace-dir.'''
Параллельный доступ к хранилищу из разных экземпляров Svacer '''не допускается'''. Если необходимо использовать разделяемое хранилище и конкурентный доступ, Svacer следует запускать в режиме удаленного промежуточного хранилища.
Процедура импорта c промежуточным хранилищем по умолчанию (размещается в '''<path to project>/.svacer-dir'''):

svacer import --svace <path to svace> [path to project]

где '''<path to svace>''' — путь к исполняемому файлу svace из дистрибутива svace, '''[path to project]''' — путь к проекту (директории, содержащей .svace-dir). Его можно не указывать, тогда в качестве пути к проекту будет использована текущая директория.

Процедура импорта с явным указанием размещения промежуточного хранилища:

svacer import --store <path to store> --svace <path to svace> <path to project>

=== Пользовательские атрибуты ===
При импорте данных можно ассоциировать пользовательские строковые атрибуты со снимком. Значения атрибутов доступно посредством публичного REST API и интерфейса командной строки. Это позволяет связать дополнительные данные с результатами (например commit ID). Пользовательские атрибуты нельзя модифицировать после импорта данных на сервер.
Пользовательские атрибуты экспортируются и импортируются как часть информации при использовании функциональности по экспорту и импорту снимков.

Пользовательский атрибут может быть передан при использовании команды import посредством опции '''--field <name>:<value>'''. Опция может быть указана несколько раз в командной строке.

svacer import ... --field f1:val1 --field f2:val2 ...

Если одно и тоже поле указано несколько раз, то значения поля сохраняются как JSON массив строк.
'''Допустимое имя''' пользовательского атрибута состоит из латинских букв, цифр, знаков подчеркивание или минуса.

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

'''svacer access''' --project <project name> --branch <branch name> --snapshot <name or id> --user <user name> --password <password> '''custom_fields'''

Результат операции выдается как JSON объект в stdout. Объект имеет следующую структуру
{
"field name1":"value",
"field name2": ["value", "value"..]
}
Для получения значения конкретного пользовательского атрибута используется следующая команда

'''svacer access''' --project <project name> --branch <branch name> --snapshot <name or id> --user <user name> --password <password> '''custom_fields --get <field name>'''

Значение атрибута выводится в stdout как JSON строка или массив.
=== Клонирование ветки ===
При импорте данных возможно клонирование ветки (вместе со снимками, разметкой и комментариями) из того же проекта, куда происходит импорт данных.

Для клонирования ветки следует использовать опцию '''--if-no-branch <value>'''

svacer import ... --if-no-branch <value> ...

Значения, которые может принимать опция '''--if-no-branch''':

* '''clone-{name|id}''' — клонировать ветку с заданным именем|id (по умолчанию clone-master)
* '''create-empty''' — создает пустую ветку
* '''return-error''' — возвращает ошибку, если для опции '''--branch <branch_name>''' не существует ветки с именем branch_name

{{Note}} Если не указать данную опцию, то будет автоматически клонироваться ветка master, поэтому для избежания ошибок следует убедиться, что ветка master существует, если данная опция не указана, иначе будет выведена ошибка.

==== Клонирование разметки и комментариев ====
При импорте данных возможно клонирование разметки и комментариев ветки из того же проекта, куда происходит импорт данных.

Для клонирования разметки и комментариев следует использовать опцию '''--clone-review {name|id}'''

svacer import ... --clone-review {name|id} ...

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

Приоритет опции '''--clone-review''' выше, чем у опции '''--if-no-branch''', поэтому возможно клонировать снимки из одной ветки, а разметку и комментарии из другой.

Если ветка с таким именем или id не будет найдена, то при загрузке данных ('''svacer upload ...''', либо '''svacer import --upload ...''') загрузка произойдет, но без склонированной разметки.

=== Прикрепление файлов ===
При импорте данных возможно прикрепление файлов размером до 300Мб к снимку. Файлы будут доступны пользователю в веб-интерфейсе и посредством интерфейса командной строки. Прикрепленные файлы фиксируются в момент операции импорта и не могут быть модифицированы после загрузки на сервер. Удалить файлы может администратор посредством веб интерфейса. Основное назначение данной функциональности прикрепление некоторой иммутабельной информации к результатам анализа для использования в интеграциях со сторонними системами.
Прикрепленные файлы являются частью данных, которые экспортируются и импортируются посредством функциональности экспорта и импорта снимков.

Для прикрепления файлов следует использовать опцию '''--attach <file name>'''

svacer import ... --attach file1.txt --attach file2.txt ...

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

[[File:SnapshotInfo.png|none|alt=Snapshot Info Window]]

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

'''svacer access''' --project <project name> --branch <branch name> --snapshot <name or id> --user <user name> --password <password> '''attachments''' --list

Результат работы команды представляет собой JSON массив объектов вида

[{
"id": 11,
"snapshot_id": "d99c23f7-9fb9-4f4e-85ac-2539328947e0",
"lid": 122885,
"short_name": "Makefile",
"description": "/home/ruseer/static-analysis/svacer/Makefile",
"created_by": "importer",
"updated_by": null,
"create_ts": "2022-10-18T06:41:54.532925Z",
"update_ts": null,
"checksum": "9b1e02a276e810829ac2e38fb775c4ff8d269d0f44fd0fbae40f79a0320389ad"
}]

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

'''svacer access''' --project <project name> --branch <branch name> --snapshot <name or id> --user <user name> --password <password> '''attachments''' --get <id> <output file>

* Если '''<output file>''' не указан, то результат будет напечатан в stdout;
* Если '''<branch>''' не указан, то будет использован ветка master;
* Если '''<snapshot>''' не указан, то будет использован последний снимок на указанной ветке.

=== Загрузка данных на сервер ===
{{Note|type=warn|text=При загрузке данных на сервер, а также при прочих взаимодействиях клиента Svacer с сервером Svacer, крайне рекомендуется, чтобы версия клиента совпадала с версией сервера. В случае несовпадения версий возможны непредсказуемые ошибки.}}

Для загрузки данных из промежуточного хранилища на сервер используется команда '''upload''':

svacer upload --user <user> --password <pwd> --host <host> --port <rest_port> --grpc <grpc_port> <path_to_store>

Если отсутствуют параметры:
* '''--user''' и '''--password''', то используется специальный системный пользователь '''importer''' — он предназначен для импорта данных на сервер;
* '''--host''', то используется '''locahost''';
* '''--port''' и '''--grpc''', то используются их значения по умолчанию;
При загрузке данных на сервер уже загруженные снимки повторно не загружаются. Разделяемая информация (такая как исходные файлы, где один и тот же файл может использоваться в различных анализах и т.п.) также повторно не загружается.
При сбоях в ходе загрузки проводится повторная загрузка, но при этом загружаются только недостающие данные.

В случае если Svacer запущен с поддержкой SSL/TLS или работает за reverse proxy и доступен по протоколу HTTPS, то для загрузки требуется явно указать протокол в параметре '''--host''', либо добавить опцию '''--ssl'''.

svacer upload --host https://<url_without_port> <path_to_store>
svacer upload --ssl --host <url_without_port> <path_to_store>

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

Для информации о загрузке данных на сервер с авторизацией в LDAP см. [[LDAP configuration#Использование CLI сервера Svacer с поддержкой LDAP|Использование CLI Svacer с поддержкой LDAP]].

При загрузке данных на сервер можно включить печать краткой статистики по загруженным результатам. Данная статистика включает информацию о новых и пропущенных предупреждениях, по сравнению с последним ранее загруженным снимком. Выдача краткой статистики возможно в текстовом или JSON виде. Результаты печатаются в stdout.

{{Note|text=Для корректной работы опций <code>--quality-gate</code> и <code>--quick-stats</code> при использовании reverse proxy, в частности Nginx, для gRPC порта Svacer, необходимо в настройках секции http или server добавить инструкцию:
underscores_in_headers on;
См. [[Help:Configuration#Nginx|пример конфига]]}}

svacer upload ... --quick-stats --out-format text ...

Пример вывода
Quick Stats:
Previous snapshot : Snapshot 2022-11-16 10:11:37 +0300
Current snapshot : Snapshot 2022-11-16 10:23:08 +0300
New : 1
Missing : 0
Matched : 1
Same : 0

svacer upload ... --quick-stats --out-format json ...

Пример вывода
{"branch":"391f21d1-2173-449c-9d1a-dd846d2a6471","snapshot":"34a1125d-86a3-45d3-9b41-cb5da24ab96e","snapshotName":"Snapshot 2022-11-21 10:19:06 +0300","lastSnapshot":"59657ae8-c3b6-48bc-b586-a6c0580cdb50","lastSnapshotName":"Snapshot 2022-11-21 10:18:09 +0300","same":2}

Формат JSON определяется protobuf3 схемой (ряд полей носит внутренний характер):
message ImportSummaryContext {
string branch = 1;
string snapshot = 2;
string snapshotName = 9;
string lastSnapshot = 3;
string lastSnapshotName = 4;
int64 new = 5;
int64 missing = 6;
int64 matched = 7;
int64 same = 8;
string qualityGate = 10;
string baseline_branch_name = 11;
string baseline_project_name = 12;
string branch_name = 13;
string project_name = 14;
string project_id = 15;
string baseline_snapshot_id = 16;
string baseline_branch_id = 19;
string baseline_project_id = 20;
string baseline_snapshot_name = 21;
}

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

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

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

svacer container snapshot rename --host <host> --port <port> --user <user name> --password <pwd> --id <snapshot id> --name <snapshot name>

Идентификатор снимка можно посмотреть в веб-интерфейсе или получить посредством public API.

=== Модификация путей в разметке при импорте ===

==== Обычное поведение ====
По умолчанию пути к файлам не меняются, за исключением пути к папки '''.svace-dir''', он будет заменён на '''.build'''. Эту информацию можно увидеть при импорте проекта:

svacer import --clean .svacer-dir
...
info The path prefix of .svace-dir 'C:\work\generate_files\gen_exp' will be trimmed when converting file paths
...

После этого все маркеры из этой папки и дочерних будут в '''Review''' показывать путь вида '''/.build/test500_1.c''' вместо полного пути для файла '''C:\work\generate_files\gen_exp\test500_1.c'''.

[[File:SimpleSourceCode.png|none|alt=Simple Source Code Window]]

==== Использование --path-prefix ====
При необходимости модификацию по умолчанию можно заменить через '''--path-prefix'''.
Значения опции передаются в виде:

--path-prefix "prefix_for_replace1:value1;prefix_for_replace2:value2; ..."

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

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

svacer --debug import --clean --upload --path-prefix "C::\work:work" .svacer-dir
...
INFO Creating regular object store
DEBUG Creating path mapping rule 'C:\work' => 'work'
DEBUG Creating path mapping rule 'C:/work' => 'work'
DEBUG Creating path mapping rule '/C_/work' => 'work'
...

После импорта на сервере можно увидеть файл: '''/work/generate_files/gen_exp/test500_1.c'''

[[File:PathPrefixSourceCode.png|none|alt=PathPrefixSourceCode]]

==== Использование --build-object @auto ====
При импорте конкретного файла *.svres исходный код может быть загружен, при указании опции '''--build-object @auto'''. В случае, если этот файл лежит в папке .svace-dir, исходный код будет взят из нее. При отсутствии папки .svace-dir файлы будут браться по абсолютным путям из файла *.svres.
Для указания конкретных директорий поиска подходящих файлов из *.svres следует использовать опцию '''--source-tree''', которую можно указать несколько раз, чтобы задать несколько корневых директорий. Поиск в этих директориях будет происходить только в случае, когда по путям из файла *.svres были найдены не все файлы. В случае успешного сопоставления, на сервер будут загружены соответствующие файлы из директории source tree.

==== Использование --full-paths ====
Допустимо также полное отключение модификаций путей, для этого импорт надо производить с опцией '''--full-paths'''. Опция блокирует как модификацию по умолчанию '''.build''', так и явные указания через '''--path-prefix'''.

svacer --debug import --clean --upload --full-paths .svacer-dir

После загрузки на сервере будет виден только полный путь: '''/C_/work/generate_files/gen_exp/test500_1.c'''.

[[File:FullPathsSourceCode.png|none|alt=FullPathsSourceCode window]]

Пути из Windows преобразуются в стиль Linux с небольшим преобразованием символов.

=== Использование quality gate ===

Возможна проверка новых, пропущенных, одинаковых, измененных предупреждений, для этого надо производить импорт с опцией '''--quality-gate'''.

--quality-gate value Specify a quality gate. Format: stat_1:severity_1:N_1:[statuses_1],...,stat_k:severity_k:N_k:[statuses_k], stat takes values: new, missing, matched, same, total; severity takes the following values: all, critical, major, normal, minor, undefined, <detector name part>; N is a natural number; statuses - an optional field, specified in square brackets with a separator ";" possible values - confirmed, false_positive, wont_fix, unclear, undecided, when specifying statuses, the quality gate will be searched only for markers that have exactly these statuses, for example [confirmed;wont_fix;undecided]. If the severity of the number N is exceeded, it will out a warning. Also, as a value, you can specify a json or yaml file in which the quality gate is specified.

Флаг принимает на вход тип предупреждений (stat), severity, их количество (N) и их статусы (statuses).

* stat задает тип предупреждений. Возможные значения:
** '''new''' — присутствует в новом снимке, но отсутствует в старом
** '''missing''' — присутствует в старом снимке, но отсутствует в новом
** '''matched''' — присутствуют изменения в файлах, не повлиявшие на выданное предупреждение
** '''same''' — одинаковые
** '''total''' — сумма всех вышеперечисленных (то есть количество предупреждений в объединении старого и нового снимков)
* severity задается либо непосредственным его указанием ('''critical''', '''major''', '''normal''', '''minor''', '''undefined'''), либо '''all''' (все severity), либо частью имени детектора в формате [https://www.postgresql.org/docs/current/functions-matching.html postgres ILIKE]
* N — порог, после которого вызывается срабатывание. Не включает данное число (т. е. если указать 5, то при нахождении 6 и более вызывается срабатывание quality-gate)
* statuses — '''опциональное''' поле, в котором можно указать какие статусы (разметку) учитывать при нахождении предупреждений. Возможные значения '''confirmed''', '''false_positive''', '''wont_fix''', '''unclear''', '''undecided'''. Задаются в квадратных скобках с разделителем <code>;</code>. Например <code>[confirmed;wont_fix]</code>. Если не указать данное поле, то будут учитываться все статусы. При указании в command line рекомендуется значение опции <code>--quality-gate</code> экранировать в двойные кавычки. Принципы учета статусов:
** Если предупреждение размечено в новом снимке (значение не '''undecided'''), разметка берется из нового предупреждения
** Если в новом снимке нет разметки у данного предупреждения, а в старом есть, то берется разметка из старого предупреждения
** В остальных случаях у данного предупреждения разметка равна '''undecided'''.

Пример:
--quality-gate "total:critical:0:[confirmed;wont_fix],new:all:10"

Тогда опция сработает, если либо:

# Cтатическим анализатором будут найдены общее количество предупреждений (новых, пропущенных, одинаковых, измененных) с '''severity:critical''' и статусами '''confirmed''' и '''won't fix'''
# Cтатическим анализатором будут найдены новые предупреждения с любым статусом и severity

Пример вывода:
Quality gate exceed:
Previous snapshot : Snapshot 2025-06-16 15:37:09 +0300
Current snapshot : Snapshot 2025-06-16 15:37:39 +0300
Stat : total
Severity : Critical
Severity Statuses : confirmed wont_fix
Severity Threshold : 0
Found Severity : 3

Также quality-gate можно задать файлом в формате json или yaml (не yml).

Пример json файла:

<code>["total:all:1", "total:proc:1"]</code>

Пример yaml файла:
- "total:all:1"
- "total:proc:1"

{{Note|text=Для корректной работы опций <code>--quality-gate</code> и <code>--quick-stats</code> при использовании reverse proxy, в частности Nginx, для gRPC порта Svacer, необходимо в настройках секции http или server добавить инструкцию:
underscores_in_headers on;
См. [[Help:Configuration#Nginx|пример конфига]]}}

==== Флаг --quality-gate-exit-code ====
В случае срабатывания quality gate можно указать какой exit code от 0 до 125 будет возвращен.

--quality-gate-exit-code value Specify the exit code of the application in the range from 0 to 125, which will be issued when the quality-gate is exceeded. The default is 0.

{{Note|text=Значение по умолчанию 0, поэтому без явного задания exit code срабатывание quality-gate не вернет ненулевой статус и при использовании в CI/CD pipeline не будет помечен как failed. Так сделано для упрощения внедрения quality-gate опции в существующий CI/CD. Вначале можно проанализировать логи и если данные корректны, добавить опцию <code>--quality-gate-exit-code</code> с ненулевым значением.}}

==== Флаг --quality-gate-verbose ====
Если необходимо выводить информацию и об успешно прошедших quality gate, то нужно добавить флаг <code>--quality-gate-verbose</code>

Пример вывода:
Quality gate exceed:
Previous snapshot : Snapshot 2025-06-16 15:37:39 +0300
Current snapshot : Snapshot 2025-06-16 16:10:33 +0300
Stat : total
Severity : Critical
Severity Statuses : confirmed wont_fix
Severity Threshold : 0
Found Severity : 3
The result of comparison of those who have completed quality gate:
Previous snapshot : Snapshot 2025-06-16 15:37:39 +0300
Current snapshot : Snapshot 2025-06-16 16:10:33 +0300
Stat : new
Severity : All
Severity Threshold : 10
Found Severity : 0

==== Флаг --baseline ====
Если сравнение необходимо проводить не с предыдущим снимком в этой же ветке, то можно указать флаг <code>--baseline</code> (также работает для флага <code>--quick-stats</code>).

--baseline value A snapshot to compare (--quality-gate and/or --quick-stats). Format: {project}:::{branch}:::{snapshot} or {project}:::{branch} or {project} use UUID or name. By default, snapshot is the last added, branch is master. If the flag is not specified, then the comparison will be with the latest snapshot from the branch where the snapshot is loaded.

Указывается в формате <code>{project}:::{branch}:::{snapshot}</code> или <code>{project}:::{branch}</code> или <code>{project}</code>, используя имена или UUID. По умолчанию используется ветка master (если указан только проект) и последний добавленный снимок (если снимок не указан).

При указании данного флага меняется вывод:

* В текстовом формате добавляются строки об имени проекта, ветки и снимка, с которым сравнивался загружаемый снимок
* В json формате добавляются имена и id проекта, ветки и снимка, с которым сравнивался загружаемый снимок

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

==== Флаг --baseline-check ====
Для вывода quick-stats и quality-gate даже в случае отсутствия снимка, ветки или проекта используйте опцию <code>--baseline-check</code>.

Данный флаг принимает следующие параметры:

* пустой или <code>project,branch,snapshot</code> — требует проект, ветку и снимок, по умолчанию
* <code>skip</code> — разрешает отсутствие проекта, ветки, снимка
* <code>project</code> — требует проект, разрешает отсутствие ветки и снимка
* <code>project,branch</code> — требует проект и ветку, разрешает отсутствие снимка

Можно использовать полные названия с запятыми или сокращения без запятых: <code>p</code> для project, <code>b</code> для branch, <code>s</code> для snapshot, например <code>pbs</code>. Всегда пытается найти снимок; если он не найден, то использует пустой baseline и все предупреждения помечаются как New. Ошибка возвращается только если не выполнен обязательный уровень.

==== Флаг --out-file ====

Для указания файла, в который необходимо вывести результаты quality gate, используйте опцию <code>--out-file</code> (по умолчанию вывод идет в stdout).

==== Флаг --out-format ====

Для указания в каком формате вывести результаты quality gate используйте опцию <code>--out-format</code>. Принимает значения text (человекочитаемый) и json. По умолчанию text.

Svacer

2026-02-10T10:13:22Z

Akuzmin: /* Релизы */ add 12-0-1

Svacer — сервер для хранения и обработки результатов статического анализа. Поддерживает импорт результатов анализа из [https://svace.ispras.ru Svace] напрямую и из прочих анализаторов через формат [[Help:Sarif|SARIF]].

=== Документация ===
Version 12.x.x
# [[Help:Introduction|Введение]]
# [[Help:Installation|Установка и обновление]]
# [[Help:Configuration|Настройка сервера]]
# [[Help:Import from Svace|Импорт из Svace]]
# [[Help:Backup|Резервное копирование]]
# [[Help:UI manual|Использование веб-интерфейса]]
# [[Help:Public API|Public REST API]]
# [[Help:CLI|CLI]]
# [[LDAP configuration|LDAP]]
# [[OIDC|OpenID Connect]]
# [[Help:Sarif|SARIF]]
# [[Help:Statistics|Статистика]]
# [[Help:Match|Механизмы сопоставления предупреждений и переноса разметки]]
# [[Help:XSvacer|XSvacer — расширение функциональности Svacer]]
# [[Help:Utils|Дополнительные утилиты]]
# [[Metrics|Prometheus-метрики]]
# [[Pipelines|Примеры пайплайнов]]
# [[Notifications|Уведомления]]

=== Релизы ===
Также доступны в виде docker-образа на [https://hub.docker.com/r/ispras/svacer docker hub] и как пакеты в [[Help:Installation#Установка и запуск из deb/rpm пакета|репозиториях]]

{| class="wikitable"
! version !! distrib !! linux bin !! windows bin !! deb/rpm !! doc
!svace checkers version
|-
| 12.0.1
| [https://svacer.ispras.ru/releases/svacer-12-0-1/svacer-12-0-1-linux.tar.gz svacer-12-0-1-linux.tar.gz] [https://svacer.ispras.ru/releases/svacer-12-0-1/svacer-12-0-1-windows.zip svacer-12-0-1-windows.zip]
| [https://svacer.ispras.ru/releases/svacer-12-0-1/svacer svacer] [https://svacer.ispras.ru/releases/svacer-12-0-1/svacer-server svacer-server] [https://svacer.ispras.ru/releases/svacer-12-0-1/svacer-server.sig svacer-server.sig]
| [https://svacer.ispras.ru/releases/svacer-12-0-1/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-12-0-1/svacer-server.exe svacer-server.exe] [https://svacer.ispras.ru/releases/svacer-12-0-1/svacer-server_win.sig svacer-server_win.sig]
| [https://svacer.ispras.ru/releases/svacer-12-0-1/svacer_12.0-1_amd64.deb svacer_12.0-1_amd64.deb] [https://svacer.ispras.ru/releases/svacer-12-0-1/svacer-12.0-1.x86_64.rpm svacer-12.0-1.x86_64.rpm]
| [[Changelog#Release 12-0-1|Changelog]] [[Help:Installation#Обновление|Upgrade notes]] [[Svacer#Документация|Documentation 12.x.x]]
|5.0.251220
|-
| 12.0.0
| [https://svacer.ispras.ru/releases/svacer-12-0-0/svacer-12-0-0-linux.tar.gz svacer-12-0-0-linux.tar.gz] [https://svacer.ispras.ru/releases/svacer-12-0-0/svacer-12-0-0-windows.zip svacer-12-0-0-windows.zip]
| [https://svacer.ispras.ru/releases/svacer-12-0-0/svacer svacer] [https://svacer.ispras.ru/releases/svacer-12-0-0/svacer-server svacer-server] [https://svacer.ispras.ru/releases/svacer-12-0-0/svacer-server.sig svacer-server.sig]
| [https://svacer.ispras.ru/releases/svacer-12-0-0/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-12-0-0/svacer-server.exe svacer-server.exe] [https://svacer.ispras.ru/releases/svacer-12-0-0/svacer-server_win.sig svacer-server_win.sig]
| [https://svacer.ispras.ru/releases/svacer-12-0-0/svacer_12.0-0_amd64.deb svacer_12.0-0_amd64.deb] [https://svacer.ispras.ru/releases/svacer-12-0-0/svacer-12.0-0.x86_64.rpm svacer-12.0-0.x86_64.rpm]
| [[Changelog#Release 12-0-0|Changelog]] [[Release notes 12-0-0|Release notes]] [[Help:Installation#Обновление|Upgrade notes]] [[Svacer#Документация|Documentation 12.x.x]]
|4.0.251120
|-
| 11.2.0
| [https://svacer.ispras.ru/releases/svacer-11-2-0/svacer-11-2-0-linux.tar.gz svacer-11-2-0-linux.tar.gz] [https://svacer.ispras.ru/releases/svacer-11-2-0/svacer-11-2-0-windows.zip svacer-11-2-0-windows.zip]
| [https://svacer.ispras.ru/releases/svacer-11-2-0/svacer svacer] [https://svacer.ispras.ru/releases/svacer-11-2-0/svacer-server svacer-server]
| [https://svacer.ispras.ru/releases/svacer-11-2-0/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-11-2-0/svacer-server.exe svacer-server.exe]
| [https://svacer.ispras.ru/releases/svacer-11-2-0/svacer_11.2-0_amd64.deb svacer_11.2-0_amd64.deb] [https://svacer.ispras.ru/releases/svacer-11-2-0/svacer-11.2-0.x86_64.rpm svacer-11.2-0.x86_64.rpm]
| [[Changelog#Release 11-2-0|Changelog]] [[Help:Installation#Обновление|Upgrade notes]] [[Documentation 11.x.x]]
|4.0.250415
|-
| 11.1.0
| [https://svacer.ispras.ru/releases/svacer-11-1-0/svacer-11-1-0-linux.tar.gz svacer-11-1-0-linux.tar.gz] [https://svacer.ispras.ru/releases/svacer-11-1-0/svacer-11-1-0-windows.zip svacer-11-1-0-windows.zip]
| [https://svacer.ispras.ru/releases/svacer-11-1-0/svacer svacer] [https://svacer.ispras.ru/releases/svacer-11-1-0/svacer-server svacer-server]
| [https://svacer.ispras.ru/releases/svacer-11-1-0/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-11-1-0/svacer-server.exe svacer-server.exe]
| [https://svacer.ispras.ru/releases/svacer-11-1-0/svacer_11.1-0_amd64.deb svacer_11.1-0_amd64.deb] [https://svacer.ispras.ru/releases/svacer-11-1-0/svacer-11.1-0.x86_64.rpm svacer-11.1-0.x86_64.rpm]
| [[Changelog#Release 11-1-0|Changelog]] [[Help:Installation#Обновление|Upgrade notes]] [[Documentation 11.x.x]]
|4.0.250415
|-
| 11.0.0
| [https://svacer.ispras.ru/releases/svacer-11-0-0/svacer-11-0-0-linux.tar.gz svacer-11-0-0-linux.tar.gz] [https://svacer.ispras.ru/releases/svacer-11-0-0/svacer-11-0-0-windows.zip svacer-11-0-0-windows.zip]
| [https://svacer.ispras.ru/releases/svacer-11-0-0/svacer svacer] [https://svacer.ispras.ru/releases/svacer-11-0-0/svacer-server svacer-server]
| [https://svacer.ispras.ru/releases/svacer-11-0-0/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-11-0-0/svacer-server.exe svacer-server.exe]
| [https://svacer.ispras.ru/releases/svacer-11-0-0/svacer_11.0-0_amd64.deb svacer_11.0-0_amd64.deb] [https://svacer.ispras.ru/releases/svacer-11-0-0/svacer-11.0-0.x86_64.rpm svacer-11.0-0.x86_64.rpm]
| [[Changelog#Release 11-0-0|Changelog]] [[Release notes 11-0-0|Release notes]] [[Help:Installation#Обновление|Upgrade notes]] [[Documentation 11.x.x]]
|4.0.250415
|-
| 10.0.1
| [https://svacer.ispras.ru/releases/svacer-10-0-1/svacer-10-0-1-linux.tar.gz svacer-10-0-1-linux.tar.gz] [https://svacer.ispras.ru/releases/svacer-10-0-1/svacer-10-0-1-windows.zip svacer-10-0-1-windows.zip]
| [https://svacer.ispras.ru/releases/svacer-10-0-1/svacer svacer] [https://svacer.ispras.ru/releases/svacer-10-0-1/svacer-server svacer-server]
| [https://svacer.ispras.ru/releases/svacer-10-0-1/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-10-0-1/svacer-server.exe svacer-server.exe]
| [https://svacer.ispras.ru/releases/svacer-10-0-1/svacer_10.0-1_amd64.deb svacer_10.0-1_amd64.deb] [https://svacer.ispras.ru/releases/svacer-10-0-1/svacer-10.0-1.x86_64.rpm svacer-10.0-1.x86_64.rpm]
| [[Changelog#Release 10-0-1|Changelog]] [[Help:Installation#Обновление|Upgrade notes]] [[Documentation 10.x.x]]
|4.0.241102
|-
| 10.0.0
| [https://svacer.ispras.ru/releases/svacer-10-0-0/svacer-10-0-0-linux.tar.gz svacer-10-0-0-linux.tar.gz] [https://svacer.ispras.ru/releases/svacer-10-0-0/svacer-10-0-0-windows.zip svacer-10-0-0-windows.zip]
| [https://svacer.ispras.ru/releases/svacer-10-0-0/svacer svacer] [https://svacer.ispras.ru/releases/svacer-10-0-0/svacer-server svacer-server]
| [https://svacer.ispras.ru/releases/svacer-10-0-0/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-10-0-0/svacer-server.exe svacer-server.exe]
| [https://svacer.ispras.ru/releases/svacer-10-0-0/svacer_10.0-0_amd64.deb svacer_10.0-0_amd64.deb] [https://svacer.ispras.ru/releases/svacer-10-0-0/svacer-10.0-0.x86_64.rpm svacer-10.0-0.x86_64.rpm]
| [[Changelog#Release 10-0-0|Changelog]] [[Release notes 10-0-0|Release notes]] [[Help:Installation#Обновление|Upgrade notes]] [[Documentation 10.x.x]]
|4.0.241102
|-
| 9.0.2
| [https://svacer.ispras.ru/releases/svacer-9-0-2/svacer-9-0-2.zip svacer-9-0-2.zip]
| [https://svacer.ispras.ru/releases/svacer-9-0-2/svacer svacer] [https://svacer.ispras.ru/releases/svacer-9-0-2/svacer-server svacer-server]
| [https://svacer.ispras.ru/releases/svacer-9-0-2/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-9-0-2/svacer-server.exe svacer-server.exe]
| [https://svacer.ispras.ru/releases/svacer-9-0-2/svacer_9.0-2_amd64.deb svacer_9.0-2_amd64.deb] [https://svacer.ispras.ru/releases/svacer-9-0-2/svacer-9.0-2.x86_64.rpm svacer-9.0-2.x86_64.rpm]
| [[Changelog#Release 9-0-2|Changelog]] [[Help:Installation#9-0-0|Upgrade notes]] [[Documentation 9.x.x]]
|3.4.240312
|-
| 9.0.1
| [https://svacer.ispras.ru/releases/svacer-9-0-1/svacer-9-0-1.zip svacer-9-0-1.zip]
| [https://svacer.ispras.ru/releases/svacer-9-0-1/svacer svacer] [https://svacer.ispras.ru/releases/svacer-9-0-1/svacer-server svacer-server]
| [https://svacer.ispras.ru/releases/svacer-9-0-1/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-9-0-1/svacer-server.exe svacer-server.exe]
| [https://svacer.ispras.ru/releases/svacer-9-0-1/svacer_9.0-1_amd64.deb svacer_9.0-1_amd64.deb] [https://svacer.ispras.ru/releases/svacer-9-0-1/svacer-9.0-1.x86_64.rpm svacer-9.0-1.x86_64.rpm]
| [[Changelog#Release 9-0-1|Changelog]] [[Help:Installation#9-0-0|Upgrade notes]] [[Documentation 9.x.x]]
|3.4.240312
|-
| 9.0.0
| [https://svacer.ispras.ru/releases/svacer-9-0-0/svacer-9-0-0.zip svacer-9-0-0.zip]
| [https://svacer.ispras.ru/releases/svacer-9-0-0/svacer svacer] [https://svacer.ispras.ru/releases/svacer-9-0-0/svacer-server svacer-server]
| [https://svacer.ispras.ru/releases/svacer-9-0-0/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-9-0-0/svacer-server.exe svacer-server.exe]
| [https://svacer.ispras.ru/releases/svacer-9-0-0/svacer_9.0-0_amd64.deb svacer_9.0-0_amd64.deb] [https://svacer.ispras.ru/releases/svacer-9-0-0/svacer-9.0-0.x86_64.rpm svacer-9.0-0.x86_64.rpm]
| [[Changelog#Release 9-0-0|Changelog]] [[Release notes 9-0-0|Release notes]] [[Help:Installation#9-0-0|Upgrade notes]] [[Documentation 9.x.x]]
|3.4.240312
|-
| 8.0.1
| [https://svacer.ispras.ru/releases/svacer-8-0-1/svacer-8-0-1.zip svacer-8-0-1.zip]
| [https://svacer.ispras.ru/releases/svacer-8-0-1/svacer svacer]
| [https://svacer.ispras.ru/releases/svacer-8-0-1/svacer.exe svacer.exe]
| [https://svacer.ispras.ru/releases/svacer-8-0-1/svacer_8.0-1_amd64.deb svacer_8.0-1_amd64.deb] [https://svacer.ispras.ru/releases/svacer-8-0-1/svacer-8.0-1.x86_64.rpm svacer-8.0-1.x86_64.rpm] [https://svacer.ispras.ru/releases/svacer-8-0-1/svacer-8.0.1.msi svacer-8.0.1.msi]
| [[Changelog#Release 8-0-1|Changelog]] [[Documentation 8.x.x]]
|3.4.0
|-
| 8.0.0
| [https://svacer.ispras.ru/releases/svacer-8-0-0/svacer-8-0-0.zip svacer-8-0-0.zip]
| [https://svacer.ispras.ru/releases/svacer-8-0-0/svacer svacer]
| [https://svacer.ispras.ru/releases/svacer-8-0-0/svacer.exe svacer.exe]
| [https://svacer.ispras.ru/releases/svacer-8-0-0/svacer_8.0-0_amd64.deb svacer_8.0-0_amd64.deb] [https://svacer.ispras.ru/releases/svacer-8-0-0/svacer-8.0-0.x86_64.rpm svacer-8.0-0.x86_64.rpm] [https://svacer.ispras.ru/releases/svacer-8-0-0/svacer-8.0.0.msi svacer-8.0.0.msi]
| [[Changelog#Release 8-0-0|Changelog]] [[Release notes 8-0-0|Release notes]] [[Documentation 8.x.x]]
|3.4.0
|}

[https://svacer.ispras.ru/releases Предыдущие релизы] | [https://nextcloud.ispras.ru/index.php/s/x4r4cMJAMr5RZtd?path=%2F Еще более старые релизы]

=== FAQ ===
* [https://gitlab.ispras.ru/svace/svace-support/-/wikis/home Документация на статический анализатор Svace]
* [[Help:Introduction#Системные требования|Системные требования]]
* [[Примеры использования хуков#Создание кейсов в системах отслеживания ошибок|Создание из Svacer кейсов в Gitlab, Jira, Redmine]]
* Public REST API
:* [[Help:Public API#Примеры использования public REST API|Примеры использования]]
:* [https://gitlab.ispras.ru/svacer-public Репозитории с примерами на Python и Go]
:* [https://svacer-demo.ispras.ru/api/public/swagger/ Спецификация OpenAPI]
* [https://t.me/+6pvgZ0oveNVhOTc6 Группа технической поддержки в Telegram]

=== Демо ===
https://svacer-demo.ispras.ru

* admin / admin — логин / пароль администратора
* user / user — логин / пароль пользователя

Changelog

2026-02-09T12:31:14Z

Akuzmin: minor fixes

=== Release 12-0-1 ===
10.02.2026
* Убраны ограничения на размер поля advanced filter в пользовательских фильтрах
* В публичных запросах, возвращающих маркеры, добавлено поле <code>checker_situation</code> соответствующее полю <code>situation</code> в детекторах
* Добавлена возможность фильтрации по <code>checker_situation</code> в advanced filter
* Добавлена возможность фильтрации по <code>checker_labels</code> в advanced filter. Поле содержит массив текстовых меток. Сейчас используется для пометки детекторов, соответствующих ГОСТ 71207-2024
* Добавлен публичный фильтр по детекторам, соответствующим ГОСТ 71207-2024
* Импортировано описание детекторов из <code>Svace 5.0.251220</code>
* При миграции со старых версий баз, а также при миграциях, связанных с изменением схемы генерации инвариантов, реализовано полное сохранение разметки и комментариев на маркерах и последующее восстановление пропущенных
* Ряд таймаутов вынесен на уровень переменных окружения для адаптации под пользовательские сценарии
* Добавлена подсветка синтаксиса для языка Lua
* Исправлены проблемы безопасности, связанные с импортом данных и механизмом токенов доступа (PAT)
* При загрузке снимков, svace-dir и разметки через командную строку появилась возможность указать флаг <code>retry-policy</code>, который задает время ожидания ответа от сервера, количество дополнительных попыток и задержку между повторами, например <code>30m:10:1m</code>

=== Release 12-0-0 ===
28.11.2025

* API методы на fullmarkers позволяют [[Help:Public API#Примеры использования фильтров в public api|указать фильтр]] с полем фильтрации по checker reliability
* В функциональность полнотекстового поиска добавлен поиск маркеров по id и инварианту
* Промежуточное хранилище при импорте результатов командой <code>svacer import / svacer sarif2 import</code> теперь использует новый формат представления. Это должно снизить использование памяти при импорте
* Сериализация JSON переведена на jsonv2 библиотеку в Go
* Импорт SARIF теперь более устойчив к пропускам в файле (отсутствие таких полей как location)
* Добавлены переменные окружения <code>SVACER_TIMEOUT_IMPORT_RESULTS</code> для [[Help:Configuration#Переменные окружения|контроля таймаута]] на ожидание начала импорта результатов и <code>SVACER_NUM_PARALLEL_IMPORTS</code> на [[Help:Configuration#Переменные окружения|ограничение числа параллельных импортов]]. По умолчанию значения 15 минут и <code>(максимальное число коннектов к БД) / 2</code>. Ограничения необходимы для предотвращения бесконечных ожиданий и зависаний при импорте данных
* Убраны лишние сообщения об устаревших детекторах при старте сервера или импорте снимков
* В метрики Prometheus добавлен ряд показателей размеров object store
* Размер лога сервера, показываемого в Web-интерфейсе, ограничен. Размер [[Help:Configuration#Переменные окружения|задается переменной окружения]] SVACER_TAIL_LOG_SIZE (по умолчанию 1Мб). Показывается последний кусок не более SVACER_TAIL_LOG_SIZE. Сам лог файл не ограничивается в размерах и кнопка выгрузки лога выгружает полный лог
* ['''Экспериментально'''] Можно [[Help:Configuration#Переменные окружения|указать JSON-формат]] лог-файла посредством параметра <code>svacer-server --log-format=json ...</code>, также формат может быть указан через переменную окружения <code>SVACER_LOG_FORMAT=json</code>. Опции также работают для CLI-клиента svacer
* При запуске сервера можно указать флаг <code>--force-invariant-refresh</code> для принудительной регенерации инвариантов. Это может решить проблему с переносом разметки
* Добавлена переменная окружения SVACER_INV_GEN_JOBS для контроля числа параллельных заданий при регенерации инвариантов. При ограниченных ресурсах машины рекомендуем ставить значение 2. По умолчанию значение ставится в 70% от <code>runtime.GOMAXPROCS</code>
* Добавлена функциональность по чистке object store при удалении снимков
* Добавлена возможность создания [[Afilters|сложных пользовательских фильтров]] по условиям, выраженным предикатом
* Проведена работа по предотвращению зависаний при исчерпывании доступных соединений с PostgreSQL сервером
* Добавлен файл с чексуммой бинарника сервера <code>svacer-server</code> и проверка чексуммы при запуске
* Упростили [[Help:XSvacer:AIAssistant#Активация и запуск ИИ-ассистента|деплой ИИ-ассистента]]: добавили его сервис в docker-compose и deb/rpm пакеты
* Расширили возможности конфигурации при запуске сервера через [https://svacer.ispras.ru/extra/docker-compose.yml docker-compose]: теперь можно включить debug, указать конфиг LDAP и параметр public-url
* Добавлена возможность указания минимального количества снимков, которое необходимо оставлять в ветке, тип очистки и период удаления в [[Help:CLI/cleanup|автоматическом удалении снимков]]
* ['''Экспериментально'''] Добавлена возможность [[Edit markers (command line)|автоматически обрабатывать маркеры]] при импорте данных. Также обработка маркеров доступна через [[Help:UI manual#Работа со снимками|UI]]
* Добавлен флаг <code>diff-url</code> для команды <code>quickdiff</code> в CLI, также как и для команд <code>import</code>, <code>upload</code>, <code>sarif2 import</code> с указанием опции <code>quick-stat</code>. Данный флаг позволяет получать ссылку на diff снимков
* Добавлены предупреждения если в командах <code>import</code>, <code>sarif2 import</code> используются флаги, которые используются флагом <code>upload</code>, но флаг <code>upload</code> не установлен
* Добавлена интеграция с внешними системами посредством механизма [[Help:Configuration#Механизм интеграции с внешними системами посредством Webhook-ов|Webhooks]]
* Добавлена [[Help:Configuration#Настройка защиты от перебора паролей пользователей|защита от перебора пароля пользователя]]
* Добавлена возможность задать [[Help:Configuration#Настройка парольной политики внутреннего механизма аутентификации Svacer|парольную политику безопасности]] для пользователей, использующих встроенный механизм аутентификации Svacer
* Добавлена возможность задать [[Help:Configuration#Задание вкладки по умолчанию на странице входа в GUI Svacer (а также отключение внутреннего механизма аутентификации Svacer)|вкладку по умолчанию]] для страницы входа в систему
* Исправлена ошибка, приводящая к разрастанию базы данных
* Исправлена ошибка, связанная с невозможностью в ряде случаев использовать механизм подписок
* Форма [[Help:UI manual#Разметка маркера с помощью ассистента AI|разметки]] с помощью [[Help:XSvacer:AIAssistant|ИИ-ассистента]] реализована в основном интерфейсе Svacer
* [[Help:XSvacer:Webide#Запуск функциональности при использовании docker compose|Упрощён запуск функциональности Webide]] при запуске сервера через [https://svacer.ispras.ru/extra/docker-compose.yml docker-compose]

=== Release 11-2-0 ===
22.07.2025

* Исправлены зависания сервера
* Добавлено автоматическое удаление архивов и прочих временных файлов при импорте .svace-dir и SARIF-файлов через REST API

=== Release 11-1-0 ===
08.07.2025

* Команды <code>--project-group, --if-no-group, --autoclean, --autoclean-svace</code> можно использовать в REST API для импорта svace-dir
* При использовании REST API для импорта svace-dir сервер будет автоматически удалять директории <code>.svace-dir</code> и <code>.svacer</code> если не указаны явные опции <code>--autoclean=false, --autoclean-svace=false</code>
* Добавлена опция запуска сервера <code>--classic-inv-mode</code> для включения режима совместимости по генерации инвариантов с версией <= 8.x.x
* Исправлены ошибки в работе <code>--quality-gate</code>, добавлена возможность учета статусов разметки. Добавлена возможность [[Help:Import from Svace#Флаг --baseline|указания baseline]] для сравнений при использовании опции <code>--quality-gate</code>
* Исправлены ошибки при подключении к PostgreSQL в SSL-режиме
* Исправлен ряд ошибок при работе с LDAP
* Команда <code>quickdiff</code> в CLI теперь выдает информацию также о Same и Matched предупреждениях

=== Release 11-0-0 ===
19.05.2025

* Убраны излишние сообщения в логе сервера о login/logout операциях. Они будут выводиться только при запуске сервера с опцией <code>--debug</code>
* Команды CLI <code>svacer sarif *</code> были убраны, для [[Help:Sarif|импорта и экспорта]] следует использовать <code>svacer sarif2 *</code>
* Экспорт SARIF теперь включает все комментарии как отдельные объекты в <code>Properties</code>
* При экспорте в SARIF теперь экспортируются поля <code>Labels, Orig function</code>
* Импорт SARIF теперь корректным образом учитывает relatedLocations и формирует трассу
* Импорт SARIF теперь автоматически импортирует исходники, если они включены в сам SARIF файл
* Добавлена возможность указания [[Help:Sarif#Мэппинг severity|мэппинга severity]] детекторов при импорте из SARIF
* Добавлен механизм указания правил резолвинга путей при импортировании исходного кода вместе с SARIF файлом
* Экспорт исходников из снимка будет доступен только при наличии исходников на сервере
* Добавлены флаги <code>--autoclean</code>, <code>--autoclean-svace</code> в команду <code>svacer import</code> для автоматического удаления <code>.svace-dir / .svacer-dir</code> после успешного импорта и загрузки данных на сервер
* Улучшена поддержка [[OIDC]]
* Улучшена поддержка [[LDAP configuration|LDAP]]
* Добавлена интеграция с хранилищем секретов [[Infisical]]
* Добавлена [[Notifications|служба нотификаций]] пользователей через почтовые сообщения и мессенджер telegram
* Добавлен механизм аутентификации и [[Help:UI manual#Управление токенами доступа|управления]] персональными токенами доступа
* Добавлен механизм упоминания пользователей через специальную конструкцию @login в комментариях к разметке
* В разделе Статистика добавлен дашборд с [[Release notes 11-0-0#Изменения в разделе Статистика|Общей статистикой]], содержащей метрики по последним импортированным снимкам в ветках проектов
* В статистике по активности пользователей добавлена возможность просмотра панели с актуальной информацией о маркере и опция показа только действий с актуальной разметкой
* Большинство CLI команд, работающих с сервером, теперь делают явный logout после завершения
* Svacer при импорте результатов Svace автоматически импортирует файлы <code>*.warn, *.err</code> с предупреждениями от самого анализатора Svace. Автоматический импорт не будет происходить при размере этих файлов более 30Мб (большой размер может свидетельствовать о проблемах в ходе анализа)
* Переменная окружения <code>SVACER_CACHE_DIR</code> теперь учитывается во всех местах (ранее в ряде случаев мог неявно использоваться <code>$HOME/.cache</code>)
* Добавлена возможность [[Help:CLI/cleanup|автоматического удаления снимков]]

=== Release 10-0-1 ===
17.02.2025

* Исправлена ошибка с временной таблицей при обработке планов автомиграции разметки при импорте результатов (ERROR: relation "loaded_review" already exists)

=== Release 10-0-0 ===
16.01.2025

* Множество изменений в UI, смотрите [[Release notes 10-0-0]]
* Сделали [[Help:Installation#deb/rpm|dnf/yum репозиторий]] для RPM-пакетов Svacer
* Реализована возможность [[Markup2|экспорта, импорта и копирования разметки посредством Public REST API и CLI]]
* Реализован дополнительный экспериментальный механизм [[Help:UI manual#Настройка интерфейса|генерации PDF на основе HTML]]. Генерация PDF переведена на асинхронный режим с показом нотификации пользователю
* Добавлена возможность очистки всей разметки и/или комментариев на ветке проекта
* Улучшения функциональности просмотра маркеров в встроенном IDE Theia
* Добавлена функциональность по [[Help:UI manual#Глобальный поиск|глобальному поиску]] маркеров, комментариев и снимков по различным атрибутам
* Добавлена возможность [[Help:UI manual#Просмотр статистики|получения статистики]] по маркерам и активностям пользователей при разметке
* В API fullmarkers добавлен параметр <code>labels: true/false</code> для выгрузки меток маркера
* Реализован Public API для получения/добавления/удаления меток маркеров
* Настройки LDAP и прочие настройки аутентификации добавлены в единый конфигурационный файл
* Добавлена возможность удаления кода из снимка при частичном импорте в Svacer
* Добавлена опция minVersion, maxVersion для TLS при запуске сервера Svacer
* Добавлена поддержка групп проектов при импорте снимков в CLI
* При импорте снимков реализована поддержка автоматического определения пути префикса для переноса разметки
* Исправлен ряд ошибок в импорте и генерации [[Help:Sarif|SARIF]]
* Исправлены ошибки в копировании разметки между ветками, клонировании проектов и веток
* Добавлена возможность отключения бэкграунд задач по очистке мусора
* Добавлено экспериментальное CLI API для просмотра асинхронных задач на генерацию PDF
* Добавлена возможность визуализации производительности сервера на основе [https://github.com/arl/statsviz statsviz]
* Добавлена поддержка относительных путей в svres файле
* Добавлена возможность ожидания завершения операций по очистки мусора при выполнении операций по импорту результатов анализа
* Добавлена поддержка CWE таксономий при экспорте [[Help:Sarif|SARIF]]
* Добавлена переменная окружения SVACER_TOKEN_LIFETIME для управления временем жизни токена аутентификации
* Добавлена переменная окружения SVACER_RESET_ADMIN_PASSWORD для явного указания желаемого пароля при операции по сбросу пароля администратора
* Добавлен [[Notifications|механизм нотификаций пользователей]] о внутренних событиях Svacer (экспериментальный функционал)

=== Release 9-0-2 ===
22.07.2024

* Еще некоторые исправления, связанные с миграцией данных
* Исправлена проблема с навигацией по Go to Definition

=== Release 9-0-1 ===
15.07.2024

* Исправлены ошибки в клонировании проектов, приводящие к размножению записей в некоторых внутренних таблицах
* Различные исправления, связанные с миграцией данных
* Исправлена работа ряда CLI команд с включенным TLS на сервере
* Исправлен ряд ошибок в генерации PDF

=== Release 9-0-0 ===
04.06.2024

* Множество изменений в UI, смотрите [[Release notes 9-0-0]]
* Svacer разделен на два исполняемых файла: <code>svacer-server</code> — сервер и <code>svacer</code> — клиент
* {{Note}}Object store заменен на другую реализацию. Конвертация данных запускается автоматически при апгрейде и требует примерно 2х-2.2х дискового пространства, после конвертации старый object store будет удален. Время конвертации зависит от объема данных и скорости диска
* {{Note}}Изменен [[Help:Match|алгоритм сопоставления предупреждений]]. При старте сервера будет произведена регенерация всех инвариантов во всех ветках. Это может занять продолжительное время (зависит от мощности сервера и объемов данных)
* Добавлена возможность [[Help:Match#Ручное сопоставление предупреждений (экспериментальная возможность)|ручного сопоставления предупреждений]] для переноса разметки
* Добавлена экспериментальная поддержка [[OIDC|OpenID]] протокола для аутентификации
* Добавлена экспериментальная возможность [[Help:CLI#Слияние снимков из CLI (экспериментальная опция)|слияния снимков через CLI]]
* Исправлены баги в [[Help:Sarif|импорте Sarif]], добавлена поддержка импорта с относительными путями к файлам (флаг <code>--base-dir</code>)
* Лог сервера работает в режиме append, прежние данные не затираются
* Добавлена возможность передачи токена аутентификации в клиент Svacer через переменную окружения <code>SVACER_AUTH_TOKEN=token</code>
* Добавлена возможность передачи логина и пароля в клиент Svacer через переменную окружения <code>SVACER_AUTH_CREDS=login:password</code>
* Добавлен public REST endpoint для импорта <code>.svace-dir</code> на стороне сервера
* Добавлена возможность импорта <code>.svace-dir</code> из веб-интерфейса
* Добавлены [[Metrics|метрики]] для Prometheus, доступны при запуске сервера с переменной окружения <code>SVACER_TRACE_OPTIONS=prom_metrics_on</code> на <code>/api/metrics</code>
* Добавлена очистка БД от мусора с возможностью настройки периодичности данной операции через переменную окружения <code>SVACER_GC_PERIOD=val</code> где val — duration в формате <code>hhmmss</code> или [https://en.wikipedia.org/wiki/Cron Cron]
* Добавлена возможность клонирования проектов
* Добавлен импорт <code>*warn, *.err</code> файлов из <code>.svace-dir</code>, которые содержат диагностические сообщения от Svace
* Добавлена возможность [[Help:CLI#Ограничение числа запросов|ограничения числа запросов]] на сервер с указанием параметров в переменной окружения <code>SVACER_SERVER_THROTTLE_PARAMS</code>
* Добавлен шаблон для импорта разметки из кода на Go: <code>DEFAULT_GO</code>
* Добавлена возможность [[Help:CLI#Аутентификация из файла|аутентификации из файла]]
* Исправлены проблемы безопасности
* Добавлена возможность просмотра исходного кода снимка с предупреждениями анализатора во внешней IDE собранной на базе [https://theia-ide.org/ Theia IDE]
* К команде automigrate add в CLI добавлен флаг <code>skip-exist</code>, чтобы при добавлении паттерна, который уже существует, не выдавало ошибки
* К команде upload (import с флагом upload) с указанием флага <code>quality-gate</code> теперь можно добавить флаг <code>quality-gate-verbose</code>. Если его указать, то также будет выведен результат успешных проверок quality-gate
* Улучшения в поддержке протокола LDAP

=== Release 8-0-1 ===
22.01.2024

* Исправлена работа в изолированной от сети среде. Загрузка Web UI больше не требует доступа к публичным CDN
* Добавлена поддержка функций при указании пользовательского фильтра
* Добавлено API для управления пользовательскими фильтрами. Детали и пример использования можно найти здесь: https://gitlab.ispras.ru/svacer-public/api-go-examples/-/tree/master/api-ui-settings
* Исправлено отображение Checker Severity при экспорте в SARIF. Теперь Critical -> error; Major, Normal -> warning; Minor -> note; any other -> warning

=== Release 8-0-0 ===
21.11.2023

* Множество изменений в UI. Смотрите обзор в [[Release notes 8-0-0]]
* Добавлен новый импорт и экспорт из SARIF в command line с поддержкой исходного кода в SARIF файлах и импортом описания детекторов из SARIF
* Добавлены группы проектов
* Переделана модель ролей и доступов. Добавлен CLI для управления ролями и доступами
* Добавлена возможность настройки автопереноса разметки между ветками, в том числе в разных проектах
* Импорт/экспорт снимков включает информацию о детекторах
* Исправлена работа интерфейса с Undefined детекторами (т. е. детекторами, информация о которых отсутствует в Svacer)
* Добавлено экспериментальное API по управлению детекторами и конфигурациями детекторов
* Добавлена очистка исходного кода от Svacer-specific комментариев перед экспортом разметки в код
* Добавлена возможность включения режима обязательного комментария при разметке кода. Комментарий будет сгруппирован с операцией разметки и будет иметь ссылку на нее
* Утилита миграции со старого svace-сервера больше не поддерживается. При необходимости миграции используйте утилиту из прошлых релизов Svacer
* Добавлена Swagger документация на API
* Добавлено хранение истории изменений комментариев
* Опция <code>--pathPrefix</code> поддерживает файлы в JSON формате вида: <code>[{ "prefix": "/some/path", "replace": "/test" }, ...]</code>
* При использовании операции по обновлению <code>pathPrefix</code> на сервере, данные о прежнем <code>pathPrefix</code> запоминаются в мета-информации о снимке
* Добавлена возможность переименования снимков в UI
* Sensitive информация (детали подключения к БД с данными аутентификации) убрана из UI и API
* ОС в docker-образе Svacer обновлена с Ubuntu 18 до Ubuntu 22
* Улучшена логика автоопределения портов и протоколов при соединении с сервером из Svacer CLI

=== Release 7-0-1 ===
23.05.2023

* Исправлена проблема с фильтрацией предупреждений для C# проектов

=== Release 7-0-0 ===
16.05.2023

* Убрана зависимость от PostgreSQL из .deb и .rpm пакетов, чтобы проще было ставить Svacer только как клиент
* Сделан пакет для Windows (.msi) и документация по установке и запуску на Windows
* Теперь, если при svacer import и svacer sarif не указан путь к проекту, им считается текущая директория
* Информация о разметке и блокировках теперь обновляется автоматически при изменении в другом браузере (табе) или другим пользователем
* UI для пользовательских фильтров улучшен и перенесен в правую верхнюю часть экрана
* UI для выбора проекта, ветки и снимка теперь находится на одном уровне
* Улучшен UI для режима сравнения снимков
* Добавлена возможность работать одновременно с несколькими открытыми файлами в режиме Code, это поведение можно изменить в настройках профиля пользователя
* В левой навигационной панели детекторы теперь по умолчанию группируются по серьезности, это поведение можно изменить в настройках профиля пользователя
* Профиль текущего пользователя теперь можно смотреть/редактировать только через меню в правом верхнем углу
* Добавлена возможность копирования в системном логе и журнале
* Для пользователя теперь запоминается последний контекст (проект/ветка/снимок), с которым он работал, он автоматически открывается при старте новой сессии
* Групповая разметка теперь делается единой транзакцией, в случае ошибок или отмены все изменения откатываются
* Добавлено предупреждение при использовании некорректных путей при использовании REST API с префиксом /api
* Поддержка указания паролей из файла или pipe-а при использование Svacer CLI
* Добавлена поддержка multi-tab code view для режима просмотра кода объекта сборки
* Добавлена поддержка сохранения информации об удаленных детекторах при загрузке информации о детекторах из новой версии Svace
* Исправлен импорт результатов анализа, если сборка проводилась с опцией --disable-dxr
* Исправлены проблемы при импорте и прикреплении нескольких файлов к снимку
* Исправлены ошибки с входом в систему пользователей LDAP (специальные символы в пароле, вход по атрибуту mail)
* Добавлена возможность использования резервных серверов LDAP
* Добавлена возможность автоматического назначения пользователям LDAP роли Svacer, в зависимости от принадлежности пользователя к LDAP группе
* Добавлены новые public запросы на получение маркеров/снимков/проектов с учетом заданных параметров фильтрации
* Добавлена поддержка TLS при работе сервера по протоколам HTTP и gRPC
* Добавлена возможность загрузки статистики по общему количеству предупреждений и по количеству размеченных предупреждений для проектов и веток через REST API
* Добавлена вкладка выбора проектов в расширении VSCode
* Убрана возможность использовать всплывающее окно в VScode для добавления/редактирования/удаления комментариев, установки ревью-статусов, локов и т.д.

=== Release 6-0-3 ===
25.01.2023

* RPM-пакет теперь при сборке упаковывается в gzip вместо zstd для обратной совместимости со старыми дистрибутивами
* Если short url некорректен, то Svacer теперь будет возвращать корректный http error NotFound
* Если путь к лог файлу явно не указан, то svacer.log будет создаваться во временной директории. Это решает проблемы при запуске Svacer из директорий с запретом на запись. Путь к лог файлу будет печататься в stdout
* Лог файлы не будут создаваться, когда используется опция --help
* Исправлены проблемы при миграции схемы данных, когда в PostgreSQL используется SSL подключение
* Добавлены описания детекторов из последнего релиза Svace, которые были пропущены в релизе 6-0-2
* Исправлена работа Svacer за proxy-сервером, где выставляется Header "X-Content-Type-Options nosniff"
* Добавлены кнопки для скачивания системного лога и журнала из web-интерфейса
* Поправлен ряд ошибок валидации схемы при экспорте в SARIF
* Исправлено поведение при наличии нескольких хуков в конфигурационном файле
* В информацию о маркере для хуков добавлены checker severity и reliability
* Исправлен случайный порядок URL для маркеров при использовании public API для получения URL-ов
* На главную страницу добавлена кнопка "Помощь", которая открывает документацию
* При использовании команд навигации в режиме "Browse code" текущий файл теперь корректно подсвечивается в дереве файлов
* В диалоге групповой разметки убран индикатор изменений в виде кружочка, наличие изменений можно определить по активности кнопок "Apply" и "Reset"
* Кнопка обновления в верхнем меню теперь корректно обновляет информацию на странице Settings/Project
* Различные небольшие исправления в пользовательском интерфейсе

=== Release 6-0-2 ===
16.12.2022

* Исправлена проблема в UI с сохраненными пользовательскими фильтрами

=== Release 6-0-1 ===
13.12.2022

* Добавлено описание ряда детекторов, которые есть в последнем релизе Svace 3.3.2 но были пропущены в Svacer
* Исправлено вылетание в Login Screen при удалении нотификации из панели нотификаций
* Исправлено появление белого экрана при клике на детектор, информация о котором отсутствует
* Ряд различных небольших исправлений в UI
* Промежуточное хранилище будет очищаться по умолчанию при использовании команды import

=== Release 6-0-0 ===
30.11.2022

* Добавлено копирование комментариев при копировании разметки
* Комментарии добавлены к отчету в формате csv
* Добавлена возможность вводить пароль с клавиатуры для консольных команд
* Добавлена возможность импортировать разметку из объекта сборки (из ранее загруженных данных)
* Добавлена возможность импортировать разметку сразу после загрузки на сервер (опция для команды svacer upload)
* Добавлена возможность загружать исходный код не из папки .svace-dir
* Добавлена возможность бэкапа и восстановление объектного хранилища в сервер PostgresSQL
* Добавлена возможность создания отчета по проекту в формате PDF через интерфейс командной строки и посредством REST API
* Добавлена возможность подавления предупреждений через inline комментарии в коде
* Добавлена возможность подавления предупреждений по идентификатору предупреждения через command line и REST API
* Добавлена возможность ассоциировать организацию с пользователем и реестр организаций
* Добавлена фильтрация списка комментариев по пользователю в правой панели веб-интерфейса
* Добавлен поиск пользователей по его атрибутам в панели управления пользователями
* Добавлена возможность заполнения данных профиля LDAP пользователя данными, полученными от LDAP сервера
* Добавлена возможность прикреплять файлы к снимкам при импорте результатов (данные файлы составляют часть экспортируемых данных при экспорте снимков)
* Добавлена возможность ассоциировать пользовательские атрибуты типа "строка" или массив строк со снимком при импорте данных (данные атрибуты составляют часть экспортируемых данных при экспорте снимков)
* Добавлены command line операции по получению прикрепленных файлов и пользовательских атрибутов со снимков
* Добавлена возможность группового добавления комментариев
* Добавлена возможность указания сетевого интерфейса для работы WEB и GRPC серверов
* Добавлен вывод краткой статистики по загруженному снимку при команде upload. Поддерживается текстовой и JSON форматы вывода
* Существенно расширены возможности по интеграции Visual Studio Code с сервером Svacer
* Добавлен флаг --git в команду import. При наличии такого флага, ищется ближайший git репозиторий содержащий .svace-dir и при наличии такого - используется путь к гит репозиторию для замены путей на префикс .build.
* Portable PostgreSQL больше не входит в поставку. Вместо него поставляется docker-compose.yml файл для запуска PostgreSQL в докер-контейнере
* Добавлено больше данных и информации об ошибках в вывод команды svacer import
* Изменение Public API: добавлена точка входа /api/public/login
* Операции по импорту и экспорту снимков доступны теперь обычным пользователям (не администраторам) при использовании command line интерфейса
* Операция по экспорту снимков доступна обычному пользователю из веб-интерфейса (импорт все еще требует роль администратора для веб-интерфейса)
* Операции по экспорту снимков переведены на асинхронный режим. Нотификация о готовности будет показана пользователю и доступна в панели нотификаций
* Обновлено описание детекторов в соответствии с релизом Svace 3.3.2
* Исправлена ошибка обработки корневых сертификатов при подключении к LDAP серверу по протоколу ldaps
* Исправлено ошибочное создание дубликатов локальных учетных записей LDAP пользователей (case sensitive login)
* Различные исправления в пользовательском интерфейсе с целью оптимизации производительности
* Добавлены пропущенные проверки ролей при работе с веб-интерфейсом
* Svacer больше не создает временные файлы в директории с исполняемым файлом
* Устаранены задержки при удалении веток и проектов

Help:Installation

2026-01-19T14:09:18Z

Akuzmin: /* 12-x-x */ add volumes info

== Установка и запуск ==
Для использования только клиента Svacer достаточно [[Svacer#Релизы|скачать исполняемый файл]] '''svacer''', или установить [[Help:Installation#Svacer|deb/rpm пакет]].

Сервер Svacer можно запустить в [[Help:Installation#docker compose|докере]] или из [[Help:Installation#deb/rpm|deb/rpm пакета]].

=== docker compose ===
Рекомендуемый и самый простой способ деплоя — развернуть сервер Svacer в докер-контейнерах, воспользовавшиcь [https://svacer.ispras.ru/extra/docker-compose.yml docker-compose.yml] файлом:

<nowiki>curl -LO https://svacer.ispras.ru/extra/docker-compose.yml</nowiki>
docker compose up -d

После запуска контейнеров веб-интерфейс Svacer будет доступен по адресу http://localhost:8080, логин / пароль — admin / admin.

Для сборки своего докер-образа Svacer можете использовать [[Dockerfile]] в качестве референса.

Для указания других параметров сервера можете [[Help:Configuration#Дополнительные параметры при запуске в docker|переопределить команду запуска]] в docker-compose файле.

=== deb/rpm ===
==== PostgreSQL ====
{{Note|type=info|text=Disclaimer
* Рекомендуемая версия PostgreSQL — 15 и выше. С более старыми версиями корректная работа Svacer не гарантируется.
* Svacer требует эксклюзивного доступа к базе. Использование одной и той же базы для нескольких экземпляров Svacer может приводить к порче данных.}}

Для работы сервера Svacer установите PostgreSQL, следуя [https://www.postgresql.org/download/linux документации postgres]. Для RedHat-based OS нужно дополнительно установить пакет postgresql-contrib соответствующей версии.

Пример для Ubuntu 22:

sudo apt install -y postgresql-common
sudo /usr/share/postgresql-common/pgdg/apt.postgresql.org.sh
sudo apt install -y postgresql-17

Пример для Rocky Linux 9.4:

<nowiki>sudo dnf install -y https://download.postgresql.org/pub/repos/yum/reporpms/EL-9-x86_64/pgdg-redhat-repo-latest.noarch.rpm</nowiki>
sudo dnf -qy module disable postgresql
sudo dnf install -y postgresql17-server postgresql17-contrib
sudo /usr/pgsql-17/bin/postgresql-17-setup initdb
sudo systemctl enable postgresql-17
sudo systemctl start postgresql-17

==== Браузер для PDF-отчетов ====
Для создания PDF-отчетов с использованием нового HTML-генератора установите браузер Google Chrome на машину, где запускается сервер Svacer. Рекомендуется устанавливать из официального репозитория, следуя [https://www.google.com/chrome/?platform=linux инструкции с сайта google].

{{Note|type=info|text=Рекомендуемые системные требования при генерации PDF-отчетов для больших проектов с использованием HTML-генератора: Intel Core i9, 64 GB RAM, SSD, видеокарта Nvidia}}

При запуске Svacer проверит доступность браузера для генерации PDF. Если он не установлен или генерация не работает, будет использован нативный генератор: менее продвинутый, но для него не нужен браузер. Можно явно включить использование нативного генератора, передав опцию <code>--pdf-generator=native</code> при запуске сервера Svacer.

При невозможности установить Google Chrome, например если нет пакета для вашего дистрибутива Linux, можно установить Chromium. Его пакет в репозиториях, в зависимости от вышей ОС, может называться <code>chromium-browser</code> или <code>chromium</code>. В некоторых случаях генерация с Chromium может не работать. Например, если Svacer установлен из deb-пакета, а Сhromium из snap (на Ubuntu он устанавливается именно так даже при использовании apt) и сервер Svacer запускается от отдельного системного пользователя, от которого Chromium не может запуститься. В этом случае установите Google Chrome, с ним генерация работает.

==== Svacer ====
На Debian-based OS добавьте apt-репозиторий и установите Svacer из него.

<nowiki>echo 'deb [signed-by=/usr/share/keyrings/ispras.gpg] https://repo.ispras.ru/apt /' | sudo tee /etc/apt/sources.list.d/ispras.list</nowiki>
<nowiki>curl -fsSL https://repo.ispras.ru/apt/key.asc | sudo gpg --dearmor -o /usr/share/keyrings/ispras.gpg</nowiki>
sudo apt update
sudo apt install -y svacer

На RedHat-based OS добавьте dnf-репозиторий и установите Svacer из него

<nowiki>curl -fsSL https://repo.ispras.ru/rpm/ispras.repo | sudo tee /etc/yum.repos.d/ispras.repo</nowiki>
sudo dnf install -y svacer

Для создания БД PostgreSQL запустите '''psql''' от учетной записи пользователя '''postgres'''

sudo su -l postgres
psql

И выполните следующие запросы:
create database svace;
create user svace with encrypted password 'svace';
grant all privileges on database svace to svace;
alter user svace superuser;

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

При использовании других значений нужно поменять параметры подключения к БД в файле '''/etc/default/svacer'''

SVACER_ARGS="--pg postgres://<user>:<password>@127.0.0.1:5432/<database>"

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

На Astra Linux необходимо в файле '''/etc/parsec/mswitch.conf''' установить параметр <code>zero_if_notfound: yes</code>, иначе при запуске Svacer будет ошибка подключения к БД вида

error obtaining MAC configuration for user "svace" (SQLSTATE 57P03)

После создания БД и конфигурации сервера Svacer запустить его можно следующими командами

sudo systemctl enable svacer
sudo systemctl start svacer

После чего проверить успешность запуска командой

systemctl status svacer

После запуска сервер будет доступен по адресу http://localhost:8080, логин / пароль — admin / admin.

=== Установка и запуск на Windows ===
{{Note|text=При запуске на Windows [[Help:Introduction#Системные_требования|поддерживается не вся функциональность сервера]]}}
* Скачайте установщик PostgreSQL для Windows: https://www.postgresql.org/download/windows
* Установите PostgreSQL, выбрав, как минимум, компоненты "PostgreSQL Server" и "Command Line Tools"
* Задайте пароль на шаге выбора пароля для суперпользователя
* Остальные параметры при установке можно оставить по умолчанию
* После установки PostgreSQL откройте консоль, перейдите в директорию, куда установили PostgreSQL, запустите его клиент с указанием пользователя "postgres" и авторизуйтесь с паролем, заданным во время установки
cd c:\Program Files\PostgreSQL\15\bin
psql -U postgres
* Запустится консоль управления PostgreSQL. Выполните в ней следующие команды, чтобы создать БД и пользователя для Svacer
create database svace;
create user svace with encrypted password 'svace';
grant all privileges on database svace to svace;
alter user svace superuser;
* Выйдите из консоли PostgreSQL
* Запустите '''svacer-server.exe''' из консоли с указанием параметров подключения к БД. Если при создании пользователя и БД PostgreSQL вы использовали для них имя по умолчанию 'svace', как в примере выше, то указывать данные для подключения к БД при запуске сервера не обязательно
svacer-server.exe run
* Если создавали пользователя или БД с другими именами, то при запуске сервера надо указать их явно
svacer-server.exe run --pg postgres://svacer_user:svacer_password@127.0.0.1:5432/svacer_database
* После запуска сервера его веб-интерфейс будет доступен по адресу http://localhost:8080, логин / пароль — admin / admin

== Обновление ==
{{Note|type=reminder|text='''Перед обновлением настоятельно рекомендуется [[Help:Backup|делать резервные копии]]'''}}

Миграции схем БД PostgreSQL и object store происходят автоматически при обновлении на новую версию Svacer. Поэтому для обновления Svacer достаточно остановить сервер старой версии, запустить сервер новой версии, указав ему те же параметры БД и object store, и подождать, пока не пройдет обновление, после чего Svacer запустится как обычно. При больших объемах данных в БД это может занять существенное время, до нескольких часов. Прогресс можно отслеживать по логам сервера.

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

{{Note|type=warn|text=После запуска Svacer при обновлении обязательно дождитесь пока миграция БД завершится. Если прервать процесс во время миграции, принудительно остановив Svacer, база данных может оказаться в неконсистентном состоянии и придется восстанавливать данные из бэкапа.}}

=== Upgrade notes ===
==== 12-x-x ====
* Рекомендуем обновить PostgreSQL до версии 15 или выше. С более старыми версиями корректная работа Svacer не гарантируется
* Если вы использовали аутентификацию с помощью LDAP в версиях Svacer 5-1-X и у вас не работает механизм тегирования или уведомлений (подписки), см [[LDAP_configuration#Некоторые_замечания_для_пользователей,_которые_использовали_LDAP_в_версиях_Svacer_5-1-X|решение проблем с отсутствием статуса пользователя в БД]]
* В релизе 12 мы добавили имя проекта в [https://svacer.ispras.ru/extra/docker-compose.yml docker-compose.yml]. Оно влияет на названия docker volumes для БД и object store: если раньше имена формировались на основе названия директории, откуда запускался стек, теперь они привязаны к имени проекта и по умолчанию будут <code>svacer_svacer-postgres</code> и <code>svacer_svacer-object-store</code>. Чтобы после обновления docker-compose.yml файла старые вольюмы перенеслись, надо явно указать их имена в секции volumes:
volumes:
svacer-postgres:
name: old-dir-name_svacer-postgres
external: true
svacer-object-store:
name: old-dir-name_svacer-object-store
external: true

==== 11-x-x ====
Нет специфических рекомендаций по обновлению.

==== 10-x-x ====
Нет специфических рекомендаций по обновлению.

==== 9-0-0 ====
{{Note|type=reminder|text=При обновлении на эту версию рекомендуем не меньше 8GB RAM для корректности миграций}}

Базово, никаких обязательных ручных действий с базой данных или object store при обновлении на 9-0-0 не требуется. Описанные ниже шаги могут помочь увеличить производительность сервера Svacer или решить возможные проблемы.

'''1.'''

В версии 9-0-0 поменялся формат object store, поэтому при обновлении с предыдущих версий Svacer на 9-0-0 или выше будет запущена конвертация object store в новый формат. Конвертация сначала записывает новые данные, а потом, если все прошло успешно, удаляет старые. Из-за этого для конвертации нужно примерно в два раза больше свободного дискового пространства, чем занимает текущий object store. При больших размерах object store и медленном диске конвертация может занять много времени.

Конвертация запустится автоматически при обновлении на 9-0-0, но можно запустить вручную отдельно:

svacer-server kvconvert --from <path> --to <path>

Расположение object store в файловой системе описано в [[Help:Backup#Бэкап object store вручную|разделе про бэкапы]].

'''2.'''

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

delete from checkers where id not in (select max(id) from checkers group by (config_id, checker_id, languages, tools));

Если вы уже выполняли этот запрос при [[Help:Installation#8-0-0|обновлении на 8-0-0]], то второй раз запускать не обязательно.

'''3.'''

После обновления на версию 9-0-0 и завершения всех миграций БД (когда станет доступен веб-интерфейс) рекомендуем выполнить команду <code>VACUUM FULL</code> в PostgreSQL для очистки и оптимизации базы данных.

psql -h <postgres_host> -U <username> <svacer_database_name> -c 'VACUUM FULL;'

Например:

psql -h localhost -U svacer svacer_db -c 'VACUUM FULL;'

==== 8-0-0 ====
Если при обновлении на версию 8-0-0 и выше возникает подобная ошибка
Key (config_id, checker_id, languages, tools)=(4cd178ce-a2b2-4692-a45a-f84b145c807b, FB.ICAST_QUESTIONABLE_UNSIGNED_RIGHT_SHIFT, {JAVA}, {SpotBugs}) is duplicated
Это значит, что в БД есть дубликаты чекеров. Выполните следующий SQL-запрос в PostgreSQL-базе Svacer, чтобы удалить их:
delete from checkers where id not in (select max(id) from checkers group by (config_id, checker_id, languages, tools));

Svacer

2026-01-14T13:52:28Z

Akuzmin: /* Релизы */ add windows signature file

Svacer — сервер для хранения и обработки результатов статического анализа. Поддерживает импорт результатов анализа из [https://svace.ispras.ru Svace] напрямую и из прочих анализаторов через формат [[Help:Sarif|SARIF]].

=== Документация ===
Version 12.x.x
# [[Help:Introduction|Введение]]
# [[Help:Installation|Установка и обновление]]
# [[Help:Configuration|Настройка сервера]]
# [[Help:Import from Svace|Импорт из Svace]]
# [[Help:Backup|Резервное копирование]]
# [[Help:UI manual|Использование веб-интерфейса]]
# [[Help:Public API|Public REST API]]
# [[Help:CLI|CLI]]
# [[LDAP configuration|LDAP]]
# [[OIDC|OpenID Connect]]
# [[Help:Sarif|SARIF]]
# [[Help:Statistics|Статистика]]
# [[Help:Match|Механизмы сопоставления предупреждений и переноса разметки]]
# [[Help:XSvacer|XSvacer — расширение функциональности Svacer]]
# [[Help:Utils|Дополнительные утилиты]]
# [[Metrics|Prometheus-метрики]]
# [[Pipelines|Примеры пайплайнов]]
# [[Notifications|Уведомления]]

=== Релизы ===
Также доступны в виде docker-образа на [https://hub.docker.com/r/ispras/svacer docker hub] и как пакеты в [[Help:Installation#Установка и запуск из deb/rpm пакета|репозиториях]]

{| class="wikitable"
! version !! distrib !! linux bin !! windows bin !! deb/rpm !! doc
!svace checkers version
|-
| 12.0.0
| [https://svacer.ispras.ru/releases/svacer-12-0-0/svacer-12-0-0-linux.tar.gz svacer-12-0-0-linux.tar.gz] [https://svacer.ispras.ru/releases/svacer-12-0-0/svacer-12-0-0-windows.zip svacer-12-0-0-windows.zip]
| [https://svacer.ispras.ru/releases/svacer-12-0-0/svacer svacer] [https://svacer.ispras.ru/releases/svacer-12-0-0/svacer-server svacer-server] [https://svacer.ispras.ru/releases/svacer-12-0-0/svacer-server.sig svacer-server.sig]
| [https://svacer.ispras.ru/releases/svacer-12-0-0/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-12-0-0/svacer-server.exe svacer-server.exe] [https://svacer.ispras.ru/releases/svacer-12-0-0/svacer-server_win.sig svacer-server_win.sig]
| [https://svacer.ispras.ru/releases/svacer-12-0-0/svacer_12.0-0_amd64.deb svacer_12.0-0_amd64.deb] [https://svacer.ispras.ru/releases/svacer-12-0-0/svacer-12.0-0.x86_64.rpm svacer-12.0-0.x86_64.rpm]
| [[Changelog#Release 12-0-0|Changelog]] [[Release notes 12-0-0|Release notes]] [[Help:Installation#Обновление|Upgrade notes]] [[Svacer#Документация|Documentation 12.x.x]]
|4.0.251120
|-
| 11.2.0
| [https://svacer.ispras.ru/releases/svacer-11-2-0/svacer-11-2-0-linux.tar.gz svacer-11-2-0-linux.tar.gz] [https://svacer.ispras.ru/releases/svacer-11-2-0/svacer-11-2-0-windows.zip svacer-11-2-0-windows.zip]
| [https://svacer.ispras.ru/releases/svacer-11-2-0/svacer svacer] [https://svacer.ispras.ru/releases/svacer-11-2-0/svacer-server svacer-server]
| [https://svacer.ispras.ru/releases/svacer-11-2-0/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-11-2-0/svacer-server.exe svacer-server.exe]
| [https://svacer.ispras.ru/releases/svacer-11-2-0/svacer_11.2-0_amd64.deb svacer_11.2-0_amd64.deb] [https://svacer.ispras.ru/releases/svacer-11-2-0/svacer-11.2-0.x86_64.rpm svacer-11.2-0.x86_64.rpm]
| [[Changelog#Release 11-2-0|Changelog]] [[Help:Installation#Обновление|Upgrade notes]] [[Documentation 11.x.x]]
|4.0.250415
|-
| 11.1.0
| [https://svacer.ispras.ru/releases/svacer-11-1-0/svacer-11-1-0-linux.tar.gz svacer-11-1-0-linux.tar.gz] [https://svacer.ispras.ru/releases/svacer-11-1-0/svacer-11-1-0-windows.zip svacer-11-1-0-windows.zip]
| [https://svacer.ispras.ru/releases/svacer-11-1-0/svacer svacer] [https://svacer.ispras.ru/releases/svacer-11-1-0/svacer-server svacer-server]
| [https://svacer.ispras.ru/releases/svacer-11-1-0/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-11-1-0/svacer-server.exe svacer-server.exe]
| [https://svacer.ispras.ru/releases/svacer-11-1-0/svacer_11.1-0_amd64.deb svacer_11.1-0_amd64.deb] [https://svacer.ispras.ru/releases/svacer-11-1-0/svacer-11.1-0.x86_64.rpm svacer-11.1-0.x86_64.rpm]
| [[Changelog#Release 11-1-0|Changelog]] [[Help:Installation#Обновление|Upgrade notes]] [[Documentation 11.x.x]]
|4.0.250415
|-
| 11.0.0
| [https://svacer.ispras.ru/releases/svacer-11-0-0/svacer-11-0-0-linux.tar.gz svacer-11-0-0-linux.tar.gz] [https://svacer.ispras.ru/releases/svacer-11-0-0/svacer-11-0-0-windows.zip svacer-11-0-0-windows.zip]
| [https://svacer.ispras.ru/releases/svacer-11-0-0/svacer svacer] [https://svacer.ispras.ru/releases/svacer-11-0-0/svacer-server svacer-server]
| [https://svacer.ispras.ru/releases/svacer-11-0-0/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-11-0-0/svacer-server.exe svacer-server.exe]
| [https://svacer.ispras.ru/releases/svacer-11-0-0/svacer_11.0-0_amd64.deb svacer_11.0-0_amd64.deb] [https://svacer.ispras.ru/releases/svacer-11-0-0/svacer-11.0-0.x86_64.rpm svacer-11.0-0.x86_64.rpm]
| [[Changelog#Release 11-0-0|Changelog]] [[Release notes 11-0-0|Release notes]] [[Help:Installation#Обновление|Upgrade notes]] [[Documentation 11.x.x]]
|4.0.250415
|-
| 10.0.1
| [https://svacer.ispras.ru/releases/svacer-10-0-1/svacer-10-0-1-linux.tar.gz svacer-10-0-1-linux.tar.gz] [https://svacer.ispras.ru/releases/svacer-10-0-1/svacer-10-0-1-windows.zip svacer-10-0-1-windows.zip]
| [https://svacer.ispras.ru/releases/svacer-10-0-1/svacer svacer] [https://svacer.ispras.ru/releases/svacer-10-0-1/svacer-server svacer-server]
| [https://svacer.ispras.ru/releases/svacer-10-0-1/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-10-0-1/svacer-server.exe svacer-server.exe]
| [https://svacer.ispras.ru/releases/svacer-10-0-1/svacer_10.0-1_amd64.deb svacer_10.0-1_amd64.deb] [https://svacer.ispras.ru/releases/svacer-10-0-1/svacer-10.0-1.x86_64.rpm svacer-10.0-1.x86_64.rpm]
| [[Changelog#Release 10-0-1|Changelog]] [[Help:Installation#Обновление|Upgrade notes]] [[Documentation 10.x.x]]
|4.0.241102
|-
| 10.0.0
| [https://svacer.ispras.ru/releases/svacer-10-0-0/svacer-10-0-0-linux.tar.gz svacer-10-0-0-linux.tar.gz] [https://svacer.ispras.ru/releases/svacer-10-0-0/svacer-10-0-0-windows.zip svacer-10-0-0-windows.zip]
| [https://svacer.ispras.ru/releases/svacer-10-0-0/svacer svacer] [https://svacer.ispras.ru/releases/svacer-10-0-0/svacer-server svacer-server]
| [https://svacer.ispras.ru/releases/svacer-10-0-0/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-10-0-0/svacer-server.exe svacer-server.exe]
| [https://svacer.ispras.ru/releases/svacer-10-0-0/svacer_10.0-0_amd64.deb svacer_10.0-0_amd64.deb] [https://svacer.ispras.ru/releases/svacer-10-0-0/svacer-10.0-0.x86_64.rpm svacer-10.0-0.x86_64.rpm]
| [[Changelog#Release 10-0-0|Changelog]] [[Release notes 10-0-0|Release notes]] [[Help:Installation#Обновление|Upgrade notes]] [[Documentation 10.x.x]]
|4.0.241102
|-
| 9.0.2
| [https://svacer.ispras.ru/releases/svacer-9-0-2/svacer-9-0-2.zip svacer-9-0-2.zip]
| [https://svacer.ispras.ru/releases/svacer-9-0-2/svacer svacer] [https://svacer.ispras.ru/releases/svacer-9-0-2/svacer-server svacer-server]
| [https://svacer.ispras.ru/releases/svacer-9-0-2/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-9-0-2/svacer-server.exe svacer-server.exe]
| [https://svacer.ispras.ru/releases/svacer-9-0-2/svacer_9.0-2_amd64.deb svacer_9.0-2_amd64.deb] [https://svacer.ispras.ru/releases/svacer-9-0-2/svacer-9.0-2.x86_64.rpm svacer-9.0-2.x86_64.rpm]
| [[Changelog#Release 9-0-2|Changelog]] [[Help:Installation#9-0-0|Upgrade notes]] [[Documentation 9.x.x]]
|3.4.240312
|-
| 9.0.1
| [https://svacer.ispras.ru/releases/svacer-9-0-1/svacer-9-0-1.zip svacer-9-0-1.zip]
| [https://svacer.ispras.ru/releases/svacer-9-0-1/svacer svacer] [https://svacer.ispras.ru/releases/svacer-9-0-1/svacer-server svacer-server]
| [https://svacer.ispras.ru/releases/svacer-9-0-1/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-9-0-1/svacer-server.exe svacer-server.exe]
| [https://svacer.ispras.ru/releases/svacer-9-0-1/svacer_9.0-1_amd64.deb svacer_9.0-1_amd64.deb] [https://svacer.ispras.ru/releases/svacer-9-0-1/svacer-9.0-1.x86_64.rpm svacer-9.0-1.x86_64.rpm]
| [[Changelog#Release 9-0-1|Changelog]] [[Help:Installation#9-0-0|Upgrade notes]] [[Documentation 9.x.x]]
|3.4.240312
|-
| 9.0.0
| [https://svacer.ispras.ru/releases/svacer-9-0-0/svacer-9-0-0.zip svacer-9-0-0.zip]
| [https://svacer.ispras.ru/releases/svacer-9-0-0/svacer svacer] [https://svacer.ispras.ru/releases/svacer-9-0-0/svacer-server svacer-server]
| [https://svacer.ispras.ru/releases/svacer-9-0-0/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-9-0-0/svacer-server.exe svacer-server.exe]
| [https://svacer.ispras.ru/releases/svacer-9-0-0/svacer_9.0-0_amd64.deb svacer_9.0-0_amd64.deb] [https://svacer.ispras.ru/releases/svacer-9-0-0/svacer-9.0-0.x86_64.rpm svacer-9.0-0.x86_64.rpm]
| [[Changelog#Release 9-0-0|Changelog]] [[Release notes 9-0-0|Release notes]] [[Help:Installation#9-0-0|Upgrade notes]] [[Documentation 9.x.x]]
|3.4.240312
|-
| 8.0.1
| [https://svacer.ispras.ru/releases/svacer-8-0-1/svacer-8-0-1.zip svacer-8-0-1.zip]
| [https://svacer.ispras.ru/releases/svacer-8-0-1/svacer svacer]
| [https://svacer.ispras.ru/releases/svacer-8-0-1/svacer.exe svacer.exe]
| [https://svacer.ispras.ru/releases/svacer-8-0-1/svacer_8.0-1_amd64.deb svacer_8.0-1_amd64.deb] [https://svacer.ispras.ru/releases/svacer-8-0-1/svacer-8.0-1.x86_64.rpm svacer-8.0-1.x86_64.rpm] [https://svacer.ispras.ru/releases/svacer-8-0-1/svacer-8.0.1.msi svacer-8.0.1.msi]
| [[Changelog#Release 8-0-1|Changelog]] [[Documentation 8.x.x]]
|3.4.0
|-
| 8.0.0
| [https://svacer.ispras.ru/releases/svacer-8-0-0/svacer-8-0-0.zip svacer-8-0-0.zip]
| [https://svacer.ispras.ru/releases/svacer-8-0-0/svacer svacer]
| [https://svacer.ispras.ru/releases/svacer-8-0-0/svacer.exe svacer.exe]
| [https://svacer.ispras.ru/releases/svacer-8-0-0/svacer_8.0-0_amd64.deb svacer_8.0-0_amd64.deb] [https://svacer.ispras.ru/releases/svacer-8-0-0/svacer-8.0-0.x86_64.rpm svacer-8.0-0.x86_64.rpm] [https://svacer.ispras.ru/releases/svacer-8-0-0/svacer-8.0.0.msi svacer-8.0.0.msi]
| [[Changelog#Release 8-0-0|Changelog]] [[Release notes 8-0-0|Release notes]] [[Documentation 8.x.x]]
|3.4.0
|}

[https://svacer.ispras.ru/releases Предыдущие релизы] | [https://nextcloud.ispras.ru/index.php/s/x4r4cMJAMr5RZtd?path=%2F Еще более старые релизы]

=== FAQ ===
* [https://gitlab.ispras.ru/svace/svace-support/-/wikis/home Документация на статический анализатор Svace]
* [[Help:Introduction#Системные требования|Системные требования]]
* [[Примеры использования хуков#Создание кейсов в системах отслеживания ошибок|Создание из Svacer кейсов в Gitlab, Jira, Redmine]]
* Public REST API
:* [[Help:Public API#Примеры использования public REST API|Примеры использования]]
:* [https://gitlab.ispras.ru/svacer-public Репозитории с примерами на Python и Go]
:* [https://svacer-demo.ispras.ru/api/public/swagger/ Спецификация OpenAPI]
* [https://t.me/+6pvgZ0oveNVhOTc6 Группа технической поддержки в Telegram]

=== Демо ===
https://svacer-demo.ispras.ru

* admin / admin — логин / пароль администратора
* user / user — логин / пароль пользователя

Svacer

2026-01-14T09:18:09Z

Akuzmin: /* Релизы */ add signature file link

Svacer — сервер для хранения и обработки результатов статического анализа. Поддерживает импорт результатов анализа из [https://svace.ispras.ru Svace] напрямую и из прочих анализаторов через формат [[Help:Sarif|SARIF]].

=== Документация ===
Version 12.x.x
# [[Help:Introduction|Введение]]
# [[Help:Installation|Установка и обновление]]
# [[Help:Configuration|Настройка сервера]]
# [[Help:Import from Svace|Импорт из Svace]]
# [[Help:Backup|Резервное копирование]]
# [[Help:UI manual|Использование веб-интерфейса]]
# [[Help:Public API|Public REST API]]
# [[Help:CLI|CLI]]
# [[LDAP configuration|LDAP]]
# [[OIDC|OpenID Connect]]
# [[Help:Sarif|SARIF]]
# [[Help:Statistics|Статистика]]
# [[Help:Match|Механизмы сопоставления предупреждений и переноса разметки]]
# [[Help:XSvacer|XSvacer — расширение функциональности Svacer]]
# [[Help:Utils|Дополнительные утилиты]]
# [[Metrics|Prometheus-метрики]]
# [[Pipelines|Примеры пайплайнов]]
# [[Notifications|Уведомления]]

=== Релизы ===
Также доступны в виде docker-образа на [https://hub.docker.com/r/ispras/svacer docker hub] и как пакеты в [[Help:Installation#Установка и запуск из deb/rpm пакета|репозиториях]]

{| class="wikitable"
! version !! distrib !! linux bin !! windows bin !! deb/rpm !! doc
!svace checkers version
|-
| 12.0.0
| [https://svacer.ispras.ru/releases/svacer-12-0-0/svacer-12-0-0-linux.tar.gz svacer-12-0-0-linux.tar.gz] [https://svacer.ispras.ru/releases/svacer-12-0-0/svacer-12-0-0-windows.zip svacer-12-0-0-windows.zip]
| [https://svacer.ispras.ru/releases/svacer-12-0-0/svacer svacer] [https://svacer.ispras.ru/releases/svacer-12-0-0/svacer-server svacer-server] [https://svacer.ispras.ru/releases/svacer-12-0-0/svacer-server.sig svacer-server.sig]
| [https://svacer.ispras.ru/releases/svacer-12-0-0/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-12-0-0/svacer-server.exe svacer-server.exe]
| [https://svacer.ispras.ru/releases/svacer-12-0-0/svacer_12.0-0_amd64.deb svacer_12.0-0_amd64.deb] [https://svacer.ispras.ru/releases/svacer-12-0-0/svacer-12.0-0.x86_64.rpm svacer-12.0-0.x86_64.rpm]
| [[Changelog#Release 12-0-0|Changelog]] [[Release notes 12-0-0|Release notes]] [[Help:Installation#Обновление|Upgrade notes]] [[Svacer#Документация|Documentation 12.x.x]]
|4.0.251120
|-
| 11.2.0
| [https://svacer.ispras.ru/releases/svacer-11-2-0/svacer-11-2-0-linux.tar.gz svacer-11-2-0-linux.tar.gz] [https://svacer.ispras.ru/releases/svacer-11-2-0/svacer-11-2-0-windows.zip svacer-11-2-0-windows.zip]
| [https://svacer.ispras.ru/releases/svacer-11-2-0/svacer svacer] [https://svacer.ispras.ru/releases/svacer-11-2-0/svacer-server svacer-server]
| [https://svacer.ispras.ru/releases/svacer-11-2-0/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-11-2-0/svacer-server.exe svacer-server.exe]
| [https://svacer.ispras.ru/releases/svacer-11-2-0/svacer_11.2-0_amd64.deb svacer_11.2-0_amd64.deb] [https://svacer.ispras.ru/releases/svacer-11-2-0/svacer-11.2-0.x86_64.rpm svacer-11.2-0.x86_64.rpm]
| [[Changelog#Release 11-2-0|Changelog]] [[Help:Installation#Обновление|Upgrade notes]] [[Documentation 11.x.x]]
|4.0.250415
|-
| 11.1.0
| [https://svacer.ispras.ru/releases/svacer-11-1-0/svacer-11-1-0-linux.tar.gz svacer-11-1-0-linux.tar.gz] [https://svacer.ispras.ru/releases/svacer-11-1-0/svacer-11-1-0-windows.zip svacer-11-1-0-windows.zip]
| [https://svacer.ispras.ru/releases/svacer-11-1-0/svacer svacer] [https://svacer.ispras.ru/releases/svacer-11-1-0/svacer-server svacer-server]
| [https://svacer.ispras.ru/releases/svacer-11-1-0/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-11-1-0/svacer-server.exe svacer-server.exe]
| [https://svacer.ispras.ru/releases/svacer-11-1-0/svacer_11.1-0_amd64.deb svacer_11.1-0_amd64.deb] [https://svacer.ispras.ru/releases/svacer-11-1-0/svacer-11.1-0.x86_64.rpm svacer-11.1-0.x86_64.rpm]
| [[Changelog#Release 11-1-0|Changelog]] [[Help:Installation#Обновление|Upgrade notes]] [[Documentation 11.x.x]]
|4.0.250415
|-
| 11.0.0
| [https://svacer.ispras.ru/releases/svacer-11-0-0/svacer-11-0-0-linux.tar.gz svacer-11-0-0-linux.tar.gz] [https://svacer.ispras.ru/releases/svacer-11-0-0/svacer-11-0-0-windows.zip svacer-11-0-0-windows.zip]
| [https://svacer.ispras.ru/releases/svacer-11-0-0/svacer svacer] [https://svacer.ispras.ru/releases/svacer-11-0-0/svacer-server svacer-server]
| [https://svacer.ispras.ru/releases/svacer-11-0-0/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-11-0-0/svacer-server.exe svacer-server.exe]
| [https://svacer.ispras.ru/releases/svacer-11-0-0/svacer_11.0-0_amd64.deb svacer_11.0-0_amd64.deb] [https://svacer.ispras.ru/releases/svacer-11-0-0/svacer-11.0-0.x86_64.rpm svacer-11.0-0.x86_64.rpm]
| [[Changelog#Release 11-0-0|Changelog]] [[Release notes 11-0-0|Release notes]] [[Help:Installation#Обновление|Upgrade notes]] [[Documentation 11.x.x]]
|4.0.250415
|-
| 10.0.1
| [https://svacer.ispras.ru/releases/svacer-10-0-1/svacer-10-0-1-linux.tar.gz svacer-10-0-1-linux.tar.gz] [https://svacer.ispras.ru/releases/svacer-10-0-1/svacer-10-0-1-windows.zip svacer-10-0-1-windows.zip]
| [https://svacer.ispras.ru/releases/svacer-10-0-1/svacer svacer] [https://svacer.ispras.ru/releases/svacer-10-0-1/svacer-server svacer-server]
| [https://svacer.ispras.ru/releases/svacer-10-0-1/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-10-0-1/svacer-server.exe svacer-server.exe]
| [https://svacer.ispras.ru/releases/svacer-10-0-1/svacer_10.0-1_amd64.deb svacer_10.0-1_amd64.deb] [https://svacer.ispras.ru/releases/svacer-10-0-1/svacer-10.0-1.x86_64.rpm svacer-10.0-1.x86_64.rpm]
| [[Changelog#Release 10-0-1|Changelog]] [[Help:Installation#Обновление|Upgrade notes]] [[Documentation 10.x.x]]
|4.0.241102
|-
| 10.0.0
| [https://svacer.ispras.ru/releases/svacer-10-0-0/svacer-10-0-0-linux.tar.gz svacer-10-0-0-linux.tar.gz] [https://svacer.ispras.ru/releases/svacer-10-0-0/svacer-10-0-0-windows.zip svacer-10-0-0-windows.zip]
| [https://svacer.ispras.ru/releases/svacer-10-0-0/svacer svacer] [https://svacer.ispras.ru/releases/svacer-10-0-0/svacer-server svacer-server]
| [https://svacer.ispras.ru/releases/svacer-10-0-0/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-10-0-0/svacer-server.exe svacer-server.exe]
| [https://svacer.ispras.ru/releases/svacer-10-0-0/svacer_10.0-0_amd64.deb svacer_10.0-0_amd64.deb] [https://svacer.ispras.ru/releases/svacer-10-0-0/svacer-10.0-0.x86_64.rpm svacer-10.0-0.x86_64.rpm]
| [[Changelog#Release 10-0-0|Changelog]] [[Release notes 10-0-0|Release notes]] [[Help:Installation#Обновление|Upgrade notes]] [[Documentation 10.x.x]]
|4.0.241102
|-
| 9.0.2
| [https://svacer.ispras.ru/releases/svacer-9-0-2/svacer-9-0-2.zip svacer-9-0-2.zip]
| [https://svacer.ispras.ru/releases/svacer-9-0-2/svacer svacer] [https://svacer.ispras.ru/releases/svacer-9-0-2/svacer-server svacer-server]
| [https://svacer.ispras.ru/releases/svacer-9-0-2/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-9-0-2/svacer-server.exe svacer-server.exe]
| [https://svacer.ispras.ru/releases/svacer-9-0-2/svacer_9.0-2_amd64.deb svacer_9.0-2_amd64.deb] [https://svacer.ispras.ru/releases/svacer-9-0-2/svacer-9.0-2.x86_64.rpm svacer-9.0-2.x86_64.rpm]
| [[Changelog#Release 9-0-2|Changelog]] [[Help:Installation#9-0-0|Upgrade notes]] [[Documentation 9.x.x]]
|3.4.240312
|-
| 9.0.1
| [https://svacer.ispras.ru/releases/svacer-9-0-1/svacer-9-0-1.zip svacer-9-0-1.zip]
| [https://svacer.ispras.ru/releases/svacer-9-0-1/svacer svacer] [https://svacer.ispras.ru/releases/svacer-9-0-1/svacer-server svacer-server]
| [https://svacer.ispras.ru/releases/svacer-9-0-1/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-9-0-1/svacer-server.exe svacer-server.exe]
| [https://svacer.ispras.ru/releases/svacer-9-0-1/svacer_9.0-1_amd64.deb svacer_9.0-1_amd64.deb] [https://svacer.ispras.ru/releases/svacer-9-0-1/svacer-9.0-1.x86_64.rpm svacer-9.0-1.x86_64.rpm]
| [[Changelog#Release 9-0-1|Changelog]] [[Help:Installation#9-0-0|Upgrade notes]] [[Documentation 9.x.x]]
|3.4.240312
|-
| 9.0.0
| [https://svacer.ispras.ru/releases/svacer-9-0-0/svacer-9-0-0.zip svacer-9-0-0.zip]
| [https://svacer.ispras.ru/releases/svacer-9-0-0/svacer svacer] [https://svacer.ispras.ru/releases/svacer-9-0-0/svacer-server svacer-server]
| [https://svacer.ispras.ru/releases/svacer-9-0-0/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-9-0-0/svacer-server.exe svacer-server.exe]
| [https://svacer.ispras.ru/releases/svacer-9-0-0/svacer_9.0-0_amd64.deb svacer_9.0-0_amd64.deb] [https://svacer.ispras.ru/releases/svacer-9-0-0/svacer-9.0-0.x86_64.rpm svacer-9.0-0.x86_64.rpm]
| [[Changelog#Release 9-0-0|Changelog]] [[Release notes 9-0-0|Release notes]] [[Help:Installation#9-0-0|Upgrade notes]] [[Documentation 9.x.x]]
|3.4.240312
|-
| 8.0.1
| [https://svacer.ispras.ru/releases/svacer-8-0-1/svacer-8-0-1.zip svacer-8-0-1.zip]
| [https://svacer.ispras.ru/releases/svacer-8-0-1/svacer svacer]
| [https://svacer.ispras.ru/releases/svacer-8-0-1/svacer.exe svacer.exe]
| [https://svacer.ispras.ru/releases/svacer-8-0-1/svacer_8.0-1_amd64.deb svacer_8.0-1_amd64.deb] [https://svacer.ispras.ru/releases/svacer-8-0-1/svacer-8.0-1.x86_64.rpm svacer-8.0-1.x86_64.rpm] [https://svacer.ispras.ru/releases/svacer-8-0-1/svacer-8.0.1.msi svacer-8.0.1.msi]
| [[Changelog#Release 8-0-1|Changelog]] [[Documentation 8.x.x]]
|3.4.0
|-
| 8.0.0
| [https://svacer.ispras.ru/releases/svacer-8-0-0/svacer-8-0-0.zip svacer-8-0-0.zip]
| [https://svacer.ispras.ru/releases/svacer-8-0-0/svacer svacer]
| [https://svacer.ispras.ru/releases/svacer-8-0-0/svacer.exe svacer.exe]
| [https://svacer.ispras.ru/releases/svacer-8-0-0/svacer_8.0-0_amd64.deb svacer_8.0-0_amd64.deb] [https://svacer.ispras.ru/releases/svacer-8-0-0/svacer-8.0-0.x86_64.rpm svacer-8.0-0.x86_64.rpm] [https://svacer.ispras.ru/releases/svacer-8-0-0/svacer-8.0.0.msi svacer-8.0.0.msi]
| [[Changelog#Release 8-0-0|Changelog]] [[Release notes 8-0-0|Release notes]] [[Documentation 8.x.x]]
|3.4.0
|}

[https://svacer.ispras.ru/releases Предыдущие релизы] | [https://nextcloud.ispras.ru/index.php/s/x4r4cMJAMr5RZtd?path=%2F Еще более старые релизы]

=== FAQ ===
* [https://gitlab.ispras.ru/svace/svace-support/-/wikis/home Документация на статический анализатор Svace]
* [[Help:Introduction#Системные требования|Системные требования]]
* [[Примеры использования хуков#Создание кейсов в системах отслеживания ошибок|Создание из Svacer кейсов в Gitlab, Jira, Redmine]]
* Public REST API
:* [[Help:Public API#Примеры использования public REST API|Примеры использования]]
:* [https://gitlab.ispras.ru/svacer-public Репозитории с примерами на Python и Go]
:* [https://svacer-demo.ispras.ru/api/public/swagger/ Спецификация OpenAPI]
* [https://t.me/+6pvgZ0oveNVhOTc6 Группа технической поддержки в Telegram]

=== Демо ===
https://svacer-demo.ispras.ru

* admin / admin — логин / пароль администратора
* user / user — логин / пароль пользователя

Afilters

2026-01-13T12:42:30Z

Akuzmin: /* Данные о разметке */

= Advanced filters =
Поле "Расширенный фильтр" в пользовательских фильтрах предназначено для фильтрации маркеров (предупреждений) по сложным предикатам.
[[File:Image-afilters-prop.png|thumb]]
Предикат может использовать:

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

Формат фильтра определяется следующим шаблоном:

filter(markers, <predicate expr>)

Выражение <code><predicate expr></code> определяет предикат. Объект <code>markers</code> содержит массив маркеров из контекста, функция <code>filter</code> фильтрует данный список по предикату. Таким образом, применение фильтра заключается в фильтрации списка маркеров по указанному предикату.

== Список доступных полей ==

=== Поля маркера (предупреждения) ===

* <code>Comments</code> — список комментариев маркера. Объект типа Comment (смотрите ниже)
* <code>Details</code> — информация, специфичная для анализатора. Ближайший аналог — fingerprint в SARIF
* <code>File</code> — имя файла
* <code>Function</code> — имя функции, может быть mangled для С++
* <code>ID</code> — UUID маркера
* <code>Invariant</code> — инвариант маркера. Используется для автопереноса разметки между снимками
* <code>Lang</code> — язык детектора
* <code>Line</code> — номер строки в файле
* <code>LocID</code> — порядковый номер маркера относительно изначального отчета анализатора
* <code>MTid</code> — шаблон сообщения
* <code>Msg</code> — текст сообщения
* <code>OrigFunc</code> — 'человекочитаемое' имя функции. Может быть недоступно
* <code>Tags</code> — список тегов (меток) маркера
* <code>Tool</code> — модуль анализатора, ответственного за данный детектор
* <code>Traces</code> — список трасс маркера. Объект типа Trace (смотрите ниже)
* <code>WarnClass</code> — название детектора/класса детекторов

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

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

* <code>severity(item) string</code> — серьезность детектора (чекера)

Пример:

filter(markers, severity(#) == "Critical")

'''Внимание:''' использование в предикатах поля <code>Trace</code> может сказаться на скорости применения фильтра, т. к. загрузка большого числа трасс может занять время.

=== Данные о разметке ===
Поддерживаются следующие функции для получения информации о разметке:

* <code>status(item) string</code> — статус разметки текущего маркера. Пример: <code>filter(markers, status(#) == "Confirmed")</code>
* <code>action(item) string</code> — статус поля action текущего маркера. Пример: <code>filter(markers, action(#) == "Ignore")</code>
* <code>mseverity(item) string</code> — статус поля severity текущего маркера (не путать с severity детектора). Пример: <code>filter(markers, mseverity(#) == "Critical")</code>
* <code>triaged(item) bool</code> — возвращает true, если маркер имеет не дефолтную разметку. Пример: <code>filter(markers, triaged(#))</code>
* <code>get_triaged_by(item) UserInfo</code> — возвращает структуру с информацией о пользователе, который произвел разметку

Поля структуры <code>UserInfo</code>:

* <code>login: string</code> — логин пользователя
* <code>create_ts: Time (UTC)</code> — время разметки в UTC формате (RFC3339)

=== Комментарии ===
Объекты типа <code>Comment</code> содержатся в поле <code>Comments</code> маркера. Объект имеет следующие поля:

* <code>ID</code> — UUID комментария
* <code>Text</code> — текст комментария
* <code>CreatedBy</code> — имя пользователя, кто создал комментарий
* <code>CreateTs</code> — время создания комментария (объект типа <code>time.Time</code>)
* <code>UpdateTs</code> — время обновления комментария (объект типа <code>time.Time</code>), может быть пустым
* <code>UpdatedBy</code> — имя пользователя, кто обновил комментарий

=== Трассы ===
Маркер может содержать трассу маркера в поле <code>Traces</code>. Трасса описывается следующими структурами:
type Trace struct {
Role string
Locations []TraceEntry
}
type TraceEntry struct {
File string
Line uint32
Col uint32
Info string
}

Доступ к полям объекта <code>Trace</code> может выполняться, используя правила языка <code>go-expr</code>, описанные ниже.

Имена полей могут использоваться в виде как описано выше, либо в формате lowercase: <code>role, locations, file, line, col, info</code>

Пример:
filter(markers, any(.Comments, .Text == "Test") &&
any(.Traces, any(.Locations, .Info == "Boolean expression has constant value"))
)

=== Поля снимка ===
Для доступа к полям снимка можно использовать переменную <code>snapshot</code>. Переменная имеет тип структуры со следующими полями

struct {
ID string
Name string
SerialID uint32
BuildObject string
ResultsObject string
ImportTime time.Time
CreatedBy string
CreatedByID string
Details map[string]any
CreateTime time.Time
SourcesAvailable bool
}
Имена полей могут использоваться в виде, где первая буква в lowercase.

Объекты в поле <code>Details</code> можно просмотреть, нажав на кнопку <code>View JSON</code> в WebUI в поле <code>Snapshot Information</code>.

Пример:
filter(markers,
snapshot.buildObject == "5b634b75422bd554a8569cc10bfadc3aea77b73e" &&
.warnClass matches "DEREF"
)

== Описание языка предикатов ==
Для написания предикатов используется язык '''Expr'''. Детальное описание всех возможностей можно найти здесь: https://github.com/expr-lang/expr.

Далее описываются конструкции, наиболее подходящие для написания правил фильтрации.

=== Литералы ===
Comment /* */ or //
Boolean true, false
Integer 42, 0x2A, 0o52, 0b101010
Float 0.5, .5
String "foo", 'bar'
Array [1, 2, 3]
Map {a: 1, b: 2, c: 3}
Nil nil

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

Пример однострочного текста:
"Hello\nWorld"

Пример многострочного текста:
`Hello
World`

В многострочном тексте escape-последовательности не поддерживаются.

=== Операторы ===
Arithmetic: +, -, *, /, % (modulus), ^ or ** (exponent)
Comparison: ==, !=, <, >, <=, >=
Logical: not or !, and or &&, or or ||
Conditional: ?: (ternary), ?? (nil coalescing), if {} else {} (multiline)
Membership: [], ., ?., in
String: + (concatenation), contains, startsWith, endsWith
Regex: matches
Range: ..
Slice: [:]
Pipe: |

=== Операторы доступа к полю объекта ===
Можно использовать оператор <code>.</code> и оператор <code>[]</code>:
user.Name
user["Name"]

=== Оператор in ===
Оператор <code>in</code> для проверки наличия объекта в массиве или мэпе:
"John" in ["John", "Jane"]
"name" in {"name": "John", "age": 30}

=== Optional chaining ===
Оператор <code>?.</code> может использоваться для доступа к полю структуры или элементу отображения (map) без необходимости проверки, является ли структура или отображение равными <code>nil</code>. Если структура или отображение имеют значение <code>nil</code>, результатом выражения будет <code>nil</code>.

Пример вида:
author.User?.Name

значит то же самое, что:
author.User != nil ? author.User.Name : nil

=== Nil coalescing ===
Оператор <code>??</code> может использоваться для возврата левого операнда, если он не равен <code>nil</code>, в противном случае возвращается правый операнд.

Пример вида:
author.User?.Name ?? "Anonymous"

значит то же самое, что:
author.User != nil ? author.User.Name : "Anonymous"

=== Оператор конвейера ===
Оператор конвейера <code>|</code> может использоваться для передачи результата выражения левого операнда в качестве первого аргумента выражения правого операнда.

Пример вида:
user.Name | lower() | split(" ")

значит то же самое, что:
split(lower(user.Name), " ")

=== Предикаты ===
Предикат — это выражение. Предикаты можно использовать в функциях, таких как <code>filter, all, any, one, none</code> и других.
filter(0..9, {# % 2 == 0})
filter(tweets, {len(.Content) > 240})

Скобки <code>{ }</code> можно опускать:
filter(tweets, len(.Content) > 240)

=== Операции над строками ===
trim(str[, chars])
trimPrefix(str, prefix)
trimSuffix(str, suffix)
upper(str)
lower(str)
indexOf(str, substring)
lastIndexOf(str, substring)
hasPrefix(str, prefix)
hasSuffix(str, suffix)

Также есть оператор <code>matches</code> для поиска регулярного выражения в строке:
str matches "regular expression"

Для сопоставления целой строки с регулярным выражением следует использовать вариант:
str matches "^regex$"

=== Функции времени ===
Поддерживаются Go типы для времени и интервалов: <code>time.Time</code>, <code>time.Duration</code> из [https://pkg.go.dev/time time package].

Можно использовать операции сложения и вычитания над объектами с типом <code>time.Time</code>.

createdAt - now()
createdAt + duration("1h")
createdAt > now() - duration("1h")

date("2023-08-14")
date("15:04:05")
date("2023-08-14T00:00:00Z")
date("2023-08-14 00:00:00", "2006-01-02 15:04:05", "Europe/Zurich")

=== Функции над массивами ===
* <code>all(array, predicate)</code> — все объекты должны удовлетворять предикату
* <code>any(array, predicate)</code> — должен быть по крайней мере один объект, который удовлетворяет предикату
* <code>one(array, predicate)</code> — должен быть только один объект, который удовлетворяет предикату
* <code>none(array, predicate)</code> — ни один объект не должен удовлетворять предикату
* <code>find(array, predicate)</code> — возвращает первый объект, который удовлетворяет предикату
* <code>findLast(array, predicate)</code> — возвращает последний объект, который удовлетворяет предикату
* <code>count(array[, predicate])</code> — возвращает число объектов, удовлетворяющих предикату
* <code>first(array)</code> — первый объект из массива
* <code>last(array)</code> — последний объект из массива

Примеры:
all(tweets, {.Size < 280})
any(tweets, {.Size > 280})
none(tweets, {.Size > 280})
find([1, 2, 3, 4], # > 2) == 3
findLast([1, 2, 3, 4], # > 2) == 4
count(users, .Age > 18)
first([1, 2, 3]) == 1
last([1, 2, 3]) == 3

Afilters

2026-01-13T10:00:39Z

Akuzmin: return space to 'т. к.'

= Advanced filters =
Поле "Расширенный фильтр" в пользовательских фильтрах предназначено для фильтрации маркеров (предупреждений) по сложным предикатам.
[[File:Image-afilters-prop.png|thumb]]
Предикат может использовать:

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

Формат фильтра определяется следующим шаблоном:

filter(markers, <predicate expr>)

Выражение <code><predicate expr></code> определяет предикат. Объект <code>markers</code> содержит массив маркеров из контекста, функция <code>filter</code> фильтрует данный список по предикату. Таким образом, применение фильтра заключается в фильтрации списка маркеров по указанному предикату.

== Список доступных полей ==

=== Поля маркера (предупреждения) ===

* <code>Comments</code> — список комментариев маркера. Объект типа Comment (смотрите ниже)
* <code>Details</code> — информация, специфичная для анализатора. Ближайший аналог — fingerprint в SARIF
* <code>File</code> — имя файла
* <code>Function</code> — имя функции, может быть mangled для С++
* <code>ID</code> — UUID маркера
* <code>Invariant</code> — инвариант маркера. Используется для автопереноса разметки между снимками
* <code>Lang</code> — язык детектора
* <code>Line</code> — номер строки в файле
* <code>LocID</code> — порядковый номер маркера относительно изначального отчета анализатора
* <code>MTid</code> — шаблон сообщения
* <code>Msg</code> — текст сообщения
* <code>OrigFunc</code> — 'человекочитаемое' имя функции. Может быть недоступно
* <code>Tags</code> — список тегов (меток) маркера
* <code>Tool</code> — модуль анализатора, ответственного за данный детектор
* <code>Traces</code> — список трасс маркера. Объект типа Trace (смотрите ниже)
* <code>WarnClass</code> — название детектора/класса детекторов

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

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

* <code>severity(item) string</code> — серьезность детектора (чекера)

Пример:

filter(markers, severity(#) == "Critical")

'''Внимание:''' использование в предикатах поля <code>Trace</code> может сказаться на скорости применения фильтра, т. к. загрузка большого числа трасс может занять время.

=== Данные о разметке ===
Поддерживаются следующие функции для получения информации о разметке:

* <code>status(item) string</code> — статус разметки текущего маркера. Пример: <code>filter(markers, status(#) == "Confirmed")</code>
* <code>action(item) string</code> — статус поля action текущего маркера. Пример: <code>filter(markers, action(#) == "Ignore")</code>
* <code>mseverity(item) string</code> — статус поля severity текущего маркера (не путать с severity детектора). Пример: <code>filter(markers, mseverity(#) == "Critical")</code>
* <code>triaged(item) bool</code> — возвращает true, если маркер имеет не дефолтную разметку. Пример: <code>filter(markers, triaged(#))</code>
* <code>get_triaged_by(item) UserInfo</code> — возвращает структуру с информацией о пользователе, кто произвел разметку

Поля структуры <code>UserInfo</code>:

* <code>login: string</code> — логин пользователя
* <code>create_ts: Time (UTC)</code> — время разметки в UTC формате (RFC3339)

=== Комментарии ===
Объекты типа <code>Comment</code> содержатся в поле <code>Comments</code> маркера. Объект имеет следующие поля:

* <code>ID</code> — UUID комментария
* <code>Text</code> — текст комментария
* <code>CreatedBy</code> — имя пользователя, кто создал комментарий
* <code>CreateTs</code> — время создания комментария (объект типа <code>time.Time</code>)
* <code>UpdateTs</code> — время обновления комментария (объект типа <code>time.Time</code>), может быть пустым
* <code>UpdatedBy</code> — имя пользователя, кто обновил комментарий

=== Трассы ===
Маркер может содержать трассу маркера в поле <code>Traces</code>. Трасса описывается следующими структурами:
type Trace struct {
Role string
Locations []TraceEntry
}
type TraceEntry struct {
File string
Line uint32
Col uint32
Info string
}

Доступ к полям объекта <code>Trace</code> может выполняться, используя правила языка <code>go-expr</code>, описанные ниже.

Имена полей могут использоваться в виде как описано выше, либо в формате lowercase: <code>role, locations, file, line, col, info</code>

Пример:
filter(markers, any(.Comments, .Text == "Test") &&
any(.Traces, any(.Locations, .Info == "Boolean expression has constant value"))
)

=== Поля снимка ===
Для доступа к полям снимка можно использовать переменную <code>snapshot</code>. Переменная имеет тип структуры со следующими полями

struct {
ID string
Name string
SerialID uint32
BuildObject string
ResultsObject string
ImportTime time.Time
CreatedBy string
CreatedByID string
Details map[string]any
CreateTime time.Time
SourcesAvailable bool
}
Имена полей могут использоваться в виде, где первая буква в lowercase.

Объекты в поле <code>Details</code> можно просмотреть, нажав на кнопку <code>View JSON</code> в WebUI в поле <code>Snapshot Information</code>.

Пример:
filter(markers,
snapshot.buildObject == "5b634b75422bd554a8569cc10bfadc3aea77b73e" &&
.warnClass matches "DEREF"
)

== Описание языка предикатов ==
Для написания предикатов используется язык '''Expr'''. Детальное описание всех возможностей можно найти здесь: https://github.com/expr-lang/expr.

Далее описываются конструкции, наиболее подходящие для написания правил фильтрации.

=== Литералы ===
Comment /* */ or //
Boolean true, false
Integer 42, 0x2A, 0o52, 0b101010
Float 0.5, .5
String "foo", 'bar'
Array [1, 2, 3]
Map {a: 1, b: 2, c: 3}
Nil nil

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

Пример однострочного текста:
"Hello\nWorld"

Пример многострочного текста:
`Hello
World`

В многострочном тексте escape-последовательности не поддерживаются.

=== Операторы ===
Arithmetic: +, -, *, /, % (modulus), ^ or ** (exponent)
Comparison: ==, !=, <, >, <=, >=
Logical: not or !, and or &&, or or ||
Conditional: ?: (ternary), ?? (nil coalescing), if {} else {} (multiline)
Membership: [], ., ?., in
String: + (concatenation), contains, startsWith, endsWith
Regex: matches
Range: ..
Slice: [:]
Pipe: |

=== Операторы доступа к полю объекта ===
Можно использовать оператор <code>.</code> и оператор <code>[]</code>:
user.Name
user["Name"]

=== Оператор in ===
Оператор <code>in</code> для проверки наличия объекта в массиве или мэпе:
"John" in ["John", "Jane"]
"name" in {"name": "John", "age": 30}

=== Optional chaining ===
Оператор <code>?.</code> может использоваться для доступа к полю структуры или элементу отображения (map) без необходимости проверки, является ли структура или отображение равными <code>nil</code>. Если структура или отображение имеют значение <code>nil</code>, результатом выражения будет <code>nil</code>.

Пример вида:
author.User?.Name

значит то же самое, что:
author.User != nil ? author.User.Name : nil

=== Nil coalescing ===
Оператор <code>??</code> может использоваться для возврата левого операнда, если он не равен <code>nil</code>, в противном случае возвращается правый операнд.

Пример вида:
author.User?.Name ?? "Anonymous"

значит то же самое, что:
author.User != nil ? author.User.Name : "Anonymous"

=== Оператор конвейера ===
Оператор конвейера <code>|</code> может использоваться для передачи результата выражения левого операнда в качестве первого аргумента выражения правого операнда.

Пример вида:
user.Name | lower() | split(" ")

значит то же самое, что:
split(lower(user.Name), " ")

=== Предикаты ===
Предикат — это выражение. Предикаты можно использовать в функциях, таких как <code>filter, all, any, one, none</code> и других.
filter(0..9, {# % 2 == 0})
filter(tweets, {len(.Content) > 240})

Скобки <code>{ }</code> можно опускать:
filter(tweets, len(.Content) > 240)

=== Операции над строками ===
trim(str[, chars])
trimPrefix(str, prefix)
trimSuffix(str, suffix)
upper(str)
lower(str)
indexOf(str, substring)
lastIndexOf(str, substring)
hasPrefix(str, prefix)
hasSuffix(str, suffix)

Также есть оператор <code>matches</code> для поиска регулярного выражения в строке:
str matches "regular expression"

Для сопоставления целой строки с регулярным выражением следует использовать вариант:
str matches "^regex$"

=== Функции времени ===
Поддерживаются Go типы для времени и интервалов: <code>time.Time</code>, <code>time.Duration</code> из [https://pkg.go.dev/time time package].

Можно использовать операции сложения и вычитания над объектами с типом <code>time.Time</code>.

createdAt - now()
createdAt + duration("1h")
createdAt > now() - duration("1h")

date("2023-08-14")
date("15:04:05")
date("2023-08-14T00:00:00Z")
date("2023-08-14 00:00:00", "2006-01-02 15:04:05", "Europe/Zurich")

=== Функции над массивами ===
* <code>all(array, predicate)</code> — все объекты должны удовлетворять предикату
* <code>any(array, predicate)</code> — должен быть по крайней мере один объект, который удовлетворяет предикату
* <code>one(array, predicate)</code> — должен быть только один объект, который удовлетворяет предикату
* <code>none(array, predicate)</code> — ни один объект не должен удовлетворять предикату
* <code>find(array, predicate)</code> — возвращает первый объект, который удовлетворяет предикату
* <code>findLast(array, predicate)</code> — возвращает последний объект, который удовлетворяет предикату
* <code>count(array[, predicate])</code> — возвращает число объектов, удовлетворяющих предикату
* <code>first(array)</code> — первый объект из массива
* <code>last(array)</code> — последний объект из массива

Примеры:
all(tweets, {.Size < 280})
any(tweets, {.Size > 280})
none(tweets, {.Size > 280})
find([1, 2, 3, 4], # > 2) == 3
findLast([1, 2, 3, 4], # > 2) == 4
count(users, .Age > 18)
first([1, 2, 3]) == 1
last([1, 2, 3]) == 3

Help:Installation

2025-12-25T10:27:04Z

Akuzmin: /* Установка и запуск на Windows */ add Windows limitations note and link

== Установка и запуск ==
Для использования только клиента Svacer достаточно [[Svacer#Релизы|скачать исполняемый файл]] '''svacer''', или установить [[Help:Installation#Svacer|deb/rpm пакет]].

Сервер Svacer можно запустить в [[Help:Installation#docker compose|докере]] или из [[Help:Installation#deb/rpm|deb/rpm пакета]].

=== docker compose ===
Рекомендуемый и самый простой способ деплоя — развернуть сервер Svacer в докер-контейнерах, воспользовавшиcь [https://svacer.ispras.ru/extra/docker-compose.yml docker-compose.yml] файлом:

<nowiki>curl -LO https://svacer.ispras.ru/extra/docker-compose.yml</nowiki>
docker compose up -d

После запуска контейнеров веб-интерфейс Svacer будет доступен по адресу http://localhost:8080, логин / пароль — admin / admin.

Для сборки своего докер-образа Svacer можете использовать [[Dockerfile]] в качестве референса.

Для указания других параметров сервера можете [[Help:Configuration#Дополнительные параметры при запуске в docker|переопределить команду запуска]] в docker-compose файле.

=== deb/rpm ===
==== PostgreSQL ====
{{Note|type=info|text=Disclaimer
* Рекомендуемая версия PostgreSQL — 15 и выше. С более старыми версиями корректная работа Svacer не гарантируется.
* Svacer требует эксклюзивного доступа к базе. Использование одной и той же базы для нескольких экземпляров Svacer может приводить к порче данных.}}

Для работы сервера Svacer установите PostgreSQL, следуя [https://www.postgresql.org/download/linux документации postgres]. Для RedHat-based OS нужно дополнительно установить пакет postgresql-contrib соответствующей версии.

Пример для Ubuntu 22:

sudo apt install -y postgresql-common
sudo /usr/share/postgresql-common/pgdg/apt.postgresql.org.sh
sudo apt install -y postgresql-17

Пример для Rocky Linux 9.4:

<nowiki>sudo dnf install -y https://download.postgresql.org/pub/repos/yum/reporpms/EL-9-x86_64/pgdg-redhat-repo-latest.noarch.rpm</nowiki>
sudo dnf -qy module disable postgresql
sudo dnf install -y postgresql17-server postgresql17-contrib
sudo /usr/pgsql-17/bin/postgresql-17-setup initdb
sudo systemctl enable postgresql-17
sudo systemctl start postgresql-17

==== Браузер для PDF-отчетов ====
Для создания PDF-отчетов с использованием нового HTML-генератора установите браузер Google Chrome на машину, где запускается сервер Svacer. Рекомендуется устанавливать из официального репозитория, следуя [https://www.google.com/chrome/?platform=linux инструкции с сайта google].

{{Note|type=info|text=Рекомендуемые системные требования при генерации PDF-отчетов для больших проектов с использованием HTML-генератора: Intel Core i9, 64 GB RAM, SSD, видеокарта Nvidia}}

При запуске Svacer проверит доступность браузера для генерации PDF. Если он не установлен или генерация не работает, будет использован нативный генератор: менее продвинутый, но для него не нужен браузер. Можно явно включить использование нативного генератора, передав опцию <code>--pdf-generator=native</code> при запуске сервера Svacer.

При невозможности установить Google Chrome, например если нет пакета для вашего дистрибутива Linux, можно установить Chromium. Его пакет в репозиториях, в зависимости от вышей ОС, может называться <code>chromium-browser</code> или <code>chromium</code>. В некоторых случаях генерация с Chromium может не работать. Например, если Svacer установлен из deb-пакета, а Сhromium из snap (на Ubuntu он устанавливается именно так даже при использовании apt) и сервер Svacer запускается от отдельного системного пользователя, от которого Chromium не может запуститься. В этом случае установите Google Chrome, с ним генерация работает.

==== Svacer ====
На Debian-based OS добавьте apt-репозиторий и установите Svacer из него.

<nowiki>echo 'deb [signed-by=/usr/share/keyrings/ispras.gpg] https://repo.ispras.ru/apt /' | sudo tee /etc/apt/sources.list.d/ispras.list</nowiki>
<nowiki>curl -fsSL https://repo.ispras.ru/apt/key.asc | sudo gpg --dearmor -o /usr/share/keyrings/ispras.gpg</nowiki>
sudo apt update
sudo apt install -y svacer

На RedHat-based OS добавьте dnf-репозиторий и установите Svacer из него

<nowiki>curl -fsSL https://repo.ispras.ru/rpm/ispras.repo | sudo tee /etc/yum.repos.d/ispras.repo</nowiki>
sudo dnf install -y svacer

Для создания БД PostgreSQL запустите '''psql''' от учетной записи пользователя '''postgres'''

sudo su -l postgres
psql

И выполните следующие запросы:
create database svace;
create user svace with encrypted password 'svace';
grant all privileges on database svace to svace;
alter user svace superuser;

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

При использовании других значений нужно поменять параметры подключения к БД в файле '''/etc/default/svacer'''

SVACER_ARGS="--pg postgres://<user>:<password>@127.0.0.1:5432/<database>"

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

На Astra Linux необходимо в файле '''/etc/parsec/mswitch.conf''' установить параметр <code>zero_if_notfound: yes</code>, иначе при запуске Svacer будет ошибка подключения к БД вида

error obtaining MAC configuration for user "svace" (SQLSTATE 57P03)

После создания БД и конфигурации сервера Svacer запустить его можно следующими командами

sudo systemctl enable svacer
sudo systemctl start svacer

После чего проверить успешность запуска командой

systemctl status svacer

После запуска сервер будет доступен по адресу http://localhost:8080, логин / пароль — admin / admin.

=== Установка и запуск на Windows ===
{{Note|text=При запуске на Windows [[Help:Introduction#Системные_требования|поддерживается не вся функциональность сервера]]}}
* Скачайте установщик PostgreSQL для Windows: https://www.postgresql.org/download/windows
* Установите PostgreSQL, выбрав, как минимум, компоненты "PostgreSQL Server" и "Command Line Tools"
* Задайте пароль на шаге выбора пароля для суперпользователя
* Остальные параметры при установке можно оставить по умолчанию
* После установки PostgreSQL откройте консоль, перейдите в директорию, куда установили PostgreSQL, запустите его клиент с указанием пользователя "postgres" и авторизуйтесь с паролем, заданным во время установки
cd c:\Program Files\PostgreSQL\15\bin
psql -U postgres
* Запустится консоль управления PostgreSQL. Выполните в ней следующие команды, чтобы создать БД и пользователя для Svacer
create database svace;
create user svace with encrypted password 'svace';
grant all privileges on database svace to svace;
alter user svace superuser;
* Выйдите из консоли PostgreSQL
* Запустите '''svacer-server.exe''' из консоли с указанием параметров подключения к БД. Если при создании пользователя и БД PostgreSQL вы использовали для них имя по умолчанию 'svace', как в примере выше, то указывать данные для подключения к БД при запуске сервера не обязательно
svacer-server.exe run
* Если создавали пользователя или БД с другими именами, то при запуске сервера надо указать их явно
svacer-server.exe run --pg postgres://svacer_user:svacer_password@127.0.0.1:5432/svacer_database
* После запуска сервера его веб-интерфейс будет доступен по адресу http://localhost:8080, логин / пароль — admin / admin

== Обновление ==
{{Note|type=reminder|text='''Перед обновлением настоятельно рекомендуется [[Help:Backup|делать резервные копии]]'''}}

Миграции схем БД PostgreSQL и object store происходят автоматически при обновлении на новую версию Svacer. Поэтому для обновления Svacer достаточно остановить сервер старой версии, запустить сервер новой версии, указав ему те же параметры БД и object store, и подождать, пока не пройдет обновление, после чего Svacer запустится как обычно. При больших объемах данных в БД это может занять существенное время, до нескольких часов. Прогресс можно отслеживать по логам сервера.

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

{{Note|type=warn|text=После запуска Svacer при обновлении обязательно дождитесь пока миграция БД завершится. Если прервать процесс во время миграции, принудительно остановив Svacer, база данных может оказаться в неконсистентном состоянии и придется восстанавливать данные из бэкапа.}}

=== Upgrade notes ===
==== 12-x-x ====
* Рекомендуем обновить PostgreSQL до версии 15 или выше. С более старыми версиями корректная работа Svacer не гарантируется
* Если вы использовали аутентификацию с помощью LDAP в версиях Svacer 5-1-X и у вас не работает механизм тегирования или уведомлений (подписки), см [[LDAP_configuration#Некоторые_замечания_для_пользователей,_которые_использовали_LDAP_в_версиях_Svacer_5-1-X|решение проблем с отсутствием статуса пользователя в БД]]

==== 11-x-x ====
Нет специфических рекомендаций по обновлению.

==== 10-x-x ====
Нет специфических рекомендаций по обновлению.

==== 9-0-0 ====
{{Note|type=reminder|text=При обновлении на эту версию рекомендуем не меньше 8GB RAM для корректности миграций}}

Базово, никаких обязательных ручных действий с базой данных или object store при обновлении на 9-0-0 не требуется. Описанные ниже шаги могут помочь увеличить производительность сервера Svacer или решить возможные проблемы.

'''1.'''

В версии 9-0-0 поменялся формат object store, поэтому при обновлении с предыдущих версий Svacer на 9-0-0 или выше будет запущена конвертация object store в новый формат. Конвертация сначала записывает новые данные, а потом, если все прошло успешно, удаляет старые. Из-за этого для конвертации нужно примерно в два раза больше свободного дискового пространства, чем занимает текущий object store. При больших размерах object store и медленном диске конвертация может занять много времени.

Конвертация запустится автоматически при обновлении на 9-0-0, но можно запустить вручную отдельно:

svacer-server kvconvert --from <path> --to <path>

Расположение object store в файловой системе описано в [[Help:Backup#Бэкап object store вручную|разделе про бэкапы]].

'''2.'''

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

delete from checkers where id not in (select max(id) from checkers group by (config_id, checker_id, languages, tools));

Если вы уже выполняли этот запрос при [[Help:Installation#8-0-0|обновлении на 8-0-0]], то второй раз запускать не обязательно.

'''3.'''

После обновления на версию 9-0-0 и завершения всех миграций БД (когда станет доступен веб-интерфейс) рекомендуем выполнить команду <code>VACUUM FULL</code> в PostgreSQL для очистки и оптимизации базы данных.

psql -h <postgres_host> -U <username> <svacer_database_name> -c 'VACUUM FULL;'

Например:

psql -h localhost -U svacer svacer_db -c 'VACUUM FULL;'

==== 8-0-0 ====
Если при обновлении на версию 8-0-0 и выше возникает подобная ошибка
Key (config_id, checker_id, languages, tools)=(4cd178ce-a2b2-4692-a45a-f84b145c807b, FB.ICAST_QUESTIONABLE_UNSIGNED_RIGHT_SHIFT, {JAVA}, {SpotBugs}) is duplicated
Это значит, что в БД есть дубликаты чекеров. Выполните следующий SQL-запрос в PostgreSQL-базе Svacer, чтобы удалить их:
delete from checkers where id not in (select max(id) from checkers group by (config_id, checker_id, languages, tools));

Help:Introduction

2025-12-25T10:13:29Z

Akuzmin: /* Системные требования */ add Windows limitations

[[Category:Help]]
== Введение ==

Svacer предназначен для хранения и обработки результатов статического анализатора Svace и других анализаторов, поддерживающих формат [[Help:Sarif#Загрузка_на_сервер_из_SARIF|SARIF]].

Svacer состоит из двух исполняемых файлов: сервера и клиента
* Сервер используется для хранения и обработки результатов анализа, для [[Help:Installation|запуска]] нужен PostgreSQL с созданной БД
* Клиент — для взаимодействия с сервером, для него никакие зависимости не требуются

Запущенный сервер Svacer предоставляет [[Help:UI_manual#Авторизация_в_пользовательском_интерфейсе_сервера_Svacer|web-UI]] и [[Help:Public_API|REST API]] для взаимодействия.

В клиенте Svacer доступны команды для [[Help:Import_from_Svace|импорта]] предупреждений, [[Help:Import_from_Svace#Загрузка_данных_на_сервер|загрузки]] их на сервер и прочего взаимодействия с сервером.

=== Термины ===

{| class="wikitable"
|-
| Project
| Проект, подлежащий анализу. По умолчанию именем проекта считается имя директории, в которой был запущен ''svace build'' и ''svace analyze''.
На сервере проект содержит в себе несколько веток с результатами работы анализатора
|-
| Branch (ветка)
| Ветка в проекте с результатами работы анализатора. По умолчанию — master
|-
| Snapshot (снимок)
| Результат работы ''svace analyze'', импортированный в промежуточное хранилище или на сервер. Содержит:
* имя проекта;
* имя ветки;
* результаты анализа (предупреждения);
* исходники, которые были включены в build, на котором производился анализ;
* вспомогательная информация для навигации по исходникам;
* дополнительные данные;
Допускается импорт снимков без исходного кода и дополнительной информации
|-
| Marker (маркер, предупреждение)
| Предупреждение от статического анализатора с информацией о позиции в исходном файле
|-
| Разметка
| Проставление статуса маркера с опциональным добавлением комментария
|}

=== Состав дистрибутива ===

{| class="wikitable"
|-
| bin/svacer-server
| Бинарный файл сервера
|-
| bin/svacer-server.sig
| Файл подписи сервера
|-
| bin/svacer
| Бинарный файл клиента
|-
| bin/svacerai-server
| Бинарный файл сервера [[Help:XSvacer:AIAssistant|ИИ-ассистента]]
|-
| bin/pdfmergebin/libpdfium.so
| Бинарный файл и библиотека для [[Help:Installation#Генерация_PDF_на_основе_HTML|нового PDF-генератора]]
|-
| extra/docker-compose*.yml
| docker-compose файлы для запуска Svacer в docker-контейнерах
|}

=== Зависимости ===

{| class="wikitable"
|-
| PostgreSQL
| Нужен только для сервера. Рекомендуемая версия — 15 и выше. С более старыми версиями корректная работа Svacer не гарантируется.
|-
| libc.so libpthread.so libdl.so linux-vdso.so
| Серверная часть написана на Go с CGO_ENABLED=1 ввиду необходимости читать sqlite-файлы из результатов работы анализатора Svace
|-
| Директория для хранения object storage
| Сервер использует встроенную key-value database для хранения информации об исходном коде: контент-файлов и вспомогательной информации для навигации
|-
| Svace
| Нужен для импорта результатов анализа из .svace-dir. При этом лицензия на Svace нужна только для анализа, для импорта она не требуется
|}

=== Используемые порты ===

Приведены значения по умолчанию. Все значения могут быть переопределены.
{| class="wikitable"
|-
| 3002
| Используется для предоставления gRPC API (внутренний API для загрузки данных на сервер)
|-
| 8080
| Используется для REST API и web-сервера для предоставления web-UI
|}

=== Системные требования ===
{| class="wikitable"
|-
| CPU
| x86-64. Для больших проектов рекомендуется не менее 8 ядер
|-
| RAM
| От 4 ГБ. При обновлении между версиями лучше не меньше 8 ГБ. Для больших проектов — 16+ ГБ
|-
| HDD
| От 1 ГБ до нескольких ТБ при хранении множества снимков больших проектов
|-
| OS
|
* Ubuntu 18 и выше
* Debian 10 и выше
* RHEL/CentOS 8
* Rocky Linux 9 и выше
* Astra Linux Special Edition 1.7, базовый уровень защищенности
* Alt Linux p8 и выше
* Microsoft Windows 10

Функциональность сервера при запуске на Windows ограничена:
* Не поддерживается запуск сервера с параметром --svace: не будет работать импорт .svace-dir через WebUI и REST API
* Не поддерживается [[Help:Installation#Браузер_для_PDF-отчетов|генерация PDF на основе HTML]]
|-
| Browser
|
Для работы с веб-интерфейсом
* Chrome 103 и выше
* Firefox 100 и выше
* Opera 89 и выше
* Safari 16 и выше
* Edge 103 и выше
|}

Review replication

2025-12-18T12:14:46Z

Akuzmin: minor fixes

== Репликация разметки по правилам (экспериментальная функциональность) ==
При использовании разных версий Svace (или иных анализаторов), разных настроек CI/CD и прочих факторах возможны ситуации, когда снимки (snapshots) в рамках одной ветки (branch) могут иметь различные инварианты и разметка автоматически не переносится. Для решения задачи переноса разметки в таких случаях разработана утилита '''reviewer''', которая позволяет применить декларативно описанные правила переноса к существующей разметке. В дальнейшем данная функциональность будет включена в Svacer и доступна в веб-интерфейсе.

Использование утилиты подразумевает использование CLI команд <code>svacer markup2 export</code> и <code>svacer markup2 import</code> ([[Markup2|описание markup2]]) для выгрузки и импортирования разметки. Утилита reviewer обеспечивает модификацию выгружаемой разметки с целью копирования существующей разметки на неразмеченные элементы. Правила копирования задаются с использованием булевых выражений и набора предопределенных предикатов.

=== Описание утилиты ===
Утилита reviewer предназначена для Svacer версии 10 и выше. Утилита собрана под Linux, скачать можно [https://svacer.ispras.ru/releases/utils/reviewer отсюда].

==== История изменений ====
{| class="wikitable"
|+
!Версия
!Детали
|-
|devel.2025-12-18@05:11:18.075773d1
|
* Добавлена команда <code>reviewer migrate save</code> для сохранения разметки и комментариев из базы
* Добавлена команда <code>reviewer migrate restore</code> для восстановления разметки и комментариев

Команды предназначены для исправления пропущенной разметки или комментариев при апгрейде со старых версий Svacer на последний релиз.

Команды работают напрямую с базой. Могут также использоваться для бэкапа данных разметки и комментариев
|-
|devel.2025-09-15@04:26:40.654d90f2
|
* Добавлен флаг <code>--autofix-duplicate-invariants</code> для дублей инвариантов
* Добавлен флаг <code>--autofix-all</code> для дублей комментариев, инвариантов и потенциально иных проблем
* Добавлена команда <code>safe-copy</code>для копирования разметки между ветками с автоисправлением дублей комментариев и инвариантов
|-
|devel.2025-07-16@07:20:59.90a60fcd
|
* Добавлен флаг <code>--autofix-duplicate-comments</code> для удаления дублей комментариев, которые по какой-либо причине могут быть в исходных данных
|-
|devel.2025-07-14@07:20:15.74259281
|
* В журнал операций добавлены old/new статусы при операции replicate
* Добавлены вспомогательные функции <code>source_review_ct</code> и <code>target_review_ct</code> для получения времени разметки на source и target. Их можно использовать в предикатах
* Добавлено ассоциирование комментария с разметкой при репликации
* Добавлен ряд вспомогательных команд
|-
|devel.2025-06-03@09:35:03.ab170f00
|
* Исправлена работа при репликации разметки между разными проектами/ветками
|-
|devel.2025-05-26@06:18:01.853591f1
|
* Улучшено HTML-представление отчета
* Добавлен предикат <code>match_prefix_re</code> по аналогии с <code>match_suffix_re</code>
|-
|devel.2025-04-22@06:39:21.a3bc1bc1
|
* Добавлены предикаты <code>same_go_path</code> и <code>match_go_path</code> для упрощения написания правил при переносе разметки для Go проектов, где версии модулей меняются
|-
|devel.2025-04-21@04:53:47.15a3d5c0
|
* Добавлена версия
* Добавлена генерация журнала изменений
* Добавлена генерация информации о снимках при работе с сервером
* В результат записываются только обновленные разметки
* Добавлена возможность указания снимков в качестве фильтра (при условии работы с сервером)
|}

==== Использование ====
NAME:
reviewer - Svacer review help tool

USAGE:
reviewer [global options] command [command options] [arguments...]

VERSION:
devel.2025-04-21@04:53:47.15a3d5c0

COMMANDS:
syntax Prints help information about rule syntax
invariants Get information about invariants from branch. Output format is ReviewModificationJournal.SnapshotList with invariants
replicate Replicate non-empty review to invariants according to rules.
Review can be loaded either from file(s) or from server.

Review is replicated from source project/branch or file to target project/branch or file.

If no target project/branch or file is specified, replication is applied to source project/branch or file. This can be used to copy review within the same container.

Result is written to stdout or file. Reviewer does not update data on server.

help, h Shows a list of commands or help for one command

GLOBAL OPTIONS:
--debug Enabled debug output (default: false)
--log-file value Define log file for output
--host value Defines URL to svacer server. Format: <nowiki>http://host:port</nowiki>
--user value User login. When using env variable SVACER_AUTH_CREDS the format is SVACER_AUTH_CREDS=<login>:<password> (default: admin) [$SVACER_AUTH_CREDS]
--password value User password
--ldap_server value Server for LDAP authentication [$SVACER_LDAP_SERVER]
--token value Defines access token for svacer server [$SVACER_AUTH_TOKEN]
--help Show help (default: false)
--version Print version the program (default: false)

Основная команда — '''replicate''', она позволяет применить декларативные правила к разметке, полученной либо с сервера, либо из файла, куда ранее была выгружена командой <code>svacer markup2 export</code>. Результат работы команды — файл с разметкой, предназначенный для загрузки в Svacer посредством команды <code>svacer markup2 import</code>

NAME:
reviewer replicate - Replicate non-empty review to invariants according to rules.
Review can be loaded either from file(s) or from server.

Review is replicated from source project/branch or file to target project/branch or file.

If no target project/branch or file is specified, replication is applied to source project/branch or file. This can be used to copy review within the same container.

Result is written to stdout or file. Reviewer does not update data on server.

USAGE:
reviewer replicate [command options] <file name> - path to result file

OPTIONS:
--project value Project name or id
--branch value Branch name or id (default: master)
--target-project value Project name or id of the target project
--target-branch value Branch name or id of the target branch (default: master)
--source-snapshot value Snapshot name or id. Replicate reviews only from given snapshot. Host, project and branch must be provided
--target-snapshot value Snapshot name or id. Replicate reviews only to given snapshot. Host, project and branch must be provided
--file value Load review from file instead of server. File must be in 'json with new line separator' format. File may be gzipped (must have *.gz extension)
--target-file value Load target review from file instead of server. File must be in 'json with new line separator' format. File may be gzipped (must have *.gz extension)
--rule value Path to file containing replicate rules
--html Produce HTML report describing applied changes. Report is saved to <result file name>.html (default: false)
--verbose Verbose output of rule applications (default: false)
--process-all Process all reviews, even with non-default values (default: false)
--skip-comments Skip comments while replicating review information (default: false)
--skip-status Skip review status and copy only comments while replicating review information (default: false)
--journal value Write journal of modifications to specified file
--help Show help (default: false)

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

{
"actions": [
{
"source_invariant": "LX/DOWQxqWSdqMw1zBGr/A",
"target_invariant": "7YlVnmb/kAkwyxNBjCagiQ",
"rule": "unprocessed() && // ensure target has no review\n match_loc(warnclass,file,lang,tool,mtid, line) && // ensure main fields are the same\n match_suffix_re (function, \"(.+/)\" /* regexp for prefix */ ) // trim prefix and match suffix",
"source_id": "1",
"target_id": "13"
}
]
}

=== Шаги применения утилиты ===
'''Задача:''' в проекте myproject на ветке master необходимо перенести существующую разметку по некоторым правилам. Сервер запущен на localhost на порту 8080.

'''Шаги решения:'''

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

<nowiki>svacer markup2 --host=http://localhost:8080 --user admin --password admin export --project myproject --branch master --uncompressed --format json --export-all /tmp/myproject.json</nowiki>

2. Написать правила переноса разметки (предикатов переноса) в файл <code>/tmp/map.txt</code>

3. Если разметка была выгружена (шаг 1 выполнен), то применить утилиту reviewer '''с загрузкой данных из файла'''. Флаг <code>--html</code> создаст дополнительно HTML с информацией об изменениях, имя файла <code>/tmp/out.json.html</code>. Журнал изменений будет записан в файл <code>replicate_journal.json</code>

reviewer replicate --file /tmp/myproject.json --rule /tmp/map.txt --journal /tmp/replicate_journal.json --html /tmp/out.json

4. Если разметка не была выгружена (шаг 1 пропущен) применить утилиту reviewer '''с загрузкой данных с сервера'''. Флаг <code>--html</code> создаст дополнительно HTML с информацией об изменениях, имя файла <code>/tmp/out.json.html</code>. Журнал изменений будет записан в файл <code>replicate_journal.json</code>

<nowiki>reviewer --host=http://localhost:8080 --user admin --password admin replicate --project myproject --branch master --rule /tmp/map.txt --journal /tmp/replicate_journal.json --html /tmp/out.json</nowiki>

5. Проанализировать созданный журнал изменений и файл <code>/tmp/out.json.html</code>

6. Если результат устраивает, то загрузить обновленную разметку в сервер из файла <code>/tmp/out.json</code>

<nowiki>svacer markup2 --host=http://localhost:8080 --user admin --password admin import --project myproject --branch master /tmp/out.json</nowiki>

'''Примечания'''

Разметка в Svacer привязана к инвариантам. Инвариант это некоторый хэш, формируемый из полей предупреждения. Алгоритм формирования хэша описан в [[Help:Match#Описание алгоритма|этой статье]]. В рамках одного снимка все инварианты всегда уникальны.

Команда <code>markup2 export</code> с флагом <code>--export-all</code> выгружает все инварианты с ветки с информацией о разметке и комментариях.

При экспорте разметка на инварианте представлена как объект, соответствующий схеме, описанной в статье [[Markup2]]. Технически это:

* статус (тройка <code>status, severity, action</code>)
* набор комментариев
* массив locations, которые определяют множество мест, имеющих один и тот же инвариант

=== Алгоритм переноса разметки ===
Входные данные (разметка), полученные из файла или с сервера разбиваются на два вектора source и target. В source включаются все элементы с разметкой, отличной от разметки по умолчанию. В target включаются все оставшиеся элементы. Порядок элементов в source и target соответствует порядку объектов во входных данных (файле).

Если указана опция <code>--process-all</code> , то в source и target включаются все элементы (данную опцию следует использовать для случаев, если мы хотим заместить существующую разметку, а не перенести разметку на неразмеченные элементы)

Процедура проходит по всем парам <code>(source_item,target_item)</code> и для каждой пары вычисляет предикаты из файла с правилами в порядке их определения. Если какой-либо предикат вычислен в true, то происходит копирование статусов разметки и комментариев с <code>source_item</code> на <code>target_item</code>. Во избежание перезаписи разметки можно в правилах использовать предикат <code>unprocessed()</code> описанный ниже.

==== Файл задания предикатов переноса ====
Формат файла: UTF-8. Правила разделяются <code>;;</code>. В качестве комментариев допустимы <code>/**/</code> и <code>//</code>

Правила — это булевы выражение в синтаксисе [https://expr-lang.org/docs/language-definition go-expr], выражения использует операторы <code>&&, ||, !</code>, скобки и следующие дополнительные предикаты:

* <code>unprocessed()</code> — проверка, что target еще не содержит разметки. Рекомендуется использовать, чтобы избежать перезаписи разметки, если несколько правил сработали; при наличии такого предиката разметка будет скопирована лишь один раз для первого сработавшего предиката;

* <code>processed()</code> — проверка, что target уже содержит какую-либо не дефолтную разметку;

* <code>match_loc(field1, field2, ...)</code> — проверка, содержат ли locations в source и target хотя бы один общий location, который совпадает по указанным полям. Возможные поля: <code>warnclass, function, details, invariant, line, file, mtid, tool, lang</code>;

:Пример: <code>match_loc(warnclass,file,lang,tool,line)</code>

* <code>match_loc_strict(field1, field2, ...)</code> — проверка, содержат ли locations source и target одинаковые location по указанным полям;

:Пример: <code>match_loc_strict(warnclass,file,lang,tool,line)</code>

* <code>match_source_re(field, value)</code> — проверка, содержит ли location в source запись, где field совпадает с value. Value — Golang regexp;

* <code>match_target_re(field, value)</code> — проверка, содержит ли location в target запись где field совпадает с value. Value — Golang regexp;

* <code>source_review(status[, severity, action])</code> — проверка, если разметка source соответствует указанным параметрам. <code>severity, action</code> можно опускать, шаблон <code>"*"</code> соответствует всему;

* <code>target_review(status[, severity, action])</code> — проверка, если разметка target соответствует указанным параметрам. <code>severity, action</code> можно опускать, шаблон <code>"*"</code> соответствует всему;

* <code>match_source_range(lower_bound,upper_bound)</code> — проверка, если в source есть location, где line попадает в указанный диапазон. Значение <code>-1</code> означает отсутствие границы;

* <code>match_target_range(lower_bound,upper_bound)</code> — проверка, если в target есть location, где line попадает в указанный диапазон. Значение <code>-1</code> означает отсутствие границы;

* <code>match_suffix_re(field, source_prefix[,target_prefix])</code> — проверка, есть ли location в source и target, который содержит общий суффикс. Суффикс вычисляется путем отрезания префикса source_prefix и target_prefix. Если target_prefix не указан, то считается, что он равен source_prefix. Префикс определяется как Go regexp;

* <code>match_source_id(id1, id2, ...)</code> — проверка, если внутренний id source разметки совпадает с одним из аргументов;

* <code>match_target_id(id1, id2, ...)</code> — проверка, если внутренний id target разметки совпадает с одним из аргументов;

* <code>source_review_ct() time.Time</code> — возвращает время создания разметки в source;

* <code>target_review_ct() time.Time</code> — возвращает время создания разметки в target;

* <code>source_reviewed_by() string</code> — возвращает автора разметки в source;

* <code>target_reviewed_by() string</code> — возвращает автора разметки в target.

==== Пример предиката ====
// Перенос разметки для Go, где поменялся формат поля function в последних Svace

unprocessed() && // ensure target has no review
match_loc(warnclass,file,lang,tool,mtid, line) && // ensure main fields are the same
match_suffix_re (function, "(.+/)" /* regexp for prefix */ ) // trim prefix and match suffix
Файл с тремя предикатами, для случая изменения версий go модулей в пакете go-jmespath (<code>jmespath -> go-jmespath</code>)
// common case for function changes
unprocessed() &&
match_loc(warnclass,file,lang,tool,mtid, line) &&
match_suffix_re (function, "(.+/)" /* regexp for prefix */ )
;;
// handle go-jmespath case
unprocessed() &&
match_source_re(lang, "GO|Go") && match_target_re(lang, "GO|Go") &&
match_loc(warnclass,file,lang,tool,mtid, line, details)
;;
// handle go mod versions
unprocessed() &&
match_loc(warnclass,lang,tool,mtid, line) &&
match_source_re(lang, "GO|Go") && match_target_re(lang, "GO|Go") &&
same_go_path() &&
match_suffix_re (function, "(.+/)" /* regexp for prefix */ )

==== HTML отчет о результатах переноса ====
При использовании опции <code>--html</code>утилита формирует HTML файл с информацией о разметке и операциях по переносу. Файл предназначен для отладки процесса переноса. В будущем, в Svacer UI будет предусмотрен специальный интерфейс для просмотра результатов переноса.
[[File:ReviewerHTML1.png|none|thumb]]

При наличии переноса разметки в столбце с Review будет запись Review Source со ссылкой на элемент, откуда была перенесена разметка.
[[File:ReviewerHTMLReport2.png|none|thumb]]

При раскрытии элемента Review Source будут представлены основные поля location, соответствующих исходной разметке, откуда был сделан перенос.

Help:XSvacer:AIAssistant

2025-12-18T11:52:06Z

Akuzmin: Undo revision 3442 by Mitrofanov (talk)

{{Note|type=warn|text='''Disclaimer'''
* Это экспериментальная Proof of Concept версия, предоставляемая для ознакомления по принципу "как есть".
* Данная функциональность не связана с [https://svace.pages.ispras.ru/svace-website/2025/02/21/ai-assistant.html AI-ассистентом из анализатора Svace]. Функционал AI-ассистента из анализатора Svace будет интегрирован в Svacer в будущих версиях сервера.}}

== Поддержка ИИ-ассистента для разметки предупреждений ==
Данная функциональность позволяет использовать модель машинного обучения (ИИ) для помощи при разметке предупреждений.

ИИ-ассистент предназначен для разметки предупреждений статусами <code style="white-space: pre;">Confirmed</code> и <code style="white-space: pre;">False Positive</code>, которые были предсказаны моделью машинного обучения.

== Активация и запуск ИИ-ассистента ==

ИИ-ассистент реализован в виде отдельного сервиса, взаимодействующего со Svacer по REST API. Для его работы необходимо:

# Запустить docker-контейнер с моделью машинного обучения
# При необходимости: развернуть PostgreSQL-сервер для хранения базы данных ИИ-ассистента
# Запустить сервис ИИ-ассистента
# Активировать функциональность при запуске Svacer и настроить доступ к ИИ-ассистенту

=== docker compose ===
Самый простой способ деплоя — развернуть всё в докер-контейнерах, воспользовавшиcь подготовленным нами [https://svacer.ispras.ru/extra/docker-compose-with-ai.yml docker-compose] файлом:

<nowiki>curl -LO https://svacer.ispras.ru/extra/docker-compose-with-ai.yml</nowiki>
docker compose -f docker-compose-with-ai.yml up -d

=== deb/rpm ===
Если Svacer установлен из deb/rpm пакета:

1. Запустите docker-контейнер с моделью машинного обучения

docker run --rm -d --name svacerai-model -p 8000:8000 ispras/svacerai-model:latest

2. В PostgreSQL создайте отдельную БД для ИИ-сервера, запустив psql-консоль и выполнив команды:

sudo su -l postgres
psql
postgres=# create database svacerai;
postgres=# grant all privileges on database svacerai to svace;

(предполагается, что пользователь <code>svace</code> уже [[Help:Installation#deb/rpm|был создан]] для сервера Svacer)

3. В конфиг-файле ИИ-сервера <code>/etc/default/svacerai</code> укажите аргументы запуска

<pre>
# URL подключения к БД из второго шага
SVACERAI_PG_URL="postgres://svace:svace@127.0.0.1:5432/svacerai?sslmode=disable"

# адрес и порт модели из первого шага
SVACERAI_MODEL_URL="server-status:http://localhost:8000"

# интерфейс и порт, на котором будет запущен ИИ-сервер
SVACERAI_HOST="0.0.0.0:7001"

# URL сервера Svacer, который будет подключен к ИИ-серверу
SVACER_HOST="http://localhost:8080"
</pre>

4. Запустите systemd-сервис ИИ-сервера

systemctl start svacerai

5. В конфиг-файле сервера Svacer <code>/etc/default/svacer</code> включите фичу ИИ-ассистента, добавив флаг <code>--xsvacer.features aiAssistant</code> и укажите URL ИИ-сервера

<pre>
SVACER_ARGS="--pg ... --store ... --xsvacer.features aiAssistant"

# соответствует переменной SVACERAI_HOST из шага 3
XSVACER_AIASSISTANT_ASSISTANTHOSTURL=http://localhost:7001/
</pre>

6. Перезапустите сервер Svacer

systemctl restart svacer

== Дополнительная конфигурация ==
=== Подключение к ИИ-ассистенту ===
По умолчанию Svacer будет пытаться подключиться к ИИ-ассистенту по адресу <code style="white-space: pre;"><nowiki>http://localhost:8081/</nowiki></code>. Изменить этот адрес можно одним из способов:

# При запуске Svacer установить переменную окружения <code style="white-space: pre;"><nowiki>XSVACER_AIASSISTANT_ASSISTANTHOSTURL=http://{адрес ИИ-ассистента}:{порт}/</nowiki></code>
# В конфигурационном файле <code>svacer.cfg</code> добавить раздел

<pre style="white-space: pre;">
...
xsvacer:
...
aiAssistant:
assistantHostUrl: http://{адрес ИИ-ассистента}:{порт}/
...
</pre>

==== Запуск docker-контейнера с моделью машинного обучения ====
При запуске докер-контейнера с ИИ-моделью, можно создать и примонтировать вольюмы для постоянного хранения базы данных и кэша:

docker volume create svacer-ai-cache
docker volume create svacer-ai-pgdata
docker run --rm -d --name svacerai-model -p 8000:8000 -v svacer-ai-pgdata:/var/lib/postgresql/data -v svacer-ai-cache:/root/.cache ispras/svacerai-model:latest

* Вольюм <code style="white-space: pre;">cache</code> будет содержать кэш сервиса взаимодействия с моделью машинного обучения
* Вольюм <code style="white-space: pre;">pgdata</code> будет содержать файлы с данными встроенного в docker-образ PostgreSQL

=== Флаги команды запуска ИИ-ассистента ===

Глобальные флаги <code>svacerai-server help</code>

NAME:
svacerai-server - Svace AI server

USAGE:
svacerai-server [global options] command [command options] [arguments...]

COMMANDS:
run
help, h Shows a list of commands or help for one command

GLOBAL OPTIONS:
--debug (default: false) [$SVACER_AI_DEBUG]
--log-level value Defines log level. Available: info, warn, error [$SVACER_AI_LOG_LEVEL]
--log value Defines path to log file. By default file /tmp/svacer-ai-*.log will be created.
--config value Define path to file with config in YAML format (by default svacer-ai.cfg).
--help, -h show help

{| class="wikitable"
|+
!Название
!Тип данных
!Описание
|-
|debug
|bool
|Отладочный режим логирования
|-
|log-level
|string
|Уровень логирования
|-
|log
|string
|Путь к файлу с логами
|-
|config
|string
|Путь к [[Help:XSvacer:AIAssistant#Конфигурация по умолчанию|конфигурационному файлу]]
|}

Флаги запуска ИИ-ассистента <code>svacerai-server run help</code>

NAME:
svacerai-server run

USAGE:
svacerai-server run [command options] [arguments...]

OPTIONS:
--pg value Defines PostgreSQL connection URL
--host value Defines host name for the server
--svacer-host value Defines remote Svacer host
--ai-host value [ --ai-host value ] Specify the address of the service with AI models in the format <nowiki>{host id}:{http://{host address}}</nowiki>
--help, -h show help

{{Note|text=С помощью флагов запуска можно переопределять наиболее часто меняющиеся [[#Конфигурация по умолчанию|параметры конфигурации]] без необходимости создания файла <code>svacer-ai.cfg</code>}}

{| class="wikitable"
|+
!Название
!Тип данных
!Описание
!Формат
|-
|style="width: 80px"|pg
|string
|Строка подключения к базе данных ИИ-ассистента
|https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING-URIS
|-
|host
|string
|Адрес сетевого интерфейса и порт, на которых будет запущен ИИ-ассистент
|<code>{ip адрес}:{порт}</code>
|-
|svacer-host
|string
|Url сервиса Svacer, к API которого будет обращаться ИИ-ассистент
|https://en.wikipedia.org/wiki/URL#Syntax
|-
|ai-host
|[]string
|Список адресов сервисов с моделями машинного обучения. <code>host-id</code> — идентификатор сервиса моделей в [[Help:XSvacer:AIAssistant#Конфигурация по умолчанию|конфигурации]]
|<code><nowiki>{host id}:{url сервиса моделей}</nowiki></code>
|}

{{Note|text=При использовании [[#Конфигурация по умолчанию|конфигурации по умолчанию]], <code>{host id}</code> должен быть равен <code>server-status</code>}}

Пример:
<nowiki>svacerai-server run --pg postgres://svace:svace@127.0.0.1:5432/svacer_ai --host localhost:8095 --svacer-host http://localhost:8094 --ai-host server-status:http://localhost:7000</nowiki>

=== Конфигурация ИИ-ассистента ===

Управление настройками ИИ-ассистента осуществляется с помощью конфигурационного yaml-файла <code>svacer-ai.cfg</code> в рабочей директории сервиса.

{| class="wikitable"
|+
!Название
!Тип данных
!Описание
!Значение в конфигурации по умолчанию
|-
|db/url
|string
|Строка подключения к базе данных ИИ-ассистента
|<code>postgres://postgres:postgres@localhost:5432/svacer_ai?sslmode=disable</code>
|-
|http/host
|string
|Адрес сетевого интерфейса и порт, на которых будет запущен ИИ-ассистент
|<code>localhost:8081</code>
|-
|http/svacerHostUrl

ai/svacerHostUrl
|string
|Url сервиса Svacer, к API которого будет обращаться ИИ-ассистент
|<code><nowiki>http://localhost:8080/</nowiki></code>
|-
|http/svacerClientTlsCfg?

ai/svacerClientTlsCfg
|[https://pkg.go.dev/crypto/tls#Config *tls.Config]
|Настройки безопасного подключения к Svacer
|<pre style="white-space: pre;">
svacerClientTlsCfg:
insecureSkipVerify: true
</pre>
|-
|ai/svacerReviewCommentTemplate
|string
|Шаблон для формирования комментария к разметке выполненной с помощью ИИ-ассистента. В шаблон передаётся структура <code>processing.MarkerResult</code>
|См. [[Help:XSvacer:AIAssistant#Конфигурация по умолчанию|конфигурацию по умолчанию]]
|-
|ai/svacerReviewTags
|[]string
|Список названий меток, которые будут установлены маркерам, размеченным с помощью ИИ-ассистента
|<code>[AI]</code>
|-
|hosts
|map[string]object
|Список параметров подключения к сервисам с моделями машинного обучения, которые будет использовать ИИ-ассистент
|<pre style="white-space: pre;">
{id сервиса моделей}:
{параметры подключения}
(см. описание ниже)
</pre>
|}

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

Параметры подключения сервисов модели задаются в виде map, ключами которой являются идентификаторы сервисов. В значении содержатся следующие параметры:

{| class="wikitable"
|+
!Название
!Тип данных
!Описание
!Значение в конфигурации по умолчанию
|-
|url
|string
|Url сервиса с моделями машинного обучения
|<code><nowiki>http://localhost:7000</nowiki></code>
|-
|settings/requestBatchSize
|int
|Количество предупреждений, отправляемых для анализа моделью за раз
|<code>512</code>
|-
|settings/httpMultipartParameterName

settings/httpMultipartFileName

settings/httpMultipartContentType
|string
|Параметра multipart-запроса вызова модели
|<pre style="white-space: pre;">
httpMultipartParameterName: "file"
httpMultipartFileName: "file.csv"
httpMultipartContentType: "application/vnd.ms-excel"
</pre>
|-
|resources/modelList

resources/modelInference

resources/logs
|string
|Сопоставление названий ресурсов сервиса моделей
|<pre style="white-space: pre;">
modelList: "/models_info"

modelInference: "/use_model_for_file"

logs: "/log_file"
</pre>
|-
|defaults/dataCollector/csvSeparator
|string
|Разделитель csv-файла, который отправляется в сервис моделей
|<code>","</code>
|-
|defaults/dataCollector/additionalLineNumber
|int
|Количество строк исходного кода, которые добавляются до и после строки предупреждения при отправке в сервис моделей
|<code>0</code>
|-
|defaults/dataCollector/csvColumns
|[]string
|Названия столбцов csv-файла, который отправляется в сервис моделей
|<code>[id, warnClass, code]</code>
|-
|defaults/interpretation/defaultValue

defaults/interpretation/defaultValue

defaults/interpretation/defaultValue
|string
|Названия статусов, которые присваиваются результату вызова модели
|<pre style="white-space: pre;">
defaultValue: "Undecided"

leftClassValue: "False Positive"

rightClassValue: "Confirmed"
</pre>
|}

=== Конфигурация по умолчанию ===

Данная конфигурация применяется по умолчанию при запуске ИИ-ассистента, если отсутствует конфигурационный файл <code>svacer-ai.cfg</code>.

{{Note|type=error|text=Если файл <code>svacer-ai.cfg</code> существует, в нём должны содержаться все указанные параметры конфигурации.'''}}

<pre style="white-space: pre;">
varSvacerHostUrl: &svacerHostUrl "http://localhost:8080/"
varSvacerClientTlsCfg: &svacerClientTlsCfg
insecureSkipVerify: true
db:
url: "postgres://postgres:postgres@localhost:5432/svacer_ai?sslmode=disable"
http:
host: "localhost:8081"
svacerHostUrl: *svacerHostUrl
svacerClientTlsCfg: *svacerClientTlsCfg
ai:
svacerHostUrl: *svacerHostUrl
svacerClientTlsCfg: *svacerClientTlsCfg
svacerReviewCommentTemplate: |+
`Timestamp: {{now.UTC.Format "2006-01-02T15:04:05Z"}}`

`AI model: {{.Pipeline.Name}}`

`Confidence level: {{ printf "%.2f" (index .Interpretation 0).Confidence }}`

svacerReviewTags:
- AI
hosts:
server-status:
url: "http://localhost:7000"
settings:
requestBatchSize: 512
httpMultipartParameterName: "file"
httpMultipartFileName: "file.csv"
httpMultipartContentType: "application/vnd.ms-excel"
resources:
modelList: "/models_info"
modelInference: "/use_model_for_file"
logs: "/log_file"
defaults:
dataCollector:
csvSeparator: ","
additionalLinesNumber: 0
csvColumns:
- "id"
- "warnClass"
- "code"
interpretation:
defaultValue: "Undecided"
leftClassValue: "False Positive"
rightClassValue: "Confirmed"
</pre>

== Описание модели xgb.joblib ИИ-ассистента ==

Модель обучена на базе 50000+ размеченных предупреждений.

Для предсказания статуса разметки нами используются:
# языковая модель codebert-base для получения эмбеддингов кода;
# метод градиентного бустинга (xgboost) для решения задачи классификации.

Help:UI manual

2025-12-04T14:47:08Z

Akuzmin: review and minor fixes

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

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

Для авторизации в пользовательском интерфейсе сервера Svacer введите логин и пароль на странице ввода учётных данных. Учётные данные по умолчанию — admin / admin.
[[File:Авторизация 01.png|thumb|none|x300px|alt=AutorizationMain|Страница ввода учетных данных]]

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

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

[[File:Авторизация LDAP 02.png|thumb|none|x300px|alt=AutorizationLDAP|Страница входа по протоколу LDAP]]

После успешного входа отобразится пользовательский интерфейс сервера Svacer. При этом, если в прошлой сессии пользователь [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выбрал проект, его ветку и снимок]] или [[Help:UI manual#Использование фильтров|применил фильтры]], отобразятся эти проект, ветка и фильтры.

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

{{Note|type=info|text=''Чтобы после обновления системы в пользовательском веб-интерфейсе корректно отображались изменения, после авторизации обновите страницу в браузере – нажмите клавишу F5.''}}

== Описание основных элементов пользовательского интерфейса ==
Все страницы пользовательского интерфейса сервера Svacer устроены единообразно и состоят из двух частей:
# Верхняя панель – отображается на всех страницах пользовательского интерфейса. Содержит:
#* логотип сервера Svacer;
#* кнопки меню:
#** '''Разметка''' – [[Help:UI manual#Работа в режиме просмотра кода|просмотр и разметка найденных маркеров]], а также [[Help:UI manual#Сравнение снимков и маркеров|сравнение снимков или отдельных маркеров]];
#** '''Код''' – [[Help:UI manual#Работа в режиме разметки|просмотр снимков исходного кода]], связанного с результатами анализатора Svace;
#** '''Проекты''' – [[Help:UI manual#Управление проектами и группами проектов|управление проектами]] (режим доступен только пользователям с ролью admin);
#** '''Детекторы''' – [[Help:UI manual#Просмотр детекторов|просмотр списка детекторов]];
#** '''Статистика''' – [[Help:UI manual#Просмотр статистики|просмотр статистики разметки]] по всем проектам, веткам и снимкам, доступным пользователю;
#** '''Поиск''' – [[Help:UI manual#Глобальный поиск|глобальный поиск]] снимков, маркеров и комментариев к ним;
#* [[File:Icon settings.png|x25px]] – кнопка для перехода к [[Help:UI manual#Настройка сервера Svacer|настройке системы]];
#* [[File:Icon RuEng.png|x25px]] – переключатель языка пользовательского интерфейса;
#* [[File:Icon question mark.png|x25px]] – кнопка для перехода на страницу документации к системе;
#* [[File:Icon bell.png|25px]] – кнопка для перехода к [[Help:UI manual#Просмотр уведомлений в интерфейсе Системы|уведомлениям]];
#* [[File:Icon profile.png|x25px]] – кнопка меню пользователя, которое предоставляет следующие функции:
#** [[Help:UI manual#Настройка профиля пользователя|настройка профиля пользователя]];
#** [[Help:UI manual#Настройка интерфейса|настройка интерфейса]];
#** [[Help:UI manual#Настройка уведомлений|настройка уведомлений]];
#** [[Help:UI manual#Управление лицензией|управление лицензией]];
#** [[Help:UI manual#Просмотр информации о программе|просмотр информации о программе]];
#** [[Help:UI manual#Выход из системы|выход из системы]].
# Рабочая область – область экрана для просмотра информации и ввода, которая соответствует выбранному режиму работы или странице настроек.

:[[File:03 Основные элементы интерфейса – без VSCode.png|thumb|none|upright=3]]

== Базовые функции системы ==
=== Просмотр уведомлений в интерфейсе Системы===
Чтобы посмотреть уведомления, нажмите кнопку [[File:Icon bell.png|25px]] в правом верхнем углу экрана.

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

[[File:Notifications new.png|thumbnone|x300px|alt=NotificationList|Панель уведомлений]]

Нажмите кнопку [[File:Icon cross 01.png|15px]] для удаления уведомления.

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

=== Настройка профиля пользователя ===
Для перехода в профиль выберите пункт '''Профиль''' в меню пользователя в правом верхнем углу экрана:
[[File:06 Меню пользователя — без VSCode.png|thumb|none|250px|alt=UserMenu|Меню пользователя. Переход к настройке профиля]]

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

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

=== Изменение пароля ===
Для изменения пароля:
:1. Выберите пункт '''Профиль''' в меню пользователя.
:2. В разделе '''Профиль пользователя''' нажмите на ссылку '''Изменить пароль''':
:[[File:10_Профиль_изменение пароля.png|thumb|none|450px|Переход к изменению пароля в профиле пользователя]]
:3. В открывшемся окне:
::а) Введите текущий пароль.
::б) Дважды введите новый пароль.
::в) Нажмите кнопку '''Изменить'''.
::[[File:11_Профиль_ввод нового пароля.png|thumb|none|350px|Окно изменения пароля]]

=== Настройка интерфейса ===
Для перехода к настройкам выберите пункт '''Настройки интерфейса''' в меню пользователя в правом верхнем углу экрана:
[[File:187 Меню пользователя интерфейс.png|thumb|none|250px|alt=UserMenu|Меню пользователя. Переход к настройке интерфейса]]

В правой части экрана отобразится панель '''Настройки интерфейса''' с тремя группами параметров:
:1. '''Общие'''. Параметры этой группы позволяют:
::а) Выбрать фильтры, которые будут по умолчанию применяться при повторном входе в систему:
::*фильтры, установленные в предыдущей сессии (выбрано по умолчанию);
::*сохраненный пользовательский фильтр.
::б) Включить или выключить (выбрано по умолчанию) замену снимка на последний загруженный в БД Svacer снимок при открытии сохраненного контекста.
::Если параметр в состоянии «Выключен», при выборе проекта и ветки открывается последний импортированный снимок.
::в) Включить или выключить (выбрано по умолчанию) сохранение вкладок с открытыми файлами в каждом контексте.
::г) Включить (выбрано по умолчанию) или выключить сохранение применённой сортировки значений в таблице маркеров при [[Help:UI manual#Выход из системы|выходе из системы]].
::д) Включить или выключить (выбрано по умолчанию) механизм генерации PDF-файла на основе HTML при выгрузке отчета с [[Help:UI manual#Таблица маркеров|информацией о маркерах]].
{{Note|type=warn|text=''Для использования генерации PDF на основе HTML на сервере Svacer должен быть [[Help:Installation#Браузер для PDF-отчетов|установлен браузер Chromium или Google Chrome]].''}}
:[[File:08 общие настройки интерфейса.png|thumb|none|600px|alt=UserInterfaceSettings|Настройки интерфейса. Группа параметров «Общие»]]
:2. '''Навигационная панель'''. Параметры этой группы позволяют:
::а) Выбрать отображение по умолчанию данных [[Help:UI manual#Вкладка «Детекторы»|на вкладке '''Детекторы''']] навигационной панели:
::*группировка детекторов по уровням серьезности (выбрано по умолчанию);
::*отображение детекторов в виде списка.
:::Выбранное отображение будет применяться [[Help:UI manual#Вкладка «Детекторы»|на вкладке '''Детекторы''']] каждый раз после входа в систему.
::б) Выбрать отображение по умолчанию данных [[Help:UI manual#Вкладка «Файлы»|на вкладке '''Файлы''']] навигационной панели:
::*только имя файла (выбрано по умолчанию);
::*полный путь к файлу.
::в) Выбрать способ сортировки в колонке '''Маркеры''' [[Help:UI manual#Вкладка «Файлы»|на вкладке '''Файлы''']] панели навигации:
::*по общему количеству маркеров (выбрано по умолчанию);
::*по количеству размеченных маркеров.
:[[File:08_настройки навигационной панели.png|thumb|none|600px|alt=UserInterfaceSettings|Настройки интерфейса. Группа параметров «Навигационная панель»]]
:3. '''Просмотр кода'''. Параметры этой группы позволяют:
::а) Включить (выбрано по умолчанию) или выключить использование темной темы (темный фон, светлый текст) при просмотре файлов с исходным кодом.
::б) Включить или выключить (выбрано по умолчанию) переиспользование [[Help:UI manual#Вкладка с исходным кодом|вкладки с исходным кодом]] в редакторе кода.
::в) Включить или выключить (выбрано по умолчанию) отображение всех элементов трассы маркера по нажатии на ссылку '''Показать трассу''' [[Help:UI manual#Вкладка с исходным кодом|в виджете маркера]].
::Если параметр находится в состоянии «Выключен», то будет отображаться только первый элемент трассы.
::г) Выбрать отображение виджета относительно строки кода, с которой он связан:
::* над строкой кода (выбрано по умолчанию);
::* под строкой кода.
:[[File:08 настройки просмотра кода.png|thumb|none|600px|alt=UserInterfaceSettings|Настройки интерфейса. Группа параметров «Просмотр кода»]]
:Эти настройки сохраняются для учётной записи пользователя и не сбрасываются при новой сессии.
:Чтобы сбросить параметры любой группы к значениям по умолчанию, нажмите на ссылку '''Сбросить настройки''' внизу панели '''Настройки интерфейса'''.

=== Настройка уведомлений ===
Система может уведомлять пользователей по каналам E-mail и Telegram о следующих типах операций:
* добавление (при импорте, копировании, клонировании) и удаление снимков;
* изменение разметки маркеров;
* добавление комментариев к маркерам.

Для перехода к настройкам выберите пункт '''Настройки уведомлений''' в меню пользователя в правом верхнем углу экрана:
[[File:188 Меню пользователя - уведомления.png|thumb|none|250px|Меню пользователя. Переход к настройке уведомлений]]

В правой части экрана отобразится панель '''Настройки уведомлений''' с двумя группами параметров:
:1. '''Типы уведомлений'''. Параметры этой группы позволяют выбрать канал, по которому будут приходить уведомления, настроить и проверить его. Для этого:
::а) Включите опцию '''E-mail''' и (или) '''Telegram chat ID'''.
::При выборе уведомления по '''E-mail''' используется адрес электронной почты, указанный [[Help:UI manual#Настройка профиля пользователя|в профиле пользователя]].
::б) При выборе уведомления по '''Telegram''' введите '''Telegram chat ID'''.
::в) Чтобы проверить подключение к каналу нажмите кнопку '''Проверить'''.
::Отправится тестовое сообщение по указанным реквизитам:
::[[File:189 Настройки уведомлений.png|thumb|thumb|none|600px|alt=UserInterfaceSettings|Настройки уведомлений]]
:2. '''Подписки'''. Позволяют выбрать проекты, ветки и события, при возникновении которых будут приходить уведомления. Для этого:
::а) Для добавления подписки нажмите кнопку '''Добавить''' и в появившейся строке в раскрывающемся списке выберите проект и/или его ветку.
::Чтобы уведомления приходили при изменениях во всех проектах, доступных пользователю, выберите значение '''Все''' в раскрывающемся списке проектов.
::[[File:190 Настройки уведомлений. Выбор ветки.png|thumb|thumb|none|600px|alt=UserInterfaceSettings|Настройки уведомлений. Выбор ветки]]
::б) Выберите объекты, при изменении которых будут приходить уведомления – установите флажки в столбцах '''Снимки''', '''Разметка''', '''Комментарии'''.
::в) Если требуется получать уведомления о разметке и/или комментариях только в маркерах, в которых пользователь принимал участие, установите флажок в столбце '''Участие''' (доступен, только если установлены флажки в столбцах '''Разметка''' и/или '''Комментарии''').
::г) Для настройки исключения из подписки на уведомления нажмите кнопку [[File:Icon plus.png|x25px]].
::Кнопка примет вид [[File:Icon minus.png|x25px]].
::д) Для удаления подписки на уведомления нажмите кнопку [[File:Icon minus.png|x25px]].
::По окончании настройки уведомлений нажмите кнопку '''Сохранить'''.

=== Управление лицензией ===
{{Note|type=info|text=''В версии сервера Svacer 12.0.0 лицензия встроена в дистрибутив и не ограничивает функции системы. Срок действия встроенной лицензии – до 31.12.2027 г.''}}

Чтобы посмотреть текст лицензии системы и копировать его, а также для активации новой лицензии, выберите пункт '''Лицензия''' в меню пользователя в правом верхнем углу экрана.
В правой части экрана отобразится панель '''Лицензия'''.
[[File:231 Меню пользователя Переход к просмотру лицензии.png|thumb|none|450px|Меню пользователя. Переход к просмотру лицензии]]
[[File:232 Панель Лицензия.png|thumb|none|x400px|Панель «Лицензия»]]

Чтобы скопировать текст лицензии, нажмите кнопку [[File:Icon copy link.png|x15px]].
Чтобы активировать лицензию:
:1. Нажмите на ссылку '''Активировать новую'''.
:2. В открывшемся окне '''Активация лицензии''' введите лицензионный ключ и нажмите кнопку '''Активировать'''.
{{Note|type=warn|text=''Функция активации лицензии доступна пользователям с [[#Серверные доступы|серверным доступом]] '''Администрирование сервера'''.''}}
[[File:233 Окно Лицензия.png|thumb|none|600px|Окно «Активация лицензии»]]

=== Просмотр информации о программе ===
Чтобы посмотреть информацию о программе, выберите пункт '''О программе''' в меню пользователя в правом верхнем углу экрана.
[[File:12_Меню пользователя_о программе — без VSCode.png|thumb|none|250px|Меню пользователя. Переход к просмотру информации о программе]]

Откроется окно с информацией о программе
[[File:13 1 О программме.png|none|thumb|600x600px|Информация о программе]]
Нажмите на ссылку в строке '''Документация и релизы''' для перехода на страницу документации к системе и ссылкам для скачивания дистрибутивов релизов Svacer.

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

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

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

== Выбор контекста (проекта, ветки и снимка) ==
Для работы [[Help:UI manual#Работа в режиме разметки|в режиме разметки]] или [[Help:UI manual#Работа в режиме просмотра кода|режиме просмотра кода]] требуется выбрать проект, ветку и снимок с результатами работы анализатора Svace.

При необходимости список проектов можно отфильтровать по группе проектов. Это можно сделать в блоке, который расположен под [[Help:UI manual#Описание основных элементов пользовательского интерфейса|верхней панелью]].

[[File:14_Выбор проекта, верки, снимка.png|800px]]

По умолчанию после выбора проекта автоматически выбирается ветка master и последний импортированный снимок, если [[Help:UI manual#Настройка интерфейса|параметр '''При открытии сохраненного контекста заменить снимок на последний загруженный''']] находится в состоянии '''Выключен'''. Если master отсутствует, то ветку нужно выбрать вручную.

== Работа в режиме разметки ==
Режим разметки предоставляет следующий набор элементов управления:
:1. Навигационная панель:
:* [[Help:UI manual#Вкладка «Детекторы»|вкладка '''Детекторы''']];
:* [[Help:UI manual#Вкладка «Файлы»|вкладка '''Файлы''']].
:Эту панель можно скрыть. Для этого нажмите кнопку [[File:Button Скрыть навигацию.png|x25px]] в правом верхнем её углу. Чтобы панель раскрыть, нажмите кнопку [[File:Button Паказать навигацию.png|x25px]].
:2. Центральная панель:
:* [[Help:UI manual#Вкладка «Информация о снимке»|вкладка '''Информация о снимке''']] – открывается по нажатии кнопки [[File:Icon Information.png|25x25px]];
:* одна или несколько [[Help:UI manual#Вкладка с исходным кодом|вкладок с исходным кодом''']] (отображаются после выбора файлов в таблице маркеров или навигационной панели);
:* [[Help:UI manual#Таблица маркеров|таблица маркеров]];
:3. [[Help:UI manual#Функции правой панели|Правая панель]] с информацией о маркере.
:Эту панель можно скрыть. Для этого нажмите кнопку [[File:Button Паказать навигацию.png|x25px]] в левом верхнем её углу. Чтобы панель раскрыть, нажмите кнопку [[File:Button Скрыть навигацию.png|x25px]].

[[File:96 Режим разметки. Набор элементов управления.png|800px|thumb|none|Режим разметки. Набор элементов управления]]

=== Функции навигационной панели ===
==== Вкладка «Детекторы» ====
На этой вкладке отображается список детекторов Svace, которые сработали в выбранном снимке.

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

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

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

[[File:17 Файлы.png|thumb|none|300px|Вкладка '''Файлы''']]

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

На вкладке '''Файлы''' пользователю доступны следующие функции:
:1. Просмотр на [[Help:UI manual#Вкладка с исходным кодом|вкладке с исходным кодом]]: содержимого файла, места и содержания маркера, а также подробной информации о маркере [[Help:UI manual#Функции правой панели|на правой панели]] – без включения фильтрации по этому файлу. Для этого нажмите на имя файла.
:2. Применение фильтра по файлам [[Help:UI manual#Таблица маркеров|в таблице маркеров]] – для этого нажмите кнопку [[File:Icon plus.png|x25px]] в одной или нескольких строках.
:Фильтр применится, кнопка [[File:Icon plus.png|x25px]] в списке файлов поменяется на [[File:Icon minus.png|x25px]].
:3. Исключение файла из фильтра по файлам [[Help:UI manual#Таблица маркеров|в таблице маркеров]] – для этого нажмите кнопку [[File:Icon minus.png|x25px]] в строке файла.
:4. Отмена фильтрации [[Help:UI manual#Таблица маркеров|в таблице маркеров]] для всех выбранных файлов – для этого нажмите кнопку [[File:Icon minus 3.png|x25px]] или кнопку [[File:icon_return.png|x25px]] [[Help:UI manual#Вкладка «Детекторы»|на вкладке '''Детекторы''']].
:5. [[Help:UI manual#Блокировка разметки|Блокировка всех маркеров]] в файле для разметки другими пользователями – для этого нажмите кнопку [[File:icon_unlocked.png|x25px]] справа от названия файла (отображается при наведении курсора).
:6. Поиск по имени/пути файла в поле '''Поиск по полному пути'''. Поддерживается поиск с использованием [[Help:UI manual#Использование регулярных выражений|регулярных выражений]].
:7. Сортировка файлов по количеству маркеров – для этого нажмите кнопку [[File:Icon-expand-all.png|x25px]]
:8. Выгрузка списка отображаемых на панели файлов в файл формата .csv – для этого нажмите кнопку [[File:button_Скачать CSV.png|25px]]
:9. Настройка отображения файлов и сортировки в колонке '''Маркеры''' на вкладке '''Файлы''' – для этого нажмите кнопку [[File:icon_gear.png|x25px]] и поменяйте настройки.
:[[File:18 Временная настройка панели навигации.png|thumb|none|800px|Настройка отображения файлов и сортировки полей]]

=== Функции центральной панели ===
==== Вкладка «Информация о снимке» ====
На этой вкладке отображается информация о выбранном снимке.

[[File:19 Информация о снимке.png|thumb|left|600px|Вкладка '''Информация о снимке''']]
 
На вкладке '''Информация о снимке''' пользователю доступны следующие функции:
:1. Просмотр подробной информации о снимке во всплывающем окне – для этого нажмите кнопку '''Просмотреть JSON'''.
:2. Экспорт [[Help:UI manual#Экспорт|исходного кода, снимков и разметки]] – для этого нажмите кнопку '''Экспорт''' и выберите подходящий вариант.
:3. [[Help:UI manual#Импорт разметки|Импорт разметки]] – для этого нажмите кнопку '''Импорт''' и выберите подходящий вариант.
:4. Переход к более продвинутой навигации по исходному коду с подсветкой маркеров во встроенном Web-IDE Theia – для этого нажмите кнопку '''Открыть в IDE''' .
:{{Note|type=warn|text=''Функциональность является экспериментальной, доступна при наличии проектного доступа '''Экспорт снимков''' и запуске веб-приложения Svacer по протоколу HTTPS или на локальном хосте. Список доступных IDE определяется при инсталляции. Если доступна только одна IDE, то раскрывающийся список отсутствует, а IDE открывается сразу по нажатию кнопки '''Открыть в IDE'''. Если функциональность недоступна, кнопка '''Открыть в IDE''' неактивна и отображается иконка'' [[File:Icon attention.png|23x23px]]''.''}}
:5. Просмотр списка приложенных файлов — по нажатии кнопки '''Показать''', но только при наличии приложенных файлов.
:6. Скрытие списка приложенных файлов (возможно только при наличии приложенных файлов) – для этого нажмите на ссылку '''Скрыть'''.
:7. Удаление приложенного файла (возможно только при наличии приложенных файлов) — для этого нажмите кнопку [[File:icon_delete.png|x25px]].
:8. Просмотр пользовательских полей, которые пользователь указал при импорте – доступен по нажатии кнопки '''Показать''', но только при наличии этих полей.
:9. Просмотр параметров анализа во всплывающем окне – для этого нажмите кнопку '''Показать''' в строке '''Параметры анализа'''.
:10. Экспорт параметров анализа в формате .txt – для этого нажмите кнопку '''Скачать''' в строке '''Параметры анализа'''.
:11. [[Help:UI manual#Работа с таблицей статистики|Просмотр таблицы статистики]] – для этого нажмите кнопку '''Показать''' в строке '''Статистика по детекторам'''.
:Информация в таблице сгруппирована по параметрам детекторов, найденным маркерам и статусу их разметки.

==== Вкладка с исходным кодом ====
Вкладка открывается только после выбора файла [[Help:UI manual#Вкладка «Детекторы»|на вкладке '''Детекторы''']] или [[Help:UI manual#Вкладка «Файлы»|'''Файлы''']], а также [[Help:UI manual#Таблица маркеров|в таблице маркеров]]. Одновременно может быть открыто несколько вкладок с исходным кодом, если выключена [[Help:UI manual#Настройка профиля пользователя|настройка '''Переиспользование вкладки в редакторе кода''']].

В верхней части вкладки отображаются панель инструментов для работы с файлом [1] и полный путь к файлу [2]. Если в строке кода установлен курсор, то в нижнем правом углу вкладки отображается его позиция [3]:
[[File:20 Исходный код.png|thumb|none|600px|Полный путь к файлу и позиционирование курсора]]

На вкладке с исходным кодом пользователю доступны следующие функции:
:1. Отображение кода на весь экран – для этого нажмите кнопку [[File:Icon expand.png|23x23px]] или дважды кликните на вкладку файла.
:
:Для возврата к обычному отображению нажмите кнопку [[File:Icon minimize.png|24x24px]] или дважды кликните на вкладку файла.
:2. Переход к предыдущей или следующей строке, в которую пользователь установил курсор, – для этого используйте кнопки [[File:Button left.png|23x23px]] и [[File:Button right.png]] или сочетания клавиш '''Ctrl + <''' и '''Ctrl + >'''.
:3. Просмотр и открытие маркеров из списка всех маркеров в данном файле – для этого нажмите кнопку [[File:Icon list 2.png|x25px]].
:[[File:21 Исходный код Отображение списка маркеров.png|thumb|none|300px|right|Cписок маркеров в файле]]
:4. Отображение всех маркеров – для этого нажмите кнопку [[File:Icon Скрыть маркеры.png|24x24px]].
:Кнопка недоступна, если она уже нажата: все маркеры уже отображаются.
:5. Скрытие всех маркеров и трасс – для этого нажмите кнопку [[File:Icon Показать маркеры.png|24x24px]].
:Кнопка недоступна, если она уже нажата: все маркеры уже скрыты.
:6. Добавление комментария к строке кода – можно сделать двумя способами:
::а) Нажмите кнопку [[File:Button Comment Add.png|x25px]] в левой части строки, рядом с её номером (отображается только если в строке установлен курсор) и введите комментарий.
::ИЛИ
::б) Нажмите правой кнопкой мыши на строку и выберите пункт '''Добавить комментарий'''. Этим способом можно добавить несколько комментариев к одной строке.
:7. Просмотр комментария к строке – можно сделать двумя способами:
::а) Нажмите кнопку [[File:Button Comment view.png|x25px]] в левой части строки, рядом с её номером.
::ИЛИ
::б) Нажмите кнопку [[File:Button Comment view.png|x25px]] на панели инструментов и выберите в списке строку комментария.
::Отобразится виджет комментария, в котором доступны следующие функции:
::*добавление дополнительного комментария к этой строке кода по нажатии кнопки [[File:Button Comment Add.png|x25px]];
::*редактирование текста комментария по нажатии кнопки [[File:icon_edit3.png|x25px]];
::*удаление комментария по нажатии кнопки [[File:icon_delete 2.png|x25px]].
:[[File:118 Виджет комментария к строке кода.png|thumb|none|600px|Виджет комментария к строке кода]]
:8. Просмотр и открытие комментариев из списка всех комментариев в коде – для этого нажмите кнопку [[File:Button Comment view.png|x25px]] справа.
:9. Отображение всех комментариев в коде – для этого нажмите кнопку [[File:Button_Comment_view_all.png|x25px]] на панели инструментов.
:Кнопка недоступна, если она уже нажата: все комментарии уже отображаются.
:10. Скрытие всех комментариев в коде – для этого нажмите кнопку [[File:Button_Comment_hide_all.png|x25px]] на панели инструментов.
:Кнопка недоступна, если она уже нажата: все комментарии уже скрыты.
:11. Добавление открытого файла в [[Help:UI manual#Использование фильтров|фильтр]] [[Help:UI manual#Таблица маркеров|таблицы маркеров]] – для этого нажмите кнопку [[File:Icon filter add.png|x25px]] на панели инструментов.
:Фильтрация применится, вид кнопки поменяется на [[File:Icon filter remove.png|x25px]].
:12. Исключение файла из [[Help:UI manual#Использование фильтров|фильтра]] [[Help:UI manual#Таблица маркеров|таблицы маркеров]] – для этого нажмите кнопку [[File:Icon filter remove.png|x25px]] на панели инструментов.
:Фильтрация по этому файлу отменится, вид кнопки поменяется на [[File:Icon filter add.png|x25px]].
:13. Возврат к исходному маркеру (например, если был выбран другой связанный маркер на вкладке '''Трасса''' [[Help:UI manual#Функции правой панели|правой панели]]) – для этого нажмите кнопку [[File:Icon target.png|x25px]] в верхней части виджета маркера.
:14. [[Help:UI manual#Разметка маркера|Разметка маркера]] – установите '''Статус''', '''Серьезность''' и '''Действия''' в верхней части виджета маркера.
:15. Отображение блока элементов трассы в виджете маркера для строки кода – нажмите ссылку '''Показать трассу''' (доступна, если все блоки элементов трассы скрыты).
::Для последовательного перехода к другим элементам трассы воспользуйтесь кнопками [[File:Button up.png|x25px]] и [[File:Button down.png|x25px]].
::{{Note|type=info|text=''Отображение только первого элемента трассы или всех элементов трассы маркера по нажатии кнопки '''Показать трассу''' настраивается с помощью [[Help:UI manual#Настройка интерфейса|параметра '''Показывать всю трассу маркера''']].''}}
::[[File:97 Блок информации о элементе трассы.png|thumb|none|600px|Виджет маркера с блоком элемента трассы]]
:16. Скрытие блоков элементов трассы в виджете маркера для строки кода – нажмите ссылку '''Скрыть трассу''' (доступна, если хотя бы один блок элемента трассы отображается).
::Все открытые блоки элементов трассы маркера скроются.
:17. Переход к строке, в которой объявлена/определена переменная – нажмите правую кнопку мыши на строке исходного кода и выберите пункт '''Перейти к объявлению / Перейти к определению'''.
:{{Note|type=info|text=''Если для выделенного элемента кода нет объявления или определения, то отобразится сообщение: [[File:150 Объявление не найдено.png|247x247px]] или [[File:151 Определение не найдено.png|254x254px]].''}}

:18. Просмотр ссылок на панели внизу экрана – нажмите правую кнопку мыши на строке исходного кода и выберите пункт '''Найти ссылки'''. На этой панели отображается иерархический список файлов с номерами строк, в которых найдены ссылки:
:[[File:Исходный_код_Референсы.png|thumb|none|600px|Cписок файлов с номерами строк, в которых найдены ссылки]]

:* Чтобы перейти к строке кода, на которую найдена ссылка, нажмите на ссылку с номером строки на панели [1].
:* Чтобы посмотреть фрагмент кода, на который найдена ссылка, в режиме предпросмотра, нажмите кнопку [[File:icon_preview_code.png|x25px]] [2].
:{{Note|type=info|text=''Если для выделенного элемента кода нет ссылок, то отобразится сообщение: [[File:152 Ссылки не найдены.png|213x213px]].''}}

:19. Переход к просмотру выбранного файла [[Help:UI manual#Работа в режиме просмотра кода|в режиме просмотра кода]] – нажмите правую кнопку мыши на строке исходного кода и выберите пункт '''Открыть в режиме Код'''.
:20. Копирование ссылки на строку кода в буфер обмена – нажмите правую кнопку мыши на строке исходного кода и выберите пункт '''Копировать прямую ссылку'''.
::При переходе по этой ссылке будет открываться файл в режиме разметки с курсором на той строке кода, для которой была скопирована ссылка.
:21. Увеличение и уменьшение размера шрифта кода вместе с отображаемыми виджетами – нажмите правую кнопку мыши на любой строке исходного кода и выберите пункт '''Уменьшить''' или '''Увеличить''', либо установите курсор в любую строку и нажмите сочетание клавиш '''Ctrl + Alt + -''' или '''Ctrl + Alt + ='''
:22. Копирование строки кода – нажмите правую кнопку мыши на строке исходного кода и выберите пункт '''Copy'''.
:23. Вызов командной строки – нажмите правую кнопку мыши на строке исходного кода и выберите пункт '''Command Palette'''.
:[[File:25 Исходный код Вызов командной строки.png|thumb|none|600px|Командная строка]]

==== Таблица маркеров ====
Для раскрытия таблицы маркеров нажмите кнопку [[File:Button Показать таблицу.png|x25px]] в верхней части [[Help:UI manual#Функции центральной панели|центральной панели]], а для её скрытия – [[File:Button Скрыть таблицу.png|x25px]].

В верхней части таблицы находится панель, которая содержит:
* [[File:Field Детектор.png|x25px]] – поле с информацией [[Help:UI manual#Использование фильтров|о примененных фильтрах]]: как назначенных [[Help:UI manual#Функции навигационной панели|в навигационной панели]], так и с помощью [[Help:UI manual#Настройка и использование пользовательских фильтров|пользовательских фильтров]] и запросов;
* кнопка [[File:Icon download.png|x25px]] – выгрузка маркеров в файл формата .csv или .pdf: только для [[Help:UI manual#choice|выбранных]] или всех отображаемых маркеров, если ничего не выбрано. Отчет в формате .pdf может быть сгенерирован на основе HTML, так и существующим (нативным) способом. В PDF-отчете, сгенерированном на основе HTML, усовершенствованы стили, доработан титульный лист, актуализирован набор параметров для выгружаемых маркеров и пр.;
:{{Note|type=warn|text='''''Примечания:'''''
:* ''если в таблице не отображаются маркеры из-за примененных пользовательских фильтров, то в сгенерированном PDF-отчете будет указано «Нет маркеров (применены фильтры)»;''
:* ''для использования механизма генерации PDF-отчёта на основе HTML должна быть включена [[Help:UI manual#Настройка интерфейса|одноименная настройка]];''
:* ''генерация PDF-отчета на основе HTML может занимать больше времени, чем нативная генерация;''
:* ''спецсимволы (иконки), добавленные в комментариях к маркерам, не отображаются в выгруженном PDF-отчете.''}}

* кнопка [[File:Icon edit.png|x25px]] – переход [[Help:UI manual#Групповая разметка маркеров|к групповой разметке]] выбранных маркеров (доступна, если выбраны маркеры в таблице);
* кнопка [[File:Button_Comment_Add.png|x25px]] – переход к [[Help:UI manual#Добавление общего комментария к нескольким маркерам|добавлению общего комментария к нескольким выбранным маркерам]].

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

В таблице маркеров пользователю доступны следующие функции:
:1. Сортировка по значениям столбцов.
:2. Выбор маркеров для [[Help:UI manual#dwl pdf|выгрузки отчета]], [[Help:UI manual#Групповая разметка маркеров|групповой разметки]] или [[Help:UI manual#Добавление общего комментария к нескольким маркерам|добавления общего комментария к нескольким маркерам]] – для этого установите флажок в строке маркера.
:3. Просмотр подробной информации о маркере [[Help:UI manual#Функции правой панели|в правой панели]] и его места и содержания [[Help:UI manual#Вкладка с исходным кодом|на вкладке с исходным кодом]] – для этого дважды кликните на строку маркера или нажмите на имя файла в столбце '''Файл'''. Также для выбора можно использовать клавиши ↑ и ↓ – для перемещения по строкам, и Enter – для подтверждения выбора.
:4. Просмотр детальной информации о маркере в JSON-формате – для этого нажмите правой кнопкой мыши на маркер и выберите пункт '''Просмотреть JSON'''.
:5. Копирование детальной информации о маркере (JSON маркера) в буфер обмена – для этого нажмите правой кнопкой мыши на маркер и выберите пункт '''Копировать JSON'''.
:При переходе по этой ссылке будет открываться список маркеров в режиме разметки с открытым маркером (в правой панели и на вкладке с исходным кодом), для которого была скопирована ссылка.
:6. Копирование ссылки на маркер в буфер обмена – для этого нажмите правой кнопкой мыши на маркер и выберите пункт '''Копировать ссылку на маркер'''.
:7. Переход к [[Help:UI manual#Сравнение маркеров|сравнению одного маркера с другим]] – для этого нажмите правой кнопкой мыши на маркер и выберите пункт '''Сравнить с ...'''

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

На правой панели пользователю доступны следующие функции:
:1. Копирование ссылки на маркер – для этого нажмите кнопку [[File:Icon copy link.png|x25px]].
:2. [[Help:UI manual#Блокировка разметки|Блокировка маркера]] для разметки другими пользователями – для этого нажмите кнопку [[File:icon_unlocked.png|x25px]] в верхней части правой панели.
:3. [[Help:UI manual#Разметка маркера|Разметка маркера]] – для этого установите '''Статус''', '''Серьезность''' и '''Действие''' в верхней части правой панели.
:4. Просмотр истории разметки со связанными комментариями – для этого нажмите кнопку [[File:Icon history.png|x25px]] в верхней части правой панели.
:[[File:28 История изменения маркера.png|thumb|none|upright=2.5|Пример истории изменения разметки маркера]]

:5. Отображение маркера [[Help:UI manual#Вкладка с исходным кодом|на вкладке с исходным кодом]] нажмите кнопку с именем файла и номером строки в верхней части правой панели.
:6. Отображение элемента трассы [[Help:UI manual#Вкладка с исходным кодом|на вкладке с исходным кодом]] – для этого нажмите на ссылку с именем файла и номером строки на вкладке '''Трасса''' [1].
:7. Отображение кода, который соответствует строке трассы, в отдельном окне в режиме предпросмотра – для этого на вкладке '''Трасса''' нажмите кнопку [[File:Icon preview code.png|x25px]] рядом с именем файла и номером строки [2].
:[[File:31 Предпросмотр кода.png|thumb|none|upright=2.5|Элементы управления для работы с элементом трассы]]
:8. Просмотр и добавление комментариев к маркеру на вкладке '''Комментарии'''.
:Комментарии для каждого маркера уникальны. Добавление одинаковых комментариев недоступно.
:Редактор комментариев поддерживает синтаксис Markdown.
:Для упоминания пользователя, вставьте '''@''' и введите или выберите его логин. После добавления комментария по нажатии кнопки '''Применить''' указанному пользователю придет [[Help:UI manual#Просмотр уведомлений в интерфейсе Системы|уведомление в интерфейсе системы]] об упоминании с возможностью перехода к маркеру с этим комментарием.
:9. Редактирование и удаление комментариев на вкладке '''Комментарии''' с помощью кнопок [[File:Icon edit2.png|x25px]] и [[File:Icon delete.png|x25px]].
:Если [[Help:UI manual#Работа с проектами|для проекта]] установлен флажок '''Обязательный комментарий при разметке''', то удаление связанного с разметкой комментария недоступно. Его можно только отредактировать.
:[[File:32 Комментарии.png|thumb|none|upright=1.3|Вкладка '''Комментарии''']]
:{{Note|type=info|text='''''Примечания''':''
:* ''Пользователь может отредактировать и удалить только свои комментарии. Пользователю с доступом '''Изменение любых комментариев''' доступно редактирование и удаление комментариев всех пользователей. Если такой пользователь внёс изменения, то изначальный автор теряет возможность изменять свой комментарий (если у него нет доступа '''Изменение любых комментариев'''), так как авторство передаётся пользователю, который последним внёс изменения.''
:* ''Для отредактированного комментария отображается слово '''изменено''', при наведении курсора на которое отображается сообщение с логином пользователя, изменившего комментарий, и датой редактирования. Текст несохраненного комментария в поле добавления комментария не пропадает при переключении на другой маркер.''
:* ''Если открыт режим редактирования комментария, то при переключении на другой маркер режим редактирования закрывается и изменения не сохраняются.''}}
:10. Ввод, просмотр и редактирования комментария в отдельном диалоговом окне – для этого нажмите кнопку [[File:Button Comment Zoom.png|x25px]] рядом с полем ввода нового комментария или в поле существующего комментария.
:[[File:120 Окно создания, просмотра и редактирования комментария в отдельном диалоговом окне.png|thumb|none|upright=2|Окно создания, просмотра и редактирования комментария в отдельном диалоговом окне]]
:11. Просмотр подробной информации на вкладке '''Подробности'''. Содержит два блока:
:* информация о сработавшем детекторе: серьезность и надежность, а также связанные с ним коды CWE, которые содержат ссылки на описание дефектов безопасности на сайте [https://cwe.mitre.org cwe.mitre.org];
:* информацией о маркере: текстовые метки маркера, названия снимка и функции, инструмент, язык, текстовое описание и степень доверия, а также кнопки для перехода к просмотру истории маркера и запуску хуков.
::{{Note|type=info|text=''Svace, начиная с версии 4.0, для некоторых языков поставляется с моделью искусственного интеллекта, которая предсказывает истинность срабатывания маркера на основе предупреждений и собранных метрик. Это значение в Svacer отображается в параметре '''Степень доверия'''.''}}
::По нажатии на иконку [[File:icon_question_mark2.png|x25px]] справа от названия детектора отображается дополнительная информация о нём. Иконка не отображается, если дополнительная информация отсутствует.
:[[File:33 Подробная информация о маркере.png|thumb|none|upright=2|Вкладка '''Подробности''']]
:[[File:121 Окно с дополнительной информацией о детекторе.png|thumb|none|upright=2|Окно с дополнительной информацией о детекторе]]

:12. Просмотр истории обнаружения маркера в снимках данной ветки проекта – для этого на вкладке '''Подробности''' нажмите кнопку '''Показать''' в блоке информации о маркере в строке '''История'''.
:В окне просмотра истории доступна сортировка записей.
:[[File:35 История маркера.png|thumb|none|upright=2.5|Пример истории маркера]]
:13. Просмотр маркера в JSON-формате – для этого на вкладке '''Подробности''' нажмите кнопку '''Показать''' в блоке '''JSON'''.
:[[File:234 Пример JSON маркера.png|thumb|none|upright=2|Пример JSON маркера]]
:14. Запуск хуков (скриптов) – для этого нажмите кнопку '''Запустить''' на вкладке '''Подробности''' и в раскрывающемся списке доступных хуков выберите тот, который требуется запустить.
 

=== Использование фильтров ===
==== Общая информация ====
Настройка и использование фильтров доступны [[Help:UI manual#Работа в режиме разметки|в режиме разметки]].

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

# Фильтры [[Help:UI manual#Функции навигационной панели|навигационной панели]] [1]: детекторы, файлы или серьезность.
# Доступные для разметки – позволяют отобразить только маркеры, которые доступны пользователю для разметки, т. е. при использовании этого фильтра в списке не будут отображаться маркеры, заблокированные другими пользователями. Фильтр применяется по нажатии кнопки [[File:Icon view2.png|x25px]] [2] в правой части блока [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выбора проекта, ветки и снимка]].
# Размеченный – позволяют отобразить только размеченные маркеры. Фильтр применяется по нажатии кнопки [[File:Icon view.png|x25px]] [3] в правой части блока [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выбора проекта, ветки и снимка]].
# [[Help:UI manual#Настройка и использование пользовательских фильтров|Пользовательские фильтры]] – доступны по нажатии кнопки [[File:Button Фильтры.png|x25px]] [4] в правой части блока [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выбора проекта, ветки и снимка]].
# Запрос – фильтр, указанный в поле в верхней части [[Help:UI manual#Таблица маркеров|таблицы маркеров]] [5].

:[[File:36 Фильтры.png|thumb|none|upright=3|Существующие фильтры]]

Увидеть примененные фильтры (кроме '''Доступные для разметки''') и последовательность их применения можно в поле [[File:field Детектор.png|x25px]] в верхней части [[Help:UI manual#Таблица маркеров|таблицы маркеров]].

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

По нажатию кнопки [[File:Button Фильтры 2.png|x25px]] в правой части блока [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выбора контекста]] можно отменить примененные фильтры: пользовательский или все.

==== Настройка и использование пользовательских фильтров ====
Настроить пользовательские фильтры можно [[Help:UI manual#Работа в режиме разметки|в режиме разметки]]. Для этого:
:1. Нажмите кнопку [[file:button Фильтры.png|x25px]] в правой части блока [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выбора контекста]].
:В правой части экрана отобразится панель пользовательских фильтров, которая содержит три вкладки:
:* '''Пользовательский''' – параметры фильтрации, которые разделены на три группы:
::* параметры детекторов;
::* параметры маркеров;
::* файлы;
::* [[Afilters|расширенный фильтр]];
:* '''Сохраненные''' – список [[Help:UI manual#Работа с сохраненными фильтрами|сохраненных фильтров]];
:* '''Публичные''' – [[Help:UI manual#Работа с публичными фильтрами|список фильтров, доступных всем пользователям]].

:2. Настройте параметры фильтрации на вкладке '''Пользовательский''' – выберите значения в списках полей, нажмите кнопки со значениями, или введите значения.
:3. Нажмите на кнопку [[File:Icon cancel.png|x15px]] справа от значения в списке, чтобы отменить его выбор.
:4. Если параметры нужно исключить из поиска, нажмите на кнопку [[File:Icon plus 2.png|x25px]].
:Кнопка поменяется на [[File:Icon minus 3.png|x25px]].
:5. Если параметры нужно включить в поиск, нажмите на кнопку [[File:Icon minus 3.png|x25px]].
:Кнопка поменяется на [[File:Icon plus 2.png|x25px]].
:6. Если в полях '''Метки''', '''Функции''' и '''Файлы''' нужно использовать регулярные выражения:
::а) Нажмите на кнопку [[File:Button TextTempl.png|x25px]].
::Кнопка поменяется на [[File:Button Reg.png|x25px]].
::б) Введите [[Help:UI manual#Использование регулярных выражений|регулярные выражения]]. Используйте новую строку для разделения значений.
:7. Если в полях '''Метки''', '''Функции''' и '''Файлы''' нужно использовать текстовые шаблоны:
::а) Нажмите на кнопку [[File:Button Reg.png|x25px]].
::Кнопка поменяется на [[File:Button TextTempl.png|x25px]].
::б) Введите текстовые шаблоны. Используйте новую строку для разделения значений.
:8. Для создания сложного фильтра с поиском по предикатам задайте в поле '''Расширенный фильтр''' параметры в формате <code>filter(markers, <predicate expr>)</code>, где:
::* <code>filter ()</code> – функция, которая фильтрует список по предикату;
::* <code>markers</code> – объект, который содержит массив маркеров из контекста;
::* <code><predicate expr></code> – выражение, которое определяет предикат.
::Описание используемых в этом фильтре функций, объектов и выражений, а также языка предикатов доступно по нажатии на иконку [[File:Icon question mark2.png|x25px]] и в [[Afilters|статье документации]].
:9. Нажмите кнопку [[File:Button Очистить.png|x25px]], чтобы очистить все параметры фильтрации.
:10. Нажмите кнопку [[File:Button Сохранить как.png|x25px]], в открывшемся диалоге введите название и нажмите кнопку '''Сохранить'''.
:Фильтр сохранится и отобразится на [[Help:UI manual#Работа с сохраненными фильтрами|вкладке '''Сохраненные''']].
:11. Нажмите кнопку [[File:Button Применить.png|x25px]], чтобы применить фильтр.
:После применения кнопка фильтра станет зеленой, а ее название поменяется на название сохраненного фильтра.
::[[File:36 Пользовательские фильтры.png|thumb|none|upright=2|Пользовательские фильтры. Вкладка '''Пользовательский''']]

==== Работа с сохраненными фильтрами ====
На вкладке '''Сохраненные''' отображаются фильтры, [[Help:UI manual#filters saved|сохраненные на вкладке '''Пользовательский''']], а также [[Help:UI manual#filters published|скопированные с вкладки '''Публичные''']].
:[[File:37 Фильтры сохраненные.png|thumb|none|upright=2|Пользовательские фильтры. Вкладка '''Сохраненные''']]

Воспользуйтесь функциями управления фильтрами на вкладке '''Сохраненные''':
:1. Для поиска фильтра введите его название в строке поиска.
:2. Для сортировки фильтров по названию нажмите кнопку [[File:Button Sort.png|x25px]].
:3. Для редактирования сохраненного фильтра нажмите кнопку [[File:Icon edit3.png|x25px]] и [[Help:UI manual#Настройка и использование пользовательских фильтров|внесите изменения]].
:4. Создайте дубликат фильтра – нажмите кнопку [[File:Icon duplicate.png|x25px]].
:5. Для публикации фильтра нажмите кнопку [[File:Button share.png|x25px]].
:Копия сохраненного фильтра отобразится [[Help:UI manual#Работа с публичными фильтрами|на вкладке '''Публичные''']] и станет доступна другим пользователям.
:{{Note|type=warn|text=''Функция доступна только пользователям с [[#Серверные доступы|серверным доступом]] '''Управление публичными фильтрами'''''.}}
:6. Для удаления одного фильтра нажмите кнопку [[File:Icon delete 2.png|x25px]].
:7. Для удаления нескольких фильтров:
::а) Выберите фильтры для удаления – установите флажки в левой части названий фильтров или нажмите кнопку '''Выбрать всё'''.
::б) Нажмите кнопку '''Удалить'''.
:8. Примените фильтр – нажмите на его название и нажмите кнопку [[File:Button Применить.png|x25px]].

После применения:
* примененный фильтр будет отмечен [[File:Icon check.png|x25px]];
* кнопка фильтра станет зеленой, а ее название поменяется на название сохраненного фильтра.

==== Работа с публичными фильтрами ====
{{Note|type=warn|text=''Создание (публикация), изменение и удаление публичных фильтров доступны пользователям с [[#Серверные доступы|серверным доступом]] '''Управление публичными фильтрами'''''.}}

На вкладке '''Публичные''' отображаются фильтры, [[Help:UI manual#filters publishing|опубликованные на вкладке '''Сохраненные''']].
<gallery mode="packed" heights="300px" style="float:left; clear:right; margin-right:1em; margin-left:1em">
153 Пользовательские фильтры. Публичные без доступа.png|Пользовательские фильтры. Вкладка '''Публичные'''. Вид для пользователя без серверного доступа '''Управление публичными фильтрами'''
154 Пользовательские фильтры. Публичные с доступом.png|Пользовательские фильтры. Вкладка '''Публичные'''. Вид для пользователя с серверным доступом '''Управление публичными фильтрами'''
</gallery>
 
Воспользуйтесь функциями управления фильтрами на вкладке '''Публичные''':
:1. Для поиска фильтра введите его название в строке поиска.
:2. Для сортировки фильтров по названию нажмите кнопку [[File:Button Sort.png|x25px]].
:3. Чтобы посмотреть параметры фильтра, нажмите кнопку [[File:Button show.png|x25px]].
:{{Note|type=warn|text=''Функция доступна только пользователям БЕЗ [[#Серверные доступы|серверного доступа]] '''Управление публичными фильтрами.'''''}}
:4. Для редактирования публичного фильтра нажмите кнопку [[File:Icon edit3.png|x25px]] и [[Help:UI manual#Настройка и использование пользовательских фильтров|внесите изменения]].
:5. Скопируйте публичный фильтр – нажмите кнопку [[File:Icon duplicate.png|x25px]].
:Фильтр сохранится и отобразится [[Help:UI manual#Работа с сохраненными фильтрами|на вкладке '''Сохраненные''']].
:6. Для удаления одного фильтра нажмите кнопку [[File:Icon delete 2.png|x25px]].
:7. Для удаления нескольких фильтров:
::а) Выберите фильтры для удаления – установите флажки в левой части названий фильтров или нажмите кнопку '''Выбрать всё'''.
::б) Нажмите кнопку '''Удалить'''.
:8. Примените фильтр – нажмите на его название и нажмите кнопку [[File:Button Применить.png|x25px]].

После применения:
* примененный фильтр будет отмечен [[File:Icon check.png|x25px]];
* кнопка фильтра станет зеленой, а ее название поменяется на название сохраненного фильтра.

=== Сравнение снимков и маркеров ===
Чтобы сравнить снимки и маркеры в них:
:1. [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|Выберите исходный контекст]] – проект, ветку, снимок.
:2. [[Help:UI manual#Работа в режиме разметки|В режиме разметки]] нажмите кнопку [[File:Button Сравнить с.png|x25px]] и в раскрывшемся списке выберите пункт '''Сравнить с…'''.
:3. В открывшемся окне выберите проект, ветку и снимок для сравнения; нажмите кнопку [[File:Button Применить.png|x25px]].
:[[File:38 Выбор снимка для сравнения.png|thumb|none|upright=1.5|Выбор проекта, ветки и снимка для сравнения]]
:Результат сравнения отобразится [[Help:UI manual#Функции навигационной панели|в навигационной панели]] и [[Help:UI manual#Функции центральной панели|центральной панели]], причем:
:* вкладка '''Информация о снимке''' поменяется на вкладку '''Информация о различиях''' с информацией о двух сравниваемых снимках;
:* применится первый режим сравнения, в котором найдены результаты.
:4. Выберите режим сравнения.
:[[File:39 Выбор режима сравнения.png|800px|thumb|none|Выбор режима сравнения]]
:[[Help:UI manual#Функции навигационной панели|В навигационной панели]] и [[Help:UI manual#Функции центральной панели|центральной панели]] отобразятся только результаты выбранного режима сравнения. В режимах '''Сопоставленные''' и '''Одинаковые''' [[Help:UI manual#Таблица маркеров|в таблице маркеров]] добавится столбец с номером версии: V1 – маркер в файле текущего снимка, V2 – маркер в файле целевого снимка.
:{{Note|type=info|text=''Если при просмотре кода файла целевого снимка перейти к просмотру файла [[Help:UI manual#Работа в режиме просмотра кода|в режиме '''Код''']] (команда '''Открыть в режиме код'''), то режим сравнения закроется, отобразится контекст целевого снимка.''}}
<gallery heights="210" perrow="2" mode="packed" style="float:left; clear:right; margin-right:1em; margin-left:2em" "="">
File:40 Пример сравнения новые.png|Пример результатов сравнения в режиме '''Только в V1'''
File:41 Пример сравнения Отсутствующие.png|Пример результатов сравнения в режиме '''Только в V2'''
File:42 Пример сравнения Сопоставленные.png|Пример результатов сравнения в режиме '''Сопоставленные'''
File:43 Пример сравнения Одинаковые.png|Пример результатов сравнения в режиме '''Одинаковые'''
</gallery>
 
:5. Посмотрите различия в параметрах анализа – нажмите кнопку '''Показать различия''' на вкладке '''Информация о различиях'''.
:[[File:44 Различия в результатах анализа.png|600px|thumb|none|Сравнение настроек анализа]]
:6. Посмотрите различия в статистике разметки – нажмите кнопку '''Различия разметок'''.
:[[File:45 Различия в статистике по детекторам.png|thumb|none|600px|Сравнение статистики разметок]]
:7. Нажмите кнопку [[File:Icon download CSV.png|x25px]] или [[File:Icon download PDF.png|x25px]], чтобы скачать статистику в формате CSV или PDF.
:8. Отмените сравнение – нажмите кнопку [[File:Icon cancel 2.png|x25px]] в блоке выбора проекта, ветки и снимка.
 

=== Сопоставление маркеров ===
{{Note|type=warn|text=''Функциональность доступна пользователям с [[#Проектные доступы|проектным доступом]] '''Разметка маркеров''' и [[#Серверные доступы|серверным доступом]] '''Администрирование сервера'''''}}

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

Результат сопоставления, выполненного вручную, можно отменить.
==== Сопоставление маркеров вручную ====
Сопоставление маркеров вручную проводится в два этапа:
:а) Выбор пар маркеров и их сопоставление, без сохранения в БД.
:б) Просмотр выбранных пар и подтверждение операции.

Чтобы вручную сопоставить маркеры:
:1. [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|Выберите исходный контекст]].
:2. [[Help:UI manual#Работа в режиме разметки|В режиме разметки]] нажмите кнопку [[File:Button Сравнить с.png|x25px]] и в раскрывшемся списке выберите пункт '''Сопоставить маркеры'''.
:Откроется окно '''Сопоставить маркеры'''.

:3. Этап 1. На вкладке '''Сопоставление маркеров''':
::а) Выберите снимок, маркеры которого нужно сопоставить с исходным.
::Отобразятся две таблицы маркеров: слева – для исходного снимка, а справа – для выбранного.
::б) Чтобы перед сопоставлением сравнить маркеры, выберите маркеры – по одному в каждой таблице – и нажмите кнопку '''Сравнить''' (расположена над таблицей).
::Отобразится окно сравнения выбранных маркеров.
::Если требуется, повторите операцию для других пар маркеров.
::в) Выберите маркеры для сопоставления – по одному в каждой таблице – и нажмите кнопку '''Сопоставить''' (расположена над таблицей). Если требуется, повторите операцию для других пар маркеров.
::Для сопоставленных маркеров справа от названия будет отображаться номер сопоставленной пары.
::г) Для отмены сопоставления пары маркеров выберите любой сопоставленный маркер и нажмите '''Отменить сопоставление''' (расположена над таблицей). Если требуется, повторите операцию для других пар маркеров.
::д) Для просмотра фрагмента кода, в котором находится маркер – нажмите кнопку [[File:icon_preview_code.png|x25px]].
::е) Для отказа от дальнейшего сопоставления и отмены всех изменений нажмите кнопку '''Отмена'''.
::ж) Для перехода к подтверждению выбора нажмите кнопку '''Далее'''.

:[[File:122 Выбор снимка и сопоставление пар маркеров.png|800px|thumb|none|Окно '''Сопоставить маркеры'''. Выбор снимка и сопоставление пар маркеров]]
:[[File:48 Различия исходного кода.png|800px|thumb|none|Окно '''Сравнение маркеров''']]

:4. Этап 2. В открывшейся форме:
::а) Проверьте список сопоставленных пар маркеров для применения операций сопоставления.
::б) Для корректировки списка сопоставленных пар маркеров нажмите кнопку '''Назад''' и выполните операции [[Help:UI manual#MarksStep1|Этапа 1]].
::в) Для отказа от дальнейшего сопоставления и отмены всех изменений нажмите кнопку '''Отмена'''.
::г) Для запуска операции сопоставления нажмите кнопку '''Подтвердить'''.

:[[File:123 Подтверждение сопоставления.png|800px|thumb|none|Окно «Сопоставить маркеры». Подтверждение сопоставления]]

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

:[[File:124 Сообщение об окончании сопоставления отмены.png|800px|thumb|none|Сообщение об окончании операции сопоставления]]
:{{Note|type=info|text=''При сопоставлении метки маркеров удаляются.''}}

==== Отмена операций сопоставления ====
Отмена операций ручного сопоставления маркеров проводится в два этапа:
:а) Выбор операций ручного сопоставления для отмены (отката).
:б) Просмотр списка всех операций, которые будут отменены, и подтверждение отмены операций сопоставления.

Чтобы отменить (откатить) операции сопоставления:
:1. [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|Выберите исходный контекст]].
:2. [[Help:UI manual#Работа в режиме разметки|В режиме разметки]] нажмите кнопку [[File:Button Сравнить с.png|x25px]] и в раскрывшемся списке выберите пункт '''Сопоставить маркеры'''.
:Откроется окно '''Сопоставить маркеры'''.
:3. Этап 1. На вкладке '''Отмена операций сопоставления''':
::а) Выберите операции сопоставления маркеров, которые нужно отменить.
::В списке отображаются операции ручного сопоставления маркеров в исходной ветке проекта.
::б) Для отказа от продолжения операции нажмите кнопку '''Отмена'''.
::в) Для перехода к подтверждению выбора нажмите кнопку '''Далее'''.

:[[File:125 Выбор маркеров для отмены сопоставления.png|800px|thumb|none|Окно «Сопоставить маркеры». Выбор операций сопоставления маркеров для отмены]]

:4. Этап 2. В открывшейся форме:
::а) Проверьте список операций сопоставления, которые будут отменены. Список операций, помимо выбранных пользователем операций сопоставления, может дополнительно включать другие связанные операции, которые также будут отменены.
::б) Для корректировки выбранных операций сопоставления маркеров нажмите кнопку '''Назад''' и измените выбор маркеров.
::в) Для отказа от продолжения операции нажмите кнопку '''Отмена'''.
::г) Для запуска операции отмены сопоставления маркеров нажмите кнопку '''Подтвердить'''.

:[[File:126 Подтверждение отмены сопоставления.png|800px|thumb|none|Окно «Сопоставить маркеры». Подтверждение отмены операций сопоставления]]

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

:[[File:124 Сообщение об окончании сопоставления отмены.png|800px|thumb|none|Сообщение об окончании операции отмены сопоставления]]
:{{Note|type=info|text=''При отмене операции сопоставления метки маркеров удаляются.''}}

=== Сравнение маркеров ===
Чтобы сравнить два маркера:
:1. [[Help:UI manual#Работа в режиме разметки|В режиме разметки]] [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выберите исходный контекст]].
:2. Раскройте [[Help:UI manual#Таблица маркеров|таблицу маркеров]].
:3. Нажмите правой кнопкой мыши на строке маркера и выберите пункт '''Сравнить с ...'''
:[[File:155 Переход к сравнению маркеров.png|thumb|none|upright=2|Переход к сравнению маркеров]]
:Откроется окно выбора маркера для сравнения.
:[[File:46 Выбор маркера для сравнения.png|thumb|none|upright=3|Окно выбора маркера для сравнения]]
:{{Note|type=info|text=''При сравнении снимков для режимов '''Сопоставленные''' и '''Одинаковые''' в таблице маркеров по клику правой кнопкой мыши на строке маркера доступен пункт '''Сравнение с другой версией'''. При выборе данной команды происходит сравнение маркера с его версией из сравниваемого снимка.''}}
:4. Выберите проект, ветку и снимок.
:Отобразится список маркеров в выбранном снимке, где можно ввести запрос для поиска маркеров.
:[[File:47 Результат сравнения маркеров.png|thumb|none|upright=3|Выбор маркера для сравнения]]
:5. Дважды кликните на строке маркера или нажмите кнопку '''Сравнить''', чтобы перейти в окно сравнения маркеров.
:[[File:48 Различия исходного кода.png|thumb|none|upright=3|Окно сравнения маркеров]]

=== Разметка маркера ===
Разметка маркера заключается в установке статуса, а также, опционально, серьезности (критичности) и требуемого действия.
Установка серьезности и действия доступны только после установки статуса.
Разметить маркер можно [[Help:UI manual#Работа в режиме разметки|в режиме разметки]].
==== Разметка маркера вручную ====
Вручную маркер можно разметить тремя способами:
:1. '''''Способ 1'''''. С помощью кнопок в верхней части [[Help:UI manual#Функции правой панели|правой панели]].
:2. '''''Способ 2'''''. С помощью кнопок в виджете маркера [[Help:UI manual#Вкладка с исходным кодом|на вкладке с исходным кодом]].
:Если [[Help:UI manual#Работа с проектами|для проекта]] установлен флаг '''Обязательный комментарий при разметке''', то при разметке с помощью способов [[Help:UI manual#Marking1|1]] и [[Help:UI manual#Marking2|2]] откроется [[Help:UI manual#Marking3|окно разметки]], в котором обязательно нужно ввести комментарий.
<gallery mode="packed" heights="180px" style="float:left; clear:right; margin-right:1em; margin-left:0">
49 Разметка Статус.png|Выбор статуса разметки маркера
50 Разметка Серьезность.png|Выбор серьезности разметки маркера
51 Разметка Действие.png|Выбор действия разметки маркера
127 Кнопки разметки в виджете маркера.png|Кнопки разметки в виджете маркера на вкладке с исходным кодом
</gallery>
 
:3. '''''Способ 3'''''. В отдельном окне разметки вручную. Для этого:
::а) Нажмите кнопку [[File:Icon edit.png|x25px]] в верхней части правой панели или в виджете маркера на вкладке с исходным кодом.
::Откроется окно '''Разметка'''.
::<gallery heights="200" perrow="2" mode="packed" style="float:left; clear:right;">
235 Окно Разметка.png|Окно «Разметка»
File:99 Окно разметки.png|Окно разметки. Поле '''Комментарий''' – обязательное
</gallery>
::б) Выберите статус, а также, опционально, серьезность (критичность) и требуемое действие.
::в) Введите комментарий.
::Если [[Help:UI manual#Работа с проектами|для проекта]] установлен флаг '''Обязательный комментарий при разметке''', то добавление комментария обязательно.
::Редактор комментариев поддерживает синтаксис Markdown.
::Для упоминания пользователя, вставьте '''@''' и введите или выберите его логин. После добавления комментария по нажатии кнопки '''Применить''' указанному пользователю придет [[Help:UI manual#Просмотр уведомлений в интерфейсе Системы|уведомление в интерфейсе системы]] об упоминании с возможностью перехода к маркеру с этим комментарием.
::г) Нажмите кнопку '''Применить'''.

Результаты разметки со связанными комментариями отображаются [[Help:UI manual#Функции правой панели|в правой панели]] на вкладке '''Комментарии'''. При этом можно поменять текст комментария, но не результат разметки. Для её изменения нужно заново установить статус, серьезность и действие.
:[[File:100 Правая панель Комментарии с разметкой.png|300px|thumb|none|Правая панель. Комментарии, добавленные при разметке]]

==== Разметка маркера с помощью ассистента AI ====
{{Note|type=warn|text=''Функциональность доступна пользователям с [[#Проектные доступы|проектными доступами]] '''Разметка маркеров''' и '''Импорт разметки'''. Ассистент AI должен быть [[Help:XSvacer:AIAssistant|включен и настроен]].''}}
Чтобы разметить маркер с помощью ассистента AI:
:1. Нажмите кнопку [[File:Icon edit.png|x25px]] в верхней части правой панели или в виджете маркера на вкладке с исходным кодом.
Откроется окно '''Разметка'''.
:2. Смените режим разметки с помощью переключателя '''Режим разметки с помощью AI'''.
:3. В отобразившемся режиме разметки выберите '''Модель AI''', с помощью которой ассистент AI рассчитает статус разметки.
:Спрогнозированный статус и уровень доверия прогнозу отобразятся в этом же окне. Если модель AI не смогла предсказать статус разметки, то отобразится значение '''n/a''' и кнопка '''Применить''' будет неактивна.
:Если маркер уже размечен и его статус совпадает с прогнозным, то в окне отобразится сообщение об этом и дальнейшая разметка станет недоступна.
:[[File:236 Окно Разметка AI.png|400px|thumb|none|Окно «Разметка». Режим разметки с помощью ассистента AI]]
:4. Введите комментарий.
:5. Нажмите кнопку '''Применить'''.
Результаты разметки со связанными комментариями отображаются [[Help:UI manual#Функции правой панели|в правой панели]] на вкладке '''Комментарии'''. При этом можно поменять текст комментария, но не результат разметки. Для её изменения нужно заново установить статус, серьезность и действие.
Комментарий, добавленный при разметке с помощью ассистента AI, дополнительно содержит информацию о проведенной разметке: время, имя модели машинного обучения, уровень доверия прогнозу. Также для такого маркера в правой панели на вкладке '''Подробности''' присвоена метка '''AI'''.
<gallery heights="210" perrow="2" mode="packed" style="float:left; clear:right;>
237 Разметка комментарий AI.png|Правая панель.Комментарий, добавленный при разметке с помощью ассистента AI
238 Разметка метка AI.png|Правая панель.Метка AI на вкладке «Подробности»
</gallery>
 

=== Групповая разметка маркеров ===
==== Групповая разметка маркеров вручную ====
Для групповой разметки маркеров вручную:
:1. [[Help:UI manual#Работа в режиме разметки|В режиме разметки]] [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выберите исходные проект, ветку и снимок]].
:2. Включите отображение [[Help:UI manual#Таблица маркеров|таблицы маркеров]].
:3. Выберите маркеры для разметки – установите флажки в строках таблицы.
:4. Нажмите кнопку [[File:icon edit.png|x25px]] (доступна, если выбраны маркеры в таблице).
:[[File:53 Выбор маркеров для группразметки.png|thumb|none|upright=2.5|Выбор маркеров для групповой разметки]]
:Отобразится окно для групповой разметки.
:[[File:54 Окно групповой разметки.png|thumb|none|upright=2.5|Окно групповой разметки]]
:5. Выберите статус разметки, а затем (опционально) статус серьезности (критичности) и требуемое действие – нажмите кнопки со значениями.
:6. Добавьте общий комментарий для выбранных маркеров. 
:Редактор комментариев поддерживает синтаксис Markdown.
:Для упоминания пользователя, вставьте '''@''' и введите или выберите его логин. После добавления комментария по нажатии кнопки '''Применить''' указанному пользователю придет [[Help:UI manual#Просмотр уведомлений в интерфейсе Системы|уведомление в интерфейсе системы]] об упоминании с возможностью перехода к этому комментарию.
:После того, как пользователь или ассистент AI присвоил статусы и (или) написал комментарий, станет доступной кнопка '''Применить'''. 
:{{Note|type=info|text=''Ввод комментария обязателен, если [[Help:UI manual#Работа с проектами|для проекта]] установлен флаг '''Обязательный комментарий при разметке'''''.}}
:7. Если требуется отменить изменения, нажмите [[File:icon cross 01.png|x15px]] в правом верхнем углу окна или кнопку '''Отмена'''. Диалоговое окно закроется, изменения не будут применены, выделение с выбранных для разметки маркеров не снимается.
:8. Нажмите кнопку '''Применить''', чтобы запустить процесс разметки. 
Прогресс разметки отображается в соответствующем окне. Запущенный процесс можно полностью отменить нажатием кнопки '''Отмена'''. 
В результате применения разметки текст маркеров [[Help:UI manual#Таблица маркеров|в таблице маркеров]] окрасится в цвет, соответствующий выставленному статусу.

<gallery widths="400" mode="nolines" style="float:center; clear:center; margin-right:1em; margin-left:0">
56 Окно прогресса разметки.png|Окно прогресса разметки
57 Результат групповой разметки.png|Пример таблицы маркеров после применения групповой разметки
</gallery>
 

==== Групповая разметка маркеров с помощью ассистента AI ====
{{Note|type=warn|text=''Функциональность доступна пользователям с [[#Проектные доступы|проектными доступами]] '''Разметка маркеров''' и '''Импорт разметки'''. Ассистент AI должен быть [[Help:XSvacer:AIAssistant|включен и настроен]].''}}
Чтобы разметить группу маркеров с помощью ассистента AI:
:1. [[Help:UI manual#Работа в режиме разметки|В режиме разметки]] [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выберите исходные проект, ветку и снимок]].
:2. Включите отображение [[Help:UI manual#Таблица маркеров|таблицы маркеров]].
:3. [[Help:UI manual#GroupMark1|Выберите маркеры для разметки]] – установите флажки в строках таблицы.
:4. Нажмите кнопку [[File:icon edit.png|x25px]] (доступна, если выбраны маркеры в таблице).
:[[File:53 Выбор маркеров для группразметки.png|thumb|none|upright=2.5|Выбор маркеров для групповой разметки]]
:Отобразится [[Help:UI manual#GroupMark2|окно для групповой разметки]].
:5. Смените режим разметки с помощью переключателя '''Режим разметки с помощью AI'''.
:6. В отобразившемся режиме разметки выберите '''Модель AI''', с помощью которой ассистент AI рассчитает статус разметки.
:Спрогнозированный статус и уровень доверия прогнозу отобразятся в этом же окне в строке каждого выбранного маркера. Если модель AI не смогла предсказать статус разметки, то отобразится значение '''n/a''' и установка флажка столбце '''Статус разметки''' будет недоступна.
:7. Выберите маркеры для разметки – установите флажки в столбце '''Статус разметки'''.
:Если маркер уже размечен и его статус совпадает с прогнозным, то установка флажка в его строке недоступна.
:[[File:239 Групповая разметка AI.png|thumb|none|upright=2.5|Окно групповой разметки. Режим разметки с помощью ассистента AI]]
:8. Добавьте общий комментарий для выбранных маркеров. 
:Редактор комментариев поддерживает синтаксис Markdown.
:Для упоминания пользователя, вставьте '''@''' и введите или выберите его логин. После добавления комментария по нажатии кнопки '''Применить''' указанному пользователю придет [[Help:UI manual#Просмотр уведомлений в интерфейсе Системы|уведомление в интерфейсе системы]] об упоминании с возможностью перехода к этому комментарию.
:После того, как пользователь или ассистент AI присвоил статусы и (или) написал комментарий, станет доступной кнопка '''Применить'''. 
:{{Note|type=info|text=''Ввод комментария обязателен, если [[Help:UI manual#Работа с проектами|для проекта]] установлен флаг '''Обязательный комментарий при разметке'''''.}}
:9. Если требуется отменить изменения, нажмите [[File:icon cross 01.png|x15px]] в правом верхнем углу окна или кнопку '''Отмена'''. Диалоговое окно закроется, изменения не будут применены, выделение с выбранных для разметки маркеров не снимается.
:10. Нажмите кнопку '''Применить''', чтобы запустить процесс разметки. 
Прогресс разметки отображается в [[Help:UI manual#GroupMark3|соответствующем окне]]. Запущенный процесс можно полностью отменить нажатием кнопки '''Отмена'''. 
В результате применения разметки текст маркеров [[Help:UI manual#Таблица маркеров|в таблице маркеров]] окрасится в цвет, соответствующий выставленному статусу.

=== Блокировка разметки маркеров===
Пользователь может заблокировать другим пользователям возможность [[Help:UI manual#Разметка маркера|размечать маркер]] или [[Help:UI manual#Групповая разметка маркеров|группу маркеров]]. Это позволяет избежать коллизий при разметке маркеров несколькими пользователями.

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

<gallery mode="packed" heights="200px" perrow="2" style="float:left; clear:right; margin-right:1em; margin-left:1em">
58 Блокировка на вкладке Детекторы.png|Блокировка маркера на вкладке '''Детекторы'''
File:59_Блокировка_на_вкладке_Файлы.png|Блокировка маркера на вкладке '''Файлы'''
60_Блокировка_на_правой_панели.png|Блокировка маркера на правой панели
</gallery>
 

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

Чтобы посмотреть все блокировки, перейдите в раздел [[Help:UI manual#Настройка сервера Svacer|'''Настройки''']] на [[Help:UI manual#Управление блокировками разметки|вкладку '''Блокировки''']]:

[[File:61 Просмотр всех блокировок.png|thumb|none|upright=3.5|Таблица блокировок]]

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

=== Добавление комментария к нескольким маркерам ===
Для добавления комментария к нескольким маркерам одновременно:
:1. В режиме разметки [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выберите исходный контекст]] – проект, ветку, снимок.
:2. Включите отображение [[Help:UI manual#Таблица Маркеров|таблицы маркеров]].
:3. Выберите маркеры для разметки – установите флажки в строках таблицы.
:4. Нажмите кнопку [[File:Button Comment Add.png|x25px]] (доступна, если выбраны маркеры в таблице).

:[[File:128 Добавление общего комментария 1.png|400px|thumb|none|Выбор маркеров для добавления комментария к нескольким маркерам одновременно]]
:5. Отобразится окно для добавления комментария к нескольким маркерам одновременно.

:[[File:129 Добавление общего комментария 2.png|600px|thumb|none|Окно добавления комментария к нескольким маркерам одновременно]]
:6. Введите комментарий.
:Редактор комментариев поддерживает синтаксис Markdown.
:Для упоминания пользователя, вставьте '''@''' и введите или выберите его логин. После добавления комментария по нажатии кнопки '''Применить''' указанному пользователю придет [[Help:UI manual#Просмотр уведомлений в интерфейсе Системы|уведомление в интерфейсе системы]] об упоминании с возможностью перехода к маркеру с этим комментарием.
:8. Нажмите кнопку '''Сохранить'''.

=== Экспорт ===
В режиме разметки можно выполнить экспорт:
* [[Help:UI manual#Экспорт исходного кода с разметкой|исходного кода с разметкой]];
* [[Help:UI manual#Экспорт снимка в формате snap|снимка в формате snap]];
* [[Help:UI manual#Экспорт разметки и снимка в SARIF|снимка в формате SARIF]];
* [[Help:UI manual#Экспорт разметки|разметки в файл]].
{{Note|type=warn|text=''Функциональность доступна пользователям с [[#Проектные доступы|проектным доступом]] '''Экспорт снимков'''''}}

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

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

::При экспорте можно исключить файлы, соответствующие [[Help:UI manual#Использование регулярных выражений|регулярным выражениям]] в поле '''Исключить пути'''.
:4. Нажмите кнопку '''Экспортировать'''.
В итоге создастся архив файлов с исходным кодом и, если был выбран шаблон разметки, то в исходный код будет добавлена актуальная разметка в соответствии с выбранным шаблоном.

==== Экспорт снимка в формате snap ====
Чтобы экспортировать с сервера исходный код снимка в формате .snap:
:1. [[Help:UI manual#Работа в режиме разметки|В режиме разметки]] [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выберите исходный контекст]] – проект, ветку и снимок.
:2. На вкладке '''Информация о снимке''' нажмите кнопку '''Экспорт''' и выберите пункт '''Снимок (*.snap)'''.
:[[File:192 Разметка. Переход к экспорту снимка в формате snap.png|600px|thumb|none|Переход к экспорту снимка в формате snap]]
:Запустится формирование файла. При старте и по окончании экспорта пользователю отобразится соответствующее всплывающее сообщение.
:[[File:193 Сообщение. Экспорт снимка.png|thumb|600px|thumb|none|Пример всплывающих сообщений при старте и окончании экспорта снимка]]

==== Экспорт разметки и снимка в SARIF ====
Чтобы экспортировать разметку и при необходимости исходный код снимка в файл формата SARIF:
:1. [[Help:UI manual#Работа в режиме разметки|В режиме разметки]] [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выберите исходный контекст]] – проект, ветку и снимок.
:2. На вкладке '''Информация о снимке''' нажмите кнопку '''Экспорт''' и выберите пункт '''SARIF'''.
:[[File:194 Разметка. Переход к экспорту снимка SARIF.png|thumb|600px|thumb|none|Переход к экспорту снимка SARIF]]
:3. В открывшемся окне:
::а) Выключите (опционально) формирование названия файла по умолчанию – снимите соответствующий флажок и введите название снимка.
::б) Опционально включите или выключите экспорт исходных файлов.
::в) Нажмите кнопку '''Экспортировать'''.
:[[File:195 Окно экспорта SARIF.png|thumb|600px|thumb|none|Окно экспорта снимка SARIF]]
:Запустится формирование файла. При старте и по окончании экспорта пользователю отобразится всплывающее сообщение.
:[[File:220 Сообщение. Экспорт SARIF.png|thumb|400px|thumb|none|Пример всплывающих сообщений при старте и окончании экспорта снимка в SARIF]]

==== Экспорт разметки ====
Чтобы из ветки проекта экспортировать в файл разметку и/или комментарии:
:1. [[Help:UI manual#Работа в режиме разметки|В режиме разметки]] [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выберите исходный контекст]] – проект, ветку и снимок.
:2. На вкладке '''Информация о снимке''' нажмите кнопку '''Экспорт''' и выберите пункт '''Разметка'''.
:[[File:196 Разметка. Переход к экспорту разметки.png|thumb|thumb|thumb|600px|none|Переход к экспорту разметки]]
:3. В открывшемся окне:
::а) Выберите вариант экспорта.
::б) Если требуется экспортировать неразмеченные маркеры, установите флажок '''Включая разметку со статусом "Undecided"'''.
::в) Нажмите кнопку '''Экспортировать'''.
:[[File:197 Окно экспорта разметки.png|thumb|thumb|thumb|600px|none|Окно экспорта разметки]]

=== Импорт разметки ===
В режиме разметки можно импортировать разметку из двух источников:
* [[Help:UI manual#Импорт разметки из файла|из файла]];
* [[Help:UI manual#Импорт разметки из исходного кода|из исходного кода снимка]].
{{Note|type=warn|text=''Функциональность доступна пользователям с [[#Проектные доступы|проектным доступом]] '''Импорт разметки'''''}}

==== Импорт разметки из файла ====
Чтобы импортировать файл с разметкой:
:1. [[Help:UI manual#Работа в режиме разметки|В режиме разметки]] [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выберите исходный контекст]] – проект, ветку и снимок.
:2. На вкладке '''Информация о снимке''' нажмите кнопку '''Импорт''' и выберите пункт '''Разметка из файла'''.
:[[File:198 Разметка. Переход к импорту разметки из файла.png|thumb|thumb|thumb|600px|none|Переход к импорту файла с разметкой]]
:3. В открывшемся окне:
::а) Выберите файл архива в формате .gz.
::б) Выберите варианты импорта и действия при наличии конфликта разметки.
::в) Нажмите кнопку '''Импортировать'''.
:[[File:199 Окно импорта файла с разметкой.png|thumb|600px|thumb|none|Окно импорта файла с разметкой]]
:По окончании пользователю отобразится всплывающее сообщение с информацией о выполненной операции.
:[[File:200 Сообщение. Импорт разметки из файла.png|thumb|thumb|thumb|600px|none|Пример всплывающего сообщения об окончании импорта разметки из файла]]

==== Импорт разметки из исходного кода ====
Чтобы импортировать разметку из исходного кода снимка в ветку проекта:
:1. [[Help:UI manual#Работа в режиме разметки|В режиме разметки]] [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выберите исходный контекст]] – проект, ветку и снимок.
:2. На вкладке '''Информация о снимке''' нажмите кнопку '''Импорт''' и выберите пункт '''Разметка из исходного кода'''.
:[[File:201 Разметка. Переход к импорту разметки из кода.png|thumb|thumb|thumb|thumb|600px|none|Переход к импорту исходного кода с разметкой]]
:3. В открывшемся окне выберите шаблон разметки и нажмите кнопку '''Импортировать'''.
:[[File:134_Импорт_разметки.png|thumb|thumb|thumb|600px|none|Окно импорта исходного кода с разметкой]]
:По окончании пользователю отобразится всплывающее сообщение с информацией о выполненной операции.
:[[File:203 Сообщение. Импорт разметки из кода.png|thumb|thumb|thumb|thumb|600px|none|Пример всплывающего сообщения об окончании импорта разметки из исходного кода снимка]]

=== Работа с таблицей статистики ===
Чтобы посмотреть краткую статистику о разметке маркеров:
:1. [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|Выберите исходный контекст]].
:2. Перейдите [[Help:UI manual#Работа в режиме разметки|в режим разметки]].
:3. На вкладке '''Информация о снимке''' в строке свойства '''Статистика по детекторам''' нажмите кнопку '''Показать'''.

:[[File:64 Переход к просмотру статистики.png|600px|thumb|none|Переход к просмотру статистики]]

:Отобразится таблица статистики:
:[[File:65 Таблица статистики.png|600px|thumb|none|Таблица статистики]]
:4. Нажмите кнопку [[File:Icon download CSV.png|x20px]] или [[File:Icon download PDF.png|x20px]], чтобы выгрузить статистику в соответствующем формате.
:5. Нажмите кнопку [[File:Icon filter.png|x20px]] в строке статистики, чтобы применить [[Help:UI manual#Настройка и использование пользовательских фильтров|пользовательский фильтр]] с параметрами, которые соответствуют выбранному значению.

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

Для этого:
:1. Перейдите в режим просмотра кода по кнопке меню [[File:Button Код.png|x25px]] в верхней части экрана.
:2. [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|Выберите исходный контекст]]. 
:{{Note|type=info|text=''По умолчанию выбран контекст (проект, ветка), заданный ранее в режиме [[Help:UI manual#Работа в режиме разметки|'''Разметка''']]. Если Пользователь перешел в раздел '''Кoд''' из режима сравнения снимков раздела [[Help:UI manual#Работа в режиме разметки|'''Разметка''']], то для изменения контекста требуется отменить режим сравнения.''}}
:В левой части экрана отобразится иерархический список файлов снимка, а в правой – поле для отображения исходного кода файла.
:[[File:67 Режим просмотра кода.png|600px|thumb|none|Режим просмотра кода. Начальное состояние]]
:3. Для поиска файла:
::а) Кликните на поле поиска или нажмите комбинацию клавиш '''Ctrl+Shift+O'''.
::б) В открывшемся окне введите поисковый запрос и выберите файл.
:4. В левой части экрана раскройте группу файлов и нажмите на имя файла.
:В правой части отобразится исходный код файла.
:[[File:68 Режим просмотра кода открыт один файл.png|600px|thumb|none|Пример одного открытого файла]]
:5. Если требуется, откройте другие файлы.
:Они отобразятся на отдельных вкладках, если выключена [[Help:UI manual#Настройка профиля пользователя|настройка '''Переиспользование вкладки в редакторе кода''']].
:[[File:69 Режим просмотра кода открыто три файла.png|600px|thumb|none|Пример трёх открытых файлов]]
:6. Для перехода к предыдущей или следующей строке, в которую пользователь устанавливал курсор, используйте кнопки [[File:Button left.png|x25px]] и [[File:Button right.png|x25px]] или сочетания клавиш '''Ctrl+< и Ctrl+>'''.
:7. Вызовите функции, доступные по нажатии правой кнопки мыши на строке исходного кода
:* '''Перейти к объявлению''' – для перехода к строке, в которой объявлена переменная;
:* '''Перейти к определению''' – для перехода к строке, в которой определена переменная и функция;
:* '''Найти ссылки''' – для просмотра ссылок в панели с иерархическим списком файлов, именами файлов и номерами строк, в которых найдены ссылки;
::{{Note|type=info|text=''Если для выделенного элемента кода нет объявления, определения или ссылок, то отобразится сообщение: [[File:150 Объявление не найдено.png|x25px]], [[File:151 Определение не найдено.png|x25px]] или [[File:152 Ссылки не найдены.png|x25px]].''}}
::[[File:24 Исходный код Cписок файлов со ссылками.png|thumb|none|600px|Cписок файлов с номерами строк, в которых найдены ссылки]]
:* '''Копировать прямую ссылку''' – копирование ссылки на строку кода в буфер обмена.
::При переходе по этой ссылке будет открываться файл в режиме просмотра кода с курсором на той строке кода, для которой была скопирована ссылка;
:* '''Уменьшить''' и '''Увеличить''' – увеличение и уменьшение размера шрифта кода (эти функции также можно вызвать с помощью сочетаний клавиш '''Ctrl+Alt+-''' или '''Ctrl+Alt+=''').
:* '''Copy''' – для копирования строки в буфер обмена;
:* '''Command Palette''' – для вызова командной строки.
:6. Установите курсор в строке кода, чтобы отобразилось его позиционирование в правом нижнем углу.
:[[File:130 Позиционирование к коде.png|600px|thumb|none|Отображение позиционирования курсора в коде]]
:7. Сравните файлы – для этого:
::а) Нажмите правой кнопки мыши на имени файла и выберите пункт '''Сравнить с…'''
::[[File:156 Переход к сравнению файлов.png|thumb|none|600px|Переход к сравнению файлов]]
::б) В открывшемся окне выберите файл для сравнения. Для этого выберите проект, ветку и снимок, а затем раскройте группы файлов или воспользуйтесь поисковой строкой, нажмите на имя файла.
::По умолчанию выбраны проект и ветка исходного контекста.
::в) Нажмите кнопку '''Сравнить'''.
:Откроется окно сравнения файлов.

:[[File:Code compare 2.png|600px|thumb|none|Окно выбора файла для сравнения]]

:[[File:Code_compare_3.png|600px|thumb|none|Окно сравнения файлов]]

==Управление проектами и группами проектов==
В разделе '''Проекты''' отображаются все проекты со всеми ветками и снимками.
Для удобства работы проекты могут быть [[Help:UI manual#Работа с группами проектов|сгруппированы]]. Один проект может быть включен в несколько групп проектов.
[[File:101 Раздел Проекты.png|thumb|none|upright=3|Раздел '''Проекты''']]

===Работа с проектами===
Список проектов отображается в левой части экрана и организован в виде иерархии. При этом:
* для проектов, разметку маркеров которых нужно в обязательном порядке снабжать комментариями, отображается иконка [[File:Icon comment.png|x25px]];
* в нижней части списка отображается общее количество проектов и веток с учетом примененных фильтров, а также выбранных проектов и веток.
В списке доступны:
* поиск по имени проекта;
* фильтрация списка по группам проектов;
* сортировка по названию или дате создания (по умолчанию – по названию).
При работе с проектами пользователю доступны следующие функции:
:1. Загрузка актуальных данных с сервера – для этого нажмите кнопку [[File:Icon refresh.png|x25px]].
:2. Просмотр списка веток – для этого нажмите на название проекта.
:Ветки отобразятся в этом же списке проекта на втором уровне.
:3. Просмотр списка снимков – для этого нажмите на название ветки.
:Список снимков отобразится в виде таблицы в правой части экрана.
:4. [[Help:UI manual#Работа с группами проектов|Группировка проектов]].
:5. Создание проекта:
::а) Нажмите кнопку '''Создать проект'''.
::Откроется окно создания проекта.
::[[File:102 Создание проекта.png|thumb|none|upright=1.5|Окно создания проекта]]
::б) Введите название проекта.
::в) Для выбора одной или нескольких существующих групп кликните на поле '''Группы''' и выберите одно или несколько значений в списке:
::[[File:157 Окно создания проекта. Выбор существующей группы.png|thumb|none|upright=1.5|Окно создания проекта. Пример выбора существующей группы]]
::г) Для создания одной новой группы введите ее название и нажмите кнопку '''Создать''' в появившейся форме:
::[[File:158 Окно создания проекта.Создание одной группы.png|thumb|none|upright=1.5|Окно создания проекта. Пример создания одной группы]]
::д) Для создания нескольких новых групп введите их названия через запятую и нажмите кнопку '''Создать''' в появившейся форме:
::[[File:159 Окно создания проекта. Создание нескольких групп.png|thumb|none|upright=1.5|Окно создания проекта. Пример создания двух групп]]
::е) Установите флажок, если требуется при разметке маркеров обязательно добавлять комментарий.
::ж) Нажмите кнопку '''Создать'''.
:При создании проекта автоматически создается ветка '''master'''.
:При импорте снимка в интерфейсе командной строки проект, при его отсутствии, добавляется автоматически.
:6. Добавление ветки: [[File:103 Создание ветки.png|thumb|right|none|upright=1.5|Окно добавления ветки в проект]]
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке проекта.
::б) В меню выберите пункт '''Создать ветку'''.
::в) В открывшемся окне введите название ветки и нажмите кнопку '''Создать'''.
:При импорте снимка в интерфейсе командной строки ветка, при ее отсутствии, добавляется автоматически.

:7. Клонирование проекта со всеми ветками и снимками: [[File:132 Окно клонирования проекта.png|thumb|right|none|upright=1.5|Окно клонирования проекта]]
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке проекта.
::б) В меню выберите пункт '''Клонировать'''.
::в) В открывшемся окне введите название нового проекта, при необходимости скорректируйте группы, в которые будет входить клонированный проект (по умолчанию, группы исходного проекта) и нажмите кнопку '''Клонировать'''.

:9. Редактирование параметров проекта:
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке проекта.
::б) В меню выберите пункт '''Редактировать'''.
::в) В открывшемся окне измените название проекта, скорректируйте список групп, в которые включен проект, и установите или снимите флажок обязательности комментария при разметке и нажмите кнопку '''Сохранить'''.
:10. Удаление одного проекта:
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке проекта.
::б) В меню выберите пункт '''Удалить'''.
::в) Подтвердите удаление.
:11. Удаление нескольких проектов с ветками:
::а) Выберите проекты для удаления – установите флажки в левой части названий проектов и веток или нажмите кнопку '''Выбрать всё'''.
::б) Нажмите кнопку '''Удалить''' в верхней части списка проектов и подтвердите удаление.
При удалении проекта удаляются все его ветки и снимки, разрывается связь проекта с группами.

===Работа с группами проектов===
Работа с группами проектов доступна на отдельной панели '''Группы проектов''', которая отрывается по нажатии кнопки [[File:Icon gear.png|x25px]] в списке проектов. При этом в нижней части списка отображается общее количество групп.

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

[[File:104 Панель групп.png|thumb|none|upright=3|Панель '''Группы проектов''']]
При работе с группами проектов пользователю доступны следующие функции:
:1. Просмотр списка связанных с группой проектов – для этого нажмите на название группы.
:Проекты отобразятся в этом же списке групп на втором уровне.
 
:2. Добавление группы: [[File:105 Создание группы.png|thumb|right|none|upright=1.5|Окно '''Создать группу''']]
::а) Нажмите кнопку '''Создать группу'''.
::б) В открывшемся окне введите название группы и выберите проекты, которые в неё войдут, нажмите кнопку '''Создать'''.
:Созданная группа отобразится в списке на панели '''Группы проектов'''.
 
:3. Редактирование параметров группы: [[File:106 Редактирование группы.png|thumb|right|none|upright=1.5|Окно Редактировать группу]]
::а) Нажмите кнопку [[File:Icon edit2.png|x25px]] в строке группы.
::б) В открывшемся окне измените название группы, скорректируйте состав включенных в группу проектов.
::в) Нажмите на кнопку [[File:Icon cancel.png|x25px]] справа от названия проекта в списке, чтобы исключить его из группы.
::г) Нажмите кнопку '''Сохранить'''.
 
:4. Исключение одного проекта из группы – для этого нажмите кнопку [[File:Icon hide marks.png|x25px]] в правой части списка проектов группы.
:5. Удаление одной группы – для этого нажмите кнопку [[File:Icon delete.png|x25px]] в правой части списка групп и подтвердите удаление.
:6. Удаление нескольких групп:
::а) Выберите группы для удаления – установите флажки в левой части названий групп или нажмите кнопку '''Выбрать всё'''.
::б) Нажмите кнопку '''Удалить''' в верхней части списка групп проектов и подтвердите удаление.
:При удалении группы разрывается связь проекта с группой. Сами проекты не удаляются.

===Работа с ветками===
При работе с ветками проекта пользователю доступны следующие функции:
:1. Просмотр списка снимков – для этого нажмите на название ветки в списке проектов.
:Список снимков отобразится в виде таблицы в правой части экрана.
:2. Редактирование ветки: [[File:107 Редактирование ветки.png|thumb|right|upright=1.5|Окно редактирования ветки]]
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке ветки.
::б) В меню выберите пункт '''Редактировать'''.
::в) В открывшемся окне измените название ветки и нажмите кнопку '''Сохранить'''.
 
:3. Клонирование ветки проекта: [[File:108 Клонирование ветки.png|thumb|right|upright=1.5|Окно клонирования ветки]]
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке ветки.
::б) В меню выберите пункт '''Клонировать'''.
::в) В открывшемся окне введите название новой ветки и нажмите кнопку '''Клонировать'''.
 
:4. Экспорт разметки в файл: [[File:197 Окно экспорта разметки.png|thumb|right|upright=1.5|Окно экспорта разметки]]
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке ветки.
::б) В меню выберите пункт '''Экспорт разметки'''.
::Откроется окно экспорта разметки.
::в) Выберите вариант экспорта.
::г) Если требуется экспортировать неразмеченные маркеры, установите флажок '''Включая разметку со статусом "Undecided"'''.
::д) Нажмите кнопку '''Экспортировать'''.
::{{Note|type=warn|text=''Функциональность доступна пользователям с [[#Проектные доступы|проектным доступом]] '''Экспорт снимков'''''}}
 
:5. Импорт разметки из файла: [[File:199 Окно импорта файла с разметкой.png|thumb|right|upright=1.5|Окно импорта разметки]]
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке ветки.
::б) В меню выберите пункт '''Импорт разметки'''.
::Откроется окно импорта разметки.
::в) Выберите файл архива в формате .gz.
::г) Выберите варианты импорта и действия при наличии конфликта разметки.
::д) Нажмите кнопку '''Импортировать'''.
::{{Note|type=warn|text=''Функциональность доступна пользователям с [[#Проектные доступы|проектным доступом]] '''Импорт снимков'''''}}
 
:6. Удаление ветки:
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке ветки.
::б) В меню выберите пункт '''Удалить'''.
::в) Подтвердите удаление.
::При удалении ветки удаляются все ее снимки.
 
:7. Очистка разметки: [[File:160 Окно очистки разметки.png|thumb|right|upright=1.5|Окно очистки разметки]]
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке ветки.
::б) В меню выберите пункт '''Очистить разметку'''.
::в) В открывшемся окне выберите вариант очистки.
::г) Нажмите кнопку '''Очистить'''.
::{{Note|type=warn|text=''Функциональность доступна пользователям с [[#Проектные доступы|проектными доступами]] '''Управление ветками и снимками''', '''Разметка маркеров''' и [[#Cерверные доступы|серверным доступом]] '''Администрирование сервера'''.''}}
 
:8. Копирование разметки в другой контейнер (проект и ветку): [[File:Image.png|thumb|right|upright=1.5|Окно копирования разметки в другой контейнер]]
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке ветки и в меню выберите пункт '''Копировать разметку'''.
::б) В открывшемся окне выберите проект и ветку, в которые нужно скопировать разметку, а также действия, которые нужно выполнить при наличии разметки.
::в) Нажмите кнопку '''Копировать'''.
 
Разметка в контейнере состоит из множества размеченных маркеров. В целевой ветке уже может находиться разметка. Все множество маркеров в исходной ветке можно разбить на два:
* «Уникальные» – маркеры, которые есть только в исходной ветке;
* «Общие» – маркеры, которые есть как в ветке-источнике, так и в ветке-приемнике.
При выполнении операции копирования разметка в уникальных маркерах всегда копируется в ветку-приемник. Для «Общих» маркеров возможны несколько вариантов продолжения копирования, но по умолчанию выбран пункт '''Не копировать''' – в этом случае разметка в «Общих» маркерах в ветке-приемнике не изменяется.

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

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

'''Пример'''
:Есть несколько контейнеров:
:* 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.
:При выполнении копирования наличие маркера в ветке-приемнике не проверяется.
:При успешном копировании выводится всплывающее сообщение с описанием выполненных операций:
:[[File:161 Сообщение об успешном копировании разметки.png|thumb|none|upright=2|Пример всплывающего сообщения об успешном копировании разметки]]

===Работа со снимками===
Список снимков отображается в правой части экрана в виде таблицы после выбора ветки проекта. При этом в нижней части списка отображается общее количество снимков в выбранной ветке и количество выбранных снимков.
В списке доступны:
* поиск по названию снимка;
* сортировка по значениям столбцов (по умолчанию — по дате создания).
При работе со снимками пользователю доступны следующие функции:
:1. Импорт снимка из файла – для этого нажмите кнопку '''Импорт''' в верхней части табличного списка снимков и в открывшемся списке выберите один из вариантов импорта: '''Снимок (*.snap)''', '''Архив .svace-dir''' или '''SARIF'''.
:{{Note|type=warn|text=''Функциональность доступна пользователям с [[#Проектные доступы|проектным доступом]] '''Импорт снимков'''''}}
:После этого:
[[File:110 Импорт снимка.png|thumb|right|upright=1.5|Окно импорта снимка из файла в формате snap]]
::а) Если выбран импорт из файла в формате snap, то в открывшемся окне:
::* выберите файл в формате .snap;
::* введите название снимка (опционально);
::* Задайте [[Edit markers (command line)|правила трансформации, пропуска и дедупликации маркеров]] в поле '''Редактировать маркеры''' – загрузите JSON-файл с правилами или введите их;
::* нажмите кнопку '''Импортировать'''.
::{{Note|type=info|text=''Если при импорте снимка из snap-файла название не введено, то будет использовано название исходного снимка (параметр «name» в JSON с информацией о снимке).''}}
[[File:133 Импорт снимка из архива svace-dir.png|thumb|right|upright=1.5|Окно импорта снимка из архива в формате svace-dir]]
[[File:133.1_Импорт_снимка_из_архива_svace-dir_-_Поля_опций.png|thumb|right|upright=1.5|Окно импорта снимка из архива в формате svace-dir. Поля опций для расширенных настроек]]
 
::б) Если выбран импорт архива .svace-dir, то в открывшемся окне:
::* выберите архив .svace-dir;
::* введите название снимка (опционально);
::* выберите шаблон разметки (опционально);
::* укажите правила префикса пути (опционально);
::* укажите расширенные настройки (опционально): для каждой настройки нажмите кнопку '''Добавить''', в появившихся полях выберите опцию и введите её значение; для удаления настройки нажмите кнопку [[File:Icon delete.png|x25px]].
::После выбора параметра в поле появляется иконка [[File:Icon question mark2.png|x15px]], по наведении курсора на которую можно посмотреть описание;
::* нажмите кнопку '''Импортировать'''.
::При старте операции и по ее окончании пользователю отобразятся соответствующие всплывающие сообщения.
::[[File:210 Сообщение. Импорт svace-dir.png|thumb|none|upright=1.5|Пример всплывающих сообщений при старте и окончании импорта снимка из архива в формате svace-dir]]
 
[[File:217 Импорт снимка SARIF.png|thumb|right|upright=1.5|Окно импорта снимка из файла в формате SARIF]]
[[File:218 Импорт снимка SARIF - поля опций.png|thumb|right|upright=1.5|Окно импорта снимка из архива в формате SARIF. Поля опций для расширенных настроек]]
::в) Если выбран импорт из файла в формате SARIF, то в открывшемся окне:
::* выберите файл в формате .sarif или .json, либо архив в одном из форматов: .tar, tar.bz2, tar.gz, zip;
::* введите название снимка (опционально);
::* укажите правила префикса пути (опционально);
::* укажите расширенные настройки (опционально): для каждой настройки нажмите кнопку '''Добавить''', в появившихся полях выберите опцию и введите её значение; для удаления настройки нажмите кнопку [[File:Icon delete.png|x25px]].
::После выбора параметра в поле появляется иконка [[File:Icon question mark2.png|x15px]], по наведении курсора на которую можно посмотреть описание;
::* нажмите кнопку '''Импортировать'''.
::При старте операции и по ее окончании пользователю отобразятся соответствующие всплывающие сообщения.
::[[File:211 Сообщение. Импорт SARIF.png|thumb|none|upright=1.5|Пример всплывающих сообщений при старте и окончании импорта снимка из архива в формате SARIF]]
:{{Note|type=info|text='''''Примечание:'''''
:* ''для импорта поддерживаются архивы папки .svace-dir, заархивированные с помощью tar, gz, bz2 или zip (*.tar, *.tar.gz, *.tar.bz2, *.zip);''
:* ''если при импорте архива .svace-dir название снимка не введено, то оно будет соответствовать времени импорта результатов анализа из Svace;''
:* ''в поле '''Расширенные настройки''' поддерживается ввод дополнительных опций команды <code>svacer import</code> – как в интерфейсе командной строки (например, <code>--attach value</code>). В аргументах дополнительных опций требуется указывать пути относительно архивированной папки. Описание опций можно найти, запустив команду <code>svacer import --help</code>''.
:* ''для импорта снимка из snap-файла, .svace-dir или SARIF может потребоваться много времени: как на загрузку, так и на обработку данных после загрузки. При работе сервера Svacer за reverse proxy их дефолтных значений таймаутов или ограничений на размер загружаемых данных может быть недостаточно, поэтому рекомендуется увеличить эти значения в конфигурационных файлах reverse proxy, см. [[Help:Configuration#Nginx|пример для Nginx]]''}}
:2. Экспорт снимка – для этого нажмите кнопку [[File:Icon export.png|x25px]] в крайнем правом столбце строки снимка и в открывшемся списке выберите один из вариантов экспорта: '''Экспорт (*.snap)''', '''Экспорт SARIF''' или '''Экспорт кода с разметкой'''.
:После этого:
::а) Если выбран экспорт в файл в формате snap, то по окончании его формирования во всплывающем сообщении нажмите кнопку '''Скачать'''.
::[[File:193 Сообщение. Экспорт снимка.png|thumb|none|upright=1.5|Пример всплывающих сообщений при старте и окончании экспорта снимка]]
:[[File:195 Окно экспорта SARIF.png|thumb|right|upright=1.5|Окно экспорта снимка SARIF]]
::б) Если выбран экспорт файла формата SARIF, то в открывшемся окне:
::* Выключите (опционально) формирование названия файла по умолчанию – снимите соответствующий флажок и введите название снимка.
::* Опционально включите или выключите экспорт исходных файлов.
::* Нажмите кнопку '''Экспортировать'''.
::Запустится формирование файла. При старте и по окончании экспорта пользователю отобразится всплывающее сообщение.
::[[File:220 Сообщение. Экспорт SARIF.png|thumb|none|upright=1.5|Пример всплывающих сообщений при старте и окончании экспорта снимка в SARIF]]
:[[File:340 Проекты Окно экспорта кода с разметкой.png||thumb|right|upright=1.5|Окно экспорта кода с разметкой]]
::в) Если выбран экспорт кода с разметкой, то в открывшемся окне:
::* Если требуется экспортировать разметку, установите флажок параметра '''Шаблон разметки''' и выберите шаблон для экспорта в списке справа.
::* Опционально включите или выключите очистку старых комментариев.
::* Опционально заполните поля для удаления префиксов и исключения путей.
:::Пример удаления префиксов путей: <code>/.build/</code>
::* Опционально введите регулярные выражения для очистки дополнительных строк (доступен, если включена очистка старых комментариев).

::При экспорте можно исключить файлы, соответствующие [[Help:UI manual#Использование регулярных выражений|регулярным выражениям]] в поле '''Исключить пути'''.
::* Нажмите кнопку '''Экспортировать'''.
::В итоге создастся архив файлов с исходным кодом и, если был выбран шаблон разметки, то в исходный код будет добавлена актуальная разметка в соответствии с выбранным шаблоном.
:3. Переход к разметке маркеров снимка:
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в крайнем правом столбце строки снимка.
::б) В меню выберите пункт '''Разметить'''.
[[File:111 Редактирование снимка.png|thumb|right|upright=1.5|Окно редактирования снимка]]
:4. Редактирование названия снимка:
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в крайнем правом столбце строки снимка.
::б) В меню выберите пункт '''Редактировать'''.
::в) Поменяйте название и нажмите кнопку '''Сохранить'''.
[[File:212 Окно Копирование снимков.png|thumb|right|upright=1.5|Окно копирования снимка. Пример для одного снимка]]
:5. Копирование одного снимка в другой проект и ветку:
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в крайнем правом столбце строки снимка.
::б) В меню выберите пункт '''Копировать'''.
::в) В открывшемся окне выберите проект и ветку, в которые нужно добавить копию снимка, нажмите кнопку '''Копировать'''.
::При старте операции и по ее окончании пользователю отобразятся соответствующие всплывающие сообщения.
::[[File:213 Сообщение. Копирование снимков.png|thumb|none|upright=1.5|Пример всплывающих сообщений при старте и окончании копирования одного снимка]]
[[File:214 Окно Копирование нескольких снимков.png|thumb|right|upright=1.5|Окно копирования снимка. Пример для двух снимков]]
:6. Копирование нескольких снимков в другой проект и ветку:
::а) Чтобы выбрать для копирования все снимки, установите флажок в заголовке табличного списка снимков.
::б) Чтобы выбрать несколько снимков, установите флажки в крайнем правом столбце табличного списка.
::в) Нажмите кнопку '''Копировать''' в верхней части табличного списка снимков.
::г) В открывшемся окне выберите проект и ветку, в которые нужно добавить копии выбранных снимков, нажмите кнопку '''Копировать'''.
::При старте операции и по ее окончании пользователю отобразятся соответствующие всплывающие сообщения.
::[[File:215 Сообщение. Копирование двух снимков.png|thumb|none|upright=1.5|Пример всплывающих сообщений при старте и окончании копирования двух снимков]]
:[[File:134 Импорт разметки.png|thumb|right|upright=1.5|Окно импорта разметки]]
:7. Импорт разметки из комментариев исходного кода снимка в активную ветку проекта:
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в крайнем правом столбце строки снимка.
::б) В меню выберите пункт '''Импорт разметки из исходного кода'''.
::в) В открывшемся окне выберите шаблон разметки и нажмите кнопку '''Импортировать'''.
::По окончании пользователю отобразится всплывающее сообщение с информацией о выполненной операции.
::[[File:216 Сообщение. Импорт разметки из кода.png|thumb|none|upright=1.5|Пример всплывающего сообщения об окончании импорта разметки из файла]]

:8. Просмотр информации о снимке в JSON-формате:
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке снимка крайнем правом столбце.
::б) В меню выберите пункт '''Просмотреть JSON'''.
:[[File:112 Просмотр JSON снимка.png|thumb|none|upright=3|Окно просмотра информации о снимке в JSON-формате]]
:9. Удаление одного снимка:
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке снимка крайнем правом столбце.
::б) В меню выберите пункт '''Удалить'''.
::в) Подтвердите удаление.
:10. Удаление нескольких снимков:
::а) Чтобы выбрать для удаления все снимки, установите флажок в заголовке табличного списка снимков.
::б) Чтобы выбрать несколько снимков, установите флажки в крайнем правом столбце табличного списка.
::в) Нажмите кнопку '''Удалить''' в верхней части табличного списка снимков и подтвердите удаление.

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

[[File:135 Раздел Детекторы.png|thumb|none|upright=3|Раздел «Детекторы»]]

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

{{Note|type=info|text=''При обновлении списка детекторов и их параметров в Svace изменения попадают в Svacer при выпуске новой версии системы!''}}

В разделе '''Детекторы''' пользователю доступны следующие функции:
:1. Поиск детектора по его названию, серьезности, надежности и коду дефекта безопасности CWE.
:2. Сортировка по значениям столбцов (по умолчанию – по названию детектора).
:3. Переход к просмотру описания дефекта безопасности на сайте [https://cwe.mitre.org cwe.mitre.org] (открывается в отдельном окне) – для этого нажмите на ссылку в столбце '''CWE'''.
:4. Просмотр дополнительной информации о детекторе при её наличии – для этого нажмите на иконку [[File:icon_question_mark2.png|x25px]] справа от названия детектора.

:[[File:121_Окно с дополнительной информацией о детекторе.png|thumb|none|upright=2|Раздел «Детекторы». Пример окна с дополнительной информацией о детекторе]]

:5. Фильтрация списка – для этого:
::а) Нажмите кнопку [[File:Button Фильтр.png|x25px]].
::б) В открывшемся окне '''Фильтр''' настройте параметры фильтрации – выберите значения в списках полей или нажмите кнопки со значениями.
::в) Нажмите кнопку [[File:button_Очистить.png|x25px]], чтобы очистить все параметры фильтрации.
::г) Нажмите кнопку [[File:button_Применить.png|x25px]], чтобы применить фильтр.

:[[File:137 Детекторы.Фильтр.png|thumb|none|upright=2|Раздел «детекторы». Окно «Фильтр»]]

:6. Отмена примененных фильтров – для этого нажмите кнопку [[File:Button Фильтр отмена.png|x25px]].
:7. Выбор отображаемых столбцов – для этого нажмите на кнопку '''Столбцы''' и в открывшемся списке установите или снимите флажки рядом с названиями столбцов.
:Для настройки скрытия или показа доступны все столбцы, кроме '''Детектор'''. Столбцы '''Статус''' и '''Инструменты''' по умолчанию скрыты.
:Пользовательская настройка отображения столбцов сохраняется и не сбрасывается при повторном входе пользователя в систему.

:[[File:138 Детекторы выбор столбцов.png|thumb|none|upright=1.5|Раздел «Детекторы». Выбор отображаемых столбцов]]

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

== Просмотр статистики ==
В разделе '''Статистика''' пользователь может посмотреть статистические данные о разметке по всем проектам, веткам и снимкам, доступным пользователю. Все статистические данные разделены на три группы и отображаются в отдельных дашбордах:
* [[Help:UI manual#Работа с дашбордом «Общая статистика»|'''Общая статистика''']] – показатели по последним импортированным снимкам в ветках проектов;
* [[Help:UI manual#Работа с дашбордом «Распределение маркеров»|'''Распределение маркеров''']] – диаграммы с информацией о количестве маркеров и их распределении по серьезности, статусу разметки и языкам;
* [[Help:UI manual#Работа с дашбордом «Активность по разметке»|'''Активность по разметке''']] – информация об активности пользователей при разметке маркеров.

[[File:162 Раздел Статистика. Начальное состояние.png|thumb|none|upright=3|Раздел '''Статистика'''. Начальное состояние]]
Чтобы посмотреть информацию:
:1. Выберите дашборд – нажмите кнопку с его названием в верхней части экрана.
:2. Выберите [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|контекст]] (опционально). В дашборде '''Общая статистика''' выбор снимка недоступен.
:2. Нажмите кнопку [[File:Button Play.png|x25px]].
:Если контекст не был выбран, отобразится статистика по всем проектам, веткам и снимкам, доступным пользователю. При этом информация об их количестве отображается в верхней части каждого дашборда.
:[[File:163 Раздел Статистика. Контекст не выбран.png|thumb|none|upright=2.5|Раздел '''Статистика'''. Пример дашборда '''Общая статистика'''. Контекст не выбран]]
:Если контекст был выбран, то отобразится статистика только для выбранных проектов, веток и снимков (кроме '''Общая статистика'''). При этом информация об их количестве отображается в верхней части каждого дашборда.
:[[File:164 Раздел Статистика. Контекст выбран.png|thumb|none|upright=2.5|Раздел '''Статистика'''. Пример дашборда '''Общая статистика'''. Контекст выбран]]

=== Работа с дашбордом «Общая статистика» ===
На дашборде '''Общая статистика''' отображается информация о разметке маркеров в последних импортированных снимках в разрезе проектов и веток. Информация представлена в виде блоков со следующими данными:
* общая информация:
** названия проекта и ветки;
** количество снимков в ветке и дата последнего импорта;
** дата последней разметки маркеров;
* показатели последнего импортированного снимка:
** количество строк кода;
** количество маркеров;
** плотность маркеров – процентное отношение количества маркеров на тысячу строк кода;
** процент и количество размеченных маркеров;
** процент и количество подтвержденных маркеров – со статусом Confirmed;
** процент и количество критичных маркеров – с серьезностью детектора Critical.
:[[File:204 Статистика. Общая статистика.png|thumb|none|upright=2.5|Раздел '''Статистика'''. Дашборд '''Общая статистика''']]
Пользователю доступны следующие функции:
:1. Поиск информации по названиям проектов и веток.
:2. Сортировка данных – для этого в поле справа выберите показатель, по которому требуется сортировать информацию:
:* по датам последних разметки и импорта;
:* по показателям последнего импортированного снимка.
:Для изменения порядка сортировки используйте кнопки [[File:Button Sort.png|x25px]] и [[File:Button Sort UP.png|x25px]].
:3. Переход к последнему импортированному снимку в режиме разметки – нажмите на названия проекта и ветки в блоке.

=== Работа с дашбордом «Распределение маркеров» ===
На дашборде '''Распределение маркеров''' отображаются три диаграммы:
* Количество маркеров по серьезности;
* Количество маркеров по статусу разметки;
* Распределение маркеров по языкам.
[[File:165 Раздел Статистика. Информация о выбранном контексте.png|thumb|none|upright=2.5|Раздел '''Статистика'''. Дашборд '''Распределение маркеров''']]
Пользователю доступны следующие функции:
:1. Просмотр значения диаграммы – для этого наведите курсор на любой графический элемент любой диаграммы.
:2. Выгрузка данных диаграммы в файл формата .csv – для этого нажмите кнопку [[File:Button Download.png|x25px]] в любой диаграмме.

=== Работа с дашбордом «Активность по разметке» ===
На дашборде Активность по разметке отображается информация о действиях пользователей [[Help:UI manual#Работа в режиме разметки|по разметке маркеров]], которая может быть представлена в двух видах:
* диаграмма '''Активность по разметке''' – отражает активность пользователей по разметке маркеров за выбранный месяц (по умолчанию – текущий месяц). Цвет ячеек на диаграмме отражает количество действий пользователя, выполненных в указанную дату: чем темнее цвет, тем больше действий выполнил пользователь. Эта диаграмма отображается по умолчанию; если вид был переключен, то для возврата к этой диаграмме нажмите кнопку [[File:Button ChangeDiagram1.png|x25px]];
* диаграмма '''Лидеры по разметке''' – отражает количество действий пользователей при разметке за выбранный период (по умолчанию – период соответствует месяцу, указанному на диаграмме '''Активность по разметке''') с сортировкой по лидерам. Цвет строк на диаграмме отражает количество действий пользователя: чем темнее цвет, тем больше действий выполнил пользователь. Диаграмма отображается по нажатии кнопки [[File:Button ChangeDiagram2.png|x25px]];
[[File:166 Раздел Статистика. Активность по разметке.png|thumb|none|upright=3|Раздел '''Статистика'''. Дашборд '''Активность по разметке'''. Вид 1: диаграмма '''Активность по разметке''']]
[[File:167 Раздел Статистика. Лидеры по разметке.png|thumb|none|upright=3|Раздел '''Статистика'''. Дашборд '''Активность по разметке'''. Вид 2: диаграмма '''Лидеры по разметке''']]
Пользователю доступны следующие функции:
:1. Просмотр значения диаграммы – для этого наведите курсор на любой графический элемент любой диаграммы.
:2. Выгрузка данных диаграммы в файл формата .csv – для этого нажмите кнопку [[File:Button Download.png|x25px]] в любой диаграмме
:3. В диаграмме '''Активность по разметке''':
::а) Поиск конкретного пользователя – для этого введите фрагмент его логина в поле поиска.
::б) Просмотр статистики за любой другой месяц – для этого выберите год и месяц в раскрывающихся списках вверху диаграммы.
::в) Просмотр активности конкретного пользователя за выбранный месяц – для этого нажмите на его логин.
::Ниже диаграммы '''Активность по разметке''' отобразится список действий по разметке выбранного пользователя. Измененная (неактуальная) разметка отмечена иконкой [[File:Icon archive.png|x25px]].
::[[File:168 Раздел Статистика. Активность по разметке. Выбранный пользователь.png|thumb|none|upright=3|Раздел '''Статистика'''. Дашборд '''Активность по разметке'''. Диаграмма '''Активность по разметке''' и список действий по разметке выбранного пользователя]]
::г) Просмотр активности пользователей в конкретный день месяца – для этого нажмите на число.
::Ниже диаграммы '''Активность по разметке''' отобразится список действий по разметке пользователей за выбранную дату.
::[[File:169 Раздел Статистика. Активность по разметке. Пользователи за дату.png|thumb|none|upright=3|Раздел '''Статистика'''. Дашборд '''Активность по разметке'''. Диаграмма '''Активность по разметке''' и список действий по разметке пользователей за выбранную дату]]
::д) Просмотр активности конкретного пользователя в конкретный день месяца – для этого нажмите ячейку таблицы на пересечении строки с логином пользователя и столбца с числом.
::Ниже диаграммы '''Активность по разметке''' отобразится список действий по разметке выбранного пользователя за выбранную дату.
::[[File:170 Раздел Статистика. Активность по разметке. Одни пользователь за дату.png|thumb|none|upright=3|Раздел '''Статистика'''. Дашборд '''Активность по разметке'''. Диаграмма '''Активность по разметке''' и список действий по разметке выбранного пользователя за выбранную дату]]
::е) Включение и выключение отображения информации о неактуальной (измененной) разметке в списке действий пользователя – для этого воспользуйтесь переключателем '''Исключить активность по неактуальной разметке'''.
::ж) Просмотр маркера в [[Help:UI manual#Работа в режиме разметки|режиме разметки]] – для этого в списке действий нажмите на ссылку с именем файла и номером строки.
::з) Просмотр информации о маркере – для этого в списке действий нажмите кнопку [[File:Button show.png|x25px]] слева от названия маркера.
::В правой части экрана отобразится панель с информацией о маркере.
::[[File:205 Статистика. Активность по разметке. Панель с информацией о маркере.png|thumb|none|upright=3|Панель с информацией о маркере]]
:4. В диаграмме '''Лидеры по разметке''':
::а) Поиск конкретного пользователя – для этого введите фрагмент его логина в поле поиска.
::б) Просмотр статистики за любой другой период времени, кроме текущего месяца – для этого кликните на поле даты вверху диаграммы и вручную введите даты, либо в раскрывшемся календаре выберите диапазон дат: предложенный ('''Сегодня''', '''Вчера''', '''Неделю назад''' и т. п.) или свой.
::[[File:171 Раздел Статистика. Лидеры по разметке. Выбор дат.png|thumb|none|upright=3|Раздел '''Статистика'''. Дашборд '''Активность по разметке'''. Диаграмма '''Лидеры по разметке'''. Выбор диапазона дат]]
::в) Просмотр активности конкретного пользователя за указанный период – для этого нажмите на его логин.
::Ниже диаграммы '''Лидеры по разметке''' отобразится список действий по разметке выбранного пользователя. Измененная (неактуальная) разметка отмечена иконкой [[File:Icon archive.png|x25px]].
::[[File:172 Раздел Статистика. Лидеры по разметке. Выбранный пользователь.png|thumb|none|upright=3|Раздел '''Статистика'''. Дашборд '''Активность по разметке'''. Диаграмма '''Лидеры по разметке''' и список действий по разметке выбранного пользователя]]
::г) Включение и выключение отображения в списке действий пользователя по неактуальной (измененной) разметке – для этого воспользуйтесь переключателем '''Исключить активность по неактуальной разметке'''.
::д) Просмотр маркера в [[Help:UI manual#Работа в режиме разметки|режиме разметки]] – для этого в списке действий нажмите на ссылку с именем файла и номером строки.
::e) Просмотр информации о маркере – для этого в списке действий нажмите кнопку [[File:Button show.png|x25px]] слева от названия маркера.
::В правой части экрана отобразится панель с информацией о маркере.

== Глобальный поиск ==
Глобальный поиск позволяет одновременно по всем доступным пользователю проектам и веткам выполнить поиск в следующих категориях:
* Маркеры;
* Комментарии к маркерам;
* Снимки.

Чтобы воспользоваться глобальным поиском, перейдите в раздел '''Поиск'''.
[[File:173 Раздел Поиск. Начальное состояние.png|thumb|none|upright=3|Раздел '''Поиск'''. Начальное состояние]]

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

=== Поиск маркеров ===
Чтобы воспользоваться поиском маркеров:
:1. Выберите категорию '''Маркеры''' раздела '''Поиск''' (выбран по умолчанию).
:2. Для базового поиска:
::а) Перейдите на вкладку '''Базовый поиск''' (открыта по умолчанию).
::[[File:174 Раздел Поиск. Категория Маркеры. Базовый поиск.png|thumb|none|upright=3|Раздел '''Поиск'''. Категория '''Маркеры'''. Базовый поиск]]
::б) Введите фрагмент названия маркера, детектора, функции или файла.
::в) Выберите (опционально) группу проектов, проект, ветку и снимок, в которых нужно найти маркеры.
::По умолчанию выбраны все группы, проекты, ветки и снимки.
::г) Нажмите кнопку '''Поиск'''.
:Отобразятся результаты поиска.
:[[File:175 Раздел Поиск. Пример результатов поиска в категории Маркеры.png|thumb|none|upright=3|Раздел '''Поиск'''. Пример результатов поиска в категории '''Маркеры''']]
:3. Для поиска по полям:
::а) Перейдите на вкладку '''Поиск по полям'''.
::[[File:176 Раздел Поиск. Категория Маркеры. Поиск по полям.png|thumb|none|upright=3|Раздел '''Поиск'''. Категория '''Маркеры'''. Поиск по полям]]
::б) Заполните поля поиска.
::в) Выберите (опционально) группу проектов, проект, ветку и снимок, в которых нужно найти маркеры.
::По умолчанию выбраны все группы, проекты, ветки и снимки.
::г) Нажмите кнопку '''Поиск'''.
:Отобразятся результаты поиска.
:[[File:177 Раздел Поиск. Пример результатов поиска по полям в категории Маркеры.png|thumb|none|upright=3|Раздел '''Поиск'''. Пример результатов поиска по полям в категории '''Маркеры''']]
:4. Для очистки значений в полях поиска нажмите кнопку '''Очистить'''.
:5. Чтобы перейти к найденному файлу с маркером в [[Help:UI manual#Работа в режиме разметки|режиме разметки]], в результатах поиска кликните на ссылку в имени файла с номером строки исходного кода.
:6. Чтобы посмотреть подробную информацию о найденном маркере, в результатах поиска нажмите кнопку [[File:Button show.png|x25px]].
Отобразится правая панель с открытой вкладкой '''Подробности'''.
:[[File:341 Раздел Поиск. Подробная информация о маркере.png|thumb|none|upright=3|Раздел '''Поиск'''. Пример просмотра подробной информации о найденном маркере]]

=== Поиск комментариев к маркерам ===
Чтобы воспользоваться поиском по комментариям к маркерам:
:1. Выберите категорию '''Комментарии к маркерам''' раздела '''Поиск'''.
:2. Для базового поиска:
::а) Перейдите на вкладку '''Базовый поиск''' (открыта по умолчанию).
::[[File:178 Раздел Поиск. Категория Комментарии к маркерам. Базовый поиск.png|thumb|none|upright=3|Раздел '''Поиск'''. Категория '''Комментарии к маркерам'''. Базовый поиск]]
::б) Введите фрагмент комментария или логина его автора.
::в) Выберите (опционально) группу проектов, проект, ветку и снимок, в которых нужно найти комментарии.
::По умолчанию выбраны все группы, проекты, ветки и снимки.
::г) Нажмите кнопку '''Поиск'''.
:Отобразятся результаты поиска.
:[[File:179 Раздел Поиск. Пример результатов поиска в категории Комментарии к маркерам.png|thumb|none|upright=3|Раздел '''Поиск'''. Пример результатов поиска в категории '''Комментарии к маркерам''']]
:3. Для поиска по полям:
::а) Перейдите на вкладку '''Поиск по полям'''.
::[[File:180 Раздел Поиск. Категория Комментарии к маркерам. Поиск по полям.png|thumb|none|upright=3|Раздел '''Поиск'''. Категория '''Комментарии к маркерам'''. Поиск по полям]]
::б) Заполните поля поиска.
::в) Выберите (опционально) группу проектов, проект, ветку и снимок, в которых нужно найти комментарии.
::По умолчанию выбраны все группы, проекты, ветки и снимки.
::г) Нажмите кнопку '''Поиск'''.
:Отобразятся результаты поиска.
:[[File:181 Раздел Поиск. Пример результатов поиска по полям в категории Комментарии к маркерам.png|thumb|none|upright=3|Раздел '''Поиск'''. Пример результатов поиска по полям в категории '''Комментарии к маркерам''']]
:4. Для очистки поискового запроса нажмите кнопку '''Очистить'''.
:5. Чтобы перейти в [[Help:UI manual#Работа в режиме разметки|режим разметки]] к файлу маркера с найденным комментарием, в результатах поиска кликните на ссылку в имени файла с номером строки исходного кода.
:6. Чтобы посмотреть подробную информацию о маркере с найденным комментарием, в результатах поиска нажмите кнопку [[File:Button show.png|x25px]]. Отобразится правая панель с открытой вкладкой '''Комментарии'''.

=== Поиск снимков ===
Чтобы воспользоваться поиском по снимкам:
:1. Выберите категорию '''Снимки''' раздела '''Поиск'''.
:2. Для базового поиска:
::а) Перейдите на вкладку '''Базовый поиск''' (открыта по умолчанию).
::[[File:182 Раздел Поиск. Категория Снимки. Базовый поиск.png|thumb|none|upright=3|Раздел '''Поиск'''. Категория '''Снимки'''. Базовый поиск]]
::б) Введите фрагмент названия снимка, пользовательского поля снимка (названия или его значения) или логина пользователя, который импортировал снимок.
::в) Выберите (опционально) группу проектов, проект, ветку и снимок, в которых нужно найти снимки.
::По умолчанию выбраны все группы, проекты, ветки и снимки.
::г) Нажмите кнопку '''Поиск'''.
:Отобразятся результаты поиска.
:[[File:183 Раздел Поиск. Пример результатов поиска в категории Снимки.png|thumb|none|upright=3|Раздел '''Поиск'''. Пример результатов поиска в категории '''Снимки''']]

:3. Для поиска по полям:
::а) Перейдите на вкладку '''Поиск по полям'''.
::[[File:184 Раздел Поиск. Категория Снимки. Поиск по полям.png|thumb|none|upright=3|Раздел '''Поиск'''. Категория '''Снимки'''. Поиск по полям]]
::б) Заполните поля поиска.
::в) Выберите (опционально) группу проектов, проект, ветку и снимок, в которых нужно найти снимки.
::По умолчанию выбраны все группы, проекты, ветки и снимки.
::г) Нажмите кнопку '''Поиск'''.
:Отобразятся результаты поиска.
:[[File:185 Раздел Поиск. Пример результатов поиска по полям в категории Снимки.png|thumb|none|upright=3|Раздел '''Поиск'''. Пример результатов поиска по полям в категории '''Снимки''']]
:4. Для очистки поискового запроса нажмите кнопку '''Очистить'''.
:5. Чтобы посмотреть подробную информацию о найденном снимке, в результатах поиска кликните на ссылку в пути размещения снимка.
:Найденный снимок откроется в [[Help:UI manual#Работа в режиме разметки|режиме разметки]] со всеми его маркерами.

=== Просмотр истории поиска ===
Чтобы посмотреть историю поиска, нажмите кнопку '''История поиска''' в разделе '''Поиск'''.

В истории отображаются 100 последних поисковых запросов пользователя.
[[File:186 Раздел Поиск. Пример истории поиска.png|thumb|none|upright=3|Раздел '''Поиск'''. Пример истории поиска]]

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

== Настройка сервера Svacer ==
Перейти в раздел '''Настройки''' можно по нажатии кнопки [[File:Icon settings.png|x25px]] в верхней правой части экрана.

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

=== Управление пользователями, ролями и организациями===
==== Управление пользователями ====
Реестром учетных записей пользователей можно управлять на вкладке '''Пользователи''' в разделе '''Управление пользователями''' страницы '''Настройки'''. 
Для [[LDAP configuration|учетных записей с доступом по LDAP]] рядом с логином отображается индикатор [[File:Icon LDAP.png|x25px]], для учетных записей с доступом по OIDC рядом с логином отображается индикатор [[File:Icon_OIDC.png|x25px]], а для учетных записей с признаком '''Мастер разметки''' – индикатор [[File:Icon markup master.png|x25px]]. 
В разделе доступны:
* поиск по атрибутам учётной записи пользователя;
* фильтрация списка по типам учётных записей:
:* все;
:* системные;
:* LDAP;
:* OIDC;
:* заблокированные;
:* активные;
:* по ролям;
:* по организациям.
* сортировка по колонкам '''Логин''', '''ФИО''' и '''Дата создания''' (по умолчанию).
:[[File:74 Вкладка Пользователи на странице Настройки.png|thumb|none|upright=3|Вкладка '''Пользователи''' в разделе '''Управление пользователями''' страницы '''Настройки''']]
Для управления пользователями:
:1. Создайте учетную запись пользователя:
::а) Нажмите кнопку '''Создать'''.
::Откроется окно добавления учетной записи пользователя.
::[[File:76 Окно Добавить пользователя.png|thumb|none|upright=1.5|Окно '''Создать пользователя''']]
::б) Заполните поля:
::* Логин;
::* Пароль;
::* e-mail;
::* ФИО.
::в) Выберите [[Help:UI manual#Управление организациями|организации]], в которые должен входить пользователь, а также назначьте ему [[Help:UI manual#Управление ролями|роли]] – выберите значения в раскрывающихся списках полей '''Организации''' и '''Роли''' соответственно. Для отмены выбора нажмите на кнопку [[File:Icon cancel.png|x25px]] справа от значения.
::г) Включите опции '''Изменить пароль при первом входе в систему''' и '''Мастер разметки'''. 
::{{Note|type=info|text=''Если для учётной записи активирована опция '''Мастер разметки''', есть разрешение на разметку и этот пользователь разметил маркер в каком-либо снимке, то изменить его разметку может только пользователь, в учётной записи которого также активирована опция '''Мастер разметки''' или которому предоставлен [[#Cерверные доступы|серверный доступ]] '''Изменение любой разметки'''.''}}
::д) Нажмите кнопку '''Создать'''.
: В таблице со списком пользователей добавится новая запись.

:2. Воспользуйтесь функциями в строке учетной записи в крайнем правом столбце – нажмите кнопку [[File:Button menu.png|x25px]] и выберите пункт:
:* '''Редактировать''' – для перехода к редактированию данных профиля;
:* '''Изменить пароль''' – для перехода к изменению пароля;
:* '''Сбросить настройки пользователя''' – для возврата пользовательских настроек к их значениям по умолчанию;
:* '''Заблокировать''' – для блокировки учетной записи. В этом случае для учетной записи пользователя блокируется доступ к системе, а в списке рядом с логином учетной записи отображается индикатор [[File:Icon_Archived.png|x25px]];
:* '''Разблокировать''' – для восстановления доступа пользователя к системе;
:* '''Настройки уведомлений''' – для настройки уведомлений пользователя об операциях со снимками и маркерами – аналогично [[Help:UI manual#Настройка уведомлений|настройке уведомлений в меню пользователя]];
::[[File:219 Настройки Настройка уведомлений выбранного пользователя.png|thumb|none|upright=2|Настройки уведомлений выбранного пользователя]]
:* '''Удалить''' – для удаления учётной записи пользователя;
:* '''Показать доступы пользователя''' – для отображения списка объединенных доступов всех ролей, назначенных пользователю.
::[[File:113 Список доступов пользователя.png|thumb|none|upright=3|Список доступов пользователя]]
::{{Note|type=warn|text=''Функции блокировки и удаления недоступны для системных учетных записей. При изменении логина или списка доступов у авторизованного пользователя, он будет перенаправлен на страницу авторизации.''}}

:3. Воспользуйтесь функциями управления несколькими учётными записями одновременно:
::а) Чтобы выбрать несколько записей, установите флажки в первом столбце списка пользователей.
::б) Чтобы выбрать все отображаемые учётные записи, установите один флажок в заголовке столбцов в первом столбце списка.
::в) Нажмите кнопку '''Действия''' в верхней части списка пользователей и выберите пункт: '''Сбросить настройки пользователя''', '''Заблокировать''', '''Разблокировать''' или '''Удалить'''. В списке активны только действия, доступные всем выбранным учетным записям.
:4. Для [[LDAP configuration|учетной записи с доступом по LDAP]] обновите данные – в окне редактирования данных профиля пользователя нажмите кнопку '''Загрузить из LDAP'''.
:Загрузятся параметры профиля пользователя и его контакты из профиля в службе каталогов, если они там указаны.
:[[File:78 Загрузка данных из LDAP.png|thumb|none|upright=1.5|Загрузка данных из LDAP]]

==== Управление ролями ====
Реестром ролей можно управлять на вкладке '''Роли''' в разделе '''Управление пользователями''' страницы '''Настройки'''.
[[File:79 Переход к управлению ролями.png|thumb|none|upright=3|Вкладка '''Роли''' в разделе '''Управление пользователями''' страницы '''Настройки''']]
{{Note|type=info|text=''Роли [[Help:UI manual#Описание ролевой модели|admin, filter_master и importer]] являются встроенными с особым значением. Их нельзя удалить или изменить.''}}

Доступен поиск по названию роли и сортировка по колонкам '''Название''' (по умолчанию) и '''Пользователи'''. 
Для управления ролями доступны следующие функции:
:1. Создание новой роли:
::а) Нажмите кнопку '''Создать'''.
::[[File:81 Окно добавления роли.png|thumb|none|upright=3|Окно добавления роли]]
::б) Заполните поля появившейся формы:
:::*введите название роли;
:::*в блоке '''Серверные доступы''' выберите доступы – нажмите кнопку '''Выбрать всё''' или установите флажки для активации доступов.
:::При наведении курсора на иконку [[File:Icon question mark2.png|x25px]] отображается пояснение к доступу.
:::*в блоке '''Проектные доступы''' выберите тип доступа: группа проектов или определённый проект или его ветка;
:::*если выбран тип '''Группа проектов''', выберите название группы и установите флажки для активации доступов;
:::*если выбран тип '''Проект / Ветка''', выберите название проекта или ветки проекта, установите флажки для активации доступов.
:::Если выбрано значение '''Все''', то доступы будут предоставлены для всех проектов;
:::*для удаления строки с проектными доступами в блоке '''Проектные доступы''' нажмите кнопку [[File:Icon delete.png|x25px]] в крайнем правом столбце.
::в) Нажмите кнопку '''Создать'''.

:2. Просмотр доступов роли, нажмите на ссылку '''Показать доступы''' в столбце '''Доступы'''.
:[[File:114 Список доступов роли.png|thumb|none|upright=3|Список доступов роли]]

:3. Редактирование роли:
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке роли в крайнем правом столбце.
::б) В меню выберите пункт '''Редактировать''' и внесите изменения.

:4. Создание копии роли:
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке исходной роли в крайнем правом столбце.
::б) В меню выберите пункт '''Создать копию'''.
:В реестр ролей добавится новая запись с именем исходной роли и добавленным порядковым номером копии.

:5. Просмотр информации о роли в JSON-формате:
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке исходной роли в крайнем правом столбце.
::б) В меню выберите пункт '''Просмотреть JSON'''.

:6. Удаление роли:
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке исходной роли в крайнем правом столбце.
::б) В меню выберите пункт '''Удалить'''.
::в) Подтвердите удаление.

:7. Удаление несколько ролей одновременно:
::а) Для выбора нескольких записей установите флажки в первом столбце списка ролей.
::б) Чтобы выбрать все записи, установите один флажок в заголовке столбцов в первом столбце списка ролей.
::в) Нажмите кнопку '''Удалить''' и подтвердите удаление.

==== Управление организациями ====
Пользователи могут быть связаны с организациями. Один пользователь может принадлежать нескольким организациям. Организации носят информационный характер и не влияют на права пользователей в системе. 
Реестром организаций можно управлять на вкладке '''Организации''' в разделе '''Управление пользователями''' страницы '''Настройки'''.
[[File:92 Вкладка Организации на странице Настройки.png|thumb|none|upright=3|Вкладка '''Организации''' в разделе '''Управление пользователями''' страницы '''Настройки''']]
Доступен поиск по названию и сокращенному названию организации и сортировка по колонкам '''Название''' (по умолчанию), '''Сокращенное название''' и '''Пользователи'''.
Для управления организациями, доступны следующие функции:
:1. Создание организации:
::а) Нажмите кнопку '''Создать'''.
::б) Заполните поля появившейся формы.
::в) Нажмите кнопку '''Создать'''.
::[[File:93 Окно добавления организации в реестр.png|thumb|none|upright=1.5|Окно добавления организации в реестр]]

:2. Редактирование организации:
::а) Нажмите кнопку [[File:Icon edit2.png|x25px]] в крайнем правом столбце.
::б) В появившейся форме отредактируйте данные организации.
::в) Нажмите кнопку '''Сохранить'''.

:3. Удаление организации:
::а) Нажмите кнопку [[File:Icon delete.png|x25px]] в крайнем правом столбце.
::б) В появившемся диалоге подтвердите удаление, нажав на кнопку '''Удалить'''.

:4. Удаление несколько организаций одновременно:
::а) Для выбора нескольких записей установите флажки в первом столбце списка организаций.
::б) Чтобы выбрать все организации, установите один флажок в заголовке столбцов в первом столбце списка.
::в) Нажмите кнопку '''Удалить''' и подтвердите удаление.

=== Настройка глобальных фильтров ===
В разделе '''Глобальные фильтры''' страницы '''Настройки''' можно настроить глобальные фильтры, применительно [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|к выбранным проекту или ветке проекта]]: 
{{Note|type=info|text=''По умолчанию выбран контекст (проект, ветка), заданный ранее в режиме '''Разметка''', или '''Код'''.''}}
[[File:82 Вкладка Фильтры на странице Настройки.png|thumb|none|upright=4|Раздел '''Глобальные фильтры''' на странице '''Настройки''']]

В разделе доступен поиск по названию фильтра.

Для настройки фильтров:
:1. Выберите проект и ветку в верхней строке раздела. По умолчанию указаны проект и ветка, выбранные в разделе '''Разметка'''.
:2. Чтобы добавить фильтр, нажмите кнопку '''Создать'''.
:Отобразится новая строка:
:[[File:83 Новая строка с фильтром.png|thumb|none|upright=4|Новая строка с фильтром]]

:3. Чтобы изменить настройки фильтров:
::а) Введите или поменяйте название фильтра
::б) Включите или выключите фильтр – нажмите на значение в столбце '''Статус''', чтобы отобразилась иконка [[File:Icon check2.png|x25px]] (по умолчанию) или [[File:Icon cross 01.png|x25px]].
::в) Выберите область применения фильтра – нажмите на значение в столбце '''Область''' один или два раза, чтобы отобразилось значение '''ветка''' или '''проект'''.
::г) Введите [[Help:UI manual#Использование регулярных выражений|регулярное выражение]] или загрузите его из файла в столбцах '''Включить пути по шаблону''', '''Исключить пути по шаблону''' и '''Детекторы'''.
::{{Note|type=info|text=''Шаблоны регулярных выражений не зависят от регистра и поддерживают следующий синтаксис:''
:* ''; – для разделения списков значений;''
:* ''* – любое количество символов;''
:* ''? – один произвольный символ;''
:* ''re: – включая значения, определяемые регулярным выражением;''
:* ''re!: – исключая значения, определяемые регулярным выражением (только для столбца '''Детекторы''').''}}
::д) Выберите уровни серьезности (критичности) и надежности:
::* [[File:Icon_critical_on.png|x30px]] – уровень выбран;
::* [[File:Icon_critical_off.png|x30px]] – уровень не выбран.
::Для изменения выбора нажмите на название уровня.
:4. Нажмите кнопку [[File:Icon delete.png|x25px]] в крайнем правом столбце, чтобы удалить один фильтр.
:5. Чтобы удалить несколько фильтров:
::а) Для выбора нескольких записей установите флажки в первом столбце списка фильтров.
::б) Чтобы выбрать все записи, установите один флажок в заголовке столбцов в первом столбце списка фильтров.
::в) Нажмите кнопку '''Удалить'''.
:6. Для сохранения и применения изменений нажмите кнопку '''Применить'''.
Если не применить изменения, то при переходе в другой раздел системы отобразится сообщение о том, что изменения не применены:
:[[File:115 Запрос на изменение глобальных фильтров.png|thumb|none|upright=1.5]]

:{{Note|type=warn|text=''После применения глобальных фильтров пользователям, у которых в режиме разметки открыт данный контекст, требуется перезагрузить страницу (нажать клавишу F5) для обновления списка маркеров.''}}

=== Управление блокировками разметки ===
Чтобы посмотреть список всех [[Help:UI manual#Блокировка разметки|блокировок]], перейдите на вкладку '''Блокировки''' страницы '''Настройки''':
[[File:61 Просмотр всех блокировок.png|800px|thumb|none|Раздел '''Блокировки''' страницы '''Настройки''']]
{{Note|type=info|text=''Пользователю отображается список блокировок в контейнерах, к которым у него есть доступ. Удаление не своих блокировок доступно пользователям с соответствующим доступом.''}}

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

Для удаления одной блокировки:
:1. Нажмите кнопку [[File:Icon delete.png|x25px]] в строке проекта в крайнем правом столбце.
:2. Подтвердите удаление.
Для удаления нескольких блокировок:
:1. Чтобы выбрать для удаления все блокировки, установите флажок в заголовке табличного списка.
:2. Чтобы выбрать несколько блокировок, установите флажки в крайнем правом столбце табличного списка.
:3. Нажмите кнопку '''Удалить''' в верхней части списка.

=== Ведение журнала операций ===
В разделе '''Журнал операций''' страницы '''Настройки''' доступны просмотр и откат выполнения групповых операций по разметке и комментированию маркеров, таких как импорт разметки, копирование разметки, импорт снимков и т. п.
[[File:206 Настройки. Журнал операций.png|800px|thumb|none|Раздел '''Журнал операций''' на странице '''Настройки''']]
В разделе доступны:
* поиск по названию контейнера, типу операции и её описанию;
* фильтрация списка:
** по статусу операции: '''Applied''', '''Reverted''', '''Invalid''';
** типу операции;
** генератору операции;
** автору операции;
** диапазону дат создания операции;
* сортировка по всем колонкам, кроме '''Описание'''.

Чтобы откатить выполнение операции, нажмите кнопку [[File:Icon return.png|x25px]] в строке и подтвердите действие в открывшемся окне.
{{Note|type=warn|text=''Откат своих операций доступен пользователям с [[#Проектные доступы|проектными доступами]] '''Разметка маркеров''' и '''Импорт разметки'''. Откат операций других пользователей доступен пользователям с [[#Проектные доступы|проектным доступом]] '''Разметка маркеров''' и [[#Серверные доступы|серверным доступом]] '''Администрирование сервера''' или серверным доступами '''Изменение любой разметки''' и '''Изменение любых комментариев'''.''}}

=== Управление шаблонами разметки ===
Управление шаблонами разметки доступно в разделе '''Шаблоны разметки''' страницы '''Настройки''':
[[File:84 Вкладка Шаблоны на странице Настройки.png|thumb|none|upright=3|Раздел '''Шаблоны разметки''' на странице '''Настройки''']]

Шаблоны разметки нужны для [[Help:UI manual#Импорт разметки|импорта]]/[[Help:UI manual#Экспорт разметки|экспорта разметки]]. С их помощью комментарии в исходном коде будут преобразовываться в разметку на сервере истории и обратно.

Шаблон с именем DEFAULT есть всегда, его нельзя отредактировать или удалить.

{{Note|type=info|text=''Для корректного создания или изменения шаблонов разметки следует обратиться к разработчикам Svacer.''}}

Для управления шаблонами:
:1. Нажмите кнопку '''Создать'''.
:Откроется окно создания шаблона.
:[[File:Добавление шаблона разметки.png|thumb|none|upright=1.5|Окно создания шаблона разметки]]
:2. Введите название шаблона.
:3. Нажмите кнопку '''Создать'''.
:Шаблон появится в списке шаблонов для разметки в правой панели формы
:4. Отредактируйте поля шаблона разметки:
:[[File:85 Поля шаблона, доступные для редактирования.png|thumb|none|upright=2.5|Редактирование шаблона разметки]]
:5. Нажмите '''Сохранить'''.
:6. Чтобы клонировать существующий шаблон разметки, нажмите кнопку [[File:Icon_clone.png|x20px]] в правой части строки шаблона в списке.
:7. Для удаления одного шаблона:
::а) Нажмите кнопку [[File:Icon delete.png|x25px]] в правой части строки шаблона в списке.
::б) Подтвердите удаление.
:8. Для удаления нескольких шаблонов:
::а) Выберите шаблоны для удаления – установите флажки в левой части названий шаблонов или нажмите кнопку '''Выбрать всё'''.
::б) Нажмите кнопку '''Удалить''' в верхней части списка шаблонов и подтвердите удаление.

=== Управление токенами доступа ===
Управление персональными токенами доступа выполняется в разделе '''Токены доступа''' на странице '''Настройки'''.
[[File:207 Настройки. Токены доступа.png|800px|thumb|none|Раздел '''Токены доступа''' на странице '''Настройки''']]
В разделе доступны:
* поиск по названию токена и его описанию, а также по логину пользователя;
* сортировка по всем колонкам, кроме '''Описание'''.
Для управления токенами доступа:
:1. Создайте токен:
::а) Нажмите кнопку '''Создать'''.
::б) В окне '''Создать токен доступа''' введите название и, опционально, описание токена; выберите срок действия.
::По умолчанию срок действия токена 90 дней (минимальный срок 1 день, максимальный – 365).
::в) Нажмите кнопку '''Создать'''.
::[[File:208 Окно Создание токена доступа.png|thumb|none|upright=1.5|Окно '''Создать токен доступа''']]
::Отобразится окно с токеном доступа.
::{{Note|type=warn|text=''Токен отображается только один раз – при создании''}}
::[[File:209 Токен доступа.png|thumb|none|upright=1.5|Пример токена]]
::г) Нажмите кнопку '''Скопировать в буфер обмена''' и сохраните токен в надежном месте.
:2. Для удаления одного токена:
::а) Нажмите кнопку [[File:Icon delete.png|x25px]] в крайнем правом столбце.
::б) Подтвердите удаление.
:3. Для удаления нескольких токенов:
::а) Чтобы выбрать для удаления все токены, установите флажок в заголовке табличного списка.
::б) Чтобы выбрать несколько токенов, установите флажки в крайнем правом столбце табличного списка.
::в) Нажмите кнопку '''Удалить''' в верхней части табличного списка токенов и подтвердите удаление.

=== Управление асинхронными задачами ===
К асинхронным задачам относятся:
* экспорт snap и SARIF файлов (в режиме [[Help:UI manual#Экспорт|'''Разметки''']] и в разделе [[Help:UI manual#Работа со снимками|'''Проекты''']]);
* [[#Работа со снимками|копирование снимков]].
Управление этими задачами выполняется в разделе '''Асинхронные задачи''' на странице '''Настройки'''.

В разделе доступны:
* поиск по идентификатору задачи, её типу, описанию, статусу, а также по логину пользователя;
* фильтрация списка:
:* по статусу;
:* типу задачи;
:* пользователю;
:* диапазону дат старта и завершения выполнения задачи;
* сортировка по всем колонкам, кроме '''Описание'''.
[[File:342 Настройки. Асинхронные задачи.png|800px|thumb|none|Раздел '''Асинхронные задачи''' на странице '''Настройки''']]

Для управления асинхронными задачами:
:1. Чтобы посмотреть лог выполнения задачи, нажмите кнопку в крайнем правом столбце.
:Откроется окно с текстом лога.
:[[File:343 Окно с текстом лога асинхронной задачи.png|600px|thumb|none|Окно с текстом лога асинхронной задачи]]
:2. Чтобы скачать лог, нажмите кнопку в крайнем правом столбце или откройте окно с текстом лога и нажмите кнопку '''Скачать лог'''.
:3. Для удаления истории об одной задаче:
::а) Нажмите кнопку [[File:Icon delete.png|x25px]] в строке задачи в крайнем правом столбце.
::б) Подтвердите удаление.
:4. Для удаления истории о нескольких задачах:
::а) Чтобы выбрать для удаления все задачи, установите флажок в заголовке табличного списка.
::б) Чтобы выбрать несколько задач, установите флажки в крайнем левом столбце табличного списка.
::в) Нажмите кнопку '''Удалить''' в верхней части списка.

=== Просмотр информации о сервере ===
В разделе '''Информация о сервере''' на странице '''Настройки''' отображаются вкладки:
* '''Параметры''' – параметры, с которыми запущен сервер;
* '''Системный лог''' – журнал событий сервера;
* '''Системный журнал''' – журнал базы данных.
[[File:344 Настройки. Информация о сервере. Вкладка Параметры.png|thumb|none|upright=3|Раздел '''Информация о сервере''' на странице '''Настройки'''. Вкладка '''Параметры''']]
[[File:345 Настройки. Информация о сервере. Вкладка Системный лог.png|thumb|none|upright=3|Раздел '''Информация о сервере''' на странице '''Настройки'''. Вкладка '''Системный лог''']]
[[File:346 Настройки. Информация о сервере. Вкладка Системный журнал.png|thumb|none|upright=3|Раздел '''Информация о сервере''' на странице '''Настройки'''. Вкладка '''Системный журнал''']]

{{Note|type=warn|text=''На вкладке '''Системный лог''' вывод информации ограничен 1 Мб последних данных (значение [[Help:Configuration#Переменные_окружения|настраивается в параметрах сервера]]). При скачивании файл содержит данные лога в полном объеме.''}}

Доступны функции:
* поиск параметров по их имени и значению – на вкладке '''Параметры''';
* копирование записей – на вкладках '''Системный лог''' и '''Системный журнал''';
* выгрузка лога в файлы в формате .log по нажатии кнопки '''Скачать''' – на вкладках '''Системный лог''' и '''Системный журнал'''.

== Выход из системы ==
Для выхода из системы выберите пункт '''Выйти''' в меню пользователя в правом верхнем углу экрана.
[[File:95 Выход из системы —без VSCode.png|thumb|none|upright=1.5|Выход из системы]]

== Использование регулярных выражений ==
Регулярные выражения можно использовать:
* для поиска и фильтрации данных [[Help:UI manual#Функции навигационной панели|в навигационной панели]] [[Help:UI manual#Вкладка «Файлы»|на вкладке '''Файлы''']];
* в окне настройки [[Help:UI manual#Настройка и использование пользовательских фильтров|пользовательских фильтров]] в блоке '''Файлы''';
* при [[Help:UI manual#Экспорт исходного кода с разметкой|экспорте кода с разметкой]];
* при [[Help:UI manual#Настройка глобальных фильтров|настройке глобальных фильтров]];
* в полях [[Help:UI manual#Глобальный поиск|глобального поиска]].

Особенности реализации:
:1. Поиск происходит только по регулярному выражению. Если требуется найти специальный символ в качестве обычного символа, его нужно экранировать (например, точку: <code>\.</code>)
:2. При поиске находятся вхождения подстроки в полном пути к файлу (аналогично grep). Если требуется найти по полной строке, используйте символы начала и конца строки: <code>^</code> и <code>$</code>
:3. Поиск не зависит от регистра символов (case insensitive) и поддерживает следующий синтаксис:
::* ; – для разделения списков значений;
::* * – любое количество символов;
::* ? – один произвольный символ.
:В окне настройки [[Help:UI manual#Настройка и использование пользовательских фильтров|пользовательских фильтров]] в блоке '''Файлы''' можно применить фильтр как для отображения только маркеров из файлов, которые подходят под паттерн, так и для скрытия таких маркеров. Для переключения между этими режимами используйте кнопки [[File:Icon plus 2.png|x20px]] и [[File:Icon minus 3.png|x20px]], которые расположены рядом с полем ввода. В остальных частях интерфейса следует использовать теги re: и re!:

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

== Описание ролевой модели ==
=== Серверные доступы ===
{| class="wikitable"
! Полномочие (доступ) !! Описание !! Влияние на графический интерфейс !! admin !! filter_master !! importer
|-
| Создание проектов
|| Создание и клонирование проектов. Пользователь, создавший проект, имеет полный доступ к управлению этим проектом
|| Наличие полномочия делает доступным:
* раздел [[Help:UI manual#Управление проектами и группами проектов|'''Проекты''']];
* кнопку '''Создать проект''';
* форму создания, клонирования и редактирования проекта.

Наличие доступа предоставляет автору проекта полные права на управление своими проектами, включая разметку (даже при отсутствии у него соответствующего проектного доступа), а также позволяет удалять приложения к снимкам в созданных проектах
|| + || – || –

|-
| Настройка групп проектов
|| Создание, редактирование и удаление групп проектов
|| Наличие полномочия делает доступным:
* раздел [[Help:UI manual#Управление проектами и группами проектов|'''Проекты''']] с кнопкой для перехода к настройке групп;
* панель [[Help:UI manual#Работа с группами проектов|'''Группы проектов''']] с полным списком проектов в группах.
Наличие доступа предоставляет права на просмотр маркеров во всех проектах
|| + || – || –

|-
| Управление пользователями
|| Создание, редактирование и удаление пользователей
|| Наличие полномочия делает доступной вкладку [[Help:UI manual#Управление пользователями|'''Пользователи''']] в разделе [[Help:UI manual#Управление пользователями, ролями и организациями|'''Настройки – Управление пользователями''']] со всеми функциями управления учетными записями пользователей
|| + || – || –

|-
| Управление ролями
|| Создание, редактирование и удаление ролей
|| Наличие полномочия делает доступной вкладку [[Help:UI manual#Управление ролями|'''Роли''']] в разделе [[Help:UI manual#Управление пользователями, ролями и организациями|'''Настройки – Управление пользователями''']] со всеми функциями управления ролями
|| + || – || –

|-
| Управление организациями
|| Создание, редактирование и удаление организаций
|| Наличие полномочия делает доступной вкладку [[Help:UI manual#Управление организациями|'''Организации''']] в разделе [[Help:UI manual#Управление пользователями, ролями и организациями|'''Настройки – Управление пользователями''']] со всеми функциями управления организациями
|| + || – || –

|-
| Управление шаблонами разметки
|| Создание, редактирование и удаление шаблонов разметки
|| Наличие полномочия делает доступным раздел [[Help:UI manual#Управление шаблонами разметки|'''Настройки – Шаблоны разметки''']] со всеми функциями управления учетными записями шаблонами
|| + || – || –

|-
| Удаление блокировок
|| Просмотр и удаление блокировок всех пользователей
|| Наличие полномочия позволяет просматривать и удалять блокировки всех пользователей в разделе [[Help:UI manual#Управление блокировками разметки|'''Настройки – Блокировки''']]
|| + || – || –

|-
| Администрирование сервера
|| Просмотр настроек сервера, системных лог-файлов и выполнение операций по администрированию сервера Svacer, включая активацию лицензии
|| Наличие полномочия делает доступным раздел [[Help:UI manual#Просмотр информации о сервере|'''Настройки – Информация о сервере''']]
Совместно с проектными доступами '''Управление ветками''' и снимками и '''Разметка маркеров''' становится доступна функция очистки разметки и комментариев в ветке
|| + || – || –

|-
| Управление публичными фильтрами
|| Публикация, редактирование и удаление публичных фильтров
|| Наличие полномочия позволяет публиковать сохраненные фильтры, а также редактировать и удалять публичные фильтры
|| + || – || –

|-
| Изменение любой разметки
|| Изменение любой разметки маркеров, включая выполненную пользователями с признаком [[Help:UI manual#Управление пользователями, ролями и организациями|'''Мастер разметки''']]
|| Доступ позволяет переразмечать маркеры (добавлять новую разметку), которые разметили любые пользователи, в том числе те, для которых активирована опция [[Help:UI manual#Управление пользователями, ролями и организациями|'''Мастер разметки''']].
При этом:
# Полномочие не предоставляет доступ ко всем проектам. Т. е. пользователь с таким полномочием может изменять разметку только в проектах, к которым у него имеется доступ.
# Для переразметки маркеров пользователю должен быть предоставлен проектный доступ '''Разметка маркеров'''.
# Чтобы переразметить заблокированный маркер, сначала нужно [[Help:UI manual#Блокировка разметки маркеров|снять его блокировку]]
|| + || – || –

|-
| Изменение любых комментариев
|| Редактирование и удаление любых пользовательских комментариев к маркерам
|| Доступ позволяет изменять/удалять комментарии, которые создали любые пользователи, в том числе те, для которых активирована опция [[Help:UI manual#Управление пользователями, ролями и организациями|'''Мастер разметки''']].
При этом:
# Полномочие не предоставляет доступ ко всем проектам. Т. е. пользователь с таким полномочием может изменять разметку только в проектах, к которым у него имеется доступ.
# Для добавления комментариев пользователю должно быть предоставлено проектное полномочие '''Разметка маркеров'''.
# Чтобы поменять комментарий к заблокированному маркеру, сначала нужно [[Help:UI manual#Блокировка разметки маркеров|снять его блокировку]]
|| + || – || –

|-
| Создание резервных копий
|| Создание, просмотр и восстановление резервных копий в интерфейсе командной строки
|| –
|| + || – || –

|-
| Запуск скриптов
|| Запуск скриптов (hooks) по кнопке, расположенной на вкладке '''Подробности''' в правой панели, содержащей информацию о маркере
|| Наличие полномочия добавляет строку '''Хуки''' на вкладке '''Подробности''' правой панели с возможностью запуска скриптов
|| + || – || –
|}

=== Проектные доступы===
{| class="wikitable"
! Полномочие (доступ) !! Описание !! Влияние на графический интерфейс !! admin !! filter_master !! importer
|-
| Управление проектом и его ветками
|| Редактирование и удаление проекта, включая операции по управлению ветками и снимками проекта, настройке глобальных фильтров, импорту/экспорту разметки и просмотру маркеров
|| Наличие полномочия делает доступным:
* раздел [[Help:UI manual#Управление проектами и группами проектов|'''Проекты''']];
* все функции управления проектом (проектами в группе) и его содержимым (за исключением разметки маркеров) – т. е. все операции с проектом, ветками и снимками.
Наличие полномочия позволяет удалять приложения к снимкам и экспортировать разметку с исходным кодом
|| + || – || –

|-
| Управление ветками и снимками
|| Редактирование и удаление ветки проекта, включая операции по управлению снимками, настройке глобальных фильтров, импорту/экспорту разметки и просмотру маркеров
|| Наличие полномочия делает доступным:
* раздел [[Help:UI manual#Управление проектами и группами проектов|'''Проекты''']];
* все функции управления веткой и снимками проекта (за исключением разметки маркеров) – т. е. доступны все операции с веткой и снимками, но не операции управления проектом.
Наличие полномочия позволяет удалять приложения к снимкам и экспортировать разметку с исходным кодом.
Запрещено клонировать ветку при наличии доступа только к этой ветке
|| + || – || –

|-
| Настройка глобальных фильтров
|| Создание, редактирование и удаление глобальных фильтров
|| Наличие полномочия делает доступным раздел [[Help:UI manual#Настройка глобальных фильтров|'''Настройки – Глобальные фильтры''']].
Список проектов и веток в разделе определяется полномочиями к этим проектам и веткам
|| + || + || –

|-
| Импорт снимков
|| Загрузка, редактирование названия и удаление снимков
|| Наличие полномочия делает доступным:
* раздел [[Help:UI manual#Управление проектами и группами проектов|'''Проекты''']];
* функции просмотра проекта и ветки, управления снимками в указанной ветке (включая импорт .svace-dir, SARIF и *.snap), просмотра маркеров в указанном контейнере
|| + || – || +

|-
| Импорт разметки
|| Импорт разметки из файла и комментариев в исходном коде
|| Наличие полномочия делает доступным импорт разметки из файла, импорт разметки из комментариев исходного кода снимка и просмотр маркеров в указанном контейнере
|| + || – || +

|-
| Экспорт снимков
|| Экспорт данных снимков с разметкой и их открытие в IDE
|| Наличие полномочия позволяет:

* экспортировать разметку с исходными кодами;
* экспортировать снимки в форматах *.snap и SARIF;
* просматривать код с маркерами в Web-IDE
|| + || – || +

|-
| Просмотр маркеров
|| Просмотр маркеров и кода снимков, просмотр блокировок маркеров
|| Наличие полномочия предоставляет доступ к следующим функциям [[Help:UI manual#Работа в режиме разметки|в режиме разметки]]:
* просмотр и выбор снимков в указанном контейнере;
* просмотр содержимого снимков и маркеров (без возможности разметки).
Также наличие полномочия предоставляет доступ к разделу [[Help:UI manual#Управление блокировками разметки|'''Настройки – Блокировки''']], но только в части просмотра блокировок в доступных контейнерах, без возможности их удаления
|| + || + || +

|-
| Разметка маркеров
|| Просмотр и разметка маркеров в снимках, включая добавление комментариев, управление списком блокировок
|| Наличие полномочия позволяет пользователю размечать маркеры в указанном контейнере, добавлять комментарии, управлять своими блокировками, т. е. для собственных блокировок доступны кнопки удаления, а блокировки других пользователей доступны только для просмотра.
При отсутствии полномочия в таблице маркеров недоступны поля для установки флажков, а кнопка групповой разметки неактивна.
Для разметки маркеров с помощью AI совместно с данным доступом должен быть активен доступ '''Импорт разметки'''
|| + || – || –

|-
| Report API
|| Использование Report API для получения статистических показателей
|| –
|| + || – || –
|}

=== Известные ограничения ===

* Управление ''своими'' проектами для пользователей только c серверной ролью "Create Projects" без дополнительных прав может не работать для проектов, созданных до Release 7-0-0.
: Workaround: добавить пользователю явно проектные доступы на каждый необходимый проект.

Help:UI manual

2025-12-03T15:33:51Z

Akuzmin: minor fixes

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

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

Для авторизации в пользовательском интерфейсе сервера Svacer введите логин и пароль на странице ввода учётных данных. Учётные данные по умолчанию — admin / admin.
[[File:Авторизация 01.png|thumb|none|x300px|alt=AutorizationMain|Страница ввода учетных данных]]

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

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

[[File:Авторизация LDAP 02.png|thumb|none|x300px|alt=AutorizationLDAP|Страница входа по протоколу LDAP]]

После успешного входа отобразится пользовательский интерфейс сервера Svacer. При этом, если в прошлой сессии пользователь [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выбрал проект, его ветку и снимок]] или [[Help:UI manual#Использование фильтров|применил фильтры]], отобразятся эти проект, ветка и фильтры.

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

{{Note|type=info|text=''Чтобы после обновления системы в пользовательском веб-интерфейсе корректно отображались изменения, после авторизации обновите страницу в браузере – нажмите клавишу F5.''}}

== Описание основных элементов пользовательского интерфейса ==
Все страницы пользовательского интерфейса сервера Svacer устроены единообразно и состоят из двух частей:
# Верхняя панель – отображается на всех страницах пользовательского интерфейса. Содержит:
#* логотип сервера Svacer;
#* кнопки меню:
#** '''Разметка''' – [[Help:UI manual#Работа в режиме просмотра кода|просмотр и разметка найденных маркеров]], а также [[Help:UI manual#Сравнение снимков и маркеров|сравнение снимков или отдельных маркеров]];
#** '''Код''' – [[Help:UI manual#Работа в режиме разметки|просмотр снимков исходного кода]], связанного с результатами анализатора Svace;
#** '''Проекты''' – [[Help:UI manual#Управление проектами и группами проектов|управление проектами]] (режим доступен только пользователям с ролью admin);
#** '''Детекторы''' – [[Help:UI manual#Просмотр детекторов|просмотр списка детекторов]];
#** '''Статистика''' – [[Help:UI manual#Просмотр статистики|просмотр статистики разметки]] по всем проектам, веткам и снимкам, доступным пользователю;
#** '''Поиск''' – [[Help:UI manual#Глобальный поиск|глобальный поиск]] снимков, маркеров и комментариев к ним;
#* [[File:Icon settings.png|x25px]] – кнопка для перехода к [[Help:UI manual#Настройка сервера Svacer|настройке системы]];
#* [[File:Icon RuEng.png|x25px]] – переключатель языка пользовательского интерфейса;
#* [[File:Icon question mark.png|x25px]] – кнопка для перехода на страницу документации к системе;
#* [[File:Icon bell.png|25px]] – кнопка для перехода к [[Help:UI manual#Просмотр уведомлений в интерфейсе Системы|уведомлениям]];
#* [[File:Icon profile.png|x25px]] – кнопка меню пользователя, которое предоставляет следующие функции:
#** [[Help:UI manual#Настройка профиля пользователя|настройка профиля пользователя]];
#** [[Help:UI manual#Настройка интерфейса|настройка интерфейса]];
#** [[Help:UI manual#Настройка уведомлений|настройка уведомлений]];
#** [[Help:UI manual#Управление лицензией|управление лицензией]];
#** [[Help:UI manual#Просмотр информации о программе|просмотр информации о программе]];
#** [[Help:UI manual#Выход из системы|выход из системы]].
# Рабочая область – область экрана для просмотра информации и ввода, которая соответствует выбранному режиму работы или странице настроек.

:[[File:03 Основные элементы интерфейса – без VSCode.png|thumb|none|upright=3]]

== Базовые функции системы ==
=== Просмотр уведомлений в интерфейсе Системы===
Чтобы посмотреть уведомления, нажмите кнопку [[File:Icon bell.png|25px]] в правом верхнем углу экрана.

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

[[File:Notifications new.png|thumbnone|x300px|alt=NotificationList|Панель уведомлений]]

Нажмите кнопку [[File:Icon cross 01.png|15px]] для удаления уведомления.

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

=== Настройка профиля пользователя ===
Для перехода в профиль выберите пункт '''Профиль''' в меню пользователя в правом верхнем углу экрана:
[[File:06 Меню пользователя — без VSCode.png|thumb|none|250px|alt=UserMenu|Меню пользователя. Переход к настройке профиля]]

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

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

=== Изменение пароля ===
Для изменения пароля:
:1. Выберите пункт '''Профиль''' в меню пользователя.
:2. В разделе '''Профиль пользователя''' нажмите на ссылку '''Изменить пароль''':
:[[File:10_Профиль_изменение пароля.png|thumb|none|450px|Переход к изменению пароля в профиле пользователя]]
:3. В открывшемся окне:
::а) Введите текущий пароль.
::б) Дважды введите новый пароль.
::в) Нажмите кнопку '''Изменить'''.
::[[File:11_Профиль_ввод нового пароля.png|thumb|none|350px|Окно изменения пароля]]

=== Настройка интерфейса ===
Для перехода к настройкам выберите пункт '''Настройки интерфейса''' в меню пользователя в правом верхнем углу экрана:
[[File:187 Меню пользователя интерфейс.png|thumb|none|250px|alt=UserMenu|Меню пользователя. Переход к настройке интерфейса]]

В правой части экрана отобразится панель '''Настройки интерфейса''' с тремя группами параметров:
:1. '''Общие'''. Параметры этой группы позволяют:
::а) Выбрать фильтры, которые будут по умолчанию применяться при повторном входе в систему:
::*фильтры, установленные в предыдущей сессии (выбрано по умолчанию);
::*сохраненный пользовательский фильтр.
::б) Включить или выключить (выбрано по умолчанию) замену снимка на последний загруженный в БД Svacer снимок при открытии сохраненного контекста.
::Если параметр в состоянии «Выключен», при выборе проекта и ветки открывается последний импортированный снимок.
::в) Включить или выключить (выбрано по умолчанию) сохранение вкладок с открытыми файлами в каждом контексте.
::г) Включить (выбрано по умолчанию) или выключить сохранение применённой сортировки значений в таблице маркеров при [[Help:UI manual#Выход из системы|выходе из системы]].
::д) Включить или выключить (выбрано по умолчанию) механизм генерации PDF-файла на основе HTML при выгрузке отчета с [[Help:UI manual#Таблица маркеров|информацией о маркерах]].
{{Note|type=warn|text=''Для использования генерации PDF на основе HTML на сервере Svacer должен быть [[Help:Installation#Браузер для PDF-отчетов|установлен браузер Chromium или Google Chrome]].''}}
:[[File:08 общие настройки интерфейса.png|thumb|none|600px|alt=UserInterfaceSettings|Настройки интерфейса. Группа параметров «Общие»]]
:2. '''Навигационная панель'''. Параметры этой группы позволяют:
::а) Выбрать отображение по умолчанию данных [[Help:UI manual#Вкладка «Детекторы»|на вкладке '''Детекторы''']] навигационной панели:
::*группировка детекторов по уровням серьезности (выбрано по умолчанию);
::*отображение детекторов в виде списка.
:::Выбранное отображение будет применяться [[Help:UI manual#Вкладка «Детекторы»|на вкладке '''Детекторы''']] каждый раз после входа в систему.
::б) Выбрать отображение по умолчанию данных [[Help:UI manual#Вкладка «Файлы»|на вкладке '''Файлы''']] навигационной панели:
::*только имя файла (выбрано по умолчанию);
::*полный путь к файлу.
::в) Выбрать способ сортировки в колонке '''Маркеры''' [[Help:UI manual#Вкладка «Файлы»|на вкладке '''Файлы''']] панели навигации:
::*по общему количеству маркеров (выбрано по умолчанию);
::*по количеству размеченных маркеров.
:[[File:08_настройки навигационной панели.png|thumb|none|600px|alt=UserInterfaceSettings|Настройки интерфейса. Группа параметров «Навигационная панель»]]
:3. '''Просмотр кода'''. Параметры этой группы позволяют:
::а) Включить (выбрано по умолчанию) или выключить использование темной темы (темный фон, светлый текст) при просмотре файлов с исходным кодом.
::б) Включить или выключить (выбрано по умолчанию) переиспользование [[Help:UI manual#Вкладка с исходным кодом|вкладки с исходным кодом]] в редакторе кода.
::в) Включить или выключить (выбрано по умолчанию) отображение всех элементов трассы маркера по нажатии на ссылку '''Показать трассу''' [[Help:UI manual#Вкладка с исходным кодом|в виджете маркера]].
::Если параметр находится в состоянии «Выключен», то будет отображаться только первый элемент трассы.
::г) Выбрать отображение виджета относительно строки кода, с которой он связан:
::* над строкой кода (выбрано по умолчанию);
::* под строкой кода.
:[[File:08 настройки просмотра кода.png|thumb|none|600px|alt=UserInterfaceSettings|Настройки интерфейса. Группа параметров «Просмотр кода»]]
:Эти настройки сохраняются для учётной записи пользователя и не сбрасываются при новой сессии.
:Чтобы сбросить параметры любой группы к значениям по умолчанию, нажмите на ссылку '''Сбросить настройки''' внизу панели '''Настройки интерфейса'''.

=== Настройка уведомлений ===
Система может уведомлять пользователей по каналам E-mail и Telegram о следующих типах операций:
* добавление (при импорте, копировании, клонировании) и удаление снимков;
* изменение разметки маркеров;
* добавление комментариев к маркерам.

Для перехода к настройкам выберите пункт '''Настройки уведомлений''' в меню пользователя в правом верхнем углу экрана:
[[File:188 Меню пользователя - уведомления.png|thumb|none|250px|Меню пользователя. Переход к настройке уведомлений]]

В правой части экрана отобразится панель '''Настройки уведомлений''' с двумя группами параметров:
:1. '''Типы уведомлений'''. Параметры этой группы позволяют выбрать канал, по которому будут приходить уведомления, настроить и проверить его. Для этого:
::а) Включите опцию '''E-mail''' и (или) '''Telegram chat ID'''.
::При выборе уведомления по '''E-mail''' используется адрес электронной почты, указанный [[Help:UI manual#Настройка профиля пользователя|в профиле пользователя]].
::б) При выборе уведомления по '''Telegram''' введите '''Telegram chat ID'''.
::в) Чтобы проверить подключение к каналу нажмите кнопку '''Проверить'''.
::Отправится тестовое сообщение по указанным реквизитам:
::[[File:189 Настройки уведомлений.png|thumb|thumb|none|600px|alt=UserInterfaceSettings|Настройки уведомлений]]
:2. '''Подписки'''. Позволяют выбрать проекты, ветки и события, при возникновении которых будут приходить уведомления. Для этого:
::а) Для добавления подписки нажмите кнопку '''Добавить''' и в появившейся строке в раскрывающемся списке выберите проект и/или его ветку.
::Чтобы уведомления приходили при изменениях во всех проектах, доступных пользователю, выберите значение '''Все''' в раскрывающемся списке проектов.
::[[File:190 Настройки уведомлений. Выбор ветки.png|thumb|thumb|none|600px|alt=UserInterfaceSettings|Настройки уведомлений. Выбор ветки]]
::б) Выберите объекты, при изменении которых будут приходить уведомления – установите флажки в столбцах '''Снимки''', '''Разметка''', '''Комментарии'''.
::в) Если требуется получать уведомления о разметке и/или комментариях только в маркерах, в которых пользователь принимал участие, установите флажок в столбце '''Участие''' (доступен, только если установлены флажки в столбцах '''Разметка''' и/или '''Комментарии''').
::г) Для настройки исключения из подписки на уведомления нажмите кнопку [[File:Icon plus.png|x25px]].
::Кнопка примет вид [[File:Icon minus.png|x25px]].
::д) Для удаления подписки на уведомления нажмите кнопку [[File:Icon minus.png|x25px]].
::По окончании настройки уведомлений нажмите кнопку '''Сохранить'''.

=== Управление лицензией ===
{{Note|type=info|text=''В версии сервера Svacer 12.0.0 лицензия встроена в дистрибутив и не ограничивает функции системы. Срок действия встроенной лицензии – до 31.12.2027 г.''}}

Чтобы посмотреть текст лицензии системы и копировать его, а также для активации новой лицензии, выберите пункт '''Лицензия''' в меню пользователя в правом верхнем углу экрана.
В правой части экрана отобразится панель '''Лицензия'''.
[[File:231 Меню пользователя Переход к просмотру лицензии.png|thumb|none|450px|Меню пользователя. Переход к просмотру лицензии]]
[[File:232 Панель Лицензия.png|thumb|none|x400px|Панель «Лицензия»]]

Чтобы скопировать текст лицензии, нажмите кнопку [[File:Icon copy link.png|x15px]].
Чтобы активировать лицензию:
:1. Нажмите на ссылку '''Активировать новую'''.
:2. В открывшемся окне '''Активация лицензии''' введите лицензионный ключ и нажмите кнопку '''Активировать'''.
{{Note|type=warn|text=''Функция активации лицензии доступна пользователям с [[#Серверные доступы|серверным доступом]] '''Администрирование сервера'''.''}}
[[File:233 Окно Лицензия.png|thumb|none|600px|Окно «Активация лицензии»]]

=== Просмотр информации о программе ===
Чтобы посмотреть информацию о программе, выберите пункт '''О программе''' в меню пользователя в правом верхнем углу экрана.
[[File:12_Меню пользователя_о программе — без VSCode.png|thumb|none|250px|Меню пользователя. Переход к просмотру информации о программе]]

Откроется окно с информацией о программе
[[File:13 1 О программме.png|none|thumb|600x600px|Информация о программе]]
Нажмите на ссылку в строке '''Документация и релизы''' для перехода на страницу документации к системе и ссылкам для скачивания дистрибутивов релизов Svacer.

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

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

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

== Выбор контекста (проекта, ветки и снимка) ==
Для работы [[Help:UI manual#Работа в режиме разметки|в режиме разметки]] или [[Help:UI manual#Работа в режиме просмотра кода|режиме просмотра кода]] требуется выбрать проект, ветку и снимок с результатами работы анализатора Svace.

При необходимости список проектов можно отфильтровать по группе проектов. Это можно сделать в блоке, который расположен под [[Help:UI manual#Описание основных элементов пользовательского интерфейса|верхней панелью]].

[[File:14_Выбор проекта, верки, снимка.png|800px]]

По умолчанию после выбора проекта автоматически выбирается ветка master и последний импортированный снимок, если [[Help:UI manual#Настройка интерфейса|параметр '''При открытии сохраненного контекста заменить снимок на последний загруженный''']] находится в состоянии '''Выключен'''. Если master отсутствует, то ветку нужно выбрать вручную.

== Работа в режиме разметки ==
Режим разметки предоставляет следующий набор элементов управления:
:1. Навигационная панель:
:* [[Help:UI manual#Вкладка «Детекторы»|вкладка '''Детекторы''']];
:* [[Help:UI manual#Вкладка «Файлы»|вкладка '''Файлы''']].
:Эту панель можно скрыть. Для этого нажмите кнопку [[File:Button Скрыть навигацию.png|x25px]] в правом верхнем её углу. Чтобы панель раскрыть, нажмите кнопку [[File:Button Паказать навигацию.png|x25px]].
:2. Центральная панель:
:* [[Help:UI manual#Вкладка «Информация о снимке»|вкладка '''Информация о снимке''']] – открывается по нажатии кнопки [[File:Icon Information.png|25x25px]];
:* одна или несколько [[Help:UI manual#Вкладка с исходным кодом|вкладок с исходным кодом''']] (отображаются после выбора файлов в таблице маркеров или навигационной панели);
:* [[Help:UI manual#Таблица маркеров|таблица маркеров]];
:3. [[Help:UI manual#Функции правой панели|Правая панель]] с информацией о маркере.
:Эту панель можно скрыть. Для этого нажмите кнопку [[File:Button Паказать навигацию.png|x25px]] в левом верхнем её углу. Чтобы панель раскрыть, нажмите кнопку [[File:Button Скрыть навигацию.png|x25px]].

[[File:96 Режим разметки. Набор элементов управления.png|800px|thumb|none|Режим разметки. Набор элементов управления]]

=== Функции навигационной панели ===
==== Вкладка «Детекторы» ====
На этой вкладке отображается список детекторов Svace, которые сработали в выбранном снимке.

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

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

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

[[File:17 Файлы.png|thumb|none|300px|Вкладка '''Файлы''']]

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

На вкладке '''Файлы''' пользователю доступны следующие функции:
:1. Просмотр на [[Help:UI manual#Вкладка с исходным кодом|вкладке с исходным кодом]]: содержимого файла, места и содержания маркера, а также подробной информации о маркере [[Help:UI manual#Функции правой панели|на правой панели]] – без включения фильтрации по этому файлу. Для этого нажмите на имя файла.
:2. Применение фильтра по файлам [[Help:UI manual#Таблица маркеров|в таблице маркеров]] – для этого нажмите кнопку [[File:Icon plus.png|x25px]] в одной или нескольких строках.
:Фильтр применится, кнопка [[File:Icon plus.png|x25px]] в списке файлов поменяется на [[File:Icon minus.png|x25px]].
:3. Исключение файла из фильтра по файлам [[Help:UI manual#Таблица маркеров|в таблице маркеров]] – для этого нажмите кнопку [[File:Icon minus.png|x25px]] в строке файла.
:4. Отмена фильтрации [[Help:UI manual#Таблица маркеров|в таблице маркеров]] для всех выбранных файлов – для этого нажмите кнопку [[File:Icon minus 3.png|x25px]] или кнопку [[File:icon_return.png|x25px]] [[Help:UI manual#Вкладка «Детекторы»|на вкладке '''Детекторы''']].
:5. [[Help:UI manual#Блокировка разметки|Блокировка всех маркеров]] в файле для разметки другими пользователями – для этого нажмите кнопку [[File:icon_unlocked.png|x25px]] справа от названия файла (отображается при наведении курсора).
:6. Поиск по имени/пути файла в поле '''Поиск по полному пути'''. Поддерживается поиск с использованием [[Help:UI manual#Использование регулярных выражений|регулярных выражений]].
:7. Сортировка файлов по количеству маркеров – для этого нажмите кнопку [[File:Icon-expand-all.png|x25px]]
:8. Выгрузка списка отображаемых на панели файлов в файл формата .csv – для этого нажмите кнопку [[File:button_Скачать CSV.png|25px]]
:9. Настройка отображения файлов и сортировки в колонке '''Маркеры''' на вкладке '''Файлы''' – для этого нажмите кнопку [[File:icon_gear.png|x25px]] и поменяйте настройки.
:[[File:18 Временная настройка панели навигации.png|thumb|none|800px|Настройка отображения файлов и сортировки полей]]

=== Функции центральной панели ===
==== Вкладка «Информация о снимке» ====
На этой вкладке отображается информация о выбранном снимке.

[[File:19 Информация о снимке.png|thumb|left|600px|Вкладка '''Информация о снимке''']]
 
На вкладке '''Информация о снимке''' пользователю доступны следующие функции:
:1. Просмотр подробной информации о снимке во всплывающем окне – для этого нажмите кнопку '''Просмотреть JSON'''.
:2. Экспорт [[Help:UI manual#Экспорт|исходного кода, снимков и разметки]] – для этого нажмите кнопку '''Экспорт''' и выберите подходящий вариант.
:3. [[Help:UI manual#Импорт разметки|Импорт разметки]] – для этого нажмите кнопку '''Импорт''' и выберите подходящий вариант.
:4. Переход к более продвинутой навигации по исходному коду с подсветкой маркеров во встроенном Web-IDE Theia – для этого нажмите кнопку '''Открыть в IDE''' .
:{{Note|type=warn|text=''Функциональность является экспериментальной, доступна при наличии проектного доступа '''Экспорт снимков''' и запуске веб-приложения Svacer по протоколу HTTPS или на локальном хосте. Список доступных IDE определяется при инсталляции. Если доступна только одна IDE, то раскрывающийся список отсутствует, а IDE открывается сразу по нажатию кнопки '''Открыть в IDE'''. Если функциональность недоступна, кнопка '''Открыть в IDE''' неактивна и отображается иконка'' [[File:Icon attention.png|23x23px]]''.''}}
:5. Просмотр списка приложенных файлов — по нажатии кнопки '''Показать''', но только при наличии приложенных файлов.
:6. Скрытие списка приложенных файлов (возможно только при наличии приложенных файлов) – для этого нажмите на ссылку '''Скрыть'''.
:7. Удаление приложенного файла (возможно только при наличии приложенных файлов) — для этого нажмите кнопку [[File:icon_delete.png|x25px]].
:8. Просмотр пользовательских полей, которые пользователь указал при импорте – доступен по нажатии кнопки '''Показать''', но только при наличии этих полей.
:9. Просмотр параметров анализа во всплывающем окне – для этого нажмите кнопку '''Показать''' в строке '''Параметры анализа'''.
:10. Экспорт параметров анализа в формате .txt – для этого нажмите кнопку '''Скачать''' в строке '''Параметры анализа'''.
:11. [[Help:UI manual#Работа с таблицей статистики|Просмотр таблицы статистики]] – для этого нажмите кнопку '''Показать''' в строке '''Статистика по детекторам'''.
:Информация в таблице сгруппирована по параметрам детекторов, найденным маркерам и статусу их разметки.

==== Вкладка с исходным кодом ====
Вкладка открывается только после выбора файла [[Help:UI manual#Вкладка «Детекторы»|на вкладке '''Детекторы''']] или [[Help:UI manual#Вкладка «Файлы»|'''Файлы''']], а также [[Help:UI manual#Таблица маркеров|в таблице маркеров]]. Одновременно может быть открыто несколько вкладок с исходным кодом, если выключена [[Help:UI manual#Настройка профиля пользователя|настройка '''Переиспользование вкладки в редакторе кода''']].

В верхней части вкладки отображаются панель инструментов для работы с файлом [1] и полный путь к файлу [2]. Если в строке кода установлен курсор, то в нижнем правом углу вкладки отображается его позиция [3]:
[[File:20 Исходный код.png|thumb|none|600px|Полный путь к файлу и позиционирование курсора]]

На вкладке с исходным кодом пользователю доступны следующие функции:
:1. Отображение кода на весь экран – для этого нажмите кнопку [[File:Icon expand.png|23x23px]] или дважды кликните на вкладку файла.
:
:Для возврата к обычному отображению нажмите кнопку [[File:Icon minimize.png|24x24px]] или дважды кликните на вкладку файла.
:2. Переход к предыдущей или следующей строке, в которую пользователь установил курсор, – для этого используйте кнопки [[File:Button left.png|23x23px]] и [[File:Button right.png]] или сочетания клавиш '''Ctrl + <''' и '''Ctrl + >'''.
:3. Просмотр и открытие маркеров из списка всех маркеров в данном файле – для этого нажмите кнопку [[File:Icon list 2.png|x25px]].
:[[File:21 Исходный код Отображение списка маркеров.png|thumb|none|300px|right|Cписок маркеров в файле]]
:4. Отображение всех маркеров – для этого нажмите кнопку [[File:Icon Скрыть маркеры.png|24x24px]].
:Кнопка недоступна, если она уже нажата: все маркеры уже отображаются.
:5. Скрытие всех маркеров и трасс – для этого нажмите кнопку [[File:Icon Показать маркеры.png|24x24px]].
:Кнопка недоступна, если она уже нажата: все маркеры уже скрыты.
:6. Добавление комментария к строке кода – можно сделать двумя способами:
::а) Нажмите кнопку [[File:Button Comment Add.png|x25px]] в левой части строки, рядом с её номером (отображается только если в строке установлен курсор) и введите комментарий.
::ИЛИ
::б) Нажмите правой кнопкой мыши на строку и выберите пункт '''Добавить комментарий'''. Этим способом можно добавить несколько комментариев к одной строке.
:7. Просмотр комментария к строке – можно сделать двумя способами:
::а) Нажмите кнопку [[File:Button Comment view.png|x25px]] в левой части строки, рядом с её номером.
::ИЛИ
::б) Нажмите кнопку [[File:Button Comment view.png|x25px]] на панели инструментов и выберите в списке строку комментария.
::Отобразится виджет комментария, в котором доступны следующие функции:
::*добавление дополнительного комментария к этой строке кода по нажатии кнопки [[File:Button Comment Add.png|x25px]];
::*редактирование текста комментария по нажатии кнопки [[File:icon_edit3.png|x25px]];
::*удаление комментария по нажатии кнопки [[File:icon_delete 2.png|x25px]].
:[[File:118 Виджет комментария к строке кода.png|thumb|none|600px|Виджет комментария к строке кода]]
:8. Просмотр и открытие комментариев из списка всех комментариев в коде – для этого нажмите кнопку [[File:Button Comment view.png|x25px]] справа.
:9. Отображение всех комментариев в коде – для этого нажмите кнопку [[File:Button_Comment_view_all.png|x25px]] на панели инструментов.
:Кнопка недоступна, если она уже нажата: все комментарии уже отображаются.
:10. Скрытие всех комментариев в коде – для этого нажмите кнопку [[File:Button_Comment_hide_all.png|x25px]] на панели инструментов.
:Кнопка недоступна, если она уже нажата: все комментарии уже скрыты.
:11. Добавление открытого файла в [[Help:UI manual#Использование фильтров|фильтр]] [[Help:UI manual#Таблица маркеров|таблицы маркеров]] – для этого нажмите кнопку [[File:Icon filter add.png|x25px]] на панели инструментов.
:Фильтрация применится, вид кнопки поменяется на [[File:Icon filter remove.png|x25px]].
:12. Исключение файла из [[Help:UI manual#Использование фильтров|фильтра]] [[Help:UI manual#Таблица маркеров|таблицы маркеров]] – для этого нажмите кнопку [[File:Icon filter remove.png|x25px]] на панели инструментов.
:Фильтрация по этому файлу отменится, вид кнопки поменяется на [[File:Icon filter add.png|x25px]].
:13. Возврат к исходному маркеру (например, если был выбран другой связанный маркер на вкладке '''Трасса''' [[Help:UI manual#Функции правой панели|правой панели]]) – для этого нажмите кнопку [[File:Icon target.png|x25px]] в верхней части виджета маркера.
:14. [[Help:UI manual#Разметка маркера|Разметка маркера]] – установите '''Статус''', '''Серьезность''' и '''Действия''' в верхней части виджета маркера.
:15. Отображение блока элементов трассы в виджете маркера для строки кода – нажмите ссылку '''Показать трассу''' (доступна, если все блоки элементов трассы скрыты).
::Для последовательного перехода к другим элементам трассы воспользуйтесь кнопками [[File:Button up.png|x25px]] и [[File:Button down.png|x25px]].
::{{Note|type=info|text=''Отображение только первого элемента трассы или всех элементов трассы маркера по нажатии кнопки '''Показать трассу''' настраивается с помощью [[Help:UI manual#Настройка интерфейса|параметра '''Показывать всю трассу маркера''']].''}}
::[[File:97 Блок информации о элементе трассы.png|thumb|none|600px|Виджет маркера с блоком элемента трассы]]
:16. Скрытие блоков элементов трассы в виджете маркера для строки кода – нажмите ссылку '''Скрыть трассу''' (доступна, если хотя бы один блок элемента трассы отображается).
::Все открытые блоки элементов трассы маркера скроются.
:17. Переход к строке, в которой объявлена/определена переменная – нажмите правую кнопку мыши на строке исходного кода и выберите пункт '''Перейти к объявлению / Перейти к определению'''.
:{{Note|type=info|text=''Если для выделенного элемента кода нет объявления или определения, то отобразится сообщение: [[File:150 Объявление не найдено.png|247x247px]] или [[File:151 Определение не найдено.png|254x254px]].''}}

:18. Просмотр ссылок на панели внизу экрана – нажмите правую кнопку мыши на строке исходного кода и выберите пункт '''Найти ссылки'''. На этой панели отображается иерархический список файлов с номерами строк, в которых найдены ссылки:
:[[File:Исходный_код_Референсы.png|thumb|none|600px|Cписок файлов с номерами строк, в которых найдены ссылки]]

:* Чтобы перейти к строке кода, на которую найдена ссылка, нажмите на ссылку с номером строки на панели [1].
:* Чтобы посмотреть фрагмент кода, на который найдена ссылка, в режиме предпросмотра, нажмите кнопку [[File:icon_preview_code.png|x25px]] [2].
:{{Note|type=info|text=''Если для выделенного элемента кода нет ссылок, то отобразится сообщение: [[File:152 Ссылки не найдены.png|213x213px]].''}}

:19. Переход к просмотру выбранного файла [[Help:UI manual#Работа в режиме просмотра кода|в режиме просмотра кода]] – нажмите правую кнопку мыши на строке исходного кода и выберите пункт '''Открыть в режиме Код'''.
:20. Копирование ссылки на строку кода в буфер обмена – нажмите правую кнопку мыши на строке исходного кода и выберите пункт '''Копировать прямую ссылку'''.
::При переходе по этой ссылке будет открываться файл в режиме разметки с курсором на той строке кода, для которой была скопирована ссылка.
:21. Увеличение и уменьшение размера шрифта кода вместе с отображаемыми виджетами – нажмите правую кнопку мыши на любой строке исходного кода и выберите пункт '''Уменьшить''' или '''Увеличить''', либо установите курсор в любую строку и нажмите сочетание клавиш '''Ctrl + Alt + -''' или '''Ctrl + Alt + ='''
:22. Копирование строки кода – нажмите правую кнопку мыши на строке исходного кода и выберите пункт '''Copy'''.
:23. Вызов командной строки – нажмите правую кнопку мыши на строке исходного кода и выберите пункт '''Command Palette'''.
:[[File:25 Исходный код Вызов командной строки.png|thumb|none|600px|Командная строка]]

==== Таблица маркеров ====
Для раскрытия таблицы маркеров нажмите кнопку [[File:Button Показать таблицу.png|x25px]] в верхней части [[Help:UI manual#Функции центральной панели|центральной панели]], а для её скрытия – [[File:Button Скрыть таблицу.png|x25px]].

В верхней части таблицы находится панель, которая содержит:
* [[File:Field Детектор.png|x25px]] – поле с информацией [[Help:UI manual#Использование фильтров|о примененных фильтрах]]: как назначенных [[Help:UI manual#Функции навигационной панели|в навигационной панели]], так и с помощью [[Help:UI manual#Настройка и использование пользовательских фильтров|пользовательских фильтров]] и запросов;
* кнопка [[File:Icon download.png|x25px]] – выгрузка маркеров в файл формата .csv или .pdf: только для [[Help:UI manual#choice|выбранных]] или всех отображаемых маркеров, если ничего не выбрано. Отчет в формате .pdf может быть сгенерирован на основе HTML, так и существующим (нативным) способом. В PDF-отчете, сгенерированном на основе HTML, усовершенствованы стили, доработан титульный лист, актуализирован набор параметров для выгружаемых маркеров и пр.;
:{{Note|type=warn|text='''''Примечания:'''''
:* ''если в таблице не отображаются маркеры из-за примененных пользовательских фильтров, то в сгенерированном PDF-отчете будет указано «Нет маркеров (применены фильтры)»;''
:* ''для использования механизма генерации PDF-отчёта на основе HTML должна быть включена [[Help:UI manual#Настройка интерфейса|одноименная настройка]];''
:* ''генерация PDF-отчета на основе HTML может занимать больше времени, чем нативная генерация;''
:* ''спецсимволы (иконки), добавленные в комментариях к маркерам, не отображаются в выгруженном PDF-отчете.''}}

* кнопка [[File:Icon edit.png|x25px]] – переход [[Help:UI manual#Групповая разметка маркеров|к групповой разметке]] выбранных маркеров (доступна, если выбраны маркеры в таблице);
* кнопка [[File:Button_Comment_Add.png|x25px]] – переход к [[Help:UI manual#Добавление общего комментария к нескольким маркерам|добавлению общего комментария к нескольким выбранным маркерам]].

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

В таблице маркеров пользователю доступны следующие функции:
:1. Сортировка по значениям столбцов.
:2. Выбор маркеров для [[Help:UI manual#dwl pdf|выгрузки отчета]], [[Help:UI manual#Групповая разметка маркеров|групповой разметки]] или [[Help:UI manual#Добавление общего комментария к нескольким маркерам|добавления общего комментария к нескольким маркерам]] – для этого установите флажок в строке маркера.
:3. Просмотр подробной информации о маркере [[Help:UI manual#Функции правой панели|в правой панели]] и его места и содержания [[Help:UI manual#Вкладка с исходным кодом|на вкладке с исходным кодом]] – для этого дважды кликните на строку маркера или нажмите на имя файла в столбце '''Файл'''. Также для выбора можно использовать клавиши ↑ и ↓ – для перемещения по строкам, и Enter – для подтверждения выбора.
:4. Просмотр детальной информации о маркере в JSON-формате – для этого нажмите правой кнопкой мыши на маркер и выберите пункт '''Просмотреть JSON'''.
:5. Копирование детальной информации о маркере (JSON маркера) в буфер обмена – для этого нажмите правой кнопкой мыши на маркер и выберите пункт '''Копировать JSON'''.
:При переходе по этой ссылке будет открываться список маркеров в режиме разметки с открытым маркером (в правой панели и на вкладке с исходным кодом), для которого была скопирована ссылка.
:6. Копирование ссылки на маркер в буфер обмена – для этого нажмите правой кнопкой мыши на маркер и выберите пункт '''Копировать ссылку на маркер'''.
:7. Переход к [[Help:UI manual#Сравнение маркеров|сравнению одного маркера с другим]] – для этого нажмите правой кнопкой мыши на маркер и выберите пункт '''Сравнить с ...'''

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

На правой панели пользователю доступны следующие функции:
:1. Копирование ссылки на маркер – для этого нажмите кнопку [[File:Icon copy link.png|x25px]].
:2. [[Help:UI manual#Блокировка разметки|Блокировка маркера]] для разметки другими пользователями – для этого нажмите кнопку [[File:icon_unlocked.png|x25px]] в верхней части правой панели.
:3. [[Help:UI manual#Разметка маркера|Разметка маркера]] – для этого установите '''Статус''', '''Серьезность''' и '''Действие''' в верхней части правой панели.
:4. Просмотр истории разметки со связанными комментариями – для этого нажмите кнопку [[File:Icon history.png|x25px]] в верхней части правой панели.
:[[File:28 История изменения маркера.png|thumb|none|upright=2.5|Пример истории изменения разметки маркера]]

:5. Отображение маркера [[Help:UI manual#Вкладка с исходным кодом|на вкладке с исходным кодом]] нажмите кнопку с именем файла и номером строки в верхней части правой панели.
:6. Отображение элемента трассы [[Help:UI manual#Вкладка с исходным кодом|на вкладке с исходным кодом]] – для этого нажмите на ссылку с именем файла и номером строки на вкладке '''Трасса''' [1].
:7. Отображение кода, который соответствует строке трассы, в отдельном окне в режиме предпросмотра – для этого на вкладке '''Трасса''' нажмите кнопку [[File:Icon preview code.png|x25px]] рядом с именем файла и номером строки [2].
:[[File:31 Предпросмотр кода.png|thumb|none|upright=2.5|Элементы управления для работы с элементом трассы]]
:8. Просмотр и добавление комментариев к маркеру на вкладке '''Комментарии'''.
:Комментарии для каждого маркера уникальны. Добавление одинаковых комментариев недоступно.
:Редактор комментариев поддерживает синтаксис Markdown.
:Для упоминания пользователя, вставьте '''@''' и введите или выберите его логин. После добавления комментария по нажатии кнопки '''Применить''' указанному пользователю придет [[Help:UI manual#Просмотр уведомлений в интерфейсе Системы|уведомление в интерфейсе системы]] об упоминании с возможностью перехода к маркеру с этим комментарием.
:9. Редактирование и удаление комментариев на вкладке '''Комментарии''' с помощью кнопок [[File:Icon edit2.png|x25px]] и [[File:Icon delete.png|x25px]].
:Если [[Help:UI manual#Работа с проектами|для проекта]] установлен флажок '''Обязательный комментарий при разметке''', то удаление связанного с разметкой комментария недоступно. Его можно только отредактировать.
:[[File:32 Комментарии.png|thumb|none|upright=1.3|Вкладка '''Комментарии''']]
:{{Note|type=info|text='''''Примечания''':''
:* ''Пользователь может отредактировать и удалить только свои комментарии. Пользователю с доступом '''Изменение любых комментариев''' доступно редактирование и удаление комментариев всех пользователей. Если такой пользователь внёс изменения, то изначальный автор теряет возможность изменять свой комментарий (если у него нет доступа '''Изменение любых комментариев'''), так как авторство передаётся пользователю, который последним внёс изменения.''
:* ''Для отредактированного комментария отображается слово '''изменено''', при наведении курсора на которое отображается сообщение с логином пользователя, изменившего комментарий, и датой редактирования. Текст несохраненного комментария в поле добавления комментария не пропадает при переключении на другой маркер.''
:* ''Если открыт режим редактирования комментария, то при переключении на другой маркер режим редактирования закрывается и изменения не сохраняются.''}}
:10. Ввод, просмотр и редактирования комментария в отдельном диалоговом окне – для этого нажмите кнопку [[File:Button Comment Zoom.png|x25px]] рядом с полем ввода нового комментария или в поле существующего комментария.
:[[File:120 Окно создания, просмотра и редактирования комментария в отдельном диалоговом окне.png|thumb|none|upright=2|Окно создания, просмотра и редактирования комментария в отдельном диалоговом окне]]
:11. Просмотр подробной информации на вкладке '''Подробности'''. Содержит два блока:
:* информация о сработавшем детекторе: серьезность и надежность, а также связанные с ним коды CWE, которые содержат ссылки на описание дефектов безопасности на сайте [https://cwe.mitre.org cwe.mitre.org];
:* информацией о маркере: текстовые метки маркера, названия снимка и функции, инструмент, язык, текстовое описание и степень доверия, а также кнопки для перехода к просмотру истории маркера и запуску хуков.
::{{Note|type=info|text=''Svace, начиная с версии 4.0, для некоторых языков поставляется с моделью искусственного интеллекта, которая предсказывает истинность срабатывания маркера на основе предупреждений и собранных метрик. Это значение в Svacer отображается в параметре '''Степень доверия'''.''}}
::По нажатии на иконку [[File:icon_question_mark2.png|x25px]] справа от названия детектора отображается дополнительная информация о нём. Иконка не отображается, если дополнительная информация отсутствует.
:[[File:33 Подробная информация о маркере.png|thumb|none|upright=2|Вкладка '''Подробности''']]
:[[File:121 Окно с дополнительной информацией о детекторе.png|thumb|none|upright=2|Окно с дополнительной информацией о детекторе]]

:12. Просмотр истории обнаружения маркера в снимках данной ветки проекта – для этого на вкладке '''Подробности''' нажмите кнопку '''Показать''' в блоке информации о маркере в строке '''История'''.
:В окне просмотра истории доступна сортировка записей.
:[[File:35 История маркера.png|thumb|none|upright=2.5|Пример истории маркера]]
:13. Просмотр маркера в JSON-формате – для этого на вкладке '''Подробности''' нажмите кнопку '''Показать''' в блоке '''JSON'''.
:[[File:234 Пример JSON маркера.png|thumb|none|upright=2|Пример JSON маркера]]
:14. Запуск хуков (скриптов) – для этого нажмите кнопку '''Запустить''' на вкладке '''Подробности''' и в раскрывающемся списке доступных хуков выберите тот, который требуется запустить.
 

=== Использование фильтров ===
==== Общая информация ====
Настройка и использование фильтров доступны [[Help:UI manual#Работа в режиме разметки|в режиме разметки]].

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

# Фильтры [[Help:UI manual#Функции навигационной панели|навигационной панели]] [1]: детекторы, файлы или серьезность.
# Доступные для разметки – позволяют отобразить только маркеры, которые доступны пользователю для разметки, т. е. при использовании этого фильтра в списке не будут отображаться маркеры, заблокированные другими пользователями. Фильтр применяется по нажатии кнопки [[File:Icon view2.png|x25px]] [2] в правой части блока [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выбора проекта, ветки и снимка]].
# Размеченный – позволяют отобразить только размеченные маркеры. Фильтр применяется по нажатии кнопки [[File:Icon view.png|x25px]] [3] в правой части блока [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выбора проекта, ветки и снимка]].
# [[Help:UI manual#Настройка и использование пользовательских фильтров|Пользовательские фильтры]] – доступны по нажатии кнопки [[File:Button Фильтры.png|x25px]] [4] в правой части блока [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выбора проекта, ветки и снимка]].
# Запрос – фильтр, указанный в поле в верхней части [[Help:UI manual#Таблица маркеров|таблицы маркеров]] [5].

:[[File:36 Фильтры.png|thumb|none|upright=3|Существующие фильтры]]

Увидеть примененные фильтры (кроме '''Доступные для разметки''') и последовательность их применения можно в поле [[File:field Детектор.png|x25px]] в верхней части [[Help:UI manual#Таблица маркеров|таблицы маркеров]].

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

По нажатию кнопки [[File:Button Фильтры 2.png|x25px]] в правой части блока [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выбора контекста]] можно отменить примененные фильтры: пользовательский или все.

==== Настройка и использование пользовательских фильтров ====
Настроить пользовательские фильтры можно [[Help:UI manual#Работа в режиме разметки|в режиме разметки]]. Для этого:
:1. Нажмите кнопку [[file:button Фильтры.png|x25px]] в правой части блока [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выбора контекста]].
:В правой части экрана отобразится панель пользовательских фильтров, которая содержит три вкладки:
:* '''Пользовательский''' – параметры фильтрации, которые разделены на три группы:
::* параметры детекторов;
::* параметры маркеров;
::* файлы;
::* [[Afilters|расширенный фильтр]];
:* '''Сохраненные''' – список [[Help:UI manual#Работа с сохраненными фильтрами|сохраненных фильтров]];
:* '''Публичные''' – [[Help:UI manual#Работа с публичными фильтрами|список фильтров, доступных всем пользователям]].

:2. Настройте параметры фильтрации на вкладке '''Пользовательский''' – выберите значения в списках полей, нажмите кнопки со значениями, или введите значения.
:3. Нажмите на кнопку [[File:Icon cancel.png|x15px]] справа от значения в списке, чтобы отменить его выбор.
:4. Если параметры нужно исключить из поиска, нажмите на кнопку [[File:Icon plus 2.png|x25px]].
:Кнопка поменяется на [[File:Icon minus 3.png|x25px]].
:5. Если параметры нужно включить в поиск, нажмите на кнопку [[File:Icon minus 3.png|x25px]].
:Кнопка поменяется на [[File:Icon plus 2.png|x25px]].
:6. Если в полях '''Метки''', '''Функции''' и '''Файлы''' нужно использовать регулярные выражения:
::а) Нажмите на кнопку [[File:Button TextTempl.png|x25px]].
::Кнопка поменяется на [[File:Button Reg.png|x25px]].
::б) Введите [[Help:UI manual#Использование регулярных выражений|регулярные выражения]]. Используйте новую строку для разделения значений.
:7. Если в полях '''Метки''', '''Функции''' и '''Файлы''' нужно использовать текстовые шаблоны:
::а) Нажмите на кнопку [[File:Button Reg.png|x25px]].
::Кнопка поменяется на [[File:Button TextTempl.png|x25px]].
::б) Введите текстовые шаблоны. Используйте новую строку для разделения значений.
:8. Для создания сложного фильтра с поиском по предикатам задайте в поле '''Расширенный фильтр''' параметры в формате <code>filter(markers, <predicate expr>)</code>, где:
::* <code>filter ()</code> – функция, которая фильтрует список по предикату;
::* <code>markers</code> – объект, который содержит массив маркеров из контекста;
::* <code><predicate expr></code> – выражение, которое определяет предикат.
::Описание используемых в этом фильтре функций, объектов и выражений, а также языка предикатов доступно по нажатии на иконку [[File:Icon question mark2.png|x25px]] и в [[Afilters|статье документации]].
:9. Нажмите кнопку [[File:Button Очистить.png|x25px]], чтобы очистить все параметры фильтрации.
:10. Нажмите кнопку [[File:Button Сохранить как.png|x25px]], в открывшемся диалоге введите название и нажмите кнопку '''Сохранить'''.
:Фильтр сохранится и отобразится на [[Help:UI manual#Работа с сохраненными фильтрами|вкладке '''Сохраненные''']].
:11. Нажмите кнопку [[File:Button Применить.png|x25px]], чтобы применить фильтр.
:После применения кнопка фильтра станет зеленой, а ее название поменяется на название сохраненного фильтра.
::[[File:36 Пользовательские фильтры.png|thumb|none|upright=2|Пользовательские фильтры. Вкладка '''Пользовательский''']]

==== Работа с сохраненными фильтрами ====
На вкладке '''Сохраненные''' отображаются фильтры, [[Help:UI manual#filters saved|сохраненные на вкладке '''Пользовательский''']], а также [[Help:UI manual#filters published|скопированные с вкладки '''Публичные''']].
:[[File:37 Фильтры сохраненные.png|thumb|none|upright=2|Пользовательские фильтры. Вкладка '''Сохраненные''']]

Воспользуйтесь функциями управления фильтрами на вкладке '''Сохраненные''':
:1. Для поиска фильтра введите его название в строке поиска.
:2. Для сортировки фильтров по названию нажмите кнопку [[File:Button Sort.png|x25px]].
:3. Для редактирования сохраненного фильтра нажмите кнопку [[File:Icon edit3.png|x25px]] и [[Help:UI manual#Настройка и использование пользовательских фильтров|внесите изменения]].
:4. Создайте дубликат фильтра – нажмите кнопку [[File:Icon duplicate.png|x25px]].
:5. Для публикации фильтра нажмите кнопку [[File:Button share.png|x25px]].
:Копия сохраненного фильтра отобразится [[Help:UI manual#Работа с публичными фильтрами|на вкладке '''Публичные''']] и станет доступна другим пользователям.
:{{Note|type=warn|text=''Функция доступна только пользователям с [[#Серверные доступы|серверным доступом]] '''Управление публичными фильтрами'''''.}}
:6. Для удаления одного фильтра нажмите кнопку [[File:Icon delete 2.png|x25px]].
:7. Для удаления нескольких фильтров:
::а) Выберите фильтры для удаления – установите флажки в левой части названий фильтров или нажмите кнопку '''Выбрать всё'''.
::б) Нажмите кнопку '''Удалить'''.
:8. Примените фильтр – нажмите на его название и нажмите кнопку [[File:Button Применить.png|x25px]].

После применения:
* примененный фильтр будет отмечен [[File:Icon check.png|x25px]];
* кнопка фильтра станет зеленой, а ее название поменяется на название сохраненного фильтра.

==== Работа с публичными фильтрами ====
{{Note|type=warn|text=''Создание (публикация), изменение и удаление публичных фильтров доступны пользователям с [[#Серверные доступы|серверным доступом]] '''Управление публичными фильтрами'''''.}}

На вкладке '''Публичные''' отображаются фильтры, [[Help:UI manual#filters publishing|опубликованные на вкладке '''Сохраненные''']].
<gallery mode="packed" heights="300px" style="float:left; clear:right; margin-right:1em; margin-left:1em">
153 Пользовательские фильтры. Публичные без доступа.png|Пользовательские фильтры. Вкладка '''Публичные'''. Вид для пользователя без серверного доступа '''Управление публичными фильтрами'''
154 Пользовательские фильтры. Публичные с доступом.png|Пользовательские фильтры. Вкладка '''Публичные'''. Вид для пользователя с серверным доступом '''Управление публичными фильтрами'''
</gallery>
 
Воспользуйтесь функциями управления фильтрами на вкладке '''Публичные''':
:1. Для поиска фильтра введите его название в строке поиска.
:2. Для сортировки фильтров по названию нажмите кнопку [[File:Button Sort.png|x25px]].
:3. Чтобы посмотреть параметры фильтра, нажмите кнопку [[File:Button show.png|x25px]].
:{{Note|type=warn|text=''Функция доступна только пользователям БЕЗ [[#Серверные доступы|серверного доступа]] '''Управление публичными фильтрами.'''''}}
:4. Для редактирования публичного фильтра нажмите кнопку [[File:Icon edit3.png|x25px]] и [[Help:UI manual#Настройка и использование пользовательских фильтров|внесите изменения]].
:5. Скопируйте публичный фильтр – нажмите кнопку [[File:Icon duplicate.png|x25px]].
:Фильтр сохранится и отобразится [[Help:UI manual#Работа с сохраненными фильтрами|на вкладке '''Сохраненные''']].
:6. Для удаления одного фильтра нажмите кнопку [[File:Icon delete 2.png|x25px]].
:7. Для удаления нескольких фильтров:
::а) Выберите фильтры для удаления – установите флажки в левой части названий фильтров или нажмите кнопку '''Выбрать всё'''.
::б) Нажмите кнопку '''Удалить'''.
:8. Примените фильтр – нажмите на его название и нажмите кнопку [[File:Button Применить.png|x25px]].

После применения:
* примененный фильтр будет отмечен [[File:Icon check.png|x25px]];
* кнопка фильтра станет зеленой, а ее название поменяется на название сохраненного фильтра.

=== Сравнение снимков и маркеров ===
Чтобы сравнить снимки и маркеры в них:
:1. [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|Выберите исходный контекст]] – проект, ветку, снимок.
:2. [[Help:UI manual#Работа в режиме разметки|В режиме разметки]] нажмите кнопку [[File:Button Сравнить с.png|x25px]] и в раскрывшемся списке выберите пункт '''Сравнить с…'''.
:3. В открывшемся окне выберите проект, ветку и снимок для сравнения; нажмите кнопку [[File:Button Применить.png|x25px]].
:[[File:38 Выбор снимка для сравнения.png|thumb|none|upright=1.5|Выбор проекта, ветки и снимка для сравнения]]
:Результат сравнения отобразится [[Help:UI manual#Функции навигационной панели|в навигационной панели]] и [[Help:UI manual#Функции центральной панели|центральной панели]], причем:
:* вкладка '''Информация о снимке''' поменяется на вкладку '''Информация о различиях''' с информацией о двух сравниваемых снимках;
:* применится первый режим сравнения, в котором найдены результаты.
:4. Выберите режим сравнения.
:[[File:39 Выбор режима сравнения.png|800px|thumb|none|Выбор режима сравнения]]
:[[Help:UI manual#Функции навигационной панели|В навигационной панели]] и [[Help:UI manual#Функции центральной панели|центральной панели]] отобразятся только результаты выбранного режима сравнения. В режимах '''Сопоставленные''' и '''Одинаковые''' [[Help:UI manual#Таблица маркеров|в таблице маркеров]] добавится столбец с номером версии: V1 – маркер в файле текущего снимка, V2 – маркер в файле целевого снимка.
:{{Note|type=info|text=''Если при просмотре кода файла целевого снимка перейти к просмотру файла [[Help:UI manual#Работа в режиме просмотра кода|в режиме '''Код''']] (команда '''Открыть в режиме код'''), то режим сравнения закроется, отобразится контекст целевого снимка.''}}
<gallery heights="210" perrow="2" mode="packed" style="float:left; clear:right; margin-right:1em; margin-left:2em" "="">
File:40 Пример сравнения новые.png|Пример результатов сравнения в режиме '''Только в V1'''
File:41 Пример сравнения Отсутствующие.png|Пример результатов сравнения в режиме '''Только в V2'''
File:42 Пример сравнения Сопоставленные.png|Пример результатов сравнения в режиме '''Сопоставленные'''
File:43 Пример сравнения Одинаковые.png|Пример результатов сравнения в режиме '''Одинаковые'''
</gallery>
 
:5. Посмотрите различия в параметрах анализа – нажмите кнопку '''Показать различия''' на вкладке '''Информация о различиях'''.
:[[File:44 Различия в результатах анализа.png|600px|thumb|none|Сравнение настроек анализа]]
:6. Посмотрите различия в статистике разметки – нажмите кнопку '''Различия разметок'''.
:[[File:45 Различия в статистике по детекторам.png|thumb|none|600px|Сравнение статистики разметок]]
:7. Нажмите кнопку [[File:Icon download CSV.png|x25px]] или [[File:Icon download PDF.png|x25px]], чтобы скачать статистику в формате CSV или PDF.
:8. Отмените сравнение – нажмите кнопку [[File:Icon cancel 2.png|x25px]] в блоке выбора проекта, ветки и снимка.
 

=== Сопоставление маркеров ===
{{Note|type=warn|text=''Функциональность доступна пользователям с [[#Проектные доступы|проектным доступом]] '''Разметка маркеров''' и [[#Серверные доступы|серверным доступом]] '''Администрирование сервера'''''}}

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

Результат сопоставления, выполненного вручную, можно отменить.
==== Сопоставление маркеров вручную ====
Сопоставление маркеров вручную проводится в два этапа:
:а) Выбор пар маркеров и их сопоставление, без сохранения в БД.
:б) Просмотр выбранных пар и подтверждение операции.

Чтобы вручную сопоставить маркеры:
:1. [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|Выберите исходный контекст]].
:2. [[Help:UI manual#Работа в режиме разметки|В режиме разметки]] нажмите кнопку [[File:Button Сравнить с.png|x25px]] и в раскрывшемся списке выберите пункт '''Сопоставить маркеры'''.
:Откроется окно '''Сопоставить маркеры'''.

:3. Этап 1. На вкладке '''Сопоставление маркеров''':
::а) Выберите снимок, маркеры которого нужно сопоставить с исходным.
::Отобразятся две таблицы маркеров: слева – для исходного снимка, а справа – для выбранного.
::б) Чтобы перед сопоставлением сравнить маркеры, выберите маркеры – по одному в каждой таблице – и нажмите кнопку '''Сравнить''' (расположена над таблицей).
::Отобразится окно сравнения выбранных маркеров.
::Если требуется, повторите операцию для других пар маркеров.
::в) Выберите маркеры для сопоставления – по одному в каждой таблице – и нажмите кнопку '''Сопоставить''' (расположена над таблицей). Если требуется, повторите операцию для других пар маркеров.
::Для сопоставленных маркеров справа от названия будет отображаться номер сопоставленной пары.
::г) Для отмены сопоставления пары маркеров выберите любой сопоставленный маркер и нажмите '''Отменить сопоставление''' (расположена над таблицей). Если требуется, повторите операцию для других пар маркеров.
::д) Для просмотра фрагмента кода, в котором находится маркер – нажмите кнопку [[File:icon_preview_code.png|x25px]].
::е) Для отказа от дальнейшего сопоставления и отмены всех изменений нажмите кнопку '''Отмена'''.
::ж) Для перехода к подтверждению выбора нажмите кнопку '''Далее'''.

:[[File:122 Выбор снимка и сопоставление пар маркеров.png|800px|thumb|none|Окно '''Сопоставить маркеры'''. Выбор снимка и сопоставление пар маркеров]]
:[[File:48 Различия исходного кода.png|800px|thumb|none|Окно '''Сравнение маркеров''']]

:4. Этап 2. В открывшейся форме:
::а) Проверьте список сопоставленных пар маркеров для применения операций сопоставления.
::б) Для корректировки списка сопоставленных пар маркеров нажмите кнопку '''Назад''' и выполните операции [[Help:UI manual#MarksStep1|Этапа 1]].
::в) Для отказа от дальнейшего сопоставления и отмены всех изменений нажмите кнопку '''Отмена'''.
::г) Для запуска операции сопоставления нажмите кнопку '''Подтвердить'''.

:[[File:123 Подтверждение сопоставления.png|800px|thumb|none|Окно «Сопоставить маркеры». Подтверждение сопоставления]]

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

:[[File:124 Сообщение об окончании сопоставления отмены.png|800px|thumb|none|Сообщение об окончании операции сопоставления]]
:{{Note|type=info|text=''При сопоставлении метки маркеров удаляются.''}}

==== Отмена операций сопоставления ====
Отмена операций ручного сопоставления маркеров проводится в два этапа:
:а) Выбор операций ручного сопоставления для отмены (отката).
:б) Просмотр списка всех операций, которые будут отменены, и подтверждение отмены операций сопоставления.

Чтобы отменить (откатить) операции сопоставления:
:1. [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|Выберите исходный контекст]].
:2. [[Help:UI manual#Работа в режиме разметки|В режиме разметки]] нажмите кнопку [[File:Button Сравнить с.png|x25px]] и в раскрывшемся списке выберите пункт '''Сопоставить маркеры'''.
:Откроется окно '''Сопоставить маркеры'''.
:3. Этап 1. На вкладке '''Отмена операций сопоставления''':
::а) Выберите операции сопоставления маркеров, которые нужно отменить.
::В списке отображаются операции ручного сопоставления маркеров в исходной ветке проекта.
::б) Для отказа от продолжения операции нажмите кнопку '''Отмена'''.
::в) Для перехода к подтверждению выбора нажмите кнопку '''Далее'''.

:[[File:125 Выбор маркеров для отмены сопоставления.png|800px|thumb|none|Окно «Сопоставить маркеры». Выбор операций сопоставления маркеров для отмены]]

:4. Этап 2. В открывшейся форме:
::а) Проверьте список операций сопоставления, которые будут отменены. Список операций, помимо выбранных пользователем операций сопоставления, может дополнительно включать другие связанные операции, которые также будут отменены.
::б) Для корректировки выбранных операций сопоставления маркеров нажмите кнопку '''Назад''' и измените выбор маркеров.
::в) Для отказа от продолжения операции нажмите кнопку '''Отмена'''.
::г) Для запуска операции отмены сопоставления маркеров нажмите кнопку '''Подтвердить'''.

:[[File:126 Подтверждение отмены сопоставления.png|800px|thumb|none|Окно «Сопоставить маркеры». Подтверждение отмены операций сопоставления]]

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

:[[File:124 Сообщение об окончании сопоставления отмены.png|800px|thumb|none|Сообщение об окончании операции отмены сопоставления]]
:{{Note|type=info|text=''При отмене операции сопоставления метки маркеров удаляются.''}}

=== Сравнение маркеров ===
Чтобы сравнить два маркера:
:1. [[Help:UI manual#Работа в режиме разметки|В режиме разметки]] [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выберите исходный контекст]].
:2. Раскройте [[Help:UI manual#Таблица маркеров|таблицу маркеров]].
:3. Нажмите правой кнопкой мыши на строке маркера и выберите пункт '''Сравнить с ...'''
:[[File:155 Переход к сравнению маркеров.png|thumb|none|upright=2|Переход к сравнению маркеров]]
:Откроется окно выбора маркера для сравнения.
:[[File:46 Выбор маркера для сравнения.png|thumb|none|upright=3|Окно выбора маркера для сравнения]]
:{{Note|type=info|text=''При сравнении снимков для режимов '''Сопоставленные''' и '''Одинаковые''' в таблице маркеров по клику правой кнопкой мыши на строке маркера доступен пункт '''Сравнение с другой версией'''. При выборе данной команды происходит сравнение маркера с его версией из сравниваемого снимка.''}}
:4. Выберите проект, ветку и снимок.
:Отобразится список маркеров в выбранном снимке, где можно ввести запрос для поиска маркеров.
:[[File:47 Результат сравнения маркеров.png|thumb|none|upright=3|Выбор маркера для сравнения]]
:5. Дважды кликните на строке маркера или нажмите кнопку '''Сравнить''', чтобы перейти в окно сравнения маркеров.
:[[File:48 Различия исходного кода.png|thumb|none|upright=3|Окно сравнения маркеров]]

=== Разметка маркера ===
Разметка маркера заключается в установке статуса, а также, опционально, серьезности (критичности) и требуемого действия.
Установка серьезности и действия доступны только после установки статуса.
Разметить маркер можно [[Help:UI manual#Работа в режиме разметки|в режиме разметки]].
==== Разметка маркера вручную ====
Вручную маркер можно разметить тремя способами:
:1. '''''Способ 1'''''. С помощью кнопок в верхней части [[Help:UI manual#Функции правой панели|правой панели]].
:2. '''''Способ 2'''''. С помощью кнопок в виджете маркера [[Help:UI manual#Вкладка с исходным кодом|на вкладке с исходным кодом]].
:Если [[Help:UI manual#Работа с проектами|для проекта]] установлен флаг '''Обязательный комментарий при разметке''', то при разметке с помощью способов [[Help:UI manual#Marking1|1]] и [[Help:UI manual#Marking2|2]] откроется [[Help:UI manual#Marking3|окно разметки]], в котором обязательно нужно ввести комментарий.
<gallery mode="packed" heights="180px" style="float:left; clear:right; margin-right:1em; margin-left:0">
49 Разметка Статус.png|Выбор статуса разметки маркера
50 Разметка Серьезность.png|Выбор серьезности разметки маркера
51 Разметка Действие.png|Выбор действия разметки маркера
127 Кнопки разметки в виджете маркера.png|Кнопки разметки в виджете маркера на вкладке с исходным кодом
</gallery>
 
:3. '''''Способ 3'''''. В отдельном окне разметки вручную. Для этого:
::а) Нажмите кнопку [[File:Icon edit.png|x25px]] в верхней части правой панели или в виджете маркера на вкладке с исходным кодом.
::Откроется окно '''Разметка'''.
::<gallery heights="200" perrow="2" mode="packed" style="float:left; clear:right;">
235 Окно Разметка.png|Окно «Разметка»
File:99 Окно разметки.png|Окно разметки. Поле '''Комментарий''' – обязательное
</gallery>
::б) Выберите статус, а также, опционально, серьезность (критичность) и требуемое действие.
::в) Введите комментарий.
::Если [[Help:UI manual#Работа с проектами|для проекта]] установлен флаг '''Обязательный комментарий при разметке''', то добавление комментария обязательно.
::Редактор комментариев поддерживает синтаксис Markdown.
::Для упоминания пользователя, вставьте '''@''' и введите или выберите его логин. После добавления комментария по нажатии кнопки '''Применить''' указанному пользователю придет [[Help:UI manual#Просмотр уведомлений в интерфейсе Системы|уведомление в интерфейсе системы]] об упоминании с возможностью перехода к маркеру с этим комментарием.
::г) Нажмите кнопку '''Применить'''.

Результаты разметки со связанными комментариями отображаются [[Help:UI manual#Функции правой панели|в правой панели]] на вкладке '''Комментарии'''. При этом можно поменять текст комментария, но не результат разметки. Для её изменения нужно заново установить статус, серьезность и действие.
:[[File:100 Правая панель Комментарии с разметкой.png|300px|thumb|none|Правая панель. Комментарии, добавленные при разметке]]

==== Разметка маркера с помощью ассистента AI ====
{{Note|type=warn|text=''Функциональность доступна пользователям с [[#Проектные доступы|проектными доступами]] '''Разметка маркеров''' и '''Импорт разметки'''. Ассистент AI должен быть [[Help:XSvacer:AIAssistant|включен и настроен]].''}}
Чтобы разметить маркер с помощью ассистента AI:
:1. Нажмите кнопку [[File:Icon edit.png|x25px]] в верхней части правой панели или в виджете маркера на вкладке с исходным кодом.
Откроется окно '''Разметка'''.
:2. Смените режим разметки с помощью переключателя '''Режим разметки с помощью AI'''.
:3. В отобразившемся режиме разметки выберите '''Модель AI''', с помощью которой ассистент AI рассчитает статус разметки.
:Спрогнозированный статус и уровень доверия прогнозу отобразятся в этом же окне. Если модель AI не смогла предсказать статус разметки, то отобразится значение '''n/a''' и кнопка '''Применить''' будет неактивна.
:Если маркер уже размечен и его статус совпадает с прогнозным, то в окне отобразится сообщение об этом и дальнейшая разметка станет недоступна.
:[[File:236 Окно Разметка AI.png|400px|thumb|none|Окно «Разметка». Режим разметки с помощью ассистента AI]]
:4. Введите комментарий.
:5. Нажмите кнопку '''Применить'''.
Результаты разметки со связанными комментариями отображаются [[Help:UI manual#Функции правой панели|в правой панели]] на вкладке '''Комментарии'''. При этом можно поменять текст комментария, но не результат разметки. Для её изменения нужно заново установить статус, серьезность и действие.
Комментарий, добавленный при разметке с помощью ассистента AI, дополнительно содержит информацию о проведенной разметке: время, имя модели машинного обучения, уровень доверия прогнозу. Также для такого маркера в правой панели на вкладке '''Подробности''' присвоена метка '''AI'''.
<gallery heights="210" perrow="2" mode="packed" style="float:left; clear:right;>
237 Разметка комментарий AI.png|Правая панель.Комментарий, добавленный при разметке с помощью ассистента AI
238 Разметка метка AI.png|Правая панель.Метка AI на вкладке «Подробности»
</gallery>
 

=== Групповая разметка маркеров ===
==== Групповая разметка маркеров вручную ====
Для групповой разметки маркеров вручную:
:1. [[Help:UI manual#Работа в режиме разметки|В режиме разметки]] [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выберите исходные проект, ветку и снимок]].
:2. Включите отображение [[Help:UI manual#Таблица маркеров|таблицы маркеров]].
:3. Выберите маркеры для разметки – установите флажки в строках таблицы.
:4. Нажмите кнопку [[File:icon edit.png|x25px]] (доступна, если выбраны маркеры в таблице).
:[[File:53 Выбор маркеров для группразметки.png|thumb|none|upright=2.5|Выбор маркеров для групповой разметки]]
:Отобразится окно для групповой разметки.
:[[File:54 Окно групповой разметки.png|thumb|none|upright=2.5|Окно групповой разметки]]
:5. Выберите статус разметки, а затем (опционально) статус серьезности (критичности) и требуемое действие – нажмите кнопки со значениями.
:6. Добавьте общий комментарий для выбранных маркеров. 
:Редактор комментариев поддерживает синтаксис Markdown.
:Для упоминания пользователя, вставьте '''@''' и введите или выберите его логин. После добавления комментария по нажатии кнопки '''Применить''' указанному пользователю придет [[Help:UI manual#Просмотр уведомлений в интерфейсе Системы|уведомление в интерфейсе системы]] об упоминании с возможностью перехода к этому комментарию.
:После того, как пользователь или ассистент AI присвоил статусы и (или) написал комментарий, станет доступной кнопка '''Применить'''. 
:{{Note|type=info|text=''Ввод комментария обязателен, если [[Help:UI manual#Работа с проектами|для проекта]] установлен флаг '''Обязательный комментарий при разметке'''''.}}
:7. Если требуется отменить изменения, нажмите [[File:icon cross 01.png|x15px]] в правом верхнем углу окна или кнопку '''Отмена'''. Диалоговое окно закроется, изменения не будут применены, выделение с выбранных для разметки маркеров не снимается.
:8. Нажмите кнопку '''Применить''', чтобы запустить процесс разметки. 
Прогресс разметки отображается в соответствующем окне. Запущенный процесс можно полностью отменить нажатием кнопки '''Отмена'''. 
В результате применения разметки текст маркеров [[Help:UI manual#Таблица маркеров|в таблице маркеров]] окрасится в цвет, соответствующий выставленному статусу.

<gallery widths="400" mode="nolines" style="float:center; clear:center; margin-right:1em; margin-left:0">
56 Окно прогресса разметки.png|Окно прогресса разметки
57 Результат групповой разметки.png|Пример таблицы маркеров после применения групповой разметки
</gallery>
 

==== Групповая разметка маркеров с помощью ассистента AI ====
{{Note|type=warn|text=''Функциональность доступна пользователям с [[#Проектные доступы|проектными доступами]] '''Разметка маркеров''' и '''Импорт разметки'''''}}
Чтобы разметить группу маркеров с помощью ассистента AI:
:1. [[Help:UI manual#Работа в режиме разметки|В режиме разметки]] [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выберите исходные проект, ветку и снимок]].
:2. Включите отображение [[Help:UI manual#Таблица маркеров|таблицы маркеров]].
:3. [[Help:UI manual#GroupMark1|Выберите маркеры для разметки]] – установите флажки в строках таблицы.
:4. Нажмите кнопку [[File:icon edit.png|x25px]] (доступна, если выбраны маркеры в таблице).
:[[File:53 Выбор маркеров для группразметки.png|thumb|none|upright=2.5|Выбор маркеров для групповой разметки]]
:Отобразится [[Help:UI manual#GroupMark2|окно для групповой разметки]].
:5. Смените режим разметки с помощью переключателя '''Режим разметки с помощью AI'''.
:6. В отобразившемся режиме разметки выберите '''Модель AI''', с помощью которой ассистент AI рассчитает статус разметки.
:Спрогнозированный статус и уровень доверия прогнозу отобразятся в этом же окне в строке каждого выбранного маркера. Если модель AI не смогла предсказать статус разметки, то отобразится значение '''n/a''' и установка флажка столбце '''Статус разметки''' будет недоступна.
:7. Выберите маркеры для разметки – установите флажки в столбце '''Статус разметки'''.
:Если маркер уже размечен и его статус совпадает с прогнозным, то установка флажка в его строке недоступна.
:[[File:239 Групповая разметка AI.png|thumb|none|upright=2.5|Окно групповой разметки. Режим разметки с помощью ассистента AI]]
:8. Добавьте общий комментарий для выбранных маркеров. 
:Редактор комментариев поддерживает синтаксис Markdown.
:Для упоминания пользователя, вставьте '''@''' и введите или выберите его логин. После добавления комментария по нажатии кнопки '''Применить''' указанному пользователю придет [[Help:UI manual#Просмотр уведомлений в интерфейсе Системы|уведомление в интерфейсе системы]] об упоминании с возможностью перехода к этому комментарию.
:После того, как пользователь или ассистент AI присвоил статусы и (или) написал комментарий, станет доступной кнопка '''Применить'''. 
:{{Note|type=info|text=''Ввод комментария обязателен, если [[Help:UI manual#Работа с проектами|для проекта]] установлен флаг '''Обязательный комментарий при разметке'''''.}}
:9. Если требуется отменить изменения, нажмите [[File:icon cross 01.png|x15px]] в правом верхнем углу окна или кнопку '''Отмена'''. Диалоговое окно закроется, изменения не будут применены, выделение с выбранных для разметки маркеров не снимается.
:10. Нажмите кнопку '''Применить''', чтобы запустить процесс разметки. 
Прогресс разметки отображается в [[Help:UI manual#GroupMark3|соответствующем окне]]. Запущенный процесс можно полностью отменить нажатием кнопки '''Отмена'''. 
В результате применения разметки текст маркеров [[Help:UI manual#Таблица маркеров|в таблице маркеров]] окрасится в цвет, соответствующий выставленному статусу.

=== Блокировка разметки маркеров===
Пользователь может заблокировать другим пользователям возможность [[Help:UI manual#Разметка маркера|размечать маркер]] или [[Help:UI manual#Групповая разметка маркеров|группу маркеров]]. Это позволяет избежать коллизий при разметке маркеров несколькими пользователями.

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

<gallery mode="packed" heights="200px" perrow="2" style="float:left; clear:right; margin-right:1em; margin-left:1em">
58 Блокировка на вкладке Детекторы.png|Блокировка маркера на вкладке '''Детекторы'''
File:59_Блокировка_на_вкладке_Файлы.png|Блокировка маркера на вкладке '''Файлы'''
60_Блокировка_на_правой_панели.png|Блокировка маркера на правой панели
</gallery>
 

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

Чтобы посмотреть все блокировки, перейдите в раздел [[Help:UI manual#Настройка сервера Svacer|'''Настройки''']] на [[Help:UI manual#Управление блокировками разметки|вкладку '''Блокировки''']]:

[[File:61 Просмотр всех блокировок.png|thumb|none|upright=3.5|Таблица блокировок]]

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

=== Добавление комментария к нескольким маркерам ===
Для добавления комментария к нескольким маркерам одновременно:
:1. В режиме разметки [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выберите исходный контекст]] – проект, ветку, снимок.
:2. Включите отображение [[Help:UI manual#Таблица Маркеров|таблицы маркеров]].
:3. Выберите маркеры для разметки – установите флажки в строках таблицы.
:4. Нажмите кнопку [[File:Button Comment Add.png|x25px]] (доступна, если выбраны маркеры в таблице).

:[[File:128 Добавление общего комментария 1.png|400px|thumb|none|Выбор маркеров для добавления комментария к нескольким маркерам одновременно]]
:5. Отобразится окно для добавления комментария к нескольким маркерам одновременно.

:[[File:129 Добавление общего комментария 2.png|600px|thumb|none|Окно добавления комментария к нескольким маркерам одновременно]]
:6. Введите комментарий.
:Редактор комментариев поддерживает синтаксис Markdown.
:Для упоминания пользователя, вставьте '''@''' и введите или выберите его логин. После добавления комментария по нажатии кнопки '''Применить''' указанному пользователю придет [[Help:UI manual#Просмотр уведомлений в интерфейсе Системы|уведомление в интерфейсе системы]] об упоминании с возможностью перехода к маркеру с этим комментарием.
:8. Нажмите кнопку '''Сохранить'''.

=== Экспорт ===
В режиме разметки можно выполнить экспорт:
* [[Help:UI manual#Экспорт исходного кода с разметкой|исходного кода с разметкой]];
* [[Help:UI manual#Экспорт снимка в формате snap|снимка в формате snap]];
* [[Help:UI manual#Экспорт разметки и снимка в SARIF|снимка в формате SARIF]];
* [[Help:UI manual#Экспорт разметки|разметки в файл]].
{{Note|type=warn|text=''Функциональность доступна пользователям с [[#Проектные доступы|проектным доступом]] '''Экспорт снимков'''''}}

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

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

::При экспорте можно исключить файлы, соответствующие [[Help:UI manual#Использование регулярных выражений|регулярным выражениям]] в поле '''Исключить пути'''.
:4. Нажмите кнопку '''Экспортировать'''.
В итоге создастся архив файлов с исходным кодом и, если был выбран шаблон разметки, то в исходный код будет добавлена актуальная разметка, в соответствии с выбранным шаблоном.

==== Экспорт снимка в формате snap ====
Чтобы экспортировать с сервера исходный код снимка в формате .snap:
:1. [[Help:UI manual#Работа в режиме разметки|В режиме разметки]] [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выберите исходный контекст]] – проект, ветку и снимок.
:2. На вкладке '''Информация о снимке''' нажмите кнопку '''Экспорт''' и выберите пункт '''Снимок (*.snap)'''.
:[[File:192 Разметка. Переход к экспорту снимка в формате snap.png|600px|thumb|none|Переход к экспорту снимка в формате snap]]
:Запустится формирование файла. При старте и по окончании экспорта пользователю отобразится соответствующее всплывающее сообщение.
:[[File:193 Сообщение. Экспорт снимка.png|thumb|600px|thumb|none|Пример всплывающих сообщений при старте и окончании экспорта снимка]]

==== Экспорт разметки и снимка в SARIF ====
Чтобы экспортировать разметку и при необходимости исходный код снимка в файл формата SARIF:
:1. [[Help:UI manual#Работа в режиме разметки|В режиме разметки]] [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выберите исходный контекст]] – проект, ветку и снимок.
:2. На вкладке '''Информация о снимке''' нажмите кнопку '''Экспорт''' и выберите пункт '''SARIF'''.
:[[File:194 Разметка. Переход к экспорту снимка SARIF.png|thumb|600px|thumb|none|Переход к экспорту снимка SARIF]]
:3. В открывшемся окне:
::а) Выключите (опционально) формирование название файла по умолчанию – снимите соответствующий флажок и введите название снимка.
::б) Опционально включите или выключите экспорт исходных файлов.
::в) Нажмите кнопку '''Экспортировать'''.
:[[File:195 Окно экспорта SARIF.png|thumb|600px|thumb|none|Окно экспорта снимка SARIF]]
:Запустится формирование файла. При старте и по окончании экспорта пользователю отобразится всплывающее сообщение.
:[[File:220 Сообщение. Экспорт SARIF.png|thumb|400px|thumb|none|Пример всплывающих сообщений при старте и окончании экспорта снимка в SARIF]]

==== Экспорт разметки ====
Чтобы из ветки проекта экспортировать в файл разметку и/или комментарии:
:1. [[Help:UI manual#Работа в режиме разметки|В режиме разметки]] [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выберите исходный контекст]] – проект, ветку и снимок.
:2. На вкладке '''Информация о снимке''' нажмите кнопку '''Экспорт''' и выберите пункт '''Разметка'''.
:[[File:196 Разметка. Переход к экспорту разметки.png|thumb|thumb|thumb|600px|none|Переход к экспорту разметки]]
:3. В открывшемся окне:
::а) Выберите вариант экспорта.
::б) Если требуется экспортировать неразмеченные маркеры, установите флажок '''Включая разметку со статусом "Undecided"'''.
::в) Нажмите кнопку '''Экспортировать'''.
:[[File:197 Окно экспорта разметки.png|thumb|thumb|thumb|600px|none|Окно экспорта разметки]]

=== Импорт разметки ===
В режиме разметки можно импортировать разметку из двух источников:
* [[Help:UI manual#Импорт разметки из файла|из файла]];
* [[Help:UI manual#Импорт разметки из исходного кода|из исходного кода снимка]].
{{Note|type=warn|text=''Функциональность доступна пользователям с [[#Проектные доступы|проектным доступом]] '''Импорт разметки'''''}}

==== Импорт разметки из файла ====
Чтобы импортировать файл с разметкой:
:1. [[Help:UI manual#Работа в режиме разметки|В режиме разметки]] [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выберите исходный контекст]] – проект, ветку и снимок.
:2. На вкладке '''Информация о снимке''' нажмите кнопку '''Импорт''' и выберите пункт '''Разметка из файла'''.
:[[File:198 Разметка. Переход к импорту разметки из файла.png|thumb|thumb|thumb|600px|none|Переход к импорту файла с разметкой]]
:3. В открывшемся окне:
::а) Выберите файл архива в формате .gz.
::б) Выберите варианты импорта и действия при наличии конфликта разметки.
::в) Нажмите кнопку '''Импортировать'''.
:[[File:199 Окно импорта файла с разметкой.png|thumb|600px|thumb|none|Окно импорта файла с разметкой]]
:По окончании пользователю отобразится всплывающее сообщение с информацией о выполненной операции.
:[[File:200 Сообщение. Импорт разметки из файла.png|thumb|thumb|thumb|600px|none|Пример всплывающего сообщения об окончании импорта разметки из файла]]

==== Импорт разметки из исходного кода ====
Чтобы импортировать разметку из исходного кода снимка в ветку проекта:
:1. [[Help:UI manual#Работа в режиме разметки|В режиме разметки]] [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выберите исходный контекст]] – проект, ветку и снимок.
:2. На вкладке '''Информация о снимке''' нажмите кнопку '''Импорт''' и выберите пункт '''Разметка из исходного кода'''.
:[[File:201 Разметка. Переход к импорту разметки из кода.png|thumb|thumb|thumb|thumb|600px|none|Переход к импорту исходного кода с разметкой]]
:3. В открывшемся окне выберите шаблон разметки и нажмите кнопку '''Импортировать'''.
:[[File:134_Импорт_разметки.png|thumb|thumb|thumb|600px|none|Окно импорта исходного кода с разметкой]]
:По окончании пользователю отобразится всплывающее сообщение с информацией о выполненной операции.
:[[File:203 Сообщение. Импорт разметки из кода.png|thumb|thumb|thumb|thumb|600px|none|Пример всплывающего сообщения об окончании импорта разметки из исходного кода снимка]]

=== Работа с таблицей статистики ===
Чтобы посмотреть краткую статистику о разметке маркеров:
:1. [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|Выберите исходный контекст]].
:2. Перейдите [[Help:UI manual#Работа в режиме разметки|в режим разметки]].
:3. На вкладке '''Информация о снимке''' в строке свойства '''Статистика по детекторам''' нажмите кнопку '''Показать'''.

:[[File:64 Переход к просмотру статистики.png|600px|thumb|none|Переход к просмотру статистики]]

:Отобразится таблица статистики:
:[[File:65 Таблица статистики.png|600px|thumb|none|Таблица статистики]]
:4. Нажмите кнопку [[File:Icon download CSV.png|x20px]] или [[File:Icon download PDF.png|x20px]], чтобы выгрузить статистику в соответствующем формате.
:5. Нажмите кнопку [[File:Icon filter.png|x20px]] в строке статистики, чтобы применить [[Help:UI manual#Настройка и использование пользовательских фильтров|пользовательский фильтр]] с параметрами, которые соответствуют выбранному значению.

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

Для этого:
:1. Перейдите в режим просмотра кода по кнопке меню [[File:Button Код.png|x25px]] в верхней части экрана.
:2. [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|Выберите исходный контекст]]. 
:{{Note|type=info|text=''По умолчанию выбран контекст (проект, ветка), заданный ранее в режиме [[Help:UI manual#Работа в режиме разметки|'''Разметка''']]. Если Пользователь перешел в раздел '''Кoд''' из режима сравнения снимков раздела [[Help:UI manual#Работа в режиме разметки|'''Разметка''']], то для изменения контекста требуется отменить режим сравнения.''}}
:В левой части экрана отобразится иерархический список файлов снимка, а в правой – поле для отображения исходного кода файла.
:[[File:67 Режим просмотра кода.png|600px|thumb|none|Режим просмотра кода. Начальное состояние]]
:3. Для поиска файла:
::а) Кликните на поле поиска или нажмите комбинацию клавиш '''Ctrl+Shift+O'''.
::б) В открывшемся окне введите поисковый запрос и выберите файл.
:4. В левой части экрана раскройте группу файлов и нажмите на имя файла.
:В правой части отобразится исходный код файла.
:[[File:68 Режим просмотра кода открыт один файл.png|600px|thumb|none|Пример одного открытого файла]]
:5. Если требуется, откройте другие файлы.
:Они отобразятся на отдельных вкладках, если выключена [[Help:UI manual#Настройка профиля пользователя|настройка '''Переиспользование вкладки в редакторе кода''']].
:[[File:69 Режим просмотра кода открыто три файла.png|600px|thumb|none|Пример трёх открытых файлов]]
:6. Для перехода к предыдущей или следующей строке, в которую пользователь устанавливал курсор, используйте кнопки [[File:Button left.png|x25px]] и [[File:Button right.png|x25px]] или сочетания клавиш '''Ctrl+< и Ctrl+>'''.
:7. Вызовите функции, доступные по нажатии правой кнопки мыши на строке исходного кода
:* '''Перейти к объявлению''' – для перехода к строке, в которой объявлена переменная;
:* '''Перейти к определению''' – для перехода к строке, в которой определена переменная и функция;
:* '''Найти ссылки''' – для просмотра ссылок в панели с иерархическим списком файлов, именами файлов и номерами строк, в которых найдены ссылки;
::{{Note|type=info|text=''Если для выделенного элемента кода нет объявления, определения или ссылок, то отобразится сообщение: [[File:150 Объявление не найдено.png|x25px]], [[File:151 Определение не найдено.png|x25px]] или [[File:152 Ссылки не найдены.png|x25px]].''}}
::[[File:24 Исходный код Cписок файлов со ссылками.png|thumb|none|600px|Cписок файлов с номерами строк, в которых найдены ссылки]]
:* '''Копировать прямую ссылку''' – копирование ссылки на строку кода в буфер обмена.
::При переходе по этой ссылке будет открываться файл в режиме просмотра кода с курсором на той строке кода, для которой была скопирована ссылка;
:* '''Уменьшить''' и '''Увеличить''' – увеличение и уменьшение размера шрифта кода (эти функции также можно вызвать с помощью сочетаний клавиш '''Ctrl+Alt+-''' или '''Ctrl+Alt+=''').
:* '''Copy''' – для копирования строки в буфер обмена;
:* '''Command Palette''' – для вызова командной строки.
:6. Установите курсор в строке кода, чтобы отобразилось его позиционирование в правом нижнем углу.
:[[File:130 Позиционирование к коде.png|600px|thumb|none|Отображение позиционирования курсора в коде]]
:7. Сравните файлы – для этого:
::а) Нажмите правой кнопки мыши на имени файла и выберите пункт '''Сравнить с…'''
::[[File:156 Переход к сравнению файлов.png|thumb|none|600px|Переход к сравнению файлов]]
::б) В открывшемся окне выберите файл для сравнения. Для этого выберите проект, ветку и снимок, а затем раскройте группы файлов или воспользуйтесь поисковой строкой, нажмите на имя файла.
::По умолчанию выбраны проект и ветка исходного контекста.
::в) Нажмите кнопку '''Сравнить'''.
:Откроется окно сравнения файлов.

:[[File:Code compare 2.png|600px|thumb|none|Окно выбора файла для сравнения]]

:[[File:Code_compare_3.png|600px|thumb|none|Окно сравнения файлов]]

==Управление проектами и группами проектов==
В разделе '''Проекты''' отображаются все проекты со всеми ветками и снимками.
Для удобства работы проекты могут быть [[Help:UI manual#Работа с группами проектов|сгруппированы]]. Один проект может быть включен в несколько групп проектов.
[[File:101 Раздел Проекты.png|thumb|none|upright=3|Раздел '''Проекты''']]

===Работа с проектами===
Список проектов отображается в левой части экрана и организован в виде иерархии. При этом:
* для проектов, разметку маркеров которых нужно в обязательном порядке снабжать комментариями, отображается иконка [[File:Icon comment.png|x25px]];
* в нижней части списка отображается общее количество проектов и веток с учетом примененных фильтров, а также выбранных проектов и веток.
В списке доступны:
* поиск по имени проекта;
* фильтрация списка по группам проектов;
* сортировка по названию или дате создания (по умолчанию – по названию).
При работе с проектами пользователю доступны следующие функции:
:1. Загрузка актуальных данных с сервера – для этого нажмите кнопку [[File:Icon refresh.png|x25px]].
:2. Просмотр списка веток – для этого нажмите на название проекта.
:Ветки отобразятся в этом же списке проекта на втором уровне.
:3. Просмотр списка снимков – для этого нажмите на название ветки.
:Список снимков отобразится в виде таблицы в правой части экрана.
:4. [[Help:UI manual#Работа с группами проектов|Группировка проектов]].
:5. Создание проекта:
::а) Нажмите кнопку '''Создать проект'''.
::Откроется окно создания проекта.
::[[File:102 Создание проекта.png|thumb|none|upright=1.5|Окно создания проекта]]
::б) Введите название проекта.
::в) Для выбора одной или нескольких существующих групп кликните на поле '''Группы''' и выберите одно или несколько значений в списке:
::[[File:157 Окно создания проекта. Выбор существующей группы.png|thumb|none|upright=1.5|Окно создания проекта. Пример выбора существующей группы]]
::г) Для создания одной новой группы введите ее название и нажмите кнопку '''Создать''' в появившейся форме:
::[[File:158 Окно создания проекта.Создание одной группы.png|thumb|none|upright=1.5|Окно создания проекта. Пример создания одной группы]]
::д) Для создания нескольких новых групп введите их названия через запятую и нажмите кнопку '''Создать''' в появившейся форме:
::[[File:159 Окно создания проекта. Создание нескольких групп.png|thumb|none|upright=1.5|Окно создания проекта. Пример создания двух групп]]
::е) Установите флажок, если требуется при разметке маркеров обязательно добавлять комментарий.
::ж) Нажмите кнопку '''Создать'''.
:При создании проекта автоматически создается ветка '''master'''.
:При импорте снимка в интерфейсе командной строки проект, при его отсутствии, добавляется автоматически.
:6. Добавление ветки: [[File:103 Создание ветки.png|thumb|right|none|upright=1.5|Окно добавления ветки в проект]]
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке проекта.
::б) В меню выберите пункт '''Создать ветку'''.
::в) В открывшемся окне введите название ветки и нажмите кнопку '''Создать'''.
:При импорте снимка в интерфейсе командной строки ветка, при ее отсутствии, добавляется автоматически.

:7. Клонирование проекта со всеми ветками и снимками: [[File:132 Окно клонирования проекта.png|thumb|right|none|upright=1.5|Окно клонирования проекта]]
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке проекта.
::б) В меню выберите пункт '''Клонировать'''.
::в) В открывшемся окне введите название нового проекта, при необходимости скорректируйте группы, в которые будет входить клонированный проект (по умолчанию, группы исходного проекта) и нажмите кнопку '''Клонировать'''.

:9. Редактирование параметров проекта:
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке проекта.
::б) В меню выберите пункт '''Редактировать'''.
::в) В открывшемся окне измените название проекта, скорректируйте список групп, в которые включен проект, и установите или снимите флажок обязательности комментария при разметке и нажмите кнопку '''Сохранить'''.
:10. Удаление одного проекта:
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке проекта.
::б) В меню выберите пункт '''Удалить'''.
::в) Подтвердите удаление.
:11. Удаление нескольких проектов с ветками:
::а) Выберите проекты для удаления – установите флажки в левой части названий проектов и веток или нажмите кнопку '''Выбрать всё'''.
::б) Нажмите кнопку '''Удалить''' в верхней части списка проектов и подтвердите удаление.
При удалении проекта удаляются все его ветки и снимки, разрывается связь проекта с группами.

===Работа с группами проектов===
Работа с группами проектов доступна на отдельной панели '''Группы проектов''', которая отрывается по нажатии кнопки [[File:Icon gear.png|x25px]] в списке проектов. При этом в нижней части списка отображается общее количество групп.

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

[[File:104 Панель групп.png|thumb|none|upright=3|Панель '''Группы проектов''']]
При работе с группами проектов пользователю доступны следующие функции:
:1. Просмотр списка связанных с группой проектов – для этого нажмите на название группы.
:Проекты отобразятся в этом же списке групп на втором уровне.
 
:2. Добавление группы: [[File:105 Создание группы.png|thumb|right|none|upright=1.5|Окно '''Создать группу''']]
::а) Нажмите кнопку '''Создать группу'''.
::б) В открывшемся окне введите название группы и выберите проекты, которые в неё войдут, нажмите кнопку '''Создать'''.
:Созданная группа отобразится в списке на панели '''Группы проектов'''.
 
:3. Редактирование параметров группы: [[File:106 Редактирование группы.png|thumb|right|none|upright=1.5|Окно Редактировать группу]]
::а) Нажмите кнопку [[File:Icon edit2.png|x25px]] в строке группы.
::б) В открывшемся окне измените название группы, скорректируйте состав включенных в группу проектов.
::в) Нажмите на кнопку [[File:Icon cancel.png|x25px]] справа от названия проекта в списке, чтобы исключить его из группы.
::г) Нажмите кнопку '''Сохранить'''.
 
:4. Исключение одного проекта из группы – для этого нажмите кнопку [[File:Icon hide marks.png|x25px]] в правой части списка проектов группы.
:5. Удаление одной группы – для этого нажмите кнопку [[File:Icon delete.png|x25px]] в правой части списка групп и подтвердите удаление.
:6. Удаление нескольких групп:
::а) Выберите группы для удаления – установите флажки в левой части названий групп или нажмите кнопку '''Выбрать всё'''.
::б) Нажмите кнопку '''Удалить''' в верхней части списка групп проектов и подтвердите удаление.
:При удалении группы разрывается связь проекта с группой. Сами проекты не удаляются.

===Работа с ветками===
При работе с ветками проекта пользователю доступны следующие функции:
:1. Просмотр списка снимков – для этого нажмите на название ветки в списке проектов.
:Список снимков отобразится в виде таблицы в правой части экрана.
:2. Редактирование ветки: [[File:107 Редактирование ветки.png|thumb|right|upright=1.5|Окно редактирования ветки]]
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке ветки.
::б) В меню выберите пункт '''Редактировать'''.
::в) В открывшемся окне измените название ветки и нажмите кнопку '''Сохранить'''.
 
:3. Клонирование ветки проекта: [[File:108 Клонирование ветки.png|thumb|right|upright=1.5|Окно клонирования ветки]]
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке ветки.
::б) В меню выберите пункт '''Клонировать'''.
::в) В открывшемся окне введите название новой ветки и нажмите кнопку '''Клонировать'''.
 
:4. Экспорт разметки в файл: [[File:197 Окно экспорта разметки.png|thumb|right|upright=1.5|Окно экспорта разметки]]
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке ветки.
::б) В меню выберите пункт '''Экспорт разметки'''.
::Откроется окно экспорта разметки.
::в) Выберите вариант экспорта.
::г) Если требуется экспортировать неразмеченные маркеры, установите флажок '''Включая разметку со статусом "Undecided"'''.
::д) Нажмите кнопку '''Экспортировать'''.
::{{Note|type=warn|text=''Функциональность доступна пользователям с [[#Проектные доступы|проектным доступом]] '''Экспорт снимков'''''}}
 
:5. Импорт разметки из файла: [[File:199 Окно импорта файла с разметкой.png|thumb|right|upright=1.5|Окно импорта разметки]]
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке ветки.
::б) В меню выберите пункт '''Импорт разметки'''.
::Откроется окно импорта разметки.
::в) Выберите файл архива в формате .gz.
::г) Выберите варианты импорта и действия при наличии конфликта разметки.
::д) Нажмите кнопку '''Импортировать'''.
::{{Note|type=warn|text=''Функциональность доступна пользователям с [[#Проектные доступы|проектным доступом]] '''Импорт снимков'''''}}
 
:6. Удаление ветки:
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке ветки.
::б) В меню выберите пункт '''Удалить'''.
::в) Подтвердите удаление.
::При удалении ветки удаляются все ее снимки.
 
:7. Очистка разметки: [[File:160 Окно очистки разметки.png|thumb|right|upright=1.5|Окно очистки разметки]]
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке ветки.
::б) В меню выберите пункт '''Очистить разметку'''.
::в) В открывшемся окне выберите вариант очистки.
::г) Нажмите кнопку '''Очистить'''.
::{{Note|type=warn|text=''Функциональность доступна пользователям с [[#Проектные доступы|проектными доступами]] '''Управление ветками и снимками''', '''Разметка маркеров''' и [[#Cерверные доступы|серверным доступом]] '''Администрирование сервера'''.''}}
 
:8. Копирование разметки в другой контейнер (проект и ветку): [[File:Image.png|thumb|right|upright=1.5|Окно копирования разметки в другой контейнер]]
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке ветки и в меню выберите пункт '''Копировать разметку'''.
::б) В открывшемся окне выберите проект и ветку, в которые нужно скопировать разметку, а также действия, которые нужно выполнить при наличии разметки.
::в) Нажмите кнопку '''Копировать'''.
 
Разметка в контейнере состоит из множества размеченных маркеров. В целевой ветке уже может находиться разметка. Все множество маркеров в исходной ветке можно разбить на два:
* «Уникальные» – маркеры, которые есть только в исходной ветке;
* «Общие» – маркеры, которые есть как в ветке-источнике, так и в ветке-приемнике.
При выполнении операции копирования разметка в уникальных маркерах всегда копируется в ветку-приемник. Для «Общих» маркеров возможны несколько вариантов продолжения копирования, но по умолчанию выбран пункт '''Не копировать''' – в этом случае разметка в «Общих» маркерах в ветке-приемнике не изменяется.

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

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

'''Пример'''
:Есть несколько контейнеров:
:* 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.
:При выполнении копирования наличие маркера в ветке-приемнике не проверяется.
:При успешном копировании выводится всплывающее сообщение с описанием выполненных операций:
:[[File:161 Сообщение об успешном копировании разметки.png|thumb|none|upright=2|Пример всплывающего сообщения об успешном копировании разметки]]

===Работа со снимками===
Список снимков отображается в правой части экрана в виде таблицы после выбора ветки проекта. При этом в нижней части списка отображается общее количество снимков в выбранной ветке и количество выбранных снимков.
В списке доступны:
* поиск по названию снимка;
* сортировка по значениям столбцов (по умолчанию — по дате создания).
При работе со снимками пользователю доступны следующие функции:
:1. Импорт снимка из файла – для этого нажмите кнопку '''Импорт''' в верхней части табличного списка снимков и в открывшемся списке выберите один из вариантов импорта: '''Снимок (*.snap)''', '''Архив .svace-dir''' или '''SARIF'''.
:{{Note|type=warn|text=''Функциональность доступна пользователям с [[#Проектные доступы|проектным доступом]] '''Импорт снимков'''''}}
:После этого:
[[File:110 Импорт снимка.png|thumb|right|upright=1.5|Окно импорта снимка из файла в формате snap]]
::а) Если выбран импорт из файла в формате snap, то в открывшемся окне:
::* выберите файл в формате .snap;
::* введите название снимка (опционально);
::* Задайте [[Edit markers (command line)|правила трансформации, пропуска и дедупликации маркеров]] в поле '''Редактировать маркеры''' – загрузите JSON-файл с правилами или введите их;
::* нажмите кнопку '''Импортировать'''.
::{{Note|type=info|text=''Если при импорте снимка из snap-файла название не введено, то будет использовано название исходного снимка (параметр «name» в JSON с информацией о снимке).''}}
[[File:133 Импорт снимка из архива svace-dir.png|thumb|right|upright=1.5|Окно импорта снимка из архива в формате svace-dir]]
[[File:133.1_Импорт_снимка_из_архива_svace-dir_-_Поля_опций.png|thumb|right|upright=1.5|Окно импорта снимка из архива в формате svace-dir. Поля опций для расширенных настроек]]
 
::б) Если выбран импорт архива .svace-dir, то в открывшемся окне:
::* выберите архив .svace-dir;
::* введите название снимка (опционально);
::* выберите шаблон разметки (опционально);
::* укажите правила префикса пути (опционально);
::* укажите расширенные настройки (опционально): для каждой настройки нажмите кнопку '''Добавить''', в появившихся полях выберите опцию и введите её значение; для удаления настройки нажмите кнопку [[File:Icon delete.png|x25px]].
::После выбора параметра в поле появляется иконка [[File:Icon question mark2.png|x15px]], по наведении курсора на которую можно посмотреть описание;
::* нажмите кнопку '''Импортировать'''.
::При старте операции и по ее окончании пользователю отобразятся соответствующие всплывающие сообщения.
::[[File:210 Сообщение. Импорт svace-dir.png|thumb|none|upright=1.5|Пример всплывающих сообщений при старте и окончании импорта снимка из архива в формате svace-dir]]
 
[[File:217 Импорт снимка SARIF.png|thumb|right|upright=1.5|Окно импорта снимка из файла в формате SARIF]]
[[File:218 Импорт снимка SARIF - поля опций.png|thumb|right|upright=1.5|Окно импорта снимка из архива в формате SARIF. Поля опций для расширенных настроек]]
::в) Если выбран импорт из файла в формате SARIF, то в открывшемся окне:
::* выберите файл в формате .sarif или .json, либо архив в одном из форматов: .tar, tar.bz2, tar.gz, zip;
::* введите название снимка (опционально);
::* укажите правила префикса пути (опционально);
::* укажите расширенные настройки (опционально): для каждой настройки нажмите кнопку '''Добавить''', в появившихся полях выберите опцию и введите её значение; для удаления настройки нажмите кнопку [[File:Icon delete.png|x25px]].
::После выбора параметра в поле появляется иконка [[File:Icon question mark2.png|x15px]], по наведении курсора на которую можно посмотреть описание;
::* нажмите кнопку '''Импортировать'''.
::При старте операции и по ее окончании пользователю отобразятся соответствующие всплывающие сообщения.
::[[File:211 Сообщение. Импорт SARIF.png|thumb|none|upright=1.5|Пример всплывающих сообщений при старте и окончании импорта снимка из архива в формате SARIF]]
:{{Note|type=info|text='''''Примечание:'''''
:* ''для импорта поддерживаются архивы папки .svace-dir, заархивированные с помощью tar, gz, bz2 или zip (*.tar, *.tar.gz, *.tar.bz2, *.zip);''
:* ''если при импорте архива .svace-dir название снимка не введено, то оно будет соответствовать времени импорта результатов анализа из Svace;''
:* ''в поле '''Расширенные настройки''' поддерживается ввод дополнительных опций команды <code>svacer import</code> – как в интерфейсе командной строки (например, <code>--attach value</code>). В аргументах дополнительных опций требуется указывать пути относительно архивированной папки. Описание опций можно найти, запустив команду <code>svacer import --help</code>''.
:* ''для импорта снимка из snap-файла, .svace-dir или SARIF может потребоваться много времени: как на загрузку, так и на обработку данных после загрузки. При работе сервера Svacer за reverse proxy их дефолтных значений таймаутов или ограничений на размер загружаемых данных может быть недостаточно, поэтому рекомендуется увеличить эти значения в конфигурационных файлах reverse proxy, см. [[Help:Configuration#Nginx|пример для Nginx]]''}}
:2. Экспорт снимка – для этого нажмите кнопку [[File:Icon export.png|x25px]]в крайнем правом столбце строки снимка и в открывшемся списке выберите один из вариантов экспорта: '''Экспорт (*.snap)''', '''Экспорт SARIF''' или '''Экспорт кода с разметкой'''.
:После этого:
::а) Если выбран экспорт в файл в формате snap, то по окончании его формирования во всплывающем сообщении нажмите кнопку '''Скачать'''.
::[[File:193 Сообщение. Экспорт снимка.png|thumb|none|upright=1.5|Пример всплывающих сообщений при старте и окончании экспорта снимка]]
:[[File:195 Окно экспорта SARIF.png|thumb|right|upright=1.5|Окно экспорта снимка SARIF]]
::б) Если выбран экспорт файла формата SARIF, то в открывшемся окне:
::* Выключите (опционально) формирование название файла по умолчанию – снимите соответствующий флажок и введите название снимка.
::* Опционально включите или выключите экспорт исходных файлов.
::* Нажмите кнопку '''Экспортировать'''.
::Запустится формирование файла. При старте и по окончании экспорта пользователю отобразится всплывающее сообщение.
::[[File:220 Сообщение. Экспорт SARIF.png|thumb|none|upright=1.5|Пример всплывающих сообщений при старте и окончании экспорта снимка в SARIF]]
:[[File:340 Проекты Окно экспорта кода с разметкой.png||thumb|right|upright=1.5|Окно экспорта кода с разметкой]]
::в) Если выбран экспорт кода с разметкой, то в открывшемся окне:
::* Если требуется экспортировать разметку, установите флажок параметра '''Шаблон разметки''' и выберите шаблон для экспорта в списке справа.
::* Опционально включите или выключите очистку старых комментариев.
::* Опционально заполните поля для удаления префиксов и исключения путей.
::* Опционально введите регулярные выражения для очистки дополнительных строк (доступен, если включена очистка старых комментариев).::
::Пример удаления префиксов путей: <code>/.build/</code>

::При экспорте можно исключить файлы, соответствующие [[Help:UI manual#Использование регулярных выражений|регулярным выражениям]] в поле '''Исключить пути'''.
::* Нажмите кнопку '''Экспортировать'''.
::В итоге создастся архив файлов с исходным кодом и, если был выбран шаблон разметки, то в исходный код будет добавлена актуальная разметка, в соответствии с выбранным шаблоном.
:3. Переход к разметке маркеров снимка:
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в крайнем правом столбце строки снимка.
::б) В меню выберите пункт '''Разметить'''.
[[File:111 Редактирование снимка.png|thumb|right|upright=1.5|Окно редактирования снимка]]
:4. Редактирование названия снимка:
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в крайнем правом столбце строки снимка.
::б) В меню выберите пункт '''Редактировать'''.
::в) Поменяйте название и нажмите кнопку '''Сохранить'''.
[[File:212 Окно Копирование снимков.png|thumb|right|upright=1.5|Окно копирования снимка. Пример для одного снимка]]
:5. Копирование одного снимка в другой проект и ветку:
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в крайнем правом столбце строки снимка.
::б) В меню выберите пункт '''Копировать'''.
::в) В открывшемся окне выберите проект и ветку, в которые нужно добавить копию снимка, нажмите кнопку '''Копировать'''.
::При старте операции и по ее окончании пользователю отобразятся соответствующие всплывающие сообщения.
::[[File:213 Сообщение. Копирование снимков.png|thumb|none|upright=1.5|Пример всплывающих сообщений при старте и окончании копирования одного снимка]]
[[File:214 Окно Копирование нескольких снимков.png|thumb|right|upright=1.5|Окно копирования снимка. Пример для двух снимков]]
:6. Копирование нескольких снимков в другой проект и ветку:
::а) Чтобы выбрать для копирования все снимки, установите флажок в заголовке табличного списка снимков.
::б) Чтобы выбрать несколько снимков, установите флажки в крайнем правом столбце табличного списка.
::в) Нажмите кнопку '''Копировать''' в верхней части табличного списка снимков.
::г) В открывшемся окне выберите проект и ветку, в которые нужно добавить копии выбранных снимков, нажмите кнопку '''Копировать'''.
::При старте операции и по ее окончании пользователю отобразятся соответствующие всплывающие сообщения.
::[[File:215 Сообщение. Копирование двух снимков.png|thumb|none|upright=1.5|Пример всплывающих сообщений при старте и окончании копирования двух снимков]]
:[[File:134 Импорт разметки.png|thumb|right|upright=1.5|Окно импорта разметки]]
:7. Импорт разметки из комментариев исходного кода снимка в активную ветку проекта:
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в крайнем правом столбце строки снимка.
::б) В меню выберите пункт '''Импорт разметки из исходного кода'''.
::в) В открывшемся окне выберите шаблон разметки и нажмите кнопку '''Импортировать'''.
::По окончании пользователю отобразится всплывающее сообщение с информацией о выполненной операции.
::[[File:216 Сообщение. Импорт разметки из кода.png|thumb|none|upright=1.5|Пример всплывающего сообщения об окончании импорта разметки из файла]]

:8. Просмотр информации о снимке в JSON-формате:
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке снимка крайнем правом столбце.
::б) В меню выберите пункт '''Просмотреть JSON'''.
:[[File:112 Просмотр JSON снимка.png|thumb|none|upright=3|Окно просмотра информации о снимке в JSON-формате]]
:9. Удаление одного снимка:
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке снимка крайнем правом столбце.
::б) В меню выберите пункт '''Удалить'''.
::в) Подтвердите удаление.
:10. Удаление нескольких снимков:
::а) Чтобы выбрать для удаления все снимки, установите флажок в заголовке табличного списка снимков.
::б) Чтобы выбрать несколько снимков, установите флажки в крайнем правом столбце табличного списка.
::в) Нажмите кнопку '''Удалить''' в верхней части табличного списка снимков и подтвердите удаление.

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

[[File:135 Раздел Детекторы.png|thumb|none|upright=3|Раздел «Детекторы»]]

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

{{Note|type=info|text=''При обновлении списка детекторов и их параметров в Svace изменения попадают в Svacer при выпуске новой версии системы!''}}

В разделе '''Детекторы''' пользователю доступны следующие функции:
:1. Поиск детектора по его названию, серьезности, надежности и коду дефекта безопасности CWE.
:2. Сортировка по значениям столбцов (по умолчанию – по названию детектора).
:3. Переход к просмотру описания дефекта безопасности на сайте [https://cwe.mitre.org cwe.mitre.org] (открывается в отдельном окне) – для этого нажмите на ссылку в столбце '''CWE'''.
:4. Просмотр дополнительной информации о детекторе при её наличии – для этого нажмите на иконку [[File:icon_question_mark2.png|x25px]] справа от названия детектора.

:[[File:121_Окно с дополнительной информацией о детекторе.png|thumb|none|upright=2|Раздел «Детекторы». Пример окна с дополнительной информацией о детекторе]]

:5. Фильтрация списка – для этого:
::а) Нажмите кнопку [[File:Button Фильтр.png|x25px]].
::б) В открывшемся окне '''Фильтр''' настройте параметры фильтрации – выберите значения в списках полей или нажмите кнопки со значениями.
::в) Нажмите кнопку [[File:button_Очистить.png|x25px]], чтобы очистить все параметры фильтрации.
::г) Нажмите кнопку [[File:button_Применить.png|x25px]], чтобы применить фильтр.

:[[File:137 Детекторы.Фильтр.png|thumb|none|upright=2|Раздел «детекторы». Окно «Фильтр»]]

:6. Отмена примененных фильтров – для этого нажмите кнопку [[File:Button Фильтр отмена.png|x25px]].
:7. Выбор отображаемых столбцов – для этого нажмите на кнопку '''Столбцы''' и в открывшемся списке установите или снимите флажки рядом с названиями столбцов.
:Для настройки скрытия или показа доступны все столбцы, кроме '''Детектор'''. Столбцы '''Статус''' и '''Инструменты''' по умолчанию скрыты.
:Пользовательская настройка отображения столбцов сохраняется и не сбрасывается при повторном входе пользователя в систему.

:[[File:138 Детекторы выбор столбцов.png|thumb|none|upright=1.5|Раздел «Детекторы». Выбор отображаемых столбцов]]

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

== Просмотр статистики ==
В разделе '''Статистика''' пользователь может посмотреть статистические данные о разметке по всем проектам, веткам и снимкам, доступным пользователю. Все статистические данные разделены на три группы и отображаются в отдельных дашбордах:
* [[Help:UI manual#Работа с дашбордом «Общая статистика»|'''Общая статистика''']] – показатели по последним импортированным снимкам в ветках проектов;
* [[Help:UI manual#Работа с дашбордом «Распределение маркеров»|'''Распределение маркеров''']] – диаграммы с информацией о количестве маркеров и их распределении по серьезности, статусу разметки и языкам;
* [[Help:UI manual#Работа с дашбордом «Активность по разметке»|'''Активность по разметке''']] – информация об активности пользователей при разметке маркеров.

[[File:162 Раздел Статистика. Начальное состояние.png|thumb|none|upright=3|Раздел '''Статистика'''. Начальное состояние]]
Чтобы посмотреть информацию:
:1. Выберите дашборд – нажмите кнопку с его названием в верхней части экрана.
:2. Выберите [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|контекст]] (опционально). В дашборде '''Общая статистика''' выбор снимка недоступен.
:2. Нажмите кнопку [[File:Button Play.png|x25px]].
:Если контекст не был выбран, отобразится статистика по всем проектам, веткам и снимкам, доступным пользователю. При этом информация об их количестве отображается в верхней части каждого дашборда.
:[[File:163 Раздел Статистика. Контекст не выбран.png|thumb|none|upright=2.5|Раздел '''Статистика'''. Пример дашборда '''Общая статистика'''. Контекст не выбран]]
:Если контекст был выбран, то отобразится статистика только для выбранных проектов, веток и снимков (кроме '''Общая статистика'''). При этом информация об их количестве отображается в верхней части каждого дашборда.
:[[File:164 Раздел Статистика. Контекст выбран.png|thumb|none|upright=2.5|Раздел '''Статистика'''. Пример дашборда '''Общая статистика'''. Контекст выбран]]

=== Работа с дашбордом «Общая статистика» ===
На дашборде '''Общая статистика''' отображается информация о разметке маркеров в последних импортированных снимках в разрезе проектов и веток. Информация представлена в виде блоков со следующими данными:
* общая информация:
** названия проекта и ветки;
** количество снимков в ветке и дата последнего импорта;
** дата последней разметки маркеров;
* показатели последнего импортированного снимка:
** количество строк кода;
** количество маркеров;
** плотность маркеров – процентное отношение количества маркеров на тысячу строк кода;
** процент и количество размеченных маркеров;
** процент и количество подтвержденных маркеров – со статусом Confirmed;
** процент и количество критичных маркеров – с серьезностью детектора Critical.
:[[File:204 Статистика. Общая статистика.png|thumb|none|upright=2.5|Раздел '''Статистика'''. Дашборд '''Общая статистика''']]
Пользователю доступны следующие функции:
:1. Поиск информации по названиям проектов и веток.
:2. Сортировка данных – для этого в поле справа выберите показатель, по которому требуется сортировать информацию:
:* по датам последних разметки и импорта;
:* по показателям последнего импортированного снимка.
:Для изменения порядка сортировки используйте кнопки [[File:Button Sort.png|x25px]] и [[File:Button Sort UP.png|x25px]].
:3. Переход к последнему импортированному снимку в режиме разметки – нажмите на названия проекта и ветки в блоке.

=== Работа с дашбордом «Распределение маркеров» ===
На дашборде '''Распределение маркеров''' отображаются три диаграммы:
* Количество маркеров по серьезности;
* Количество маркеров по статусу разметки;
* Распределение маркеров по языкам.
[[File:165 Раздел Статистика. Информация о выбранном контексте.png|thumb|none|upright=2.5|Раздел '''Статистика'''. Дашборд '''Распределение маркеров''']]
Пользователю доступны следующие функции:
:1. Просмотр значения диаграммы – для этого наведите курсор на любой графический элемент любой диаграммы.
:2. Выгрузка данных диаграммы в файл формата .csv – для этого нажмите кнопку [[File:Button Download.png|x25px]] в любой диаграмме.

=== Работа с дашбордом «Активность по разметке» ===
На дашборде Активность по разметке отображается информация о действиях пользователей [[Help:UI manual#Работа в режиме разметки|по разметке маркеров]], которая может быть представлена в двух видах:
* диаграмма '''Активность по разметке''' – отражает активность пользователей по разметке маркеров за выбранный месяц (по умолчанию – текущий месяц). Цвет ячеек на диаграмме отражает количество действий пользователя, выполненных в указанную дату: чем темнее цвет, тем больше действий выполнил пользователь. Эта диаграмма отображается по умолчанию; если вид был переключен, то для возврата к этой диаграмме нажмите кнопку [[File:Button ChangeDiagram1.png|x25px]];
* диаграмма '''Лидеры по разметке''' – отражает количество действий пользователей при разметке за выбранный период (по умолчанию – период соответствует месяцу, указанному на диаграмме '''Активность по разметке''') с сортировкой по лидерам. Цвет строк на диаграмме отражает количество действий пользователя: чем темнее цвет, тем больше действий выполнил пользователь. Диаграмма отображается по нажатии кнопки [[File:Button ChangeDiagram2.png|x25px]];
[[File:166 Раздел Статистика. Активность по разметке.png|thumb|none|upright=3|Раздел '''Статистика'''. Дашборд '''Активность по разметке'''. Вид 1: диаграмма '''Активность по разметке''']]
[[File:167 Раздел Статистика. Лидеры по разметке.png|thumb|none|upright=3|Раздел '''Статистика'''. Дашборд '''Активность по разметке'''. Вид 2: диаграмма '''Лидеры по разметке''']]
Пользователю доступны следующие функции:
:1. Просмотр значения диаграммы – для этого наведите курсор на любой графический элемент любой диаграммы.
:2. Выгрузка данных диаграммы в файл формата .csv – для этого нажмите кнопку [[File:Button Download.png|x25px]] в любой диаграмме
:3. В диаграмме '''Активность по разметке''':
::а) Поиск конкретного пользователя – для этого введите фрагмент его логина в поле поиска.
::б) Просмотр статистики за любой другой месяц – для этого выберите год и месяц в раскрывающихся списках вверху диаграммы.
::в) Просмотр активности конкретного пользователя за выбранный месяц – для этого нажмите на его логин.
::Ниже диаграммы '''Активность по разметке''' отобразится список действий по разметке выбранного пользователя. Измененная (неактуальная) разметка отмечена иконкой [[File:Icon archive.png|x25px]].
::[[File:168 Раздел Статистика. Активность по разметке. Выбранный пользователь.png|thumb|none|upright=3|Раздел '''Статистика'''. Дашборд '''Активность по разметке'''. Диаграмма '''Активность по разметке''' и список действий по разметке выбранного пользователя]]
::г) Просмотр активности пользователей в конкретный день месяца – для этого нажмите на число.
::Ниже диаграммы '''Активность по разметке''' отобразится список действий по разметке пользователей за выбранную дату.
::[[File:169 Раздел Статистика. Активность по разметке. Пользователи за дату.png|thumb|none|upright=3|Раздел '''Статистика'''. Дашборд '''Активность по разметке'''. Диаграмма '''Активность по разметке''' и список действий по разметке пользователей за выбранную дату]]
::д) Просмотр активности конкретного пользователя в конкретный день месяца – для этого нажмите ячейку таблицы на пересечении строки с логином пользователя и столбца с числом.
::Ниже диаграммы '''Активность по разметке''' отобразится список действий по разметке выбранного пользователя за выбранную дату.
::[[File:170 Раздел Статистика. Активность по разметке. Одни пользователь за дату.png|thumb|none|upright=3|Раздел '''Статистика'''. Дашборд '''Активность по разметке'''. Диаграмма '''Активность по разметке''' и список действий по разметке выбранного пользователя за выбранную дату]]
::е) Включение и выключение отображения информации о неактуальной (измененной) разметке в списке действий пользователя – для этого воспользуйтесь переключателем '''Исключить активность по неактуальной разметке'''.
::ж) Просмотр маркера в [[Help:UI manual#Работа в режиме разметки|режиме разметки]] – для этого в списке действий нажмите на ссылку с именем файла и номером строки.
::з) Просмотр информации о маркере – для этого в списке действий нажмите кнопку [[File:Button show.png|x25px]] слева от названия маркера.
::В правой части экрана отобразится панель с информацией о маркере.
::[[File:205 Статистика. Активность по разметке. Панель с информацией о маркере.png|thumb|none|upright=3|Панель с информацией о маркере]]
:4. В диаграмме '''Лидеры по разметке''':
::а) Поиск конкретного пользователя – для этого введите фрагмент его логина в поле поиска.
::б) Просмотр статистики за любой другой период времени, кроме текущего месяца – для этого кликните на поле даты вверху диаграммы и вручную введите даты, либо в раскрывшемся календаре выберите диапазон дат: предложенный ('''Сегодня''', '''Вчера''', '''Неделю назад''' и т. п.) или свой.
::[[File:171 Раздел Статистика. Лидеры по разметке. Выбор дат.png|thumb|none|upright=3|Раздел '''Статистика'''. Дашборд '''Активность по разметке'''. Диаграмма '''Лидеры по разметке'''. Выбор диапазона дат]]
::в) Просмотр активности конкретного пользователя за указанный период – для этого нажмите на его логин.
::Ниже диаграммы '''Лидеры по разметке''' отобразится список действий по разметке выбранного пользователя. Измененная (неактуальная) разметка отмечена иконкой [[File:Icon archive.png|x25px]].
::[[File:172 Раздел Статистика. Лидеры по разметке. Выбранный пользователь.png|thumb|none|upright=3|Раздел '''Статистика'''. Дашборд '''Активность по разметке'''. Диаграмма '''Лидеры по разметке''' и список действий по разметке выбранного пользователя]]
::г) Включение и выключение отображения в списке действий пользователя по неактуальной (измененной) разметке – для этого воспользуйтесь переключателем '''Исключить активность по неактуальной разметке'''.
::д) Просмотр маркера в [[Help:UI manual#Работа в режиме разметки|режиме разметки]] – для этого в списке действий нажмите на ссылку с именем файла и номером строки.
::e) Просмотр информации о маркере – для этого в списке действий нажмите кнопку [[File:Button show.png|x25px]] слева от названия маркера.
::В правой части экрана отобразится панель с информацией о маркере.

== Глобальный поиск ==
Глобальный поиск позволяет одновременно по всем доступным пользователю проектам и веткам выполнить поиск в следующих категориях:
* Маркеры;
* Комментарии к маркерам;
* Снимки.

Чтобы воспользоваться глобальным поиском, перейдите в раздел '''Поиск'''.
[[File:173 Раздел Поиск. Начальное состояние.png|thumb|none|upright=3|Раздел '''Поиск'''. Начальное состояние]]

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

=== Поиск маркеров ===
Чтобы воспользоваться поиском маркеров:
:1. Выберите категорию '''Маркеры''' раздела '''Поиск''' (выбран по умолчанию).
:2. Для базового поиска:
::а) Перейдите на вкладку '''Базовый поиск''' (открыта по умолчанию).
::[[File:174 Раздел Поиск. Категория Маркеры. Базовый поиск.png|thumb|none|upright=3|Раздел '''Поиск'''. Категория '''Маркеры'''. Базовый поиск]]
::б) Введите фрагмент названия маркера, детектора, функции или файла.
::в) Выберите (опционально) группу проектов, проект, ветку и снимок, в которых нужно найти маркеры.
::По умолчанию выбраны все группы, проекты, ветки и снимки.
::г) Нажмите кнопку '''Поиск'''.
:Отобразятся результаты поиска.
:[[File:175 Раздел Поиск. Пример результатов поиска в категории Маркеры.png|thumb|none|upright=3|Раздел '''Поиск'''. Пример результатов поиска в категории '''Маркеры''']]
:3. Для поиска по полям:
::а) Перейдите на вкладку '''Поиск по полям'''.
::[[File:176 Раздел Поиск. Категория Маркеры. Поиск по полям.png|thumb|none|upright=3|Раздел '''Поиск'''. Категория '''Маркеры'''. Поиск по полям]]
::б) Заполните поля поиска.
::в) Выберите (опционально) группу проектов, проект, ветку и снимок, в которых нужно найти маркеры.
::По умолчанию выбраны все группы, проекты, ветки и снимки.
::г) Нажмите кнопку '''Поиск'''.
:Отобразятся результаты поиска.
:[[File:177 Раздел Поиск. Пример результатов поиска по полям в категории Маркеры.png|thumb|none|upright=3|Раздел '''Поиск'''. Пример результатов поиска по полям в категории '''Маркеры''']]
:4. Для очистки значений в полях поиска нажмите кнопку '''Очистить'''.
:5. Чтобы перейти к найденному файлу с маркером в [[Help:UI manual#Работа в режиме разметки|режиме разметки]], в результатах поиска кликните на ссылку в имени файла с номером строки исходного кода.
:6. Чтобы посмотреть подробную информацию о найденном маркере, в результатах поиска нажмите кнопку [[File:Button show.png|x25px]].
Отобразится правая панель с открытой вкладкой '''Подробности'''.
:[[File:341 Раздел Поиск. Подробная информация о маркере.png|thumb|none|upright=3|Раздел '''Поиск'''. Пример просмотра подробной информации о найденном маркере]]

=== Поиск комментариев к маркерам ===
Чтобы воспользоваться поиском по комментариям к маркерам:
:1. Выберите категорию '''Комментарии к маркерам''' раздела '''Поиск'''.
:2. Для базового поиска:
::а) Перейдите на вкладку '''Базовый поиск''' (открыта по умолчанию).
::[[File:178 Раздел Поиск. Категория Комментарии к маркерам. Базовый поиск.png|thumb|none|upright=3|Раздел '''Поиск'''. Категория '''Комментарии к маркерам'''. Базовый поиск]]
::б) Введите фрагмент комментария или логина его автора.
::в) Выберите (опционально) группу проектов, проект, ветку и снимок, в которых нужно найти комментарии.
::По умолчанию выбраны все группы, проекты, ветки и снимки.
::г) Нажмите кнопку '''Поиск'''.
:Отобразятся результаты поиска.
:[[File:179 Раздел Поиск. Пример результатов поиска в категории Комментарии к маркерам.png|thumb|none|upright=3|Раздел '''Поиск'''. Пример результатов поиска в категории '''Комментарии к маркерам''']]
:3. Для поиска по полям:
::а) Перейдите на вкладку '''Поиск по полям'''.
::[[File:180 Раздел Поиск. Категория Комментарии к маркерам. Поиск по полям.png|thumb|none|upright=3|Раздел '''Поиск'''. Категория '''Комментарии к маркерам'''. Поиск по полям]]
::б) Заполните поля поиска.
::в) Выберите (опционально) группу проектов, проект, ветку и снимок, в которых нужно найти комментарии.
::По умолчанию выбраны все группы, проекты, ветки и снимки.
::г) Нажмите кнопку '''Поиск'''.
:Отобразятся результаты поиска.
:[[File:181 Раздел Поиск. Пример результатов поиска по полям в категории Комментарии к маркерам.png|thumb|none|upright=3|Раздел '''Поиск'''. Пример результатов поиска по полям в категории '''Комментарии к маркерам''']]
:4. Для очистки поискового запроса нажмите кнопку '''Очистить'''.
:5. Чтобы перейти в [[Help:UI manual#Работа в режиме разметки|режим разметки]] к файлу маркера с найденным комментарием, в результатах поиска кликните на ссылку в имени файла с номером строки исходного кода.
:6. Чтобы посмотреть подробную информацию о маркере с найденным комментарием, в результатах поиска нажмите кнопку [[File:Button show.png|x25px]]. Отобразится правая панель с открытой вкладкой '''Комментарии'''.

=== Поиск снимков ===
Чтобы воспользоваться поиском по снимкам:
:1. Выберите категорию '''Снимки''' раздела '''Поиск'''.
:2. Для базового поиска:
::а) Перейдите на вкладку '''Базовый поиск''' (открыта по умолчанию).
::[[File:182 Раздел Поиск. Категория Снимки. Базовый поиск.png|thumb|none|upright=3|Раздел '''Поиск'''. Категория '''Снимки'''. Базовый поиск]]
::б) Введите фрагмент названия снимка, пользовательского поля снимка (названия или его значения) или логина пользователя, который импортировал снимок.
::в) Выберите (опционально) группу проектов, проект, ветку и снимок, в которых нужно найти снимки.
::По умолчанию выбраны все группы, проекты, ветки и снимки.
::г) Нажмите кнопку '''Поиск'''.
:Отобразятся результаты поиска.
:[[File:183 Раздел Поиск. Пример результатов поиска в категории Снимки.png|thumb|none|upright=3|Раздел '''Поиск'''. Пример результатов поиска в категории '''Снимки''']]

:3. Для поиска по полям:
::а) Перейдите на вкладку '''Поиск по полям'''.
::[[File:184 Раздел Поиск. Категория Снимки. Поиск по полям.png|thumb|none|upright=3|Раздел '''Поиск'''. Категория '''Снимки'''. Поиск по полям]]
::б) Заполните поля поиска.
::в) Выберите (опционально) группу проектов, проект, ветку и снимок, в которых нужно найти снимки.
::По умолчанию выбраны все группы, проекты, ветки и снимки.
::г) Нажмите кнопку '''Поиск'''.
:Отобразятся результаты поиска.
:[[File:185 Раздел Поиск. Пример результатов поиска по полям в категории Снимки.png|thumb|none|upright=3|Раздел '''Поиск'''. Пример результатов поиска по полям в категории '''Снимки''']]
:4. Для очистки поискового запроса нажмите кнопку '''Очистить'''.
:5. Чтобы посмотреть подробную информацию о найденном снимке, в результатах поиска кликните на ссылку в пути размещения снимка.
:Найденный снимок откроется в [[Help:UI manual#Работа в режиме разметки|режиме разметки]] со всеми его маркерами.

=== Просмотр истории поиска ===
Чтобы посмотреть историю поиска, нажмите кнопку '''История поиска''' в разделе '''Поиск'''.

В истории отображаются 100 последних поисковых запросов пользователя.
[[File:186 Раздел Поиск. Пример истории поиска.png|thumb|none|upright=3|Раздел '''Поиск'''. Пример истории поиска]]

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

== Настройка сервера Svacer ==
Перейти в раздел '''Настройки''' можно по нажатии кнопки [[File:Icon settings.png|x25px]] в верхней правой части экрана.

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

=== Управление пользователями, ролями и организациями===
==== Управление пользователями ====
Реестром учетных записей пользователей можно управлять на вкладке '''Пользователи''' в разделе '''Управление пользователями''' страницы '''Настройки'''. 
Для [[LDAP configuration|учетных записей с доступом по LDAP]] рядом с логином отображается индикатор [[File:Icon LDAP.png|x25px]], для учетных записей с доступом по OIDC рядом с логином отображается индикатор [[File:Icon_OIDC.png|x25px]], а для учетных записей с признаком '''Мастер разметки''' – индикатор [[File:Icon markup master.png|x25px]]. 
В разделе доступны:
* поиск по атрибутам учётной записи пользователя;
* фильтрация списка по типам учётных записей:
:* все;
:* системные;
:* LDAP;
:* OIDC;
:* заблокированные;
:* активные;
:* по ролям;
:* по организациям.
* сортировка по колонкам '''Логин''', '''ФИО''' и '''Дата создания''' (по умолчанию).
:[[File:74 Вкладка Пользователи на странице Настройки.png|thumb|none|upright=3|Вкладка '''Пользователи''' в разделе '''Управление пользователями''' страницы '''Настройки''']]
Для управления пользователями:
:1. Создайте учетную запись пользователя:
::а) Нажмите кнопку '''Создать'''.
::Откроется окно добавления учетной записи пользователя.
::[[File:76 Окно Добавить пользователя.png|thumb|none|upright=1.5|Окно '''Создать пользователя''']]
::б) Заполните поля:
::* Логин;
::* Пароль;
::* e-mail;
::* ФИО.
::в) Выберите [[Help:UI manual#Управление организациями|организации]], в которые должен входить пользователь, а также назначьте ему [[Help:UI manual#Управление ролями|роли]] – выберите значения в раскрывающихся списках полей '''Организации''' и '''Роли''' соответственно. Для отмены выбора нажмите на кнопку [[File:Icon cancel.png|x25px]] справа от значения.
::г) Включите опции '''Изменить пароль при первом входе в систему''' и '''Мастер разметки'''. 
::{{Note|type=info|text=''Если для учётной записи активирована опция '''Мастер разметки''', есть разрешение на разметку и этот пользователь разметил маркер в каком-либо снимке, то изменить его разметку может только пользователь, в учётной записи которого также активирована опция '''Мастер разметки''' или которому предоставлен [[#Cерверные доступы|серверный доступ]] '''Изменение любой разметки'''.''}}
::д) Нажмите кнопку '''Создать'''.
: В таблице со списком пользователей добавится новая запись.

:2. Воспользуйтесь функциями в строке учетной записи в крайнем правом столбце – нажмите кнопку [[File:Button menu.png|x25px]] и выберите пункт:
:* '''Редактировать''' – для перехода к редактированию данных профиля;
:* '''Изменить пароль''' – для перехода к изменению пароля;
:* '''Сбросить настройки пользователя''' – для возврата пользовательских настроек к их значениям по умолчанию;
:* '''Заблокировать''' – для блокировки учетной записи. В этом случае для учетной записи пользователя блокируется доступ к системе, а в списке рядом с логином учетной записи отображается индикатор [[File:Icon_Archived.png|x25px]];
:* '''Разблокировать''' – для восстановления доступа пользователя к системе;
:* '''Настройки уведомлений''' – для настройки уведомлений пользователя об операциях со снимками и маркерами – аналогично [[Help:UI manual#Настройка уведомлений|настройке уведомлений в меню пользователя]];
::[[File:219 Настройки Настройка уведомлений выбранного пользователя.png|thumb|none|upright=2|Настройки уведомлений выбранного пользователя]]
:* '''Удалить''' – для удаления учётной записи пользователя;
:* '''Показать доступы пользователя''' – для отображения списка объединенных доступов всех ролей, назначенных пользователю.
::[[File:113 Список доступов пользователя.png|thumb|none|upright=3|Список доступов пользователя]]
::{{Note|type=warn|text=''Функции блокировки и удаления недоступны для системных учетных записей. При изменении логина или списка доступов у авторизованного пользователя, он будет перенаправлен на страницу авторизации.''}}

:3. Воспользуйтесь функциями управления несколькими учётными записями одновременно:
::а) Чтобы выбрать несколько записей, установите флажки в первом столбце списка пользователей.
::б) Чтобы выбрать все отображаемые учётные записи, установите один флажок в заголовке столбцов в первом столбце списка.
::в) Нажмите кнопку '''Действия''' в верхней части списка пользователей и выберите пункт: '''Сбросить настройки пользователя''', '''Заблокировать''', '''Разблокировать''' или '''Удалить'''. В списке активны только действия, доступные всем выбранным учетным записям.
:4. Для [[LDAP configuration|учетной записи с доступом по LDAP]] обновите данные – в окне редактирования данных профиля пользователя нажмите кнопку '''Загрузить из LDAP'''.
:Загрузятся параметры профиля пользователя и его контакты из профиля в службе каталогов, если они там указаны.
:[[File:78 Загрузка данных из LDAP.png|thumb|none|upright=1.5|Загрузка данных из LDAP]]

==== Управление ролями ====
Реестром ролей можно управлять на вкладке '''Роли''' в разделе '''Управление пользователями''' страницы '''Настройки'''.
[[File:79 Переход к управлению ролями.png|thumb|none|upright=3|Вкладка '''Роли''' в разделе '''Управление пользователями''' страницы '''Настройки''']]
{{Note|type=info|text=''Роли [[Help:UI manual#Описание ролевой модели|admin, filter_master и importer]] являются встроенными с особым значением. Их нельзя удалить или изменить.''}}

Доступен поиск по названию роли и сортировка по колонкам '''Название''' (по умолчанию) и '''Пользователи'''. 
Для управления ролями доступны следующие функции:
:1. Создание новой роли:
::а) Нажмите кнопку '''Создать'''.
::[[File:81 Окно добавления роли.png|thumb|none|upright=3|Окно добавления роли]]
::б) Заполните поля появившейся формы:
:::*введите название роли;
:::*в блоке '''Серверные доступы''' выберите доступы – нажмите кнопку '''Выбрать всё''' или установите флажки для активации доступов.
:::При наведении курсора на иконку [[File:Icon question mark2.png|x25px]] отображается пояснение к доступу.
:::*в блоке '''Проектные доступы''' выберите тип доступа: группа проектов или определённый проект или его ветка;
:::*если выбран тип '''Группа проектов''', выберите название группы и установите флажки для активации доступов;
:::*если выбран тип '''Проект / Ветка''', выберите название проекта или ветки проекта, установите флажки для активации доступов.
:::Если выбрано значение '''Все''', то доступы будут предоставлены для всех проектов;
:::*для удаления строки с проектными доступами в блоке '''Проектные доступы''' нажмите кнопку [[File:Icon delete.png|x25px]] в крайнем правом столбце.
::в) Нажмите кнопку '''Создать'''.

:2. Просмотр доступов роли, нажмите на ссылку '''Показать доступы''' в столбце '''Доступы'''.
:[[File:114 Список доступов роли.png|thumb|none|upright=3|Список доступов роли]]

:3. Редактирование роли:
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке роли в крайнем правом столбце.
::б) В меню выберите пункт '''Редактировать''' и внесите изменения.

:4. Создание копии роли:
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке исходной роли в крайнем правом столбце.
::б) В меню выберите пункт '''Создать копию'''.
:В реестр ролей добавится новая запись с именем исходной роли и добавленным порядковым номером копии.

:5. Просмотр информации о роли в JSON-формате:
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке исходной роли в крайнем правом столбце.
::б) В меню выберите пункт '''Просмотреть JSON'''.

:6. Удаление роли:
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке исходной роли в крайнем правом столбце.
::б) В меню выберите пункт '''Удалить'''.
::в) Подтвердите удаление.

:7. Удаление несколько ролей одновременно:
::а) Для выбора нескольких записей установите флажки в первом столбце списка ролей.
::б) Чтобы выбрать все записи, установите один флажок в заголовке столбцов в первом столбце списка ролей.
::в) Нажмите кнопку '''Удалить''' и подтвердите удаление.

==== Управление организациями ====
Пользователи могут быть связаны с организациями. Один пользователь может принадлежать нескольким организациям. Организации носят информационный характер и не влияют на права пользователей в системе. 
Реестром организаций можно управлять на вкладке '''Организации''' в разделе '''Управление пользователями''' страницы '''Настройки'''.
[[File:92 Вкладка Организации на странице Настройки.png|thumb|none|upright=3|Вкладка '''Организации''' в разделе '''Управление пользователями''' страницы '''Настройки''']]
Доступен поиск по названию и сокращенному названию организации и сортировка по колонкам '''Название''' (по умолчанию), '''Сокращенное название''' и '''Пользователи'''.
Для управления организациями, доступны следующие функции:
:1. Создание организации:
::а) Нажмите кнопку '''Создать'''.
::б) Заполните поля появившейся формы.
::в) Нажмите кнопку '''Создать'''.
::[[File:93 Окно добавления организации в реестр.png|thumb|none|upright=1.5|Окно добавления организации в реестр]]

:2. Редактирование организации:
::а) Нажмите кнопку [[File:Icon edit2.png|x25px]] в крайнем правом столбце.
::б) В появившейся форме отредактируйте данные организации.
::в) Нажмите кнопку '''Сохранить'''.

:3. Удаление организации:
::а) Нажмите кнопку [[File:Icon delete.png|x25px]] в крайнем правом столбце.
::б) В появившемся диалоге подтвердите удаление, нажав на кнопку '''Удалить'''.

:4. Удаление несколько организаций одновременно:
::а) Для выбора нескольких записей установите флажки в первом столбце списка организаций.
::б) Чтобы выбрать все организации, установите один флажок в заголовке столбцов в первом столбце списка.
::в) Нажмите кнопку '''Удалить''' и подтвердите удаление.

=== Настройка глобальных фильтров ===
В разделе '''Глобальные фильтры''' страницы '''Настройки''' можно настроить глобальные фильтры, применительно [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|к выбранным проекту или ветке проекта]]: 
{{Note|type=info|text=''По умолчанию выбран контекст (проект, ветка), заданный ранее в режиме '''Разметка''', или '''Код'''.''}}
[[File:82 Вкладка Фильтры на странице Настройки.png|thumb|none|upright=4|Раздел '''Глобальные фильтры''' на странице '''Настройки''']]

В разделе доступен поиск по названию фильтра.

Для настройки фильтров:
:1. Выберите проект и ветку в верхней строке раздела. По умолчанию указаны проект и ветка, выбранные в разделе '''Разметка'''.
:2. Чтобы добавить фильтр, нажмите кнопку '''Создать'''.
:Отобразится новая строка:
:[[File:83 Новая строка с фильтром.png|thumb|none|upright=4|Новая строка с фильтром]]

:3. Чтобы изменить настройки фильтров:
::а) Введите или поменяйте название фильтра
::б) Включите или выключите фильтр – нажмите на значение в столбце '''Статус''', чтобы отобразилась иконка [[File:Icon check2.png|x25px]] (по умолчанию) или [[File:Icon cross 01.png|x25px]].
::в) Выберите область применения фильтра – нажмите на значение в столбце '''Область''' один или два раза, чтобы отобразилось значение '''ветка''' или '''проект'''.
::г) Введите [[Help:UI manual#Использование регулярных выражений|регулярное выражение]] или загрузите его из файла в столбцах '''Включить пути по шаблону''', '''Исключить пути по шаблону''' и '''Детекторы'''.
::{{Note|type=info|text=''Шаблоны регулярных выражений не зависят от регистра и поддерживают следующий синтаксис:''
:* ''; – для разделения списков значений;''
:* ''* – любое количество символов;''
:* ''? – один произвольный символ;''
:* ''re: – включая значения, определяемые регулярным выражением;''
:* ''re!: – исключая значения, определяемые регулярным выражением (только для столбца '''Детекторы''').''}}
::д) Выберите уровни серьезности (критичности) и надежности:
::* [[File:Icon_critical_on.png|x30px]] – уровень выбран;
::* [[File:Icon_critical_off.png|x30px]] – уровень не выбран.
::Для изменения выбора нажмите на название уровня.
:4. Нажмите кнопку [[File:Icon delete.png|x25px]] в крайнем правом столбце, чтобы удалить один фильтр.
:5. Чтобы удалить несколько фильтров:
::а) Для выбора нескольких записей установите флажки в первом столбце списка фильтров.
::б) Чтобы выбрать все записи, установите один флажок в заголовке столбцов в первом столбце списка фильтров.
::в) Нажмите кнопку '''Удалить'''.
:6. Для сохранения и применения изменений нажмите кнопку '''Применить'''.
Если не применить изменения, то при переходе в другой раздел системы отобразится сообщение о том, что изменения не применены:
:[[File:115 Запрос на изменение глобальных фильтров.png|thumb|none|upright=1.5]]

:{{Note|type=warn|text=''После применения глобальных фильтров пользователям, у которых в режиме разметки открыт данный контекст, требуется перезагрузить страницу (нажать клавишу F5) для обновления списка маркеров.''}}

=== Управление блокировками разметки ===
Чтобы посмотреть список всех [[Help:UI manual#Блокировка разметки|блокировок]], перейдите на вкладку '''Блокировки''' страницы '''Настройки''':
[[File:61 Просмотр всех блокировок.png|800px|thumb|none|Раздел '''Блокировки''' страницы '''Настройки''']]
{{Note|type=info|text=''Пользователю отображается список блокировок в контейнерах, к которым у него есть доступ. Удаление не своих блокировок доступно пользователям с соответствующим доступом.''}}

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

Для удаления одной блокировки:
:1. Нажмите кнопку [[File:Icon delete.png|x25px]] в строке проекта в крайнем правом столбце.
:2. Подтвердите удаление.
Для удаления нескольких блокировок:
:1. Чтобы выбрать для удаления все блокировки, установите флажок в заголовке табличного списка.
:2. Чтобы выбрать несколько блокировок, установите флажки в крайнем правом столбце табличного списка.
:3. Нажмите кнопку '''Удалить''' в верхней части списка.

=== Ведение журнала операций ===
В разделе '''Журнал операций''' страницы '''Настройки''' доступны просмотр и откат выполнения групповых операций по разметке и комментированию маркеров, таких как импорт разметки, копирование разметки, импорт снимков и т. п.
[[File:206 Настройки. Журнал операций.png|800px|thumb|none|Раздел '''Журнал операций''' на странице '''Настройки''']]
В разделе доступны:
* поиск по названию контейнера, типу операции и её описанию;
* фильтрация списка:
** по статусу операции: '''Applied''', '''Reverted''', '''Invalid''';
** типу операции;
** генератору операции;
** автору операции;
** диапазону дат создания операции;
* сортировка по всем колонкам, кроме '''Описание'''.

Чтобы откатить выполнение операции, нажмите кнопку [[File:Icon return.png|x25px]] в строке и подтвердите действие в открывшемся окне.
{{Note|type=warn|text=''Откат своих операций доступен пользователям с [[#Проектные доступы|проектными доступами]] '''Разметка маркеров''' и '''Импорт разметки'''. Откат операций других пользователей доступен пользователям с [[#Проектные доступы|проектным доступом]] '''Разметка маркеров''' и [[#Серверные доступы|серверным доступом]] '''Администрирование сервера''' или серверным доступами '''Изменение любой разметки''' и '''Изменение любых комментариев'''.''}}

=== Управление шаблонами разметки ===
Управление шаблонами разметки доступно в разделе '''Шаблоны разметки''' страницы '''Настройки''':
[[File:84 Вкладка Шаблоны на странице Настройки.png|thumb|none|upright=3|Раздел '''Шаблоны разметки''' на странице '''Настройки''']]

Шаблоны разметки нужны для [[Help:UI manual#Импорт разметки|импорта]]/[[Help:UI manual#Экспорт разметки|экспорта разметки]]. С их помощью комментарии в исходном коде будут преобразовываться в разметку на сервере истории и обратно.

Шаблон с именем DEFAULT есть всегда, его нельзя отредактировать или удалить.

{{Note|type=info|text=''Для корректного создания или изменения шаблонов разметки следует обратиться к разработчикам Svacer.''}}

Для управления шаблонами:
:1. Нажмите кнопку '''Создать'''.
:Откроется окно создания шаблона.
:[[File:Добавление шаблона разметки.png|thumb|none|upright=1.5|Окно создания шаблона разметки]]
:2. Введите название шаблона.
:3. Нажмите кнопку '''Создать'''.
:Шаблон появится в списке шаблонов для разметки в правой панели формы
:4. Отредактируйте поля шаблона разметки:
:[[File:85 Поля шаблона, доступные для редактирования.png|thumb|none|upright=2.5|Редактирование шаблона разметки]]
:5. Нажмите '''Сохранить'''.
:6. Чтобы клонировать существующий шаблон разметки, нажмите кнопку [[File:Icon_clone.png|x20px]] в правой части строки шаблона в списке.
:7. Для удаления одного шаблона:
::а) Нажмите кнопку [[File:Icon delete.png|x25px]] в правой части строки шаблона в списке.
::б) Подтвердите удаление.
:8. Для удаления нескольких шаблонов:
::а) Выберите шаблоны для удаления – установите флажки в левой части названий шаблонов или нажмите кнопку '''Выбрать всё'''.
::б) Нажмите кнопку '''Удалить''' в верхней части списка шаблонов и подтвердите удаление.

=== Управление токенами доступа ===
Управление персональными токенами доступа выполняется в разделе '''Токены доступа''' на странице '''Настройки'''.
[[File:207 Настройки. Токены доступа.png|800px|thumb|none|Раздел '''Токены доступа''' на странице '''Настройки''']]
В разделе доступны:
* поиск по названию токена и его описанию, а также по логину пользователя;
* сортировка по всем колонкам, кроме '''Описание'''.
Для управления токенами доступа:
:1. Создайте токен:
::а) Нажмите кнопку '''Создать'''.
::б) В окне '''Создать токен доступа''' введите название и, опционально, описание токена; выберите срок действия.
::По умолчанию срок действия токена 90 дней (минимальный срок 1 день, максимальный – 365).
::в) Нажмите кнопку '''Создать'''.
::[[File:208 Окно Создание токена доступа.png|thumb|none|upright=1.5|Окно '''Создать токен доступа''']]
::Отобразится окно с токеном доступа.
::{{Note|type=warn|text=''Токен отображается только один раз – при создании''}}
::[[File:209 Токен доступа.png|thumb|none|upright=1.5|Пример токена]]
::г) Нажмите кнопку '''Скопировать в буфер обмена''' и сохраните токен в надежном месте.
:2. Для удаления одного токена:
::а) Нажмите кнопку [[File:Icon delete.png|x25px]] в крайнем правом столбце.
::б) Подтвердите удаление.
:3. Для удаления нескольких токенов:
::а) Чтобы выбрать для удаления все токены, установите флажок в заголовке табличного списка.
::б) Чтобы выбрать несколько токенов, установите флажки в крайнем правом столбце табличного списка.
::в) Нажмите кнопку '''Удалить''' в верхней части табличного списка токенов и подтвердите удаление.

=== Управление асинхронными задачами ===
К асинхронным задачам относятся:
* экспорт snap и SARIF файлов (в режиме [[Help:UI manual#Экспорт|'''Разметки''']] и в разделе [[Help:UI manual#Работа со снимками|'''Проекты''']]);
* копирование снимков (см. раздел 4.6.4).
Управление этими задачами выполняется разделе '''Асинхронные задачи''' на странице '''Настройки'''.

В разделе доступны:
* поиск по идентификатору задачи, её типу, описанию, статусу, а также по логину пользователя;
* фильтрация списка:
:* по статусу;
:* типу задачи;
:* пользователю;
:* диапазону дат старта и окончания выполнения задачи;
* сортировка по всем колонкам, кроме '''Описание'''.
[[File:342 Настройки. Асинхронные задачи.png|800px|thumb|none|Раздел '''Асинхронные задачи''' на странице '''Настройки''']]

Для управления асинхронными задачами:
:1. Чтобы посмотреть лог выполнения задачи, нажмите кнопку в крайнем правом столбце.
:Откроется окно с текстом лога (Рисунок 205).
:[[File:343 Окно с текстом лога асинхронной задачи.png|600px|thumb|none|Окно с текстом лога асинхронной задачи]]
:2. Чтобы скачать лог, нажмите кнопку в крайнем правом столбце или откройте окно с текстом лога и нажмите кнопку '''Скачать лог'''.
:3. Для удаления истории об одной задаче:
::а) Нажмите кнопку [[File:Icon delete.png|x25px]] в строке задачи в крайнем правом столбце.
::б) Подтвердите удаление.
:4. Для удаления истории о нескольких задачах:
::а) Чтобы выбрать для удаления все задачи, установите флажок в заголовке табличного списка.
::б) Чтобы выбрать несколько задач, установите флажки в крайнем правом столбце табличного списка.
::в) Нажмите кнопку '''Удалить''' в верхней части списка.

=== Просмотр информации о сервере ===
В разделе '''Информация о сервере''' на странице '''Настройки''' отображаются вкладки:
* '''Параметры''' – параметры, с которыми запущен сервер;
* '''Системный лог''' – журнал событий сервера;
* '''Системный журнал''' – журнал базы данных.
[[File:344 Настройки. Информация о сервере. Вкладка Параметры.png|thumb|none|upright=3|Раздел '''Информация о сервере''' на странице '''Настройки'''. Вкладка '''Параметры''']]
[[File:345 Настройки. Информация о сервере. Вкладка Системный лог.png|thumb|none|upright=3|Раздел '''Информация о сервере''' на странице '''Настройки'''. Вкладка '''Системный лог''']]
[[File:346 Настройки. Информация о сервере. Вкладка Системный журнал.png|thumb|none|upright=3|Раздел '''Информация о сервере''' на странице '''Настройки'''. Вкладка '''Системный журнал''']]

{{Note|type=warn|text=''На вкладке '''Системный лог''' вывод информации ограничен 1 МБ последних данных (значение настраивается в параметрах сервера). При скачивании файл содержит данные лога в полном объеме.''}}

Доступны функции:
* поиск параметров по их имени и значению – на вкладке '''Параметры''';
* копирование записей – на вкладках '''Системный лог''' и '''Системный журнал''';
* выгрузка лога в файлы в формате .log по нажатии кнопки '''Скачать''' – на вкладках '''Системный лог''' и '''Системный журнал'''.

== Выход из системы ==
Для выхода из системы выберите пункт '''Выйти''' в меню пользователя в правом верхнем углу экрана.
[[File:95 Выход из системы —без VSCode.png|thumb|none|upright=1.5|Выход из системы]]

== Использование регулярных выражений ==
Регулярные выражения можно использовать:
* для поиска и фильтрации данных [[Help:UI manual#Функции навигационной панели|в навигационной панели]] [[Help:UI manual#Вкладка «Файлы»|на вкладке '''Файлы''']];
* в окне настройки [[Help:UI manual#Настройка и использование пользовательских фильтров|пользовательских фильтров]] в блоке '''Файлы''';
* при [[Help:UI manual#Экспорт исходного кода с разметкой|экспорте кода с разметкой]];
* при [[Help:UI manual#Настройка глобальных фильтров|настройке глобальных фильтров]];
* в полях [[Help:UI manual#Глобальный поиск|глобального поиска]].

Особенности реализации:
:1. Поиск происходит только по регулярному выражению. Если требуется найти специальный символ в качестве обычного символа, его нужно экранировать (например, точку: <code>\.</code>)
:2. При поиске находятся вхождения подстроки в полном пути к файлу (аналогично grep). Если требуется найти по полной строке, используйте символы начала и конца строки: <code>^</code> и <code>$</code>
:3. Поиск не зависит от регистра символов (case insensitive) и поддерживает следующий синтаксис:
::* ; – для разделения списков значений;
::* * – любое количество символов;
::* ? – один произвольный символ.
:В окне настройки [[Help:UI manual#Настройка и использование пользовательских фильтров|пользовательских фильтров]] в блоке '''Файлы''' можно применить фильтр как для отображения только маркеров из файлов, которые подходят под паттерн, так и для скрытия таких маркеров. Для переключения между этими режимами используйте кнопки [[File:Icon plus 2.png|x20px]] и [[File:Icon minus 3.png|x20px]], которые расположены рядом с полем ввода. В остальных частях интерфейса следует использовать теги re: и re!:

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

== Описание ролевой модели ==
=== Серверные доступы ===
{| class="wikitable"
! Полномочие (доступ) !! Описание !! Влияние на графический интерфейс !! admin !! filter_master !! importer
|-
| Создание проектов
|| Создание и клонирование проектов. Пользователь, создавший проект, имеет полный доступ к управлению этим проектом
|| Наличие полномочия делает доступным:
* раздел [[Help:UI manual#Управление проектами и группами проектов|'''Проекты''']];
* кнопку '''Создать проект''';
* форму создания, клонирования и редактирования проекта.

Наличие доступа предоставляет автору проекта полные права на управление своими проектами, включая разметку (даже при отсутствии у него соответствующего проектного доступа), а также позволяет удалять приложения к снимкам в созданных проектах
|| + || – || –

|-
| Настройка групп проектов
|| Создание, редактирование и удаление групп проектов
|| Наличие полномочия делает доступным:
* раздел [[Help:UI manual#Управление проектами и группами проектов|'''Проекты''']] с кнопкой для перехода к настройке групп;
* панель [[Help:UI manual#Работа с группами проектов|'''Группы проектов''']] с полным списком проектов в группах.
Наличие доступа предоставляет права на просмотр маркеров во всех проектах
|| + || – || –

|-
| Управление пользователями
|| Создание, редактирование и удаление пользователей
|| Наличие полномочия делает доступной вкладку [[Help:UI manual#Управление пользователями|'''Пользователи''']] в разделе [[Help:UI manual#Управление пользователями, ролями и организациями|'''Настройки – Управление пользователями''']] со всеми функциями управления учетными записями пользователей
|| + || – || –

|-
| Управление ролями
|| Создание, редактирование и удаление ролей
|| Наличие полномочия делает доступной вкладку [[Help:UI manual#Управление ролями|'''Роли''']] в разделе [[Help:UI manual#Управление пользователями, ролями и организациями|'''Настройки – Управление пользователями''']] со всеми функциями управления ролями
|| + || – || –

|-
| Управление организациями
|| Создание, редактирование и удаление организаций
|| Наличие полномочия делает доступной вкладку [[Help:UI manual#Управление организациями|'''Организации''']] в разделе [[Help:UI manual#Управление пользователями, ролями и организациями|'''Настройки – Управление пользователями''']] со всеми функциями управления организациями
|| + || – || –

|-
| Управление шаблонами разметки
|| Создание, редактирование и удаление шаблонов разметки
|| Наличие полномочия делает доступным раздел [[Help:UI manual#Управление шаблонами разметки|'''Настройки – Шаблоны разметки''']] со всеми функциями управления учетными записями шаблонами
|| + || – || –

|-
| Удаление блокировок
|| Просмотр и удаление блокировок всех пользователей
|| Наличие полномочия позволяет просматривать и удалять блокировки всех пользователей в разделе [[Help:UI manual#Управление блокировками разметки|'''Настройки – Блокировки''']]
|| + || – || –

|-
| Администрирование сервера
|| Просмотр настроек сервера, системных лог-файлов и выполнение операций по администрированию сервера Svacer, включая активацию лицензии
|| Наличие полномочия делает доступным раздел [[Help:UI manual#Просмотр информации о сервере|'''Настройки – Информация о сервере''']]
Совместно с проектными доступами '''Управление ветками''' и снимками и '''Разметка маркеров''' становится доступна функция очистки разметки и комментариев в ветке
|| + || – || –

|-
| Управление публичными фильтрами
|| Публикация, редактирование и удаление публичных фильтров
|| Наличие полномочия позволяет публиковать сохраненные фильтры, а также редактировать и удалять публичные фильтры
|| + || – || –

|-
| Изменение любой разметки
|| Изменение любой разметки маркеров, включая выполненную пользователями с признаком [[Help:UI manual#Управление пользователями, ролями и организациями|'''Мастер разметки''']]
|| Доступ позволяет переразмечать маркеры (добавлять новую разметку), которые разметили любые пользователи, в том числе те, для которых активирована опция [[Help:UI manual#Управление пользователями, ролями и организациями|'''Мастер разметки''']].
При этом:
# Полномочие не предоставляет доступ ко всем проектам. Т. е. пользователь с таким полномочием может изменять разметку только в проектах, к которым у него имеется доступ.
# Для переразметки маркеров пользователю должен быть предоставлен проектный доступ '''Разметка маркеров'''.
# Чтобы переразметить заблокированный маркер, сначала нужно [[Help:UI manual#Блокировка разметки маркеров|снять его блокировку]]
|| + || – || –

|-
| Изменение любых комментариев
|| Редактирование и удаление любых пользовательских комментариев к маркерам
|| Доступ позволяет изменять/удалять комментарии, которые создали любые пользователи, в том числе те, для которых активирована опция [[Help:UI manual#Управление пользователями, ролями и организациями|'''Мастер разметки''']].
При этом:
# Полномочие не предоставляет доступ ко всем проектам. Т. е. пользователь с таким полномочием может изменять разметку только в проектах, к которым у него имеется доступ.
# Для добавления комментариев пользователю должно быть предоставлено проектное полномочие '''Разметка маркеров'''.
# Чтобы поменять комментарий к заблокированному маркеру, сначала нужно [[Help:UI manual#Блокировка разметки маркеров|снять его блокировку]]
|| + || – || –

|-
| Создание резервных копий
|| Создание, просмотр и восстановление резервных копий в интерфейсе командной строки
|| –
|| + || – || –

|-
| Запуск скриптов
|| Запуск скриптов (hooks) по кнопке, расположенной на вкладке '''Подробности''' в правой панели, содержащей информацию о маркере
|| Наличие полномочия добавляет строку '''Хуки''' на вкладке '''Подробности''' правой панели с возможностью запуска скриптов
|| + || – || –
|}

=== Проектные доступы===
{| class="wikitable"
! Полномочие (доступ) !! Описание !! Влияние на графический интерфейс !! admin !! filter_master !! importer
|-
| Управление проектом и его ветками
|| Редактирование и удаление проекта, включая операции по управлению ветками и снимками проекта, настройке глобальных фильтров, импорту/экспорту разметки и просмотру маркеров
|| Наличие полномочия делает доступным:
* раздел [[Help:UI manual#Управление проектами и группами проектов|'''Проекты''']];
* все функции управления проектом (проектами в группе) и его содержимым (за исключением разметки маркеров) – т. е. все операции с проектом, ветками и снимками.
Наличие полномочия позволяет удалять приложения к снимкам и экспортировать разметку с исходным кодом
|| + || – || –

|-
| Управление ветками и снимками
|| Редактирование и удаление ветки проекта, включая операции по управлению снимками, настройке глобальных фильтров, импорту/экспорту разметки и просмотру маркеров
|| Наличие полномочия делает доступным:
* раздел [[Help:UI manual#Управление проектами и группами проектов|'''Проекты''']];
* все функции управления веткой и снимками проекта (за исключением разметки маркеров) – т. е. доступны все операции с веткой и снимками, но не операции управления проектом.
Наличие полномочия позволяет удалять приложения к снимкам и экспортировать разметку с исходным кодом.
Запрещено клонировать ветку при наличии доступа только к этой ветке
|| + || – || –

|-
| Настройка глобальных фильтров
|| Создание, редактирование и удаление глобальных фильтров
|| Наличие полномочия делает доступным раздел [[Help:UI manual#Настройка глобальных фильтров|'''Настройки – Глобальные фильтры''']].
Список проектов и веток в разделе определяется полномочиями к этим проектам и веткам
|| + || + || –

|-
| Импорт снимков
|| Загрузка, редактирование названия и удаление снимков
|| Наличие полномочия делает доступным:
* раздел [[Help:UI manual#Управление проектами и группами проектов|'''Проекты''']];
* функции просмотра проекта и ветки, управления снимками в указанной ветке (включая импорт .svace-dir, SARIF и *.snap), просмотра маркеров в указанном контейнере
|| + || – || +

|-
| Импорт разметки
|| Импорт разметки из файла и комментариев в исходном коде
|| Наличие полномочия делает доступным импорт разметки из файла, импорт разметки из комментариев исходного кода снимка и просмотр маркеров в указанном контейнере
|| + || – || +

|-
| Экспорт снимков
|| Экспорт данных снимков с разметкой и их открытие в IDE
|| Наличие полномочия позволяет:

* экспортировать разметку с исходными кодами;
* экспортировать снимки в форматах *.snap и SARIF;
* просматривать код с маркерами в Web-IDE
|| + || – || +

|-
| Просмотр маркеров
|| Просмотр маркеров и кода снимков, просмотр блокировок маркеров
|| Наличие полномочия предоставляет доступ к следующим функциям [[Help:UI manual#Работа в режиме разметки|в режиме разметки]]:
* просмотр и выбор снимков в указанном контейнере;
* просмотр содержимого снимков и маркеров (без возможности разметки).
Также наличие полномочия предоставляет доступ к разделу [[Help:UI manual#Управление блокировками разметки|'''Настройки – Блокировки''']], но только в части просмотра блокировок в доступных контейнерах, без возможности их удаления
|| + || + || +

|-
| Разметка маркеров
|| Просмотр и разметка маркеров в снимках, включая добавление комментариев, управление списком блокировок
|| Наличие полномочия позволяет пользователю размечать маркеры в указанном контейнере, добавлять комментарии, управлять своими блокировками, т. е. для собственных блокировок доступны кнопки удаления, а блокировки других пользователей доступны только для просмотра.
При отсутствии полномочия в таблице маркеров недоступны поля для установки флажков, а кнопка групповой разметки – неактивна.
Для разметки маркеров с помощью AI совместно с данным доступом должен быть активен доступ '''Импорт разметки'''
|| + || – || –

|-
| Report API
|| Использование Report API для получения статистических показателей
|| –
|| + || – || –
|}

=== Известные ограничения ===

* Управление ''своими'' проектами для пользователей только c серверной ролью "Create Projects" без дополнительных прав может не работать для проектов, созданных до Release 7-0-0.
: Workaround: добавить пользователю явно проектные доступы на каждый необходимый проект.

Help:CLI/cleanup

2025-12-03T13:01:32Z

Akuzmin: fix pic layout

= Автоматическое удаление снимков =

== Обзор ==

Удаление происходит по умолчанию раз в 24 часа (время можно задать при запуске сервера опцией <code>--snapshots-cleanup-period</code>, либо в конфигурационном файле, либо переменной окружения <code>SVACER_CLEANUP_SNAPSHOTS_PERIOD</code>, но не меньше 15 минут). Первое удаление всех подходящих снимков будет выполнено через указанное время после запуска сервера.

Применять может только пользователь с доступом '''ServerOperations'''.

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

== Добавление нового правила удаления ==

svacer server cleanup add-rule --user <user> --password <password> --project <project> --branch <branch> --snapshot <snapshot> --keep-time <nowiki><time></nowiki> --min-snapshots <min> --cleanup-type <type>

=== Параметры ===

* <code>--project</code> — проект, в котором искать снимки для удаления ('''обязательный''', используйте <code>"*"</code> для всех проектов)
* <code>--branch</code> — ветка, в которой искать снимки для удаления ('''обязательный''', используйте <code>"*"</code> для всех веток)
* <code>--snapshot</code> — снимок, который удалять ('''обязательный''', используйте <code>"*"</code> для всех снимков)
* <code>--keep-time</code> — время, которое должно пройти после создания '''(НЕ импорта)''' снимка, чтобы его удалить. Задается в формате Go Duration (например <code>33h5m</code>, <code>720h</code>). По умолчанию '''720 часов''' (30 дней).
* <code>--min-snapshots</code> — количество снимков, которое необходимо оставлять в ветке, подходящей под паттерн project + branch. По умолчанию 0
* <code>--cleanup-type</code> — тип очистки. Возможные значения - project, branch, snapshot (по умолчанию snapshot). При указании snapshot будут очищаться снимки в соответствии с паттерном проект+ветка+снимок и проверяться <code>keep-time</code> и <code>min-snapshots</code>. При указании branch будут удаляться пустые ветки в соответствии с паттерном project + branch. При указании project Будут удаляться пустые проекты (у которых нет веток) в соответствии с паттерном project. При указании branch или project невозможно указать <code>keep-time</code> и <code>min-snapshots</code>, эти флаги не учитываются.

=== Шаблоны и паттерны ===

Флаги <code>--project</code>, <code>--branch</code>, <code>--snapshot</code> можно задавать как:

'''1. Имя или ID:'''
--project "MyProject"
--project "550e8400-e29b-41d4-a716-446655440000" # UUID проекта

'''2. <code>*</code> (любое количество любых символов):'''
--project "Dev*" # DevProject, Development
--branch "*test*" # test, my-test, testing
--snapshot "nightly-*"

'''3. Регулярные выражения (с префиксом <code>re:</code>):'''
--snapshot "re:^v[0-9]+\.[0-9]+\.[0-9]+$" # v1.0.0, v2.3.5
--branch "re:^feature/[0-9]+$" # feature/123

== Добавление запрета на удаление ==

svacer server cleanup add-exclude-rule --user <user> --password <password> --project <project> --branch <branch> --snapshot <snapshot> --min-snapshots <min>

=== Параметры ===

* <code>--project</code> — проект, в котором искать снимки для удаления ('''обязательный''' , используйте <code>"*"</code> для всех проектов)

* <code>--branch</code> — ветка ('''обязательный''', используйте <code>"*"</code> для всех веток)
* <code>--snapshot</code> — снимок ('''обязательный''', используйте <code>"*"</code> для всех снимков)
Флаги проекта, ветки и снимка работают аналогично с флагами в <code>--add-rule</code>.

== Удаление правила ==

svacer server cleanup delete --user <user> --password <password> --id <config id>

Где:
* <code>--id</code> — ID конфигурации из таблицы правил или запретов (получить через <code>cleanup list</code>)

== Вывести таблицу ==

svacer server cleanup list --user <user> --password <password> --type <rule|exclude-rule|log> --format <table|json>

Где:
* <code>--type</code> — тип таблицы: <code>rule</code> — таблица правил удаления (по умолчанию); <code>exclude-rule</code> — таблица запретов на удаление; <code>log</code> — таблица удаленных снимков

* <code>--format</code> — формат вывода: <code>table</code> — человекочитаемый вывод (по умолчанию); <code>json</code> — JSON формат
== Запуск очистки вручную ==

svacer server cleanup run --user <user> --password <password>

Запускает процесс очистки немедленно (вне расписания).

== Примеры ==

=== Добавление нового правила ===

'''Удаление по времени'''

svacer server cleanup add-rule --user admin --password admin --project "Devel*" --branch "2025" --snapshot "*" --keep-time "240h"

Удалятся снимки старше 240 часов (10 дней) в проектах, начинающихся с "Devel", в ветке "2025".

'''Ограничение количества'''

svacer server cleanup add-rule --user admin --password admin --project "*" --branch "main" --snapshot "*" --min-snapshots 20

В любом проекте, в ветке "main" всегда будет не более 20 снимков, остальные будут удаляться.

'''Очистка пустых веток'''

svacer server cleanup add-rule --user admin --password admin --project "*" --branch "master" --cleanup-type branch

В любом проекте, в ветке "main" всегда будет не более 20 снимков, остальные будут удаляться.

=== Добавление запрета на удаление ===

svacer server cleanup add-exclude-rule --user admin --password admin --project "Devel*" --branch "2025" --snapshot "test*"

Снимки, начинающиеся с "test", в проектах "Devel*" и ветке "2025" '''никогда не удаляются правилами cleanup'''.

=== Вывод таблицы правил ===

svacer server cleanup list --user admin --password admin --type rule
[[File:Cleanup rules.png|none|thumb|955x955px]]

=== Вывод таблицы запретов ===

svacer server cleanup list --user admin --password admin --type exclude-rule
[[File:Cleanup exclude rule table.png|none|thumb|1009x1009px]]

=== Вывод в JSON формате ===

svacer server cleanup list --user admin --password admin --type exclude-rule --format json

Вывод:

[{"Branch":"2025","CreatedBy":"admin","CreatedById":"00000000-0000-0000-0000-000000000000","ID":"018fe552-f390-4110-9545-6ef9cbe1a406","MinBranchSnapshots":0,"Project":"Devel*","Snapshot":"test*","create_time":"2025-10-13T15:00:14.997004Z"}]

=== Удаление правила ===

svacer server cleanup delete --user admin --password admin --id b1895877-1f3c-4b12-ac19-3ff4a7bc5416

=== Использование regex ===

svacer server cleanup add-rule --user admin --password admin --project "*" --branch "re:^feature/JIRA-[0-9]+$" --snapshot "*" --keep-time 168h

Подходит: <code>feature/JIRA-123</code>, <code>feature/JIRA-456</code> Не подходит: <code>feature/JIRA-ABC</code>, <code>bugfix/JIRA-123</code>

=== Regex синтаксис ===

{| class="wikitable"
! Паттерн !! Описание !! Пример
|-
| <code>^</code> || Начало строки || <code>^test</code>
|-
| <code>[^x]</code> || Отрицание символов || <code>^[^m].*$</code>
|-
| <code>$</code> || Конец строки || <code>test$</code>
|-
| <code>.</code> || Любой символ || <code>a.c</code> → abc, a1c
|-
| <code>.*</code> || Любое кол-во символов || <code>test.*</code> → test-123
|-
| <code>.+</code> || Один или более || <code>test.+</code> → test-1
|-
| <code>[0-9]</code> || Любая цифра || <code>v[0-9]</code> → v1, v9
|-
| <code>[a-z]</code> || Буква (нижний регистр) || <code>[a-z]+</code> → abc
|-
| <code>[A-Z]</code> || Буква (верхний регистр) || <code>[A-Z]+</code> → ABC
|-
| <code>(a|b)</code> || "a" или "b" || <code>(test|prod)</code>
|-
| <code>[0-9]{2,4}</code> || От 2 до 4 цифр || <code>12</code>, <code>1234</code>
|}
Не поддерживается '''negative lookahead''' <code>(?!...)</code>. Используйте комбинацию правил и запретов.

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

<code>--branch "re:^(.{0,3}|.{5,}|[^m]...|m[^a]..|ma[^i].|mai[^n])$"</code>

Данное правило выбирает все ветки, кроме <code>main</code>.

Edit markers (command line)

2025-12-03T12:57:09Z

Akuzmin: move experimental note to the message box

{{Note|type=warn|text=Экспериментальная функциональность}}
== Обзор ==
Функциональность '''edit-markers''' позволяет автоматически обрабатывать маркеры при импорте данных с помощью правил, заданных в JSON-файле. Поддерживаются три типа операций:

* '''skip''' — пропуск (удаление) маркеров, соответствующих условию
* '''change''' — изменение полей маркеров
* '''deduplicate''' — объединение дублирующихся маркеров. У маркеров, подходящих под правило, объединяются уникальные трассы и остается только один маркер с наименьшим порядковым номером предупреждения (local_id) в файле результатов анализа. Остальные маркеры удаляются.
Все операции происходят на стороне клиента до загрузки данных на сервер. При импорте результатов Svace, а также sarif (без указания флага --upload) изменяется .svacer-dir. Директория .svace-dir остается неизменной. Снимок остается неизменным при импорте.

Данный функционал работает со снимками, созданными Svacer версии 7-0-0 и новее. Если у вас более старый снимок, то импортируйте и экспортируйте его для возможности работы с edit-markers.

== Использование ==

=== Импорт результатов Svace ===
<code>svacer import --edit-markers <файл_правил.json> [другие опции]</code>

Применяет правила редактирования к маркерам при импорте результатов анализа Svace.

=== Импорт SARIF ===
<code>svacer sarif2 import --edit-markers <файл_правил.json> [другие опции]</code>

Применяет правила при импорте SARIF-файлов.

=== Импорт снимка с редактированием ===
<code>svacer server import --edit-markers <файл_правил.json> [другие опции]</code>

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

<code>svacer server import --edit-markers rules.json --save-edited-snapshot edited_snapshot.snap</code>

== Формат файла правил ==
Правила задаются в виде JSON-файла, содержащего массив объектов правил:
[
{
"action": "тип_действия",
"rules": "условие_или_список_полей",
"change": { /* только для action: "change" */ }
},
...
]

=== Типы действий ===

==== skip — Пропуск маркеров ====
Удаляет маркеры, соответствующие условию.
...
{
"action": "skip",
"rules": "file == 'test.cpp' and line > 100"
}
...

==== change — Изменение маркеров ====
Изменяет указанные поля маркеров.
...
{
"action": "change",
"rules": "warnclass == 'UNREACHABLE_CODE'",
"change": {
"warnclass": "IGNORED",
"msg": "Код помечен как недостижимый"
}
}
...
Доступные поля для изменения: <code>warnclass</code>, <code>msg</code>, <code>lang</code>, <code>tool</code>, <code>file</code>, <code>details</code>, <code>line</code>, <code>mtid</code>, <code>function</code>.

==== deduplicate — Дедупликация ====
Объединяет маркеры с одинаковыми значениями указанных полей. Один маркер выбирается случайно, все trace от остальных маркеров добавляются к нему.
...
{
"action": "deduplicate",
"rules": "file,line,warnclass"
}
...
Поля для группировки (можно указать от 1 до 8): <code>file</code>, <code>line</code>, <code>function</code>, <code>warnclass</code>, <code>lang</code>, <code>tool</code>, <code>mtid</code>, <code>details</code>.

== Доступные поля и операторы ==

=== Поля маркеров ===
В условиях можно использовать следующие поля:

* <code>file</code> — полный путь к файлу (строка)
* <code>line</code> — номер строки (число)
* <code>function</code> — имя функции (строка)
* <code>warnclass</code> — класс предупреждения (строка)
* <code>lang</code> — язык программирования (строка)
* <code>tool</code> — инструмент анализа (строка)
* <code>mtid</code> — ID типа маркера (строка)
* <code>msg</code> — сообщение маркера (строка)
* <code>details</code> — детали маркера (строка)

=== Операторы сравнения ===

* <code>==</code>, <code>!=</code> — равно, не равно
* <code>></code>, <code>>=</code>, <code><</code>, <code><=</code> — сравнение чисел
* <code>and</code>, <code>or</code>, <code>&&</code>, <code>||</code> — логические операторы
* <code>not</code>, <code>!</code> — логическое НЕ
* <code>in</code> — проверка вхождения в список (например: <code>warnclass in ['ERROR', 'WARNING']</code>)
* <code>contains</code> — проверка вхождения подстроки

=== Функции для работы со строками ===

* <code>icontains(s, substring)</code> — содержит подстроку (без учета регистра)
* <code>hasPrefix(s, prefix)</code> — начинается с префикса
* <code>hasSuffix(s, suffix)</code> — заканчивается суффиксом
* <code>equalsFold(a, b)</code> — сравнение строк без учета регистра
* <code>lower(s)</code> — преобразование в нижний регистр
* <code>upper(s)</code> — преобразование в верхний регистр
* <code>trim(s)</code> — удаление пробелов в начале и конце строки
* <code>replace(s, old, new)</code> — замена всех вхождений подстроки
* <code>regex(s, pattern)</code> — проверка соответствия регулярному выражению
* <code>nregex(s, pattern)</code> — проверка НЕсоответствия регулярному выражению

== Примеры ==
Часть примеров используют снимок [https://svacer.ispras.ru/mediawiki/images/6/66/Bash.zip bash]. Детекторы в данном снимке выглядят так:
[[File:Edit-markers-1.png|center|thumb|967x967px]]

=== Пропуск файлов ===
В данном примере будут пропущены все файлы, которые находятся в папке <code>/.build/lib</code>
[
{
"action": "skip",
"rules": "file contains '/.build/lib'"
}
]
Сравнивая исходный снимок и снимок, где было применено edit-markers можно увидеть 215 пропущенных детекторов. Все они находятся в папке <code>/.build/lib</code>
[[File:Edit-markers-2.png|center|thumb|983x983px]]
Если необходимо указать название не зависимо от регистра, то можно использовать функцию <code>icontains</code>:

<code>[ { "action": "skip", "rules": "icontains(file, '/.build/lib')" } ]</code>

Также после применения edit-markers в информации о снимке указывается, какие правила были применены
[[File:Edit-marker.png|center|thumb|971x971px]]

=== Изменение класса предупреждений ===
При необходимости возможно изменение полей маркера. В данном примере изменим warnclass маркеров у которых в названии есть <code>UNREACHABLE_CODE</code> и находящиеся после 1000 строки, но детектор <code>UNREACHABLE_CODE</code> изменять не будем.
[
{
"action": "change",
"rules": "warnclass contains 'UNREACHABLE_CODE' and line > 1000",
"change": {
"warnclass": "UNREACHABLE",
"msg": "Изменено правилами edit markers"
}
}
]
[[File:Edit-markers-3.png|center|thumb|955x955px]]
Указанные маркеры изменили свой детектор и описание.

{{Note|text=Серьезность, Надежность и CWE привязаны к названию warnclass (детектора), поэтому, если указать''' '''несуществующий warnclass, то данные поля пропадут.}}

=== Удаление дубликатов ===
Если необходимо объединить несколько детекторов в один по одинаковым полям, то возможно сделать следующее действие (в качестве полей rules можно указать 8 возможных значений, см. описание deduplicate).
Например, в снимке содержится множество одинаковых детекторов в одном файле на одной строке.
[[File:Edit-markers-dedup.png|center|thumb|933x933px]]
Применив следующее правило все маркеры, которые находятся в одном файле, с одним детектором и на одной строке объединятся в один: выберется один с наименьшим порядковым номером предупреждения в файле результатов анализа (local_id) и у него будет объединенные уникальные трассы всех остальных маркеров.
[
{
"action": "deduplicate",
"rules": "file,warnclass,line"
}
]
[[File:Edit-markers-dedup2.png|center|thumb|948x948px]]
В данном примере у всех маркеров <code>UNUSED_FIELD</code> на строке 11 в файле <code>AddInstruction.cs</code> была трасса состоящая из трёх ролей: detected, info, Current function name. Роль detected полностью совпадала во всех маркерах, она была включена один раз, а все остальные роли добавились в объединенный маркер. Оставшиеся дублирующие маркеры были удалены.

=== Комплексный пример ===
В данном примере пропускаются все маркеры, у которых инструмент равен <code>CSA</code>, а маркеры, которые имеют детекторы <code>'BAD_COPY_PASTE', 'DEREF_AFTER_NULL', 'UNUSED_VALUE'</code> или имеют в описании подстроку <code>unsafe</code> в любом регистре, меняют детектор и описание.
[
{
"action": "skip",
"rules": "tool == 'CSA'"
},
{
"action": "change",
"rules": "warnclass in ['BAD_COPY_PASTE', 'DEREF_AFTER_NULL', 'UNUSED_VALUE'] or icontains(msg, 'unsafe')",
"change": {
"warnclass": "HIGH_PRIORITY",
"msg": "Высокоприоритетное предупреждение"
}
}
]
При сравнении с исходным снимком можно заметить, что 91 предупреждение, у которых инструмент был <code>CSA</code>, удалены из измененного снимка.
[[File:Edit-markers-5.png|center|thumb|979x979px]]
Также были изменены маркеры, в соответствии с правилами.
[[File:Edit-markers-51.png|center|thumb|980x980px]]

=== Изменение приоритета для определенных классов ===
Изменение детекторов:
[
{
"action": "change",
"rules": "warnclass in ['UNREACHABLE_CODE.TERMINATION', 'UNREACHABLE_CODE.RET', 'UNREACHABLE_CODE.ENUM']",
"change": {
"warnclass": "UNREACHABLE_CODE"
}
}
]

=== Обработка сгенерированных файлов ===
Пропускаем все маркеры в сгенерированных файлах:

[
{
"action": "skip",
"rules": "file contains 'generated' or hasPrefix(file, 'vendor/')"
}
]

=== Дедупликация с последующей фильтрацией ===
Сначала объединяем дубликаты, потом удаляем ненужные:
[
{
"action": "deduplicate",
"rules": "file,line,warnclass,function"
},
{
"action": "skip",
"rules": "icontains(file, 'third_party') or icontains(file, 'external')"
}
]

=== Работа с регулярными выражениями ===
В данном примере будут пропущены маркеры, путь к файлу которых НЕ соответствует регулярному выражению. В результате в снимке останутся только маркеры из файлов с расширениями <code>.c</code>, <code>.cpp</code>, <code>.h</code> или <code>.hpp</code>, находящихся в директории <code>/.build/builtins</code>. В данном случае мы дважды экранируем: сначала слэш, а потом точку.
[
{
"action": "skip",
"rules": "nregex(file, \"^/\\\\.build/builtins/.*\\\\.(c|cpp|h|hpp)$\")"
}
]
В результате у нас остаются только подходящие маркеры:
[[File:Edit-markers-8.png|center|thumb|979x979px]]

== Дополнительные опции ==

=== Сохранение отредактированного снимка ===
При импорте снимка можно сохранить результат применения правил:
svacer server import --edit-markers rules.json --save-edited-snapshot result.snap ...
Обязательно должно быть расширение <code>.snap</code> для сохранения.

== Важные замечания ==

# '''Порядок правил''' — правила применяются последовательно в порядке их описания в файле
# '''Валидация''' — при загрузке правил проверяется корректность JSON и соответствие полей
# '''Формат файла''' — файл правил должен иметь расширение <code>.json</code>
# '''Логирование''' — результат применения правил выводится в лог (количество обработанных и удаленных маркеров)
# '''Поле line в change''' — должно быть строкой с неотрицательным числом
# '''Поле warnclass в change''' — может принимать только русские и английские буквы, цифры, а также специальные символы, которые находятся на цифровой панели клавиатуры (и печатаются через Shift)

Afilters

2025-12-03T11:17:45Z

Akuzmin: add time package link

= Advanced filters =
Поле "Расширенный фильтр" в пользовательских фильтрах предназначено для фильтрации маркеров (предупреждений) по сложным предикатам.
[[File:Image-afilters-prop.png|thumb]]
Предикат может использовать:

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

Формат фильтра определяется следующим шаблоном:

filter(markers, <predicate expr>)

Выражение <code><predicate expr></code> определяет предикат. Объект <code>markers</code> содержит массив маркеров из контекста, функция <code>filter</code> фильтрует данный список по предикату. Таким образом, применение фильтра заключается в фильтрации списка маркеров по указанному предикату.

== Список доступных полей ==

=== Поля маркера (предупреждения) ===

* <code>Comments</code> — список комментариев маркера. Объект типа Comment (смотрите ниже)
* <code>Details</code> — информация, специфичная для анализатора. Ближайший аналог — fingerprint в SARIF
* <code>File</code> — имя файла
* <code>Function</code> — имя функции, может быть mangled для С++
* <code>ID</code> — UUID маркера
* <code>Invariant</code> — инвариант маркера. Используется для автопереноса разметки между снимками
* <code>Lang</code> — язык детектора
* <code>Line</code> — номер строки в файле
* <code>LocID</code> — порядковый номер маркера относительно изначального отчета анализатора
* <code>MTid</code> — шаблон сообщения
* <code>Msg</code> — текст сообщения
* <code>OrigFunc</code> — 'человекочитаемое' имя функции. Может быть недоступно
* <code>Tags</code> — список тегов (меток) маркера
* <code>Tool</code> — модуль анализатора, ответственного за данный детектор
* <code>Traces</code> — список трасс маркера. Объект типа Trace (смотрите ниже)
* <code>WarnClass</code> — название детектора/класса детекторов

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

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

* <code>severity(item) string</code> — серьезность детектора (чекера)

Пример:

filter(markers, severity(#) == "Critical")

'''Внимание:''' использование в предикатах поля <code>Trace</code> может сказаться на скорости применения фильтра, т. к. загрузка большого числа трасс может занять время.

=== Данные о разметке ===
Поддерживаются следующие функции для получения информации о разметке:

* <code>status(item) string</code> — статус разметки текущего маркера. Пример: <code>filter(markers, status(#) == "Confirmed")</code>
* <code>action(item) string</code> — статус поля action текущего маркера. Пример: <code>filter(markers, action(#) == "Ignore")</code>
* <code>mseverity(item) string</code> — статус поля severity текущего маркера (не путать с severity детектора). Пример: <code>filter(markers, mseverity(#) == "Critical")</code>
* <code>triaged(item) bool</code> — возвращает true, если маркер имеет не дефолтную разметку. Пример: <code>filter(markers, triaged(#))</code>
* <code>get_triaged_by(item) UserInfo</code> — возвращает структуру с информацией о пользователе, кто произвел разметку

Поля структуры <code>UserInfo</code>:

* <code>login: string</code> — логин пользователя
* <code>create_ts: Time (UTC)</code> — время разметки в UTC формате (RFC3339)

=== Комментарии ===
Объекты типа <code>Comment</code> содержатся в поле <code>Comments</code> маркера. Объект имеет следующие поля:

* <code>ID</code> — UUID комментария
* <code>Text</code> — текст комментария
* <code>CreatedBy</code> — имя пользователя, кто создал комментарий
* <code>CreateTs</code> — время создания комментария (объект типа <code>time.Time</code>)
* <code>UpdateTs</code> — время обновления комментария (объект типа <code>time.Time</code>), может быть пустым
* <code>UpdatedBy</code> — имя пользователя, кто обновил комментарий

=== Трассы ===
Маркер может содержать трассу маркера в поле <code>Traces</code>. Трасса описывается следующими структурами:
type Trace struct {
Role string
Locations []TraceEntry
}
type TraceEntry struct {
File string
Line uint32
Col uint32
Info string
}

Доступ к полям объекта <code>Trace</code> может выполняться, используя правила языка <code>go-expr</code>, описанные ниже.

Имена полей могут использоваться в виде как описано выше, либо в формате lowercase: <code>role, locations, file, line, col, info</code>

Пример:
filter(markers, any(.Comments, .Text == "Test") &&
any(.Traces, any(.Locations, .Info == "Boolean expression has constant value"))
)

=== Поля снимка ===
Для доступа к полям снимка можно использовать переменную <code>snapshot</code>. Переменная имеет тип структуры со следующими полями

struct {
ID string
Name string
SerialID uint32
BuildObject string
ResultsObject string
ImportTime time.Time
CreatedBy string
CreatedByID string
Details map[string]any
CreateTime time.Time
SourcesAvailable bool
}
Имена полей могут использоваться в виде, где первая буква в lowercase.

Объекты в поле <code>Details</code> можно просмотреть, нажав на кнопку <code>View JSON</code> в WebUI в поле <code>Snapshot Information</code>.

Пример:
filter(markers,
snapshot.buildObject == "5b634b75422bd554a8569cc10bfadc3aea77b73e" &&
.warnClass matches "DEREF"
)

== Описание языка предикатов ==
Для написания предикатов используется язык '''Expr'''. Детальное описание всех возможностей можно найти здесь: https://github.com/expr-lang/expr

Далее описываются конструкции, наиболее подходящие для написания правил фильтрации.

=== Литералы ===
Comment /* */ or //
Boolean true, false
Integer 42, 0x2A, 0o52, 0b101010
Float 0.5, .5
String "foo", 'bar'
Array [1, 2, 3]
Map {a: 1, b: 2, c: 3}
Nil nil

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

Пример однострочного текста:
"Hello\nWorld"

Пример многострочного текста:
`Hello
World`

В многострочном тексте escape-последовательности не поддерживаются.

=== Операторы ===
Arithmetic: +, -, *, /, % (modulus), ^ or ** (exponent)
Comparison: ==, !=, <, >, <=, >=
Logical: not or !, and or &&, or or ||
Conditional: ?: (ternary), ?? (nil coalescing), if {} else {} (multiline)
Membership: [], ., ?., in
String: + (concatenation), contains, startsWith, endsWith
Regex: matches
Range: ..
Slice: [:]
Pipe: |

=== Операторы доступа к полю объекта ===
Можно использовать оператор <code>.</code> и оператор <code>[]</code>:
user.Name
user["Name"]

=== Оператор in ===
Оператор <code>in</code> для проверки наличия объекта в массиве или мэпе:
"John" in ["John", "Jane"]
"name" in {"name": "John", "age": 30}

=== Optional chaining ===
Оператор <code>?.</code> может использоваться для доступа к полю структуры или элементу отображения (map) без необходимости проверки, является ли структура или отображение равными <code>nil</code>. Если структура или отображение имеют значение <code>nil</code>, результатом выражения будет <code>nil</code>.

Пример вида:
author.User?.Name

значит то же самое, что:
author.User != nil ? author.User.Name : nil

=== Nil coalescing ===
Оператор <code>??</code> может использоваться для возврата левого операнда, если он не равен <code>nil</code>, в противном случае возвращается правый операнд.

Пример вида:
author.User?.Name ?? "Anonymous"

значит то же самое, что:
author.User != nil ? author.User.Name : "Anonymous"

=== Оператор конвейера ===
Оператор конвейера <code>|</code> может использоваться для передачи результата выражения левого операнда в качестве первого аргумента выражения правого операнда.

Пример вида:
user.Name | lower() | split(" ")

значит то же самое, что:
split(lower(user.Name), " ")

=== Предикаты ===
Предикат — это выражение. Предикаты можно использовать в функциях, таких как <code>filter, all, any, one, none</code> и других.
filter(0..9, {# % 2 == 0})
filter(tweets, {len(.Content) > 240})

Скобки <code>{ }</code> можно опускать:
filter(tweets, len(.Content) > 240)

=== Операции над строками ===
trim(str[, chars])
trimPrefix(str, prefix)
trimSuffix(str, suffix)
upper(str)
lower(str)
indexOf(str, substring)
lastIndexOf(str, substring)
hasPrefix(str, prefix)
hasSuffix(str, suffix)

Также есть оператор <code>matches</code> для поиска регулярного выражения в строке:
str matches "regular expression"

Для сопоставления целой строки с регулярным выражением следует использовать вариант:
str matches "^regex$"

=== Функции времени ===
Поддерживаются Go типы для времени и интервалов: <code>time.Time</code>, <code>time.Duration</code> из [https://pkg.go.dev/time time package].

Можно использовать операции сложения и вычитания над объектами с типом <code>time.Time</code>.

createdAt - now()
createdAt + duration("1h")
createdAt > now() - duration("1h")

date("2023-08-14")
date("15:04:05")
date("2023-08-14T00:00:00Z")
date("2023-08-14 00:00:00", "2006-01-02 15:04:05", "Europe/Zurich")

=== Функции над массивами ===
* <code>all(array, predicate)</code> — все объекты должны удовлетворять предикату
* <code>any(array, predicate)</code> — должен быть по крайней мере один объект, который удовлетворяет предикату
* <code>one(array, predicate)</code> — должен быть только один объект, который удовлетворяет предикату
* <code>none(array, predicate)</code> — ни один объект не должен удовлетворять предикату
* <code>find(array, predicate)</code> — возвращает первый объект, который удовлетворяет предикату
* <code>findLast(array, predicate)</code> — возвращает последний объект, который удовлетворяет предикату
* <code>count(array[, predicate])</code> — возвращает число объектов, удовлетворяющих предикату
* <code>first(array)</code> — первый объект из массива
* <code>last(array)</code> — последний объект из массива

Примеры:
all(tweets, {.Size < 280})
any(tweets, {.Size > 280})
none(tweets, {.Size > 280})
find([1, 2, 3, 4], # > 2) == 3
findLast([1, 2, 3, 4], # > 2) == 4
count(users, .Age > 18)
first([1, 2, 3]) == 1
last([1, 2, 3]) == 3

Help:UI manual

2025-12-03T11:14:09Z

Akuzmin: add advanced filters page link

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

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

Для авторизации в пользовательском интерфейсе сервера Svacer введите логин и пароль на странице ввода учётных данных. Учётные данные по умолчанию — admin / admin.
[[File:Авторизация 01.png|thumb|none|x300px|alt=AutorizationMain|Страница ввода учетных данных]]

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

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

[[File:Авторизация LDAP 02.png|thumb|none|x300px|alt=AutorizationLDAP|Страница входа по протоколу LDAP]]

После успешного входа отобразится пользовательский интерфейс сервера Svacer. При этом, если в прошлой сессии пользователь [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выбрал проект, его ветку и снимок]] или [[Help:UI manual#Использование фильтров|применил фильтры]], отобразятся эти проект, ветка и фильтры.

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

{{Note|type=info|text=''Чтобы после обновления системы в пользовательском веб-интерфейсе корректно отображались изменения, после авторизации обновите страницу в браузере – нажмите клавишу F5.''}}

== Описание основных элементов пользовательского интерфейса ==
Все страницы пользовательского интерфейса сервера Svacer устроены единообразно и состоят из двух частей:
# Верхняя панель – отображается на всех страницах пользовательского интерфейса. Содержит:
#* логотип сервера Svacer;
#* кнопки меню:
#** '''Разметка''' – [[Help:UI manual#Работа в режиме просмотра кода|просмотр и разметка найденных маркеров]], а также [[Help:UI manual#Сравнение снимков и маркеров|сравнение снимков или отдельных маркеров]];
#** '''Код''' – [[Help:UI manual#Работа в режиме разметки|просмотр снимков исходного кода]], связанного с результатами анализатора Svace;
#** '''Проекты''' – [[Help:UI manual#Управление проектами и группами проектов|управление проектами]] (режим доступен только пользователям с ролью admin);
#** '''Детекторы''' – [[Help:UI manual#Просмотр детекторов|просмотр списка детекторов]];
#** '''Статистика''' – [[Help:UI manual#Просмотр статистики|просмотр статистики разметки]] по всем проектам, веткам и снимкам, доступным пользователю;
#** '''Поиск''' – [[Help:UI manual#Глобальный поиск|глобальный поиск]] снимков, маркеров и комментариев к ним;
#* [[File:Icon settings.png|x25px]] – кнопка для перехода к [[Help:UI manual#Настройка сервера Svacer|настройке системы]];
#* [[File:Icon RuEng.png|x25px]] – переключатель языка пользовательского интерфейса;
#* [[File:Icon question mark.png|x25px]] – кнопка для перехода на страницу документации к системе;
#* [[File:Icon bell.png|25px]] – кнопка для перехода к [[Help:UI manual#Просмотр уведомлений в интерфейсе Системы|уведомлениям]];
#* [[File:Icon profile.png|x25px]] – кнопка меню пользователя, которое предоставляет следующие функции:
#** [[Help:UI manual#Настройка профиля пользователя|настройка профиля пользователя]];
#** [[Help:UI manual#Настройка интерфейса|настройка интерфейса]];
#** [[Help:UI manual#Настройка уведомлений|настройка уведомлений]];
#** [[Help:UI manual#Управление лицензией|управление лицензией]];
#** [[Help:UI manual#Просмотр информации о программе|просмотр информации о программе]];
#** [[Help:UI manual#Выход из системы|выход из системы]].
# Рабочая область – область экрана для просмотра информации и ввода, которая соответствует выбранному режиму работы или странице настроек.

:[[File:03 Основные элементы интерфейса – без VSCode.png|thumb|none|upright=3]]

== Базовые функции системы ==
=== Просмотр уведомлений в интерфейсе Системы===
Чтобы посмотреть уведомления, нажмите кнопку [[File:Icon bell.png|25px]] в правом верхнем углу экрана.

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

[[File:Notifications new.png|thumbnone|x300px|alt=NotificationList|Панель уведомлений]]

Нажмите кнопку [[File:Icon cross 01.png|15px]] для удаления уведомления.

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

=== Настройка профиля пользователя ===
Для перехода в профиль выберите пункт '''Профиль''' в меню пользователя в правом верхнем углу экрана:
[[File:06 Меню пользователя — без VSCode.png|thumb|none|250px|alt=UserMenu|Меню пользователя. Переход к настройке профиля]]

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

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

=== Изменение пароля ===
Для изменения пароля:
:1. Выберите пункт '''Профиль''' в меню пользователя.
:2. В разделе '''Профиль пользователя''' нажмите на ссылку '''Изменить пароль''':
:[[File:10_Профиль_изменение пароля.png|thumb|none|450px|Переход к изменению пароля в профиле пользователя]]
:3. В открывшемся окне:
::а) Введите текущий пароль.
::б) Дважды введите новый пароль.
::в) Нажмите кнопку '''Изменить'''.
::[[File:11_Профиль_ввод нового пароля.png|thumb|none|350px|Окно изменения пароля]]

=== Настройка интерфейса ===
Для перехода к настройкам выберите пункт '''Настройки интерфейса''' в меню пользователя в правом верхнем углу экрана:
[[File:187 Меню пользователя интерфейс.png|thumb|none|250px|alt=UserMenu|Меню пользователя. Переход к настройке интерфейса]]

В правой части экрана отобразится панель '''Настройки интерфейса''' с тремя группами параметров:
:1. '''Общие'''. Параметры этой группы позволяют:
::а) Выбрать фильтры, которые будут по умолчанию применяться при повторном входе в систему:
::*фильтры, установленные в предыдущей сессии (выбрано по умолчанию);
::*сохраненный пользовательский фильтр.
::б) Включить или выключить (выбрано по умолчанию) замену снимка на последний загруженный в БД Svacer снимок при открытии сохраненного контекста.
::Если параметр в состоянии «Выключен», при выборе проекта и ветки открывается последний импортированный снимок.
::в) Включить или выключить (выбрано по умолчанию) сохранение вкладок с открытыми файлами в каждом контексте.
::г) Включить (выбрано по умолчанию) или выключить сохранение применённой сортировки значений в таблице маркеров при [[Help:UI manual#Выход из системы|выходе из системы]].
::д) Включить или выключить (выбрано по умолчанию) механизм генерации PDF-файла на основе HTML при выгрузке отчета с [[Help:UI manual#Таблица маркеров|информацией о маркерах]].
{{Note|type=warn|text=''Для использования генерации PDF на основе HTML на сервере Svacer должен быть [[Help:Installation#Браузер для PDF-отчетов|установлен браузер Chromium или Google Chrome]].''}}
:[[File:08 общие настройки интерфейса.png|thumb|none|600px|alt=UserInterfaceSettings|Настройки интерфейса. Группа параметров «Общие»]]
:2. '''Навигационная панель'''. Параметры этой группы позволяют:
::а) Выбрать отображение по умолчанию данных [[Help:UI manual#Вкладка «Детекторы»|на вкладке '''Детекторы''']] навигационной панели:
::*группировка детекторов по уровням серьезности (выбрано по умолчанию);
::*отображение детекторов в виде списка.
:::Выбранное отображение будет применяться [[Help:UI manual#Вкладка «Детекторы»|на вкладке '''Детекторы''']] каждый раз после входа в систему.
::б) Выбрать отображение по умолчанию данных [[Help:UI manual#Вкладка «Файлы»|на вкладке '''Файлы''']] навигационной панели:
::*только имя файла (выбрано по умолчанию);
::*полный путь к файлу.
::в) Выбрать способ сортировки в колонке '''Маркеры''' [[Help:UI manual#Вкладка «Файлы»|на вкладке '''Файлы''']] панели навигации:
::*по общему количеству маркеров (выбрано по умолчанию);
::*по количеству размеченных маркеров.
:[[File:08_настройки навигационной панели.png|thumb|none|600px|alt=UserInterfaceSettings|Настройки интерфейса. Группа параметров «Навигационная панель»]]
:3. '''Просмотр кода'''. Параметры этой группы позволяют:
::а) Включить (выбрано по умолчанию) или выключить использование темной темы (темный фон, светлый текст) при просмотре файлов с исходным кодом.
::б) Включить или выключить (выбрано по умолчанию) переиспользование [[Help:UI manual#Вкладка с исходным кодом|вкладки с исходным кодом]] в редакторе кода.
::в) Включить или выключить (выбрано по умолчанию) отображение всех элементов трассы маркера по нажатии на ссылку '''Показать трассу''' [[Help:UI manual#Вкладка с исходным кодом|в виджете маркера]].
::Если параметр находится в состоянии «Выключен», то будет отображаться только первый элемент трассы.
::г) Выбрать отображение виджета относительно строки кода, с которой он связан:
::* над строкой кода (выбрано по умолчанию);
::* под строкой кода.
:[[File:08 настройки просмотра кода.png|thumb|none|600px|alt=UserInterfaceSettings|Настройки интерфейса. Группа параметров «Просмотр кода»]]
:Эти настройки сохраняются для учётной записи пользователя и не сбрасываются при новой сессии.
:Чтобы сбросить параметры любой группы к значениям по умолчанию, нажмите на ссылку '''Сбросить настройки''' внизу панели '''Настройки интерфейса'''.

=== Настройка уведомлений ===
Система может уведомлять пользователей по каналам E-mail и Telegram о следующих типах операций:
* добавление (при импорте, копировании, клонировании) и удаление снимков;
* изменение разметки маркеров;
* добавление комментариев к маркерам.

Для перехода к настройкам выберите пункт '''Настройки уведомлений''' в меню пользователя в правом верхнем углу экрана:
[[File:188 Меню пользователя - уведомления.png|thumb|none|250px|Меню пользователя. Переход к настройке уведомлений]]

В правой части экрана отобразится панель '''Настройки уведомлений''' с двумя группами параметров:
:1. '''Типы уведомлений'''. Параметры этой группы позволяют выбрать канал, по которому будут приходить уведомления, настроить и проверить его. Для этого:
::а) Включите опцию '''E-mail''' и (или) '''Telegram chat ID'''.
::При выборе уведомления по '''E-mail''' используется адрес электронной почты, указанный [[Help:UI manual#Настройка профиля пользователя|в профиле пользователя]].
::б) При выборе уведомления по '''Telegram''' введите '''Telegram chat ID'''.
::в) Чтобы проверить подключение к каналу нажмите кнопку '''Проверить'''.
::Отправится тестовое сообщение по указанным реквизитам:
::[[File:189 Настройки уведомлений.png|thumb|thumb|none|600px|alt=UserInterfaceSettings|Настройки уведомлений]]
:2. '''Подписки'''. Позволяют выбрать проекты, ветки и события, при возникновении которых будут приходить уведомления. Для этого:
::а) Для добавления подписки нажмите кнопку '''Добавить''' и в появившейся строке в раскрывающемся списке выберите проект и/или его ветку.
::Чтобы уведомления приходили при изменениях во всех проектах, доступных пользователю, выберите значение '''Все''' в раскрывающемся списке проектов.
::[[File:190 Настройки уведомлений. Выбор ветки.png|thumb|thumb|none|600px|alt=UserInterfaceSettings|Настройки уведомлений. Выбор ветки]]
::б) Выберите объекты, при изменении которых будут приходить уведомления – установите флажки в столбцах '''Снимки''', '''Разметка''', '''Комментарии'''.
::в) Если требуется получать уведомления о разметке и/или комментариях только в маркерах, в которых пользователь принимал участие, установите флажок в столбце '''Участие''' (доступен, только если установлены флажки в столбцах '''Разметка''' и/или '''Комментарии''').
::г) Для настройки исключения из подписки на уведомления нажмите кнопку [[File:Icon plus.png|x25px]].
::Кнопка примет вид [[File:Icon minus.png|x25px]].
::д) Для удаления подписки на уведомления нажмите кнопку [[File:Icon minus.png|x25px]].
::По окончании настройки уведомлений нажмите кнопку '''Сохранить'''.

=== Управление лицензией ===
{{Note|type=info|text=''В версии сервера Svacer 12.0.0 лицензия встроена в дистрибутив и не ограничивает функции системы. Срок действия встроенной лицензии – до 31.12.2027 г.''}}

Чтобы посмотреть текст лицензии системы и копировать его, а также для активации новой лицензии, выберите пункт '''Лицензия''' в меню пользователя в правом верхнем углу экрана.
В правой части экрана отобразится панель '''Лицензия'''.
[[File:231 Меню пользователя Переход к просмотру лицензии.png|thumb|none|450px|Меню пользователя. Переход к просмотру лицензии]]
[[File:232 Панель Лицензия.png|thumb|none|x400px|Панель «Лицензия»]]

Чтобы скопировать текст лицензии, нажмите кнопку [[File:Icon copy link.png|x15px]].
Чтобы активировать лицензию:
:1. Нажмите на ссылку '''Активировать новую'''.
:2. В открывшемся окне '''Активация лицензии''' введите лицензионный ключ и нажмите кнопку '''Активировать'''.
{{Note|type=warn|text=''Функция активации лицензии доступна пользователям с [[#Серверные доступы|серверным доступом]] '''Администрирование сервера'''.''}}
[[File:233 Окно Лицензия.png|thumb|none|600px|Окно «Активация лицензии»]]

=== Просмотр информации о программе ===
Чтобы посмотреть информацию о программе, выберите пункт '''О программе''' в меню пользователя в правом верхнем углу экрана.
[[File:12_Меню пользователя_о программе — без VSCode.png|thumb|none|250px|Меню пользователя. Переход к просмотру информации о программе]]

Откроется окно с информацией о программе
[[File:13 1 О программме.png|none|thumb|600x600px|Информация о программе]]
Нажмите на ссылку в строке '''Документация и релизы''' для перехода на страницу документации к системе и ссылкам для скачивания дистрибутивов релизов Svacer.

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

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

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

== Выбор контекста (проекта, ветки и снимка) ==
Для работы [[Help:UI manual#Работа в режиме разметки|в режиме разметки]] или [[Help:UI manual#Работа в режиме просмотра кода|режиме просмотра кода]] требуется выбрать проект, ветку и снимок с результатами работы анализатора Svace.

При необходимости список проектов можно отфильтровать по группе проектов. Это можно сделать в блоке, который расположен под [[Help:UI manual#Описание основных элементов пользовательского интерфейса|верхней панелью]].

[[File:14_Выбор проекта, верки, снимка.png|800px]]

По умолчанию после выбора проекта автоматически выбирается ветка master и последний импортированный снимок, если [[Help:UI manual#Настройка интерфейса|параметр '''При открытии сохраненного контекста заменить снимок на последний загруженный''']] находится в состоянии '''Выключен'''. Если master отсутствует, то ветку нужно выбрать вручную.

== Работа в режиме разметки ==
Режим разметки предоставляет следующий набор элементов управления:
:1. Навигационная панель:
:* [[Help:UI manual#Вкладка «Детекторы»|вкладка '''Детекторы''']];
:* [[Help:UI manual#Вкладка «Файлы»|вкладка '''Файлы''']].
:Эту панель можно скрыть. Для этого нажмите кнопку [[File:Button Скрыть навигацию.png|x25px]] в правом верхнем её углу. Чтобы панель раскрыть, нажмите кнопку [[File:Button Паказать навигацию.png|x25px]].
:2. Центральная панель:
:* [[Help:UI manual#Вкладка «Информация о снимке»|вкладка '''Информация о снимке''']] – открывается по нажатии кнопки [[File:Icon Information.png|25x25px]];
:* одна или несколько [[Help:UI manual#Вкладка с исходным кодом|вкладок с исходным кодом''']] (отображаются после выбора файлов в таблице маркеров или навигационной панели);
:* [[Help:UI manual#Таблица маркеров|таблица маркеров]];
:3. [[Help:UI manual#Функции правой панели|Правая панель]] с информацией о маркере.
:Эту панель можно скрыть. Для этого нажмите кнопку [[File:Button Паказать навигацию.png|x25px]] в левом верхнем её углу. Чтобы панель раскрыть, нажмите кнопку [[File:Button Скрыть навигацию.png|x25px]].

[[File:96 Режим разметки. Набор элементов управления.png|800px|thumb|none|Режим разметки. Набор элементов управления]]

=== Функции навигационной панели ===
==== Вкладка «Детекторы» ====
На этой вкладке отображается список детекторов Svace, которые сработали в выбранном снимке.

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

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

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

[[File:17 Файлы.png|thumb|none|300px|Вкладка '''Файлы''']]

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

На вкладке '''Файлы''' пользователю доступны следующие функции:
:1. Просмотр на [[Help:UI manual#Вкладка с исходным кодом|вкладке с исходным кодом]]: содержимого файла, места и содержания маркера, а также подробной информации о маркере [[Help:UI manual#Функции правой панели|на правой панели]] – без включения фильтрации по этому файлу. Для этого нажмите на имя файла.
:2. Применение фильтра по файлам [[Help:UI manual#Таблица маркеров|в таблице маркеров]] – для этого нажмите кнопку [[File:Icon plus.png|x25px]] в одной или нескольких строках.
:Фильтр применится, кнопка [[File:Icon plus.png|x25px]] в списке файлов поменяется на [[File:Icon minus.png|x25px]].
:3. Исключение файла из фильтра по файлам [[Help:UI manual#Таблица маркеров|в таблице маркеров]] – для этого нажмите кнопку [[File:Icon minus.png|x25px]] в строке файла.
:4. Отмена фильтрации [[Help:UI manual#Таблица маркеров|в таблице маркеров]] для всех выбранных файлов – для этого нажмите кнопку [[File:Icon minus 3.png|x25px]] или кнопку [[File:icon_return.png|x25px]] [[Help:UI manual#Вкладка «Детекторы»|на вкладке '''Детекторы''']].
:5. [[Help:UI manual#Блокировка разметки|Блокировка всех маркеров]] в файле для разметки другими пользователями – для этого нажмите кнопку [[File:icon_unlocked.png|x25px]] справа от названия файла (отображается при наведении курсора).
:6. Поиск по имени/пути файла в поле '''Поиск по полному пути'''. Поддерживается поиск с использованием [[Help:UI manual#Использование регулярных выражений|регулярных выражений]].
:7. Сортировка файлов по количеству маркеров – для этого нажмите кнопку [[File:Icon-expand-all.png|x25px]]
:8. Выгрузка списка отображаемых на панели файлов в файл формата .csv – для этого нажмите кнопку [[File:button_Скачать CSV.png|25px]]
:9. Настройка отображения файлов и сортировки в колонке '''Маркеры''' на вкладке '''Файлы''' – для этого нажмите кнопку [[File:icon_gear.png|x25px]] и поменяйте настройки.
:[[File:18 Временная настройка панели навигации.png|thumb|none|800px|Настройка отображения файлов и сортировки полей]]

=== Функции центральной панели ===
==== Вкладка «Информация о снимке» ====
На этой вкладке отображается информация о выбранном снимке.

[[File:19 Информация о снимке.png|thumb|left|600px|Вкладка '''Информация о снимке''']]
 
На вкладке '''Информация о снимке''' пользователю доступны следующие функции:
:1. Просмотр подробной информации о снимке во всплывающем окне – для этого нажмите кнопку '''Просмотреть JSON'''.
:2. Экспорт [[Help:UI manual#Экспорт|исходного кода, снимков и разметки]] – для этого нажмите кнопку '''Экспорт''' и выберите подходящий вариант.
:3. [[Help:UI manual#Импорт разметки|Импорт разметки]] – для этого нажмите кнопку '''Импорт''' и выберите подходящий вариант.
:4. Переход к более продвинутой навигации по исходному коду с подсветкой маркеров во встроенном Web-IDE Theia – для этого нажмите кнопку '''Открыть в IDE''' .
:{{Note|type=warn|text=''Функциональность является экспериментальной, доступна при наличии проектного доступа '''Экспорт снимков''' и запуске веб-приложения Svacer по протоколу HTTPS или на локальном хосте. Список доступных IDE определяется при инсталляции. Если доступна только одна IDE, то раскрывающийся список отсутствует, а IDE открывается сразу по нажатию кнопки '''Открыть в IDE'''. Если функциональность недоступна, кнопка '''Открыть в IDE''' неактивна и отображается иконка'' [[File:Icon attention.png|23x23px]]''.''}}
:5. Просмотр списка приложенных файлов — по нажатии кнопки '''Показать''', но только при наличии приложенных файлов.
:6. Скрытие списка приложенных файлов (возможно только при наличии приложенных файлов) – для этого нажмите на ссылку '''Скрыть'''.
:7. Удаление приложенного файла (возможно только при наличии приложенных файлов) — для этого нажмите кнопку [[File:icon_delete.png|x25px]].
:8. Просмотр пользовательских полей, которые пользователь указал при импорте – доступен по нажатии кнопки '''Показать''', но только при наличии этих полей.
:9. Просмотр параметров анализа во всплывающем окне – для этого нажмите кнопку '''Показать''' в строке '''Параметры анализа'''.
:10. Экспорт параметров анализа в формате .txt – для этого нажмите кнопку '''Скачать''' в строке '''Параметры анализа'''.
:11. [[Help:UI manual#Работа с таблицей статистики|Просмотр таблицы статистики]] – для этого нажмите кнопку '''Показать''' в строке '''Статистика по детекторам'''.
:Информация в таблице сгруппирована по параметрам детекторов, найденным маркерам и статусу их разметки.

==== Вкладка с исходным кодом ====
Вкладка открывается только после выбора файла [[Help:UI manual#Вкладка «Детекторы»|на вкладке '''Детекторы''']] или [[Help:UI manual#Вкладка «Файлы»|'''Файлы''']], а также [[Help:UI manual#Таблица маркеров|в таблице маркеров]]. Одновременно может быть открыто несколько вкладок с исходным кодом, если выключена [[Help:UI manual#Настройка профиля пользователя|настройка '''Переиспользование вкладки в редакторе кода''']].

В верхней части вкладки отображаются панель инструментов для работы с файлом [1] и полный путь к файлу [2]. Если в строке кода установлен курсор, то в нижнем правом углу вкладки отображается его позиция [3]:
[[File:20 Исходный код.png|thumb|none|600px|Полный путь к файлу и позиционирование курсора]]

На вкладке с исходным кодом пользователю доступны следующие функции:
:1. Отображение кода на весь экран – для этого нажмите кнопку [[File:Icon expand.png|23x23px]] или дважды кликните на вкладку файла.
:
:Для возврата к обычному отображению нажмите кнопку [[File:Icon minimize.png|24x24px]] или дважды кликните на вкладку файла.
:2. Переход к предыдущей или следующей строке, в которую пользователь установил курсор, – для этого используйте кнопки [[File:Button left.png|23x23px]] и [[File:Button right.png]] или сочетания клавиш '''Ctrl + <''' и '''Ctrl + >'''.
:3. Просмотр и открытие маркеров из списка всех маркеров в данном файле – для этого нажмите кнопку [[File:Icon list 2.png|x25px]].
:[[File:21 Исходный код Отображение списка маркеров.png|thumb|none|300px|right|Cписок маркеров в файле]]
:4. Отображение всех маркеров – для этого нажмите кнопку [[File:Icon Скрыть маркеры.png|24x24px]].
:Кнопка недоступна, если она уже нажата; все маркеры уже отображаются.
:5. Скрытие всех маркеров и трасс – для этого нажмите кнопку [[File:Icon Показать маркеры.png|24x24px]].
:Кнопка недоступна, если она уже нажата; все маркеры уже скрыты.
:6. Добавление комментария к строке кода – можно сделать двумя способами:
::а) Нажмите кнопку [[File:Button Comment Add.png|x25px]] в левой части строки, рядом с её номером (отображается только если в строке установлен курсор) и введите комментарий.
::ИЛИ
::б) Нажмите правой кнопкой мыши на строку и выберите пункт '''Добавить комментарий'''. Этим способом можно добавить несколько комментариев к одной строке.
:7. Просмотр комментария к строке – можно сделать двумя способами:
::а) Нажмите кнопку [[File:Button Comment view.png|x25px]] в левой части строки, рядом с её номером.
::ИЛИ
::б) Нажмите кнопку [[File:Button Comment view.png|x25px]] на панели инструментов и выберите в списке строку комментария.
::Отобразится виджет комментария, в котором доступны следующие функции:
::*добавление дополнительного комментария к этой строке кода по нажатии кнопки [[File:Button Comment Add.png|x25px]];
::*редактирование текста комментария по нажатии кнопки [[File:icon_edit3.png|x25px]];
::*удаление комментария по нажатии кнопки [[File:icon_delete 2.png|x25px]].
:[[File:118 Виджет комментария к строке кода.png|thumb|none|600px|Виджет комментария к строке кода]]
:8. Просмотр и открытие комментариев из списка всех комментариев в коде – для этого нажмите кнопку [[File:Button Comment view.png|x25px]] справа.
:9. Отображение всех комментариев в коде – для этого нажмите кнопку [[File:Button_Comment_view_all.png|x25px]] в панели инструментов.
:Кнопка недоступна, если она уже нажата; все комментарии уже отображаются.
:10. Скрытие всех комментариев в коде – для этого нажмите кнопку [[File:Button_Comment_hide_all.png|x25px]] в панели инструментов.
:Кнопка недоступна, если она уже нажата; все комментарии уже скрыты.
:11. Добавление открытого файла в [[Help:UI manual#Использование фильтров|фильтр]] [[Help:UI manual#Таблица маркеров|таблицы маркеров]] – для этого нажмите кнопку [[File:Icon filter add.png|x25px]] в панели инструментов.
:Фильтрация применится, вид кнопки поменяется на [[File:Icon filter remove.png|x25px]].
:12. Исключение файла из [[Help:UI manual#Использование фильтров|фильтра]] [[Help:UI manual#Таблица маркеров|таблицы маркеров]] – для этого нажмите кнопку [[File:Icon filter remove.png|x25px]] в панели инструментов.
:Фильтрация по этому файлу отменится, вид кнопки поменяется на [[File:Icon filter add.png|x25px]].
:13. Возврат к исходному маркеру (например, если был выбран другой связанный маркер на вкладке '''Трасса''' [[Help:UI manual#Функции правой панели|правой панели]]) – для этого нажмите кнопку [[File:Icon target.png|x25px]] в верхней части виджета маркера.
:14. [[Help:UI manual#Разметка маркера|Разметка маркера]] – установите '''Статус''', '''Серьезность''' и '''Действия''' в верхней части виджета маркера.
:15. Отображение блока элементов трассы в виджете маркера для строки кода – нажмите ссылку '''Показать трассу''' (доступна, если все блоки элементов трассы скрыты).
::Для последовательного перехода к другим элементам трассы воспользуйтесь кнопками [[File:Button up.png|x25px]] и [[File:Button down.png|x25px]].
::{{Note|type=info|text=''Отображение только первого элемента трассы или всех элементов трассы маркера по нажатии кнопки '''Показать трассу''' настраивается с помощью [[Help:UI manual#Настройка интерфейса|параметра '''Показывать всю трассу маркера''']].''}}
::[[File:97 Блок информации о элементе трассы.png|thumb|none|600px|Виджет маркера с блоком элемента трассы]]
:16. Скрытие блоков элементов трассы в виджете маркера для строки кода – нажмите ссылку '''Скрыть трассу''' (доступна, если хотя бы один блок элемента трассы отображается).
::Все открытые блоки элементов трассы маркера скроются.
:17. Переход к строке, в которой объявлена/определена переменная – нажмите правую кнопку мыши на строке исходного кода и выберите пункт '''Перейти к объявлению / Перейти к определению'''.
:{{Note|type=info|text=''Если для выделенного элемента кода нет объявления или определения, то отобразится сообщение: [[File:150 Объявление не найдено.png|247x247px]] или [[File:151 Определение не найдено.png|254x254px]].''}}

:18. Просмотр ссылок на панели внизу экрана – нажмите правую кнопку мыши на строке исходного кода и выберите пункт '''Найти ссылки'''. На этой панели отображается иерархический список файлов с номерами строк, в которых найдены ссылки:
:[[File:Исходный_код_Референсы.png|thumb|none|600px|Cписок файлов с номерами строк, в которых найдены ссылки]]

:* Чтобы перейти к строке кода, на которую найдена ссылка, нажмите на ссылку с номером строки на панели [1].
:* Чтобы посмотреть фрагмент кода, на который найдена ссылка, в режиме предпросмотра, нажмите кнопку [[File:icon_preview_code.png|x25px]] [2].
:{{Note|type=info|text=''Если для выделенного элемента кода нет ссылок, то отобразится сообщение: [[File:152 Ссылки не найдены.png|213x213px]].''}}

:19. Переход к просмотру выбранного файла [[Help:UI manual#Работа в режиме просмотра кода|в режиме просмотра кода]] – нажмите правую кнопку мыши на строке исходного кода и выберите пункт '''Открыть в режиме Код'''.
:20. Копирование ссылки на строку кода в буфер обмена – нажмите правую кнопку мыши на строке исходного кода и выберите пункт '''Копировать прямую ссылку'''.
::При переходе по этой ссылке будет открываться файл в режиме разметки с курсором на той строке кода, для которой была скопирована ссылка.
:21. Увеличение и уменьшение размера шрифта кода вместе с отображаемыми виджетами – нажмите правую кнопку мыши на любой строке исходного кода и выберите пункт '''Уменьшить''' или '''Увеличить''', либо установите курсор в любую строку и нажмите сочетание клавиш '''Ctrl + Alt + -''' или '''Ctrl + Alt + ='''
:22. Копирование строки кода – нажмите правую кнопку мыши на строке исходного кода и выберите пункт '''Copy'''.
:23. Вызов командной строки – нажмите правую кнопку мыши на строке исходного кода и выберите пункт '''Command Palette'''.
:[[File:25 Исходный код Вызов командной строки.png|thumb|none|600px|Командная строка]]

==== Таблица маркеров ====
Для раскрытия таблицы маркеров нажмите кнопку [[File:Button Показать таблицу.png|x25px]] в верхней части [[Help:UI manual#Функции центральной панели|центральной панели]], а для её скрытия – [[File:Button Скрыть таблицу.png|x25px]].

В верхней части таблицы находится панель, которая содержит:
* [[File:Field Детектор.png|x25px]] – поле с информацией [[Help:UI manual#Использование фильтров|о примененных фильтрах]]: как назначенных [[Help:UI manual#Функции навигационной панели|в навигационной панели]], так и с помощью [[Help:UI manual#Настройка и использование пользовательских фильтров|пользовательских фильтров]] и запросов;
* кнопка [[File:Icon download.png|x25px]] – выгрузка маркеров в файл формата .csv или .pdf: только для [[Help:UI manual#choice|выбранных]] или всех отображаемых маркеров, если ничего не выбрано. Отчет в формате .pdf может быть сгенерирован на основе HTML, так и существующим (нативным) способом. В PDF-отчете, сгенерированном на основе HTML, усовершенствованы стили, доработан титульный лист, актуализирован набор параметров для выгружаемых маркеров и пр.;
:{{Note|type=warn|text='''''Примечания:'''''
:* ''если в таблице не отображаются маркеры из-за примененных пользовательских фильтров, то в сгенерированном PDF-отчете будет указано «Нет маркеров (применены фильтры)»;''
:* ''для использования механизма генерации PDF-отчёта на основе HTML должна быть включена [[Help:UI manual#Настройка интерфейса|одноименная настройка]];''
:* ''генерация PDF-отчета на основе HTML может занимать больше времени, чем нативная генерация;''
:* ''спецсимволы (иконки), добавленные в комментариях к маркерам, не отображаются в выгруженном PDF-отчете.''}}

* кнопка [[File:Icon edit.png|x25px]] – переход [[Help:UI manual#Групповая разметка маркеров|к групповой разметке]] выбранных маркеров (доступна, если выбраны маркеры в таблице);
* кнопка [[File:Button_Comment_Add.png|x25px]] – переход к [[Help:UI manual#Добавление общего комментария к нескольким маркерам|добавлению общего комментария к нескольким выбранным маркерам]].

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

В таблице маркеров пользователю доступны следующие функции:
:1. Сортировка по значениям столбцов.
:2. Выбор маркеров для [[Help:UI manual#dwl pdf|выгрузки отчета]], [[Help:UI manual#Групповая разметка маркеров|групповой разметки]] или [[Help:UI manual#Добавление общего комментария к нескольким маркерам|добавления общего комментария к нескольким маркерам]] – для этого установите флажок в строке маркера.
:3. Просмотр подробной информации о маркере [[Help:UI manual#Функции правой панели|в правой панели]] и его места и содержания [[Help:UI manual#Вкладка с исходным кодом|на вкладке с исходным кодом]] – для этого дважды кликните на строку маркера или нажмите на имя файла в столбце '''Файл'''. Также для выбора можно использовать клавиши ↑ и ↓ – для перемещения по строкам, и Enter – для подтверждения выбора.
:4. Просмотр детальной информации о маркере в JSON-формате – для этого нажмите правой кнопкой мыши на маркер и выберите пункт '''Просмотреть JSON'''.
:5. Копирование детальной информации о маркере (JSON маркера) в буфер обмена – для этого нажмите правой кнопкой мыши на маркер и выберите пункт '''Копировать JSON'''.
:При переходе по этой ссылке будет открываться список маркеров в режиме разметки с открытым маркером (в правой панели и на вкладке с исходным кодом), для которого была скопирована ссылка.
:6. Копирование ссылки на маркер в буфер обмена – для этого нажмите правой кнопкой мыши на маркер и выберите пункт '''Копировать ссылку на маркер'''.
:7. Переход к [[Help:UI manual#Сравнение маркеров|сравнению одного маркера с другим]] – для этого нажмите правой кнопкой мыши на маркер и выберите пункт '''Сравнить с ...'''

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

На правой панели пользователю доступны следующие функции:
:1. Копирование ссылки на маркер – для этого нажмите кнопку [[File:Icon copy link.png|x25px]].
:2. [[Help:UI manual#Блокировка разметки|Блокировка маркера]] для разметки другими пользователями – для этого нажмите кнопку [[File:icon_unlocked.png|x25px]] в верхней части правой панели.
:3. [[Help:UI manual#Разметка маркера|Разметка маркера]] – для этого установите '''Статус''', '''Серьезность''' и '''Действие''' в верхней части правой панели.
:4. Просмотр истории разметки со связанными комментариями – для этого нажмите кнопку [[File:Icon history.png|x25px]] в верхней части правой панели.
:[[File:28 История изменения маркера.png|thumb|none|upright=2.5|Пример истории изменения разметки маркера]]

:5. Отображение маркера [[Help:UI manual#Вкладка с исходным кодом|на вкладке с исходным кодом]] нажмите кнопку с именем файла и номером строки в верхней части правой панели.
:6. Отображение элемента трассы [[Help:UI manual#Вкладка с исходным кодом|на вкладке с исходным кодом]] – для этого нажмите на ссылку с именем файла и номером строки на вкладке '''Трасса''' [1].
:7. Отображение кода, который соответствует строке трассы, в отдельном окне в режиме предпросмотра – для этого на вкладке '''Трасса''' нажмите кнопку [[File:Icon preview code.png|x25px]] рядом с именем файла и номером строки [2].
:[[File:31 Предпросмотр кода.png|thumb|none|upright=2.5|Элементы управления для работы с элементом трассы]]
:8. Просмотр и добавление комментариев к маркеру на вкладке '''Комментарии'''.
:Комментарии для каждого маркера уникальны. Добавление одинаковых комментариев недоступно.
:Редактор комментариев поддерживает синтаксис Markdown.
:Для упоминания пользователя, вставьте '''@''' и введите или выберите его логин. После добавления комментария по нажатии кнопки '''Применить''' указанному пользователю придет [[Help:UI manual#Просмотр уведомлений в интерфейсе Системы|уведомление в интерфейсе системы]] об упоминании с возможностью перехода к маркеру с этим комментарием.
:9. Редактирование и удаление комментариев на вкладке '''Комментарии''' с помощью кнопок [[File:Icon edit2.png|x25px]] и [[File:Icon delete.png|x25px]].
:Если [[Help:UI manual#Работа с проектами|для проекта]] установлен флажок '''Обязательный комментарий при разметке''', то удаление связанного с разметкой комментария недоступно. Его можно только отредактировать.
:[[File:32 Комментарии.png|thumb|none|upright=1.3|Вкладка '''Комментарии''']]
:{{Note|type=info|text='''''Примечания''':''
:* ''Пользователь может отредактировать и удалить только свои комментарии. Пользователю с доступом '''Изменение любых комментариев''' доступно редактирование и удаление комментариев всех пользователей. Если такой пользователь внёс изменения, то изначальный автор теряет возможность изменять свой комментарий (если у него нет доступа '''Изменение любых комментариев'''), так как авторство передаётся пользователю, который последним внёс изменения.''
:* ''Для отредактированного комментария отображается слово '''изменено''', при наведении курсора на которое отображается сообщение с логином пользователя, изменившего комментарий, и датой редактирования. Текст несохраненного комментария в поле добавления комментария не пропадает при переключении на другой маркер.''
:* ''Если открыт режим редактирования комментария, то при переключении на другой маркер режим редактирования закрывается и изменения не сохраняются.''}}
:10. Ввод, просмотр и редактирования комментария в отдельном диалоговом окне – для этого нажмите кнопку [[File:Button Comment Zoom.png|x25px]] рядом с полем ввода нового комментария или в поле существующего комментария.
:[[File:120 Окно создания, просмотра и редактирования комментария в отдельном диалоговом окне.png|thumb|none|upright=2|Окно создания, просмотра и редактирования комментария в отдельном диалоговом окне]]
:11. Просмотр подробной информации на вкладке '''Подробности'''. Содержит два блока:
:* информация о сработавшем детекторе: серьезность и надежность, а также связанные с ним коды CWE, которые содержат ссылки на описание дефектов безопасности на сайте [https://cwe.mitre.org cwe.mitre.org];
:* информацией о маркере: текстовые метки маркера, названия снимка и функции, инструмент, язык, текстовое описание и степень доверия, а также кнопки для перехода к просмотру истории маркера и запуску хуков.
::{{Note|type=info|text=''Svace, начиная с версии 4.0, для некоторых языков поставляется с моделью искусственного интеллекта, которая предсказывает истинность срабатывания маркера на основе предупреждений и собранных метрик. Это значение в Svacer отображается в параметре '''Степень доверия'''.''}}
::По нажатии на иконку [[File:icon_question_mark2.png|x25px]] справа от названия детектора отображается дополнительная информация о нём. Иконка не отображается, если дополнительная информация отсутствует.
:[[File:33 Подробная информация о маркере.png|thumb|none|upright=2|Вкладка '''Подробности''']]
:[[File:121 Окно с дополнительной информацией о детекторе.png|thumb|none|upright=2|Окно с дополнительной информацией о детекторе]]

:12. Просмотр истории обнаружения маркера в снимках данной ветки проекта – для этого на вкладке '''Подробности''' нажмите кнопку '''Показать''' в блоке информации о маркере в строке '''История'''.
:В окне просмотра истории доступна сортировка записей.
:[[File:35 История маркера.png|thumb|none|upright=2.5|Пример истории маркера]]
:13. Просмотр маркера в JSON-формате – для этого на вкладке '''Подробности''' нажмите кнопку '''Показать''' в блоке '''JSON'''.
:[[File:234 Пример JSON маркера.png|thumb|none|upright=2|Пример JSON маркера]]
:14. Запуск хуков (скриптов) – для этого нажмите кнопку '''Запустить''' на вкладке '''Подробности''' и в раскрывающемся списке доступных хуков выберите тот, который требуется запустить.
 

=== Использование фильтров ===
==== Общая информация ====
Настройка и использование фильтров доступны [[Help:UI manual#Работа в режиме разметки|в режиме разметки]].

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

# Фильтры [[Help:UI manual#Функции навигационной панели|навигационной панели]] [1]: детекторы, файлы или серьезность.
# Доступные для разметки – позволяют отобразить только маркеры, которые доступны пользователю для разметки, т. е. при использовании этого фильтра в списке не будут отображаться маркеры, заблокированные другими пользователями. Фильтр применяется по нажатии кнопки [[File:Icon view2.png|x25px]] [2] в правой части блока [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выбора проекта, ветки и снимка]].
# Размеченный – позволяют отобразить только размеченные маркеры. Фильтр применяется по нажатии кнопки [[File:Icon view.png|x25px]] [3] в правой части блока [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выбора проекта, ветки и снимка]].
# [[Help:UI manual#Настройка и использование пользовательских фильтров|Пользовательские фильтры]] – доступны по нажатии кнопки [[File:Button Фильтры.png|x25px]] [4] в правой части блока [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выбора проекта, ветки и снимка]].
# Запрос – фильтр, указанный в поле в верхней части [[Help:UI manual#Таблица маркеров|таблицы маркеров]] [5].

:[[File:36 Фильтры.png|thumb|none|upright=3|Существующие фильтры]]

Увидеть примененные фильтры (кроме '''Доступные для разметки''') и последовательность их применения можно в поле [[File:field Детектор.png|x25px]] в верхней части [[Help:UI manual#Таблица маркеров|таблицы маркеров]].

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

По нажатию кнопки [[File:Button Фильтры 2.png|x25px]] в правой части блока [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выбора контекста]] можно отменить примененные фильтры: пользовательский или все.

==== Настройка и использование пользовательских фильтров ====
Настроить пользовательские фильтры можно [[Help:UI manual#Работа в режиме разметки|в режиме разметки]]. Для этого:
:1. Нажмите кнопку [[file:button Фильтры.png|x25px]] в правой части блока [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выбора контекста]].
:В правой части экрана отобразится панель пользовательских фильтров, которая содержит три вкладки:
:* '''Пользовательский''' – параметры фильтрации, которые разделены на три группы:
::* параметры детекторов;
::* параметры маркеров;
::* файлы;
::* [[Afilters|расширенный фильтр]];
:* '''Сохраненные''' – список [[Help:UI manual#Работа с сохраненными фильтрами|сохраненных фильтров]];
:* '''Публичные''' – [[Help:UI manual#Работа с публичными фильтрами|список фильтров, доступных всем пользователям]].

:2. Настройте параметры фильтрации на вкладке '''Пользовательский''' – выберите значения в списках полей, нажмите кнопки со значениями, или введите значения.
:3. Нажмите на кнопку [[File:Icon cancel.png|x15px]] справа от значения в списке, чтобы отменить его выбор.
:4. Если параметры нужно исключить из поиска, нажмите на кнопку [[File:Icon plus 2.png|x25px]].
:Кнопка поменяется на [[File:Icon minus 3.png|x25px]].
:5. Если параметры нужно включить в поиск, нажмите на кнопку [[File:Icon minus 3.png|x25px]].
:Кнопка поменяется на [[File:Icon plus 2.png|x25px]].
:6. Если в полях '''Метки''', '''Функции''' и '''Файлы''' нужно использовать регулярные выражения:
::а) Нажмите на кнопку [[File:Button TextTempl.png|x25px]].
::Кнопка поменяется на [[File:Button Reg.png|x25px]].
::б) Введите [[Help:UI manual#Использование регулярных выражений|регулярные выражения]]. Используйте новую строку для разделения значений.
:7. Если в полях '''Метки''', '''Функции''' и '''Файлы''' нужно использовать текстовые шаблоны:
::а) Нажмите на кнопку [[File:Button Reg.png|x25px]].
::Кнопка поменяется на [[File:Button TextTempl.png|x25px]].
::б) Введите текстовые шаблоны. Используйте новую строку для разделения значений.
:8. Для создания сложного фильтра с поиском по предикатам задайте в поле '''Расширенный фильтр''' параметры в формате <code>filter(markers, <predicate expr> )</code>, где:
::* <code>filter ()</code> – функция, которая фильтрует список по предикату;
::* <code>markers</code> – объект, который содержит массив маркеров из контекста;
::* <code><predicate expr></code> – выражение, которое определяет предикат.
::Описание используемых в этом фильтре функций, объектов и выражений, а также языка предикатов доступно по нажатии на иконку [[File:Icon question mark2.png|x25px]] и в [[Afilters|статье документации]].
:9. Нажмите кнопку [[File:Button Очистить.png|x25px]], чтобы очистить все параметры фильтрации.
:10. Нажмите кнопку [[File:Button Сохранить как.png|x25px]], в открывшемся диалоге введите название и нажмите кнопку '''Сохранить'''.
:Фильтр сохранится и отобразится на [[Help:UI manual#Работа с сохраненными фильтрами|вкладке '''Сохраненные''']].
:11. Нажмите кнопку [[File:Button Применить.png|x25px]], чтобы применить фильтр.
:После применения кнопка фильтра станет зеленой, а ее название поменяется на название сохраненного фильтра.
::[[File:36 Пользовательские фильтры.png|thumb|none|upright=2|Пользовательские фильтры. Вкладка '''Пользовательский''']]

==== Работа с сохраненными фильтрами ====
На вкладке '''Сохраненные''' отображаются фильтры, [[Help:UI manual#filters saved|сохраненные на вкладке '''Пользовательский''']], а также [[Help:UI manual#filters published|скопированные с вкладки '''Публичные''']].
:[[File:37 Фильтры сохраненные.png|thumb|none|upright=2|Пользовательские фильтры. Вкладка '''Сохраненные''']]

Воспользуйтесь функциями управления фильтрами на вкладке '''Сохраненные''':
:1. Для поиска фильтра введите его название в строке поиска.
:2. Для сортировки фильтров по названию нажмите кнопку [[File:Button Sort.png|x25px]].
:3. Для редактирования сохраненного фильтра нажмите кнопку [[File:Icon edit3.png|x25px]] и [[Help:UI manual#Настройка и использование пользовательских фильтров|внесите изменения]].
:4. Создайте дубликат фильтра – нажмите кнопку [[File:Icon duplicate.png|x25px]].
:5. Для публикации фильтра нажмите кнопку [[File:Button share.png|x25px]].
:Копия сохраненного фильтра отобразится [[Help:UI manual#Работа с публичными фильтрами|на вкладке '''Публичные''']] и станет доступна другим пользователям.
:{{Note|type=warn|text=''Функция доступна только пользователям с [[#Серверные доступы|серверным доступом]] '''Управление публичными фильтрами'''''.}}
:6. Для удаления одного фильтра нажмите кнопку [[File:Icon delete 2.png|x25px]].
:7. Для удаления нескольких фильтров:
::а) Выберите фильтры для удаления – установите флажки в левой части названий фильтров или нажмите кнопку '''Выбрать всё'''.
::б) Нажмите кнопку '''Удалить'''.
:8. Примените фильтр – нажмите на его название и нажмите кнопку [[File:Button Применить.png|x25px]].

После применения:
* примененный фильтр будет отмечен [[File:Icon check.png|x25px]];
* кнопка фильтра станет зеленой, а ее название поменяется на название сохраненного фильтра.

==== Работа с публичными фильтрами ====
{{Note|type=warn|text=''Создание (публикация), изменение и удаление публичных фильтров доступны пользователям с [[#Серверные доступы|серверным доступом]] '''Управление публичными фильтрами'''''.}}

На вкладке '''Публичные''' отображаются фильтры, [[Help:UI manual#filters publishing|опубликованные на вкладке '''Сохраненные''']].
<gallery mode="packed" heights="300px" style="float:left; clear:right; margin-right:1em; margin-left:1em">
153 Пользовательские фильтры. Публичные без доступа.png|Пользовательские фильтры. Вкладка '''Публичные'''. Вид для пользователя без серверного доступа '''Управление публичными фильтрами'''
154 Пользовательские фильтры. Публичные с доступом.png|Пользовательские фильтры. Вкладка '''Публичные'''. Вид для пользователя с серверным доступом '''Управление публичными фильтрами'''
</gallery>
 
Воспользуйтесь функциями управления фильтрами на вкладке '''Публичные''':
:1. Для поиска фильтра введите его название в строке поиска.
:2. Для сортировки фильтров по названию нажмите кнопку [[File:Button Sort.png|x25px]].
:3. Чтобы посмотреть параметры фильтра, нажмите кнопку [[File:Button show.png|x25px]].
:{{Note|type=warn|text=''Функция доступна только пользователям БЕЗ [[#Серверные доступы|серверного доступа]] '''Управление публичными фильтрами.'''''}}
:4. Для редактирования публичного фильтра нажмите кнопку [[File:Icon edit3.png|x25px]] и [[Help:UI manual#Настройка и использование пользовательских фильтров|внесите изменения]].
:5. Скопируйте публичный фильтр – нажмите кнопку [[File:Icon duplicate.png|x25px]].
:Фильтр сохранится и отобразится [[Help:UI manual#Работа с сохраненными фильтрами|на вкладке '''Сохраненные''']].
:6. Для удаления одного фильтра нажмите кнопку [[File:Icon delete 2.png|x25px]].
:7. Для удаления нескольких фильтров:
::а) Выберите фильтры для удаления – установите флажки в левой части названий фильтров или нажмите кнопку '''Выбрать всё'''.
::б) Нажмите кнопку '''Удалить'''.
:8. Примените фильтр – нажмите на его название и нажмите кнопку [[File:Button Применить.png|x25px]].

После применения:
* примененный фильтр будет отмечен [[File:Icon check.png|x25px]];
* кнопка фильтра станет зеленой, а ее название поменяется на название сохраненного фильтра.

=== Сравнение снимков и маркеров ===
Чтобы сравнить снимки и маркеры в них:
:1. [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|Выберите исходный контекст]] – проект, ветку, снимок.
:2. [[Help:UI manual#Работа в режиме разметки|В режиме разметки]] нажмите кнопку [[File:Button Сравнить с.png|x25px]] и в раскрывшемся списке выберите пункт '''Сравнить с…'''.
:3. В открывшемся окне выберите проект, ветку и снимок для сравнения; нажмите кнопку [[File:Button Применить.png|x25px]].
:[[File:38 Выбор снимка для сравнения.png|thumb|none|upright=1.5|Выбор проекта, ветки и снимка для сравнения]]
:Результат сравнения отобразится [[Help:UI manual#Функции навигационной панели|в навигационной панели]] и [[Help:UI manual#Функции центральной панели|центральной панели]], причем:
:* вкладка '''Информация о снимке''' поменяется на вкладку '''Информация о различиях''' с информацией о двух сравниваемых снимках;
:* применится первый режим сравнения, в котором найдены результаты.
:4. Выберите режим сравнения.
:[[File:39 Выбор режима сравнения.png|800px|thumb|none|Выбор режима сравнения]]
:[[Help:UI manual#Функции навигационной панели|В навигационной панели]] и [[Help:UI manual#Функции центральной панели|центральной панели]] отобразятся только результаты выбранного режима сравнения. В режимах '''Сопоставленные''' и '''Одинаковые''' [[Help:UI manual#Таблица маркеров|в таблице маркеров]] добавится столбец с номером версии: V1 – маркер в файле текущего снимка, V2 – маркер в файле целевого снимка.
:{{Note|type=info|text=''Если при просмотре кода файла целевого снимка перейти к просмотру файла [[Help:UI manual#Работа в режиме просмотра кода|в режиме '''Код''']] (команда '''Открыть в режиме код'''), то режим сравнения закроется, отобразится контекст целевого снимка.''}}
<gallery heights="210" perrow="2" mode="packed" style="float:left; clear:right; margin-right:1em; margin-left:2em" "="">
File:40 Пример сравнения новые.png|Пример результатов сравнения в режиме '''Только в V1'''
File:41 Пример сравнения Отсутствующие.png|Пример результатов сравнения в режиме '''Только в V2'''
File:42 Пример сравнения Сопоставленные.png|Пример результатов сравнения в режиме '''Сопоставленные'''
File:43 Пример сравнения Одинаковые.png|Пример результатов сравнения в режиме '''Одинаковые'''
</gallery>
 
:5. Посмотрите различия в параметрах анализа – нажмите кнопку '''Показать различия''' на вкладке '''Информация о различиях'''.
:[[File:44 Различия в результатах анализа.png|600px|thumb|none|Сравнение настроек анализа]]
:6. Посмотрите различия в статистике разметки – нажмите кнопку '''Различия разметок'''.
:[[File:45 Различия в статистике по детекторам.png|thumb|none|600px|Сравнение статистики разметок]]
:7. Нажмите кнопку [[File:Icon download CSV.png|x25px]] или [[File:Icon download PDF.png|x25px]], чтобы скачать статистику в формате CSV или PDF.
:8. Отмените сравнение – нажмите кнопку [[File:Icon cancel 2.png|x25px]] в блоке выбора проекта, ветки и снимка.
 

=== Сопоставление маркеров ===
{{Note|type=warn|text=''Функциональность доступна пользователям с [[#Проектные доступы|проектным доступом]] '''Разметка маркеров''' и [[#Серверные доступы|серверным доступом]] '''Администрирование сервера'''''}}

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

Результат сопоставления, выполненного вручную, можно отменить.
==== Сопоставление маркеров вручную ====
Сопоставление маркеров вручную проводится в два этапа:
:а) Выбор пар маркеров и их сопоставление, без сохранения в БД.
:б) Просмотр выбранных пар и подтверждение операции.

Чтобы вручную сопоставить маркеры:
:1. [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|Выберите исходный контекст]].
:2. [[Help:UI manual#Работа в режиме разметки|В режиме разметки]] нажмите кнопку [[File:Button Сравнить с.png|x25px]] и в раскрывшемся списке выберите пункт '''Сопоставить маркеры'''.
:Откроется окно '''Сопоставить маркеры'''.

:3. Этап 1. На вкладке '''Сопоставление маркеров''':
::а) Выберите снимок, маркеры которого нужно сопоставить с исходным.
::Отобразятся две таблицы маркеров: слева – для исходного снимка, а справа – для выбранного.
::б) Чтобы перед сопоставлением сравнить маркеры, выберите маркеры – по одному в каждой таблице и нажмите кнопку '''Сравнить''' (расположена над таблицей).
::Отобразится окно сравнения выбранных маркеров.
::Если требуется, повторите операцию для других пар маркеров.
::в) Выберите маркеры для сопоставления – по одному в каждой таблице и нажмите кнопку '''Сопоставить''' (расположена над таблицей). Если требуется, повторите операцию для других пар маркеров.
::Для сопоставленных маркеров справа от названия будет отображаться номер сопоставленной пары.
::г) Для отмены сопоставления пары маркеров выберите любой сопоставленный маркер и нажмите '''Отменить сопоставление''' (расположена над таблицей). Если требуется, повторите операцию для других пар маркеров.
::д) Для просмотра фрагмента кода, в котором находится маркер – нажмите кнопку [[File:icon_preview_code.png|x25px]].
::е) Для отказа от дальнейшего сопоставления и отмены всех изменений нажмите кнопку '''Отмена'''.
::ж) Для перехода к подтверждению выбора нажмите кнопку '''Далее'''.

:[[File:122 Выбор снимка и сопоставление пар маркеров.png|800px|thumb|none|Окно '''Сопоставить маркеры'''. Выбор снимка и сопоставление пар маркеров]]
:[[File:48 Различия исходного кода.png|800px|thumb|none|Окно '''Сравнение маркеров''']]

:4. Этап 2. В открывшейся форме:
::а) Проверьте список сопоставленных пар маркеров для применения операций сопоставления.
::б) Для корректировки списка сопоставленных пар маркеров нажмите кнопку '''Назад''' и выполните операции [[Help:UI manual#MarksStep1|Этапа 1]].
::в) Для отказа от дальнейшего сопоставления и отмены всех изменений нажмите кнопку '''Отмена'''.
::г) Для запуска операции сопоставления нажмите кнопку '''Подтвердить'''.

:[[File:123 Подтверждение сопоставления.png|800px|thumb|none|Окно «Сопоставить маркеры». Подтверждение сопоставления]]

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

:[[File:124 Сообщение об окончании сопоставления отмены.png|800px|thumb|none|Сообщение об окончании операции сопоставления]]
:{{Note|type=info|text=''При сопоставлении метки маркеров удаляются.''}}

==== Отмена операций сопоставления ====
Отмена операций ручного сопоставления маркеров проводится в два этапа:
:а) Выбор операций ручного сопоставления для отмены (отката).
:б) Просмотр списка всех операций, которые будут отменены, и подтверждение отмены операций сопоставления.

Чтобы отменить (откатить) операции сопоставления:
:1. [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|Выберите исходный контекст]].
:2. [[Help:UI manual#Работа в режиме разметки|В режиме разметки]] нажмите кнопку [[File:Button Сравнить с.png|x25px]] и в раскрывшемся списке выберите пункт '''Сопоставить маркеры'''.
:Откроется окно '''Сопоставить маркеры'''.
:3. Этап 1. На вкладке '''Отмена операций сопоставления''':
::а) Выберите операции сопоставления маркеров, которые нужно отменить.
::В списке отображаются операции ручного сопоставления маркеров в исходной ветке проекта.
::б) Для отказа от продолжения операции нажмите кнопку '''Отмена'''.
::в) Для перехода к подтверждению выбора нажмите кнопку '''Далее'''.

:[[File:125 Выбор маркеров для отмены сопоставления.png|800px|thumb|none|Окно «Сопоставить маркеры». Выбор операций сопоставления маркеров для отмены]]

:4. Этап 2. В открывшейся форме:
::а) Проверьте список операций сопоставления, которые будут отменены. Список операций, помимо выбранных пользователем операций сопоставления, может дополнительно включать другие связанные операции, которые также будут отменены.
::б) Для корректировки выбранных операций сопоставления маркеров нажмите кнопку '''Назад''' и измените выбор маркеров.
::в) Для отказа от продолжения операции нажмите кнопку '''Отмена'''.
::г) Для запуска операции отмены сопоставления маркеров нажмите кнопку '''Подтвердить'''.

:[[File:126 Подтверждение отмены сопоставления.png|800px|thumb|none|Окно «Сопоставить маркеры». Подтверждение отмены операций сопоставления]]

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

:[[File:124 Сообщение об окончании сопоставления отмены.png|800px|thumb|none|Сообщение об окончании операции отмены сопоставления]]
:{{Note|type=info|text=''При отмене операции сопоставления метки маркеров удаляются.''}}

=== Сравнение маркеров ===
Чтобы сравнить два маркера:
:1. [[Help:UI manual#Работа в режиме разметки|В режиме разметки]] [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выберите исходный контекст]].
:2. Раскройте [[Help:UI manual#Таблица маркеров|таблицу маркеров]].
:3. Нажмите правой кнопкой мыши на строке маркера и выберите пункт '''Сравнить с ...'''
:[[File:155 Переход к сравнению маркеров.png|thumb|none|upright=2|Переход к сравнению маркеров]]
:Откроется окно выбора маркера для сравнения.
:[[File:46 Выбор маркера для сравнения.png|thumb|none|upright=3|Окно выбора маркера для сравнения]]
:{{Note|type=info|text=''При сравнении снимков для режимов '''Сопоставленные''' и '''Одинаковые''' в таблице маркеров по клику правой кнопкой мыши на строке маркера доступен пункт '''Сравнение с другой версией'''. При выборе данной команды происходит сравнение маркера с его версией из сравниваемого снимка.''}}
:4. Выберите проект, ветку и снимок.
:Отобразится список маркеров в выбранном снимке, где можно ввести запрос для поиска маркеров.
:[[File:47 Результат сравнения маркеров.png|thumb|none|upright=3|Выбор маркера для сравнения]]
:5. Дважды кликните на строке маркера или нажмите кнопку '''Сравнить''', чтобы перейти в окно сравнения маркеров.
:[[File:48 Различия исходного кода.png|thumb|none|upright=3|Окно сравнения маркеров]]

=== Разметка маркера ===
Разметка маркера заключается в установке статуса, а также опционально серьезности (критичности) и требуемого действия.
Установка серьезности и действия доступны только после установки статуса.
Разметить маркер можно [[Help:UI manual#Работа в режиме разметки|в режиме разметки]].
==== Разметка маркера вручную ====
Вручную маркер можно разметить тремя способами:
:1. '''''Способ 1'''''. С помощью кнопок в верхней части [[Help:UI manual#Функции правой панели|правой панели]].
:2. '''''Способ 2'''''. С помощью кнопок в виджете маркера [[Help:UI manual#Вкладка с исходным кодом|на вкладке с исходным кодом]].
:Если [[Help:UI manual#Работа с проектами|для проекта]] установлен флаг '''Обязательный комментарий при разметке''', то при разметке с помощью способов [[Help:UI manual#Marking1|1]] и [[Help:UI manual#Marking2|2]] откроется [[Help:UI manual#Marking3|окно разметки]], в котором обязательно нужно ввести комментарий.
<gallery mode="packed" heights="180px" style="float:left; clear:right; margin-right:1em; margin-left:0">
49 Разметка Статус.png|Выбор статуса разметки маркера
50 Разметка Серьезность.png|Выбор серьезности разметки маркера
51 Разметка Действие.png|Выбор действия разметки маркера
127 Кнопки разметки в виджете маркера.png|Кнопки разметки в виджете маркера на вкладке с исходным кодом
</gallery>
 
:3. '''''Способ 3'''''. В отдельном окне разметки вручную. Для этого:
::а) Нажмите кнопку [[File:Icon edit.png|x25px]] в верхней части правой панели или в виджете маркера на вкладке с исходным кодом.
::Откроется окно '''Разметка'''.
<gallery heights="200" perrow="2" mode="packed" style="float:left; clear:right; margin-right:1em; margin-left:1em">
235 Окно Разметка.png|Окно «Разметка»
File:99 Окно разметки.png|Окно разметки. Поле '''Комментарий''' – обязательное
</gallery>
 
::б) Выберите статус, а также опционально серьезность (критичность) и требуемое действие.
::в) Введите комментарий.
::Если [[Help:UI manual#Работа с проектами|для проекта]] установлен флаг '''Обязательный комментарий при разметке''', то добавление комментария обязательно.
::Редактор комментариев поддерживает синтаксис Markdown.
::Для упоминания пользователя, вставьте '''@''' и введите или выберите его логин. После добавления комментария по нажатии кнопки '''Применить''' указанному пользователю придет [[Help:UI manual#Просмотр уведомлений в интерфейсе Системы|уведомление в интерфейсе системы]] об упоминании с возможностью перехода к маркеру с этим комментарием.
::г) Нажмите кнопку '''Применить'''.

Результаты разметки со связанными комментариями отображаются [[Help:UI manual#Функции правой панели|в правой панели]] на вкладке '''Комментарии'''. При этом можно поменять текст комментария, но не результат разметки. Для её изменения нужно заново установить статус, серьёзность и действие.
:[[File:100 Правая панель Комментарии с разметкой.png|300px|thumb|none|Правая панель. Комментарии, добавленные при разметке]]

==== Разметка маркера с помощью ассистента AI ====
{{Note|type=warn|text=''Функциональность доступна пользователям с [[#Проектные доступы|проектными доступами]] '''Разметка маркеров''' и '''Импорт разметки'''''}}
Чтобы разметить маркер с помощью ассистента AI:
:1. Нажмите кнопку [[File:Icon edit.png|x25px]] в верхней части правой панели или в виджете маркера на вкладке с исходным кодом.
Откроется окно '''Разметка'''.
:2. Смените режим разметки с помощью переключателя '''Режим разметки с помощью AI'''.
:3. В отобразившемся режиме разметки выберите '''Модель AI''', с помощью которой ассистент AI рассчитает статус разметки.
:Спрогнозированный статус и уровень доверия прогнозу отобразятся в этом же окне. Если модель AI не смогла предсказать статус разметки, то отобразится значение '''n/a''' и кнопка '''Применить''' будет неактивна.
:Если маркер уже размечен и его статус совпадает с прогнозным, то в окне отобразится сообщение об этом и дальнейшая разметка станет недоступна.
:[[File:236 Окно Разметка AI.png|400px|thumb|none|Окно «Разметка». Режим разметки с помощью ассистента AI]]
:4. Введите комментарий.
:5. Нажмите кнопку '''Применить'''.
Результаты разметки со связанными комментариями отображаются [[Help:UI manual#Функции правой панели|в правой панели]] на вкладке '''Комментарии'''. При этом можно поменять текст комментария, но не результат разметки. Для её изменения нужно заново установить статус, серьёзность и действие.
Комментарий, добавленный при разметке с помощью ассистента AI, дополнительно содержит информацию о проведенной разметке: время, имя модели машинного обучения, уровень доверия прогнозу. Также для такого маркера в правой панели на вкладке '''Подробности''' присвоена метка '''AI'''.
<gallery heights="210" perrow="2" mode="packed" style="float:left; clear:right; margin-right:1em; margin-left:1em">
237 Разметка комментарий AI.png|Правая панель.Комментарий, добавленный при разметке с помощью ассистента AI
238 Разметка метка AI.png|Правая панель.Метка AI на вкладке «Подробности»
</gallery>
 

=== Групповая разметка маркеров ===
==== Групповая разметка маркеров вручную ====
Для групповой разметки маркеров вручную:
:1. [[Help:UI manual#Работа в режиме разметки|В режиме разметки]] [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выберите исходные проект, ветку и снимок]].
:2. Включите отображение [[Help:UI manual#Таблица маркеров|таблицы маркеров]].
:3. Выберите маркеры для разметки – установите флажки в строках таблицы.
:4. Нажмите кнопку [[File:icon edit.png|x25px]] (доступна, если выбраны маркеры в таблице).
:[[File:53 Выбор маркеров для группразметки.png|thumb|none|upright=2.5|Выбор маркеров для групповой разметки]]
:Отобразится окно для групповой разметки.
:[[File:54 Окно групповой разметки.png|thumb|none|upright=2.5|Окно групповой разметки]]
:5. Выберите статус разметки, а затем (опционально) статус серьезности (критичности) и требуемое действие – нажмите кнопки со значениями.
:6. Добавьте общий комментарий для выбранных маркеров. 
:Редактор комментариев поддерживает синтаксис Markdown.
:Для упоминания пользователя, вставьте '''@''' и введите или выберите его логин. После добавления комментария по нажатии кнопки '''Применить''' указанному пользователю придет [[Help:UI manual#Просмотр уведомлений в интерфейсе Системы|уведомление в интерфейсе системы]] об упоминании с возможностью перехода к этому комментарию.
:После того, как пользователь или ассистент AI присвоил статусы и (или) написал комментарий, станет доступной кнопка '''Применить'''. 
:{{Note|type=info|text=''Ввод комментария обязателен, если [[Help:UI manual#Работа с проектами|для проекта]] установлен флаг '''Обязательный комментарий при разметке'''''.}}
:7. Если требуется отменить изменения, нажмите [[File:icon cross 01.png|x15px]] в правом верхнем углу окна или кнопку '''Отмена'''. Диалоговое окно закроется, изменения не будут применены, выделение с выбранных для разметки маркеров не снимается.
:8. Нажмите кнопку '''Применить''', чтобы запустить процесс разметки. 
Прогресс разметки отображается в соответствующем окне. Запущенный процесс можно полностью отменить нажатием кнопки '''Отмена'''. 
В результате применения разметки текст маркеров [[Help:UI manual#Таблица маркеров|в таблице маркеров]] окрасится в цвет, соответствующий выставленному статусу.

<gallery widths="400" mode="nolines" style="float:center; clear:center; margin-right:1em; margin-left:0">
56 Окно прогресса разметки.png|Окно прогресса разметки
57 Результат групповой разметки.png|Пример таблицы маркеров после применения групповой разметки
</gallery>
 

==== Групповая разметка маркеров с помощью ассистента AI ====
{{Note|type=warn|text=''Функциональность доступна пользователям с [[#Проектные доступы|проектными доступами]] '''Разметка маркеров''' и '''Импорт разметки'''''}}
Чтобы разметить группу маркеров с помощью ассистента AI:
:1. [[Help:UI manual#Работа в режиме разметки|В режиме разметки]] [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выберите исходные проект, ветку и снимок]].
:2. Включите отображение [[Help:UI manual#Таблица маркеров|таблицы маркеров]].
:3. [[Help:UI manual#GroupMark1|Выберите маркеры для разметки]] – установите флажки в строках таблицы.
:4. Нажмите кнопку [[File:icon edit.png|x25px]] (доступна, если выбраны маркеры в таблице).
:[[File:53 Выбор маркеров для группразметки.png|thumb|none|upright=2.5|Выбор маркеров для групповой разметки]]
:Отобразится [[Help:UI manual#GroupMark2|окно для групповой разметки]].
:5. Смените режим разметки с помощью переключателя '''Режим разметки с помощью AI'''.
:6. В отобразившемся режиме разметки выберите '''Модель AI''', с помощью которой ассистент AI рассчитает статус разметки.
:Спрогнозированный статус и уровень доверия прогнозу отобразятся в этом же окне в строке каждого выбранного маркера. Если модель AI не смогла предсказать статус разметки, то отобразится значение '''n/a''' и установка флажка столбце '''Статус разметки''' будет недоступна.
:7. Выберите маркеры для разметки – установите флажки в столбце '''Статус разметки'''.
:Если маркер уже размечен и его статус совпадает с прогнозным, то установка флажка в его строке недоступна.
:[[File:239 Групповая разметка AI.png|thumb|none|upright=2.5|Окно групповой разметки. Режим разметки с помощью ассистента AI]]
:8. Добавьте общий комментарий для выбранных маркеров. 
:Редактор комментариев поддерживает синтаксис Markdown.
:Для упоминания пользователя, вставьте '''@''' и введите или выберите его логин. После добавления комментария по нажатии кнопки '''Применить''' указанному пользователю придет [[Help:UI manual#Просмотр уведомлений в интерфейсе Системы|уведомление в интерфейсе системы]] об упоминании с возможностью перехода к этому комментарию.
:После того, как пользователь или ассистент AI присвоил статусы и (или) написал комментарий, станет доступной кнопка '''Применить'''. 
:{{Note|type=info|text=''Ввод комментария обязателен, если [[Help:UI manual#Работа с проектами|для проекта]] установлен флаг '''Обязательный комментарий при разметке'''''.}}
:9. Если требуется отменить изменения, нажмите [[File:icon cross 01.png|x15px]] в правом верхнем углу окна или кнопку '''Отмена'''. Диалоговое окно закроется, изменения не будут применены, выделение с выбранных для разметки маркеров не снимается.
:10. Нажмите кнопку '''Применить''', чтобы запустить процесс разметки. 
Прогресс разметки отображается в [[Help:UI manual#GroupMark3|соответствующем окне]]. Запущенный процесс можно полностью отменить нажатием кнопки '''Отмена'''. 
В результате применения разметки текст маркеров [[Help:UI manual#Таблица маркеров|в таблице маркеров]] окрасится в цвет, соответствующий выставленному статусу.

=== Блокировка разметки маркеров===
Пользователь может заблокировать другим пользователям возможность [[Help:UI manual#Разметка маркера|размечать маркер]] или [[Help:UI manual#Групповая разметка маркеров|группу маркеров]]. Это позволяет избежать коллизий при разметке маркеров несколькими пользователями.

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

<gallery mode="packed" heights="200px" perrow="2" style="float:left; clear:right; margin-right:1em; margin-left:1em">
58 Блокировка на вкладке Детекторы.png|Блокировка маркера на вкладке '''Детекторы'''
File:59_Блокировка_на_вкладке_Файлы.png|Блокировка маркера на вкладке '''Файлы'''
60_Блокировка_на_правой_панели.png|Блокировка маркера на правой панели
</gallery>
 

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

Чтобы посмотреть все блокировки, перейдите в раздел [[Help:UI manual#Настройка сервера Svacer|'''Настройки''']] на [[Help:UI manual#Управление блокировками разметки|вкладку '''Блокировки''']]:

[[File:61 Просмотр всех блокировок.png|thumb|none|upright=3.5|Таблица блокировок]]

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

=== Добавление комментария к нескольким маркерам ===
Для добавления комментария к нескольким маркерам одновременно:
:1. В режиме разметки [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выберите исходный контекст]] – проект, ветку, снимок.
:2. Включите отображение [[Help:UI manual#Таблица Маркеров|таблицы маркеров]].
:3. Выберите маркеры для разметки – установите флажки в строках таблицы.
:4. Нажмите кнопку [[File:Button Comment Add.png|x25px]] (доступна, если выбраны маркеры в таблице).

:[[File:128 Добавление общего комментария 1.png|400px|thumb|none|Выбор маркеров для добавления комментария к нескольким маркерам одновременно]]
:5. Отобразится окно для добавления комментария к нескольким маркерам одновременно.

:[[File:129 Добавление общего комментария 2.png|600px|thumb|none|Окно добавления комментария к нескольким маркерам одновременно]]
:6. Введите комментарий.
:Редактор комментариев поддерживает синтаксис Markdown.
:Для упоминания пользователя, вставьте '''@''' и введите или выберите его логин. После добавления комментария по нажатии кнопки '''Применить''' указанному пользователю придет [[Help:UI manual#Просмотр уведомлений в интерфейсе Системы|уведомление в интерфейсе системы]] об упоминании с возможностью перехода к маркеру с этим комментарием.
:8. Нажмите кнопку '''Сохранить'''.

=== Экспорт ===
В режиме разметки можно выполнить экспорт:
* [[Help:UI manual#Экспорт исходного кода с разметкой|исходного кода с разметкой]];
* [[Help:UI manual#Экспорт снимка в формате snap|снимка в формате snap]];
* [[Help:UI manual#Экспорт разметки и снимка в SARIF|снимка в формате SARIF]];
* [[Help:UI manual#Экспорт разметки|разметки в файл]].
{{Note|type=warn|text=''Функциональность доступна пользователям с [[#Проектные доступы|проектным доступом]] '''Экспорт снимков'''''}}

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

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

::При экспорте можно исключить файлы, соответствующие [[Help:UI manual#Использование регулярных выражений|регулярным выражениям]] в поле '''Исключить пути'''.
:4. Нажмите кнопку '''Экспортировать'''.
В итоге создастся архив файлов с исходным кодом и, если был выбран шаблон разметки, то в исходный код будет добавлена актуальная разметка, в соответствии с выбранным шаблоном.

==== Экспорт снимка в формате snap ====
Чтобы экспортировать с сервера исходный код снимка в формате .snap:
:1. [[Help:UI manual#Работа в режиме разметки|В режиме разметки]] [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выберите исходный контекст]] – проект, ветку и снимок.
:2. На вкладке '''Информация о снимке''' нажмите кнопку '''Экспорт''' и выберите пункт '''Снимок (*.snap)'''.
:[[File:192 Разметка. Переход к экспорту снимка в формате snap.png|600px|thumb|none|Переход к экспорту снимка в формате snap]]
:Запустится формирование файла. При старте и по окончании экспорта пользователю отобразится соответствующее всплывающее сообщение.
:[[File:193 Сообщение. Экспорт снимка.png|thumb|600px|thumb|none|Пример всплывающих сообщений при старте и окончании экспорта снимка]]

==== Экспорт разметки и снимка в SARIF ====
Чтобы экспортировать разметку и при необходимости исходный код снимка в файл формата SARIF:
:1. [[Help:UI manual#Работа в режиме разметки|В режиме разметки]] [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выберите исходный контекст]] – проект, ветку и снимок.
:2. На вкладке '''Информация о снимке''' нажмите кнопку '''Экспорт''' и выберите пункт '''SARIF'''.
:[[File:194 Разметка. Переход к экспорту снимка SARIF.png|thumb|600px|thumb|none|Переход к экспорту снимка SARIF]]
:3. В открывшемся окне:
::а) Выключите (опционально) формирование название файла по умолчанию – снимите соответствующий флажок и введите название снимка.
::б) Опционально включите или выключите экспорт исходных файлов.
::в) Нажмите кнопку '''Экспортировать'''.
:[[File:195 Окно экспорта SARIF.png|thumb|600px|thumb|none|Окно экспорта снимка SARIF]]
:Запустится формирование файла. При старте и по окончании экспорта пользователю отобразится всплывающее сообщение.
:[[File:220 Сообщение. Экспорт SARIF.png|thumb|400px|thumb|none|Пример всплывающих сообщений при старте и окончании экспорта снимка в SARIF]]

==== Экспорт разметки ====
Чтобы из ветки проекта экспортировать в файл разметку и/или комментарии:
:1. [[Help:UI manual#Работа в режиме разметки|В режиме разметки]] [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выберите исходный контекст]] – проект, ветку и снимок.
:2. На вкладке '''Информация о снимке''' нажмите кнопку '''Экспорт''' и выберите пункт '''Разметка'''.
:[[File:196 Разметка. Переход к экспорту разметки.png|thumb|thumb|thumb|600px|none|Переход к экспорту разметки]]
:3. В открывшемся окне:
::а) Выберите вариант экспорта.
::б) Если требуется экспортировать неразмеченные маркеры, установите флажок '''Включая разметку со статусом "Undecided"'''.
::в) Нажмите кнопку '''Экспортировать'''.
:[[File:197 Окно экспорта разметки.png|thumb|thumb|thumb|600px|none|Окно экспорта разметки]]

=== Импорт разметки ===
В режиме разметки можно импортировать разметку из двух источников:
* [[Help:UI manual#Импорт разметки из файла|из файла]];
* [[Help:UI manual#Импорт разметки из исходного кода|из исходного кода снимка]].
{{Note|type=warn|text=''Функциональность доступна пользователям с [[#Проектные доступы|проектным доступом]] '''Импорт разметки'''''}}

==== Импорт разметки из файла ====
Чтобы импортировать файл с разметкой:
:1. [[Help:UI manual#Работа в режиме разметки|В режиме разметки]] [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выберите исходный контекст]] – проект, ветку и снимок.
:2. На вкладке '''Информация о снимке''' нажмите кнопку '''Импорт''' и выберите пункт '''Разметка из файла'''.
:[[File:198 Разметка. Переход к импорту разметки из файла.png|thumb|thumb|thumb|600px|none|Переход к импорту файла с разметкой]]
:3. В открывшемся окне:
::а) Выберите файл архива в формате .gz.
::б) Выберите варианты импорта и действия при наличии конфликта разметки.
::в) Нажмите кнопку '''Импортировать'''.
:[[File:199 Окно импорта файла с разметкой.png|thumb|600px|thumb|none|Окно импорта файла с разметкой]]
:По окончании пользователю отобразится всплывающее сообщение с информацией о выполненной операции.
:[[File:200 Сообщение. Импорт разметки из файла.png|thumb|thumb|thumb|600px|none|Пример всплывающего сообщения об окончании импорта разметки из файла]]

==== Импорт разметки из исходного кода ====
Чтобы импортировать разметку из исходного кода снимка в ветку проекта:
:1. [[Help:UI manual#Работа в режиме разметки|В режиме разметки]] [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выберите исходный контекст]] – проект, ветку и снимок.
:2. На вкладке '''Информация о снимке''' нажмите кнопку '''Импорт''' и выберите пункт '''Разметка из исходного кода'''.
:[[File:201 Разметка. Переход к импорту разметки из кода.png|thumb|thumb|thumb|thumb|600px|none|Переход к импорту исходного кода с разметкой]]
:3. В открывшемся окне выберите шаблон разметки и нажмите кнопку '''Импортировать'''.
:[[File:134_Импорт_разметки.png|thumb|thumb|thumb|600px|none|Окно импорта исходного кода с разметкой]]
:По окончании пользователю отобразится всплывающее сообщение с информацией о выполненной операции.
:[[File:203 Сообщение. Импорт разметки из кода.png|thumb|thumb|thumb|thumb|600px|none|Пример всплывающего сообщения об окончании импорта разметки из исходного кода снимка]]

=== Работа с таблицей статистики ===
Чтобы посмотреть краткую статистику о разметке маркеров:
:1. [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|Выберите исходный контекст]].
:2. Перейдите [[Help:UI manual#Работа в режиме разметки|в режим разметки]].
:3. На вкладке '''Информация о снимке''' в строке свойства '''Статистика по детекторам''' нажмите кнопку '''Показать'''.

:[[File:64 Переход к просмотру статистики.png|600px|thumb|none|Переход к просмотру статистики]]

:Отобразится таблица статистики:
:[[File:65 Таблица статистики.png|600px|thumb|none|Таблица статистики]]
:4. Нажмите кнопку [[File:Icon download CSV.png|x20px]] или [[File:Icon download PDF.png|x20px]], чтобы выгрузить статистику в соответствующем формате.
:5. Нажмите кнопку [[File:Icon filter.png|x20px]] в строке статистики, чтобы применить [[Help:UI manual#Настройка и использование пользовательских фильтров|пользовательский фильтр]] с параметрами, которые соответствуют выбранному значению.

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

Для этого:
:1. Перейдите в режим просмотра кода по кнопке меню [[File:Button Код.png|x25px]] в верхней части экрана.
:2. [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|Выберите исходный контекст]]. 
:{{Note|type=info|text=''По умолчанию выбран контекст (проект, ветка), заданный ранее в режиме [[Help:UI manual#Работа в режиме разметки|'''Разметка''']]. Если Пользователь перешел в раздел '''Кoд''' из режима сравнения снимков раздела [[Help:UI manual#Работа в режиме разметки|'''Разметка''']], то для изменения контекста требуется отменить режим сравнения.''}}
:В левой части экрана отобразится иерархический список файлов снимка, а в правой – поле для отображения исходного кода файла.
:[[File:67 Режим просмотра кода.png|600px|thumb|none|Режим просмотра кода. Начальное состояние]]
:3. Для поиска файла:
::а) Кликните на поле поиска или нажмите комбинацию клавиш '''Ctrl+Shift+O'''.
::б) В открывшемся окне введите поисковый запрос и выберите файл.
:4. В левой части экрана раскройте группу файлов и нажмите на имя файла.
:В правой части отобразится исходный код файла.
:[[File:68 Режим просмотра кода открыт один файл.png|600px|thumb|none|Пример одного открытого файла]]
:5. Если требуется, откройте другие файлы.
:Они отобразятся на отдельных вкладках, если выключена [[Help:UI manual#Настройка профиля пользователя|настройка '''Переиспользование вкладки в редакторе кода''']].
:[[File:69 Режим просмотра кода открыто три файла.png|600px|thumb|none|Пример трёх открытых файлов]]
:6. Для перехода к предыдущей или следующей строке, в которую пользователь устанавливал курсор, используйте кнопки [[File:Button left.png|x25px]] и [[File:Button right.png|x25px]] или сочетания клавиш '''Ctrl+< и Ctrl+>'''.
:7. Вызовите функции, доступные по нажатии правой кнопки мыши на строке исходного кода
:* '''Перейти к объявлению''' – для перехода к строке, в которой объявлена переменная;
:* '''Перейти к определению''' – для перехода к строке, в которой определена переменная и функция;
:* '''Найти ссылки''' – для просмотра ссылок в панели с иерархическим списком файлов, именами файлов и номерами строк, в которых найдены ссылки;
::{{Note|type=info|text=''Если для выделенного элемента кода нет объявления, определения или ссылок, то отобразится сообщение: [[File:150 Объявление не найдено.png|x25px]], [[File:151 Определение не найдено.png|x25px]] или [[File:152 Ссылки не найдены.png|x25px]].''}}
::[[File:24 Исходный код Cписок файлов со ссылками.png|thumb|none|600px|Cписок файлов с номерами строк, в которых найдены ссылки]]
:* '''Копировать прямую ссылку''' – копирование ссылки на строку кода в буфер обмена.
::При переходе по этой ссылке будет открываться файл в режиме просмотра кода с курсором на той строке кода, для которой была скопирована ссылка;
:* '''Уменьшить''' и '''Увеличить''' – увеличение и уменьшение размера шрифта кода (эти функции также можно вызвать с помощью сочетаний клавиш '''Ctrl+Alt+-''' или '''Ctrl+Alt+=''').
:* '''Copy''' – для копирования строки в буфер обмена;
:* '''Command Palette''' – для вызова командной строки.
:6. Установите курсор в строке кода, чтобы отобразилось его позиционирование в правом нижнем углу.
:[[File:130 Позиционирование к коде.png|600px|thumb|none|Отображение позиционирования курсора в коде]]
:7. Сравните файлы – для этого:
::а) Нажмите правой кнопки мыши на имени файла и выберите пункт '''Сравнить с…'''
::[[File:156 Переход к сравнению файлов.png|thumb|none|600px|Переход к сравнению файлов]]
::б) В открывшемся окне выберите файл для сравнения. Для этого выберите проект, ветку и снимок, а затем раскройте группы файлов или воспользуйтесь поисковой строкой, нажмите на имя файла.
::По умолчанию выбраны проект и ветка исходного контекста.
::в) Нажмите кнопку '''Сравнить'''.
:Откроется окно сравнения файлов.

:[[File:Code compare 2.png|600px|thumb|none|Окно выбора файла для сравнения]]

:[[File:Code_compare_3.png|600px|thumb|none|Окно сравнения файлов]]

==Управление проектами и группами проектов==
В разделе '''Проекты''' отображаются все проекты со всеми ветками и снимками.
Для удобства работы проекты могут быть [[Help:UI manual#Работа с группами проектов|сгруппированы]]. Один проект может быть включен в несколько групп проектов.
[[File:101 Раздел Проекты.png|thumb|none|upright=3|Раздел '''Проекты''']]

===Работа с проектами===
Список проектов отображается в левой части экрана и организован в виде иерархии. При этом:
* для проектов, разметку маркеров которых нужно в обязательном порядке снабжать комментариями, отображается иконка [[File:Icon comment.png|x25px]];
* в нижней части списка отображается общее количество проектов и веток с учетом примененных фильтров, а также выбранных проектов и веток.
В списке доступны:
* поиск по имени проекта;
* фильтрация списка по группам проектов;
* сортировка по названию или дате создания (по умолчанию – по названию).
При работе с проектами пользователю доступны следующие функции:
:1. Загрузка актуальных данных с сервера – для этого нажмите кнопку [[File:Icon refresh.png|x25px]].
:2. Просмотр списка веток – для этого нажмите на название проекта.
:Ветки отобразятся в этом же списке проекта на втором уровне.
:3. Просмотр списка снимков – для этого нажмите на название ветки.
:Список снимков отобразится в виде таблицы в правой части экрана.
:4. [[Help:UI manual#Работа с группами проектов|Группировка проектов]].
:5. Создание проекта:
::а) Нажмите кнопку '''Создать проект'''.
::Откроется окно создания проекта.
::[[File:102 Создание проекта.png|thumb|none|upright=1.5|Окно создания проекта]]
::б) Введите название проекта.
::в) Для выбора одной или нескольких существующих групп кликните на поле '''Группы''' и выберите одно или несколько значений в списке:
::[[File:157 Окно создания проекта. Выбор существующей группы.png|thumb|none|upright=1.5|Окно создания проекта. Пример выбора существующей группы]]
::г) Для создания одной новой группы введите ее название и нажмите кнопку '''Создать''' в появившейся форме:
::[[File:158 Окно создания проекта.Создание одной группы.png|thumb|none|upright=1.5|Окно создания проекта. Пример создания одной группы]]
::д) Для создания нескольких новых групп введите их названия через запятую и нажмите кнопку '''Создать''' в появившейся форме:
::[[File:159 Окно создания проекта. Создание нескольких групп.png|thumb|none|upright=1.5|Окно создания проекта. Пример создания двух групп]]
::е) Установите флажок, если требуется при разметке маркеров обязательно добавлять комментарий.
::ж) Нажмите кнопку '''Создать'''.
:При создании проекта автоматически создается ветка '''master'''.
:При импорте снимка в интерфейсе командной строки проект, при его отсутствии, добавляется автоматически.
:6. Добавление ветки: [[File:103 Создание ветки.png|thumb|right|none|upright=1.5|Окно добавления ветки в проект]]
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке проекта.
::б) В меню выберите пункт '''Создать ветку'''.
::в) В открывшемся окне введите название ветки и нажмите кнопку '''Создать'''.
:При импорте снимка в интерфейсе командной строки ветка, при ее отсутствии, добавляется автоматически.

:7. Клонирование проекта со всеми ветками и снимками: [[File:132 Окно клонирования проекта.png|thumb|right|none|upright=1.5|Окно клонирования проекта]]
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке проекта.
::б) В меню выберите пункт '''Клонировать'''.
::в) В открывшемся окне введите название нового проекта, при необходимости скорректируйте группы, в которые будет входить клонированный проект (по умолчанию, группы исходного проекта) и нажмите кнопку '''Клонировать'''.

:9. Редактирование параметров проекта:
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке проекта.
::б) В меню выберите пункт '''Редактировать'''.
::в) В открывшемся окне измените название проекта, скорректируйте список групп, в которые включен проект, и установите или снимите флажок обязательности комментария при разметке и нажмите кнопку '''Сохранить'''.
:10. Удаление одного проекта:
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке проекта.
::б) В меню выберите пункт '''Удалить'''.
::в) Подтвердите удаление.
:11. Удаление нескольких проектов с ветками:
::а) Выберите проекты для удаления – установите флажки в левой части названий проектов и веток или нажмите кнопку '''Выбрать всё'''.
::б) Нажмите кнопку '''Удалить''' в верхней части списка проектов и подтвердите удаление.
При удалении проекта удаляются все его ветки и снимки, разрывается связь проекта с группами.

===Работа с группами проектов===
Работа с группами проектов доступна на отдельной панели '''Группы проектов''', которая отрывается по нажатии кнопки [[File:Icon gear.png|x25px]] в списке проектов. При этом в нижней части списка отображается общее количество групп.

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

[[File:104 Панель групп.png|thumb|none|upright=3|Панель '''Группы проектов''']]
При работе с группами проектов пользователю доступны следующие функции:
:1. Просмотр списка связанных с группой проектов – для этого нажмите на название группы.
:Проекты отобразятся в этом же списке групп на втором уровне.
 
:2. Добавление группы: [[File:105 Создание группы.png|thumb|right|none|upright=1.5|Окно '''Создать группу''']]
::а) Нажмите кнопку '''Создать группу'''.
::б) В открывшемся окне введите название группы и выберите проекты, которые в неё войдут, нажмите кнопку '''Создать'''.
:Созданная группа отобразится в списке на панели '''Группы проектов'''.
 
:3. Редактирование параметров группы: [[File:106 Редактирование группы.png|thumb|right|none|upright=1.5|Окно Редактировать группу]]
::а) Нажмите кнопку [[File:Icon edit2.png|x25px]] в строке группы.
::б) В открывшемся окне измените название группы, скорректируйте состав включенных в группу проектов.
::в) Нажмите на кнопку [[File:Icon cancel.png|x25px]] справа от названия проекта в списке, чтобы исключить его из группы.
::г) Нажмите кнопку '''Сохранить'''.
 
:4. Исключение одного проекта из группы – для этого нажмите кнопку [[File:Icon hide marks.png|x25px]] в правой части списка проектов группы.
:5. Удаление одной группы – для этого нажмите кнопку [[File:Icon delete.png|x25px]] в правой части списка групп и подтвердите удаление.
:6. Удаление нескольких групп:
::а) Выберите группы для удаления – установите флажки в левой части названий групп или нажмите кнопку '''Выбрать всё'''.
::б) Нажмите кнопку '''Удалить''' в верхней части списка групп проектов и подтвердите удаление.
:При удалении группы разрывается связь проекта с группой. Сами проекты не удаляются.

===Работа с ветками===
При работе с ветками проекта пользователю доступны следующие функции:
:1. Просмотр списка снимков – для этого нажмите на название ветки в списке проектов.
:Список снимков отобразится в виде таблицы в правой части экрана.
:2. Редактирование ветки: [[File:107 Редактирование ветки.png|thumb|right|upright=1.5|Окно редактирования ветки]]
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке ветки.
::б) В меню выберите пункт '''Редактировать'''.
::в) В открывшемся окне измените название ветки и нажмите кнопку '''Сохранить'''.
 
:3. Клонирование ветки проекта: [[File:108 Клонирование ветки.png|thumb|right|upright=1.5|Окно клонирования ветки]]
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке ветки.
::б) В меню выберите пункт '''Клонировать'''.
::в) В открывшемся окне введите название новой ветки и нажмите кнопку '''Клонировать'''.
 
:4. Экспорт разметки в файл: [[File:197 Окно экспорта разметки.png|thumb|right|upright=1.5|Окно экспорта разметки]]
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке ветки.
::б) В меню выберите пункт '''Экспорт разметки'''.
::Откроется окно экспорта разметки.
::в) Выберите вариант экспорта.
::г) Если требуется экспортировать неразмеченные маркеры, установите флажок '''Включая разметку со статусом "Undecided"'''.
::д) Нажмите кнопку '''Экспортировать'''.
::{{Note|type=warn|text=''Функциональность доступна пользователям с [[#Проектные доступы|проектным доступом]] '''Экспорт снимков'''''}}
 
:5. Импорт разметки из файла: [[File:199 Окно импорта файла с разметкой.png|thumb|right|upright=1.5|Окно импорта разметки]]
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке ветки.
::б) В меню выберите пункт '''Импорт разметки'''.
::Откроется окно импорта разметки.
::в) Выберите файл архива в формате .gz.
::г) Выберите варианты импорта и действия при наличии конфликта разметки.
::д) Нажмите кнопку '''Импортировать'''.
::{{Note|type=warn|text=''Функциональность доступна пользователям с [[#Проектные доступы|проектным доступом]] '''Импорт снимков'''''}}
 
:6. Удаление ветки:
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке ветки.
::б) В меню выберите пункт '''Удалить'''.
::в) Подтвердите удаление.
::При удалении ветки удаляются все ее снимки.
 
:7. Очистка разметки: [[File:160 Окно очистки разметки.png|thumb|right|upright=1.5|Окно очистки разметки]]
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке ветки.
::б) В меню выберите пункт '''Очистить разметку'''.
::в) В открывшемся окне выберите вариант очистки.
::г) Нажмите кнопку '''Очистить'''.
::{{Note|type=warn|text=''Функциональность доступна пользователям с [[#Проектные доступы|проектными доступами]] '''Управление ветками и снимками''', '''Разметка маркеров''' и [[#Cерверные доступы|серверным доступом]] '''Администрирование сервера'''.''}}
 
:8. Копирование разметки в другой контейнер (проект и ветку): [[File:Image.png|thumb|right|upright=1.5|Окно копирования разметки в другой контейнер]]
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке ветки и в меню выберите пункт '''Копировать разметку'''.
::б) В открывшемся окне выберите проект и ветку, в которые нужно скопировать разметку, а также действия, которые нужно выполнить при наличии разметки.
::в) Нажмите кнопку '''Копировать'''.
 
Разметка в контейнере состоит из множества размеченных маркеров. В целевой ветке уже может находиться разметка. Все множество маркеров в исходной ветке можно разбить на два:
* «Уникальные» – маркеры, которые есть только в исходной ветке;
* «Общие» – маркеры, которые есть как в ветке-источнике, так и в ветке-приемнике.
При выполнении операции копирования разметка в уникальных маркерах всегда копируется в ветку-приемник. Для «Общих» маркеров возможны несколько вариантов продолжения копирования, но по умолчанию выбран пункт '''Не копировать''' – в этом случае разметка в «Общих» маркерах в ветке-приемнике не изменяется.

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

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

'''Пример'''
:Есть несколько контейнеров:
:* 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.
:При выполнении копирования наличие маркера в ветке-приемнике не проверяется.
:При успешном копировании выводится всплывающее сообщение с описанием выполненных операций:
:[[File:161 Сообщение об успешном копировании разметки.png|thumb|none|upright=2|Пример всплывающего сообщения об успешном копировании разметки]]

===Работа со снимками===
Список снимков отображается в правой части экрана в виде таблицы после выбора ветки проекта. При этом в нижней части списка отображается общее количество снимков в выбранной ветке и количество выбранных снимков.
В списке доступны:
* поиск по названию снимка;
* сортировка по значениям столбцов (по умолчанию — по дате создания).
При работе со снимками пользователю доступны следующие функции:
:1. Импорт снимка из файла – для этого нажмите кнопку '''Импорт''' в верхней части табличного списка снимков и в открывшемся списке выберите один из вариантов импорта: '''Снимок (*.snap)''', '''Архив .svace-dir''' или '''SARIF'''.
:{{Note|type=warn|text=''Функциональность доступна пользователям с [[#Проектные доступы|проектным доступом]] '''Импорт снимков'''''}}
:После этого:
[[File:110 Импорт снимка.png|thumb|right|upright=1.5|Окно импорта снимка из файла в формате snap]]
::а) Если выбран импорт из файла в формате snap, то в открывшемся окне:
::* выберите файл в формате .snap;
::* введите название снимка (опционально);
::* Задайте [[Edit markers (command line)|правила трансформации, пропуска и дедупликации маркеров]] в поле '''Редактировать маркеры''' – загрузите JSON-файл с правилами или введите их;
::* нажмите кнопку '''Импортировать'''.
::{{Note|type=info|text=''Если при импорте снимка из snap-файла название не введено, то будет использовано название исходного снимка (параметр «name» в JSON с информацией о снимке).''}}
[[File:133 Импорт снимка из архива svace-dir.png|thumb|right|upright=1.5|Окно импорта снимка из архива в формате svace-dir]]
[[File:133.1_Импорт_снимка_из_архива_svace-dir_-_Поля_опций.png|thumb|right|upright=1.5|Окно импорта снимка из архива в формате svace-dir. Поля опций для расширенных настроек]]
 
::б) Если выбран импорт архива .svace-dir, то в открывшемся окне:
::* выберите архив .svace-dir;
::* введите название снимка (опционально);
::* выберите шаблон разметки (опционально);
::* укажите правила префикса пути (опционально);
::* укажите расширенные настройки (опционально): для каждой настройки нажмите кнопку '''Добавить''', в появившихся полях выберите опцию и введите её значение; для удаления настройки нажмите кнопку [[File:Icon delete.png|x25px]].
::После выбора параметра в поле появляется иконка [[File:Icon question mark2.png|x15px]], по наведении курсора на которую можно посмотреть описание;
::* нажмите кнопку '''Импортировать'''.
::При старте операции и по ее окончании пользователю отобразятся соответствующие всплывающие сообщения.
::[[File:210 Сообщение. Импорт svace-dir.png|thumb|none|upright=1.5|Пример всплывающих сообщений при старте и окончании импорта снимка из архива в формате svace-dir]]
 
[[File:217 Импорт снимка SARIF.png|thumb|right|upright=1.5|Окно импорта снимка из файла в формате SARIF]]
[[File:218 Импорт снимка SARIF - поля опций.png|thumb|right|upright=1.5|Окно импорта снимка из архива в формате SARIF. Поля опций для расширенных настроек]]
::в) Если выбран импорт из файла в формате SARIF, то в открывшемся окне:
::* выберите файл в формате .sarif или .json, либо архив в одном из форматов: .tar, tar.bz2, tar.gz, zip;
::* введите название снимка (опционально);
::* укажите правила префикса пути (опционально);
::* укажите расширенные настройки (опционально): для каждой настройки нажмите кнопку '''Добавить''', в появившихся полях выберите опцию и введите её значение; для удаления настройки нажмите кнопку [[File:Icon delete.png|x25px]].
::После выбора параметра в поле появляется иконка [[File:Icon question mark2.png|x15px]], по наведении курсора на которую можно посмотреть описание;
::* нажмите кнопку '''Импортировать'''.
::При старте операции и по ее окончании пользователю отобразятся соответствующие всплывающие сообщения.
::[[File:211 Сообщение. Импорт SARIF.png|thumb|none|upright=1.5|Пример всплывающих сообщений при старте и окончании импорта снимка из архива в формате SARIF]]
:{{Note|type=info|text='''''Примечание:'''''
:* ''для импорта поддерживаются архивы папки .svace-dir, заархивированные с помощью tar, gz, bz2 или zip (*.tar, *.tar.gz, *.tar.bz2, *.zip);''
:* ''если при импорте архива .svace-dir название снимка не введено, то оно будет соответствовать времени импорта результатов анализа из Svace;''
:* ''в поле '''Расширенные настройки''' поддерживается ввод дополнительных опций команды <code>svacer import</code> – как в интерфейсе командной строки (например, <code>--attach value</code>). В аргументах дополнительных опций требуется указывать пути относительно архивированной папки. Описание опций можно найти, запустив команду <code>svacer import --help</code>''.
:* ''для импорта снимка из snap-файла, .svace-dir или SARIF может потребоваться много времени: как на загрузку, так и на обработку данных после загрузки. При работе сервера Svacer за reverse proxy их дефолтных значений таймаутов или ограничений на размер загружаемых данных может быть недостаточно, поэтому рекомендуется увеличить эти значения в конфигурационных файлах reverse proxy, см. [[Help:Configuration#Nginx|пример для Nginx]]''}}
:2. Экспорт снимка – для этого нажмите кнопку [[File:Icon export.png|x25px]]в крайнем правом столбце строки снимка и в открывшемся списке выберите один из вариантов экспорта: '''Экспорт (*.snap)''', '''Экспорт SARIF''' или '''Экспорт кода с разметкой'''.
:После этого:
::а) Если выбран экспорт в файл в формате snap, то по окончании его формирования во всплывающем сообщении нажмите кнопку '''Скачать'''.
::[[File:193 Сообщение. Экспорт снимка.png|thumb|none|upright=1.5|Пример всплывающих сообщений при старте и окончании экспорта снимка]]
:[[File:195 Окно экспорта SARIF.png|thumb|right|upright=1.5|Окно экспорта снимка SARIF]]
::б) Если выбран экспорт файла формата SARIF, то в открывшемся окне:
::* Выключите (опционально) формирование название файла по умолчанию – снимите соответствующий флажок и введите название снимка.
::* Опционально включите или выключите экспорт исходных файлов.
::* Нажмите кнопку '''Экспортировать'''.
::Запустится формирование файла. При старте и по окончании экспорта пользователю отобразится всплывающее сообщение.
::[[File:220 Сообщение. Экспорт SARIF.png|thumb|none|upright=1.5|Пример всплывающих сообщений при старте и окончании экспорта снимка в SARIF]]
:[[File:340 Проекты Окно экспорта кода с разметкой.png||thumb|right|upright=1.5|Окно экспорта кода с разметкой]]
::в) Если выбран экспорт кода с разметкой, то в открывшемся окне:
::* Если требуется экспортировать разметку, установите флажок параметра '''Шаблон разметки''' и выберите шаблон для экспорта в списке справа.
::* Опционально включите или выключите очистку старых комментариев.
::* Опционально заполните поля для удаления префиксов и исключения путей.
::* Опционально введите регулярные выражения для очистки дополнительных строк (доступен, если включена очистка старых комментариев).::
::Пример удаления префиксов путей: <code>/.build/</code>

::При экспорте можно исключить файлы, соответствующие [[Help:UI manual#Использование регулярных выражений|регулярным выражениям]] в поле '''Исключить пути'''.
::* Нажмите кнопку '''Экспортировать'''.
::В итоге создастся архив файлов с исходным кодом и, если был выбран шаблон разметки, то в исходный код будет добавлена актуальная разметка, в соответствии с выбранным шаблоном.
:3. Переход к разметке маркеров снимка:
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в крайнем правом столбце строки снимка.
::б) В меню выберите пункт '''Разметить'''.
[[File:111 Редактирование снимка.png|thumb|right|upright=1.5|Окно редактирования снимка]]
:4. Редактирование названия снимка:
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в крайнем правом столбце строки снимка.
::б) В меню выберите пункт '''Редактировать'''.
::в) Поменяйте название и нажмите кнопку '''Сохранить'''.
[[File:212 Окно Копирование снимков.png|thumb|right|upright=1.5|Окно копирования снимка. Пример для одного снимка]]
:5. Копирование одного снимка в другой проект и ветку:
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в крайнем правом столбце строки снимка.
::б) В меню выберите пункт '''Копировать'''.
::в) В открывшемся окне выберите проект и ветку, в которые нужно добавить копию снимка, нажмите кнопку '''Копировать'''.
::При старте операции и по ее окончании пользователю отобразятся соответствующие всплывающие сообщения.
::[[File:213 Сообщение. Копирование снимков.png|thumb|none|upright=1.5|Пример всплывающих сообщений при старте и окончании копирования одного снимка]]
[[File:214 Окно Копирование нескольких снимков.png|thumb|right|upright=1.5|Окно копирования снимка. Пример для двух снимков]]
:6. Копирование нескольких снимков в другой проект и ветку:
::а) Чтобы выбрать для копирования все снимки, установите флажок в заголовке табличного списка снимков.
::б) Чтобы выбрать несколько снимков, установите флажки в крайнем правом столбце табличного списка.
::в) Нажмите кнопку '''Копировать''' в верхней части табличного списка снимков.
::г) В открывшемся окне выберите проект и ветку, в которые нужно добавить копии выбранных снимков, нажмите кнопку '''Копировать'''.
::При старте операции и по ее окончании пользователю отобразятся соответствующие всплывающие сообщения.
::[[File:215 Сообщение. Копирование двух снимков.png|thumb|none|upright=1.5|Пример всплывающих сообщений при старте и окончании копирования двух снимков]]
:[[File:134 Импорт разметки.png|thumb|right|upright=1.5|Окно импорта разметки]]
:7. Импорт разметки из комментариев исходного кода снимка в активную ветку проекта:
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в крайнем правом столбце строки снимка.
::б) В меню выберите пункт '''Импорт разметки из исходного кода'''.
::в) В открывшемся окне выберите шаблон разметки и нажмите кнопку '''Импортировать'''.
::По окончании пользователю отобразится всплывающее сообщение с информацией о выполненной операции.
::[[File:216 Сообщение. Импорт разметки из кода.png|thumb|none|upright=1.5|Пример всплывающего сообщения об окончании импорта разметки из файла]]

:8. Просмотр информации о снимке в JSON-формате:
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке снимка крайнем правом столбце.
::б) В меню выберите пункт '''Просмотреть JSON'''.
:[[File:112 Просмотр JSON снимка.png|thumb|none|upright=3|Окно просмотра информации о снимке в JSON-формате]]
:9. Удаление одного снимка:
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке снимка крайнем правом столбце.
::б) В меню выберите пункт '''Удалить'''.
::в) Подтвердите удаление.
:10. Удаление нескольких снимков:
::а) Чтобы выбрать для удаления все снимки, установите флажок в заголовке табличного списка снимков.
::б) Чтобы выбрать несколько снимков, установите флажки в крайнем правом столбце табличного списка.
::в) Нажмите кнопку '''Удалить''' в верхней части табличного списка снимков и подтвердите удаление.

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

[[File:135 Раздел Детекторы.png|thumb|none|upright=3|Раздел «Детекторы»]]

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

{{Note|type=info|text=''При обновлении списка детекторов и их параметров в Svace изменения попадают в Svacer при выпуске новой версии системы!''}}

В разделе '''Детекторы''' пользователю доступны следующие функции:
:1. Поиск детектора по его названию, серьезности, надежности и коду дефекта безопасности CWE.
:2. Сортировка по значениям столбцов (по умолчанию – по названию детектора).
:3. Переход к просмотру описания дефекта безопасности на сайте [https://cwe.mitre.org cwe.mitre.org] (открывается в отдельном окне) – для этого нажмите на ссылку в столбце '''CWE'''.
:4. Просмотр дополнительной информации о детекторе при её наличии – для этого нажмите на иконку [[File:icon_question_mark2.png|x25px]] справа от названия детектора.

:[[File:121_Окно с дополнительной информацией о детекторе.png|thumb|none|upright=2|Раздел «Детекторы». Пример окна с дополнительной информацией о детекторе]]

:5. Фильтрация списка – для этого:
::а) Нажмите кнопку [[File:Button Фильтр.png|x25px]].
::б) В открывшемся окне '''Фильтр''' настройте параметры фильтрации – выберите значения в списках полей или нажмите кнопки со значениями.
::в) Нажмите кнопку [[File:button_Очистить.png|x25px]], чтобы очистить все параметры фильтрации.
::г) Нажмите кнопку [[File:button_Применить.png|x25px]], чтобы применить фильтр.

:[[File:137 Детекторы.Фильтр.png|thumb|none|upright=2|Раздел «детекторы». Окно «Фильтр»]]

:6. Отмена примененных фильтров – для этого нажмите кнопку [[File:Button Фильтр отмена.png|x25px]].
:7. Выбор отображаемых столбцов – для этого нажмите на кнопку '''Столбцы''' и в открывшемся списке установите или снимите флажки рядом с названиями столбцов.
:Для настройки скрытия или показа доступны все столбцы, кроме '''Детектор'''. Столбцы '''Статус''' и '''Инструменты''' по умолчанию скрыты.
:Пользовательская настройка отображения столбцов сохраняется и не сбрасывается при повторном входе пользователя в систему.

:[[File:138 Детекторы выбор столбцов.png|thumb|none|upright=1.5|Раздел «Детекторы». Выбор отображаемых столбцов]]

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

== Просмотр статистики ==
В разделе '''Статистика''' пользователь может посмотреть статистические данные о разметке по всем проектам, веткам и снимкам, доступным пользователю. Все статистические данные разделены на три группы и отображаются в отдельных дашбордах:
* [[Help:UI manual#Работа с дашбордом «Общая статистика»|'''Общая статистика''']] – показатели по последним импортированным снимкам в ветках проектов;
* [[Help:UI manual#Работа с дашбордом «Распределение маркеров»|'''Распределение маркеров''']] – диаграммы с информацией о количестве маркеров и их распределении по серьезности, статусу разметки и языкам;
* [[Help:UI manual#Работа с дашбордом «Активность по разметке»|'''Активность по разметке''']] – информация об активности пользователей при разметке маркеров.

[[File:162 Раздел Статистика. Начальное состояние.png|thumb|none|upright=3|Раздел '''Статистика'''. Начальное состояние]]
Чтобы посмотреть информацию:
:1. Выберите дашборд – нажмите кнопку с его названием в верхней части экрана.
:2. Выберите [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|контекст]] (опционально). В дашборде '''Общая статистика''' выбор снимка недоступен.
:2. Нажмите кнопку [[File:Button Play.png|x25px]].
:Если контекст не был выбран, отобразится статистика по всем проектам, веткам и снимкам, доступным пользователю. При этом информация об их количестве отображается в верхней части каждого дашборда.
:[[File:163 Раздел Статистика. Контекст не выбран.png|thumb|none|upright=2.5|Раздел '''Статистика'''. Пример дашборда '''Общая статистика'''. Контекст не выбран]]
:Если контекст был выбран, то отобразится статистика только для выбранных проектов, веток и снимков (кроме '''Общая статистика'''). При этом информация об их количестве отображается в верхней части каждого дашборда.
:[[File:164 Раздел Статистика. Контекст выбран.png|thumb|none|upright=2.5|Раздел '''Статистика'''. Пример дашборда '''Общая статистика'''. Контекст выбран]]

=== Работа с дашбордом «Общая статистика» ===
На дашборде '''Общая статистика''' отображается информация о разметке маркеров в последних импортированных снимках в разрезе проектов и веток. Информация представлена в виде блоков со следующими данными:
* общая информация:
** названия проекта и ветки;
** количество снимков в ветке и дата последнего импорта;
** дата последней разметки маркеров;
* показатели последнего импортированного снимка:
** количество строк кода;
** количество маркеров;
** плотность маркеров – процентное отношение количества маркеров на тысячу строк кода;
** процент и количество размеченных маркеров;
** процент и количество подтвержденных маркеров – со статусом Confirmed;
** процент и количество критичных маркеров – с серьезностью детектора Critical.
:[[File:204 Статистика. Общая статистика.png|thumb|none|upright=2.5|Раздел '''Статистика'''. Дашборд '''Общая статистика''']]
Пользователю доступны следующие функции:
:1. Поиск информации по названиям проектов и веток.
:2. Сортировка данных – для этого в поле справа выберите показатель, по которому требуется сортировать информацию:
:* по датам последних разметки и импорта;
:* по показателям последнего импортированного снимка.
:Для изменения порядка сортировки используйте кнопки [[File:Button Sort.png|x25px]] и [[File:Button Sort UP.png|x25px]].
:3. Переход к последнему импортированному снимку в режиме разметки – нажмите на названия проекта и ветки в блоке.

=== Работа с дашбордом «Распределение маркеров» ===
На дашборде '''Распределение маркеров''' отображаются три диаграммы:
* Количество маркеров по серьезности;
* Количество маркеров по статусу разметки;
* Распределение маркеров по языкам.
[[File:165 Раздел Статистика. Информация о выбранном контексте.png|thumb|none|upright=2.5|Раздел '''Статистика'''. Дашборд '''Распределение маркеров''']]
Пользователю доступны следующие функции:
:1. Просмотр значения диаграммы – для этого наведите курсор на любой графический элемент любой диаграммы.
:2. Выгрузка данных диаграммы в файл формата .csv – для этого нажмите кнопку [[File:Button Download.png|x25px]] в любой диаграмме.

=== Работа с дашбордом «Активность по разметке» ===
На дашборде Активность по разметке отображается информация о действиях пользователей [[Help:UI manual#Работа в режиме разметки|по разметке маркеров]], которая может быть представлена в двух видах:
* диаграмма '''Активность по разметке''' – отражает активность пользователей по разметке маркеров за выбранный месяц (по умолчанию – текущий месяц). Цвет ячеек на диаграмме отражает количество действий пользователя, выполненных в указанную дату: чем темнее цвет, тем больше действий выполнил пользователь. Эта диаграмма отображается по умолчанию; если вид был переключен, то для возврата к этой диаграмме нажмите кнопку [[File:Button ChangeDiagram1.png|x25px]];
* диаграмма '''Лидеры по разметке''' – отражает количество действий пользователей при разметке за выбранный период (по умолчанию – период соответствует месяцу, указанному на диаграмме '''Активность по разметке''') с сортировкой по лидерам. Цвет строк на диаграмме отражает количество действий пользователя: чем темнее цвет, тем больше действий выполнил пользователь. Диаграмма отображается по нажатии кнопки [[File:Button ChangeDiagram2.png|x25px]];
[[File:166 Раздел Статистика. Активность по разметке.png|thumb|none|upright=3|Раздел '''Статистика'''. Дашборд '''Активность по разметке'''. Вид 1: диаграмма '''Активность по разметке''']]
[[File:167 Раздел Статистика. Лидеры по разметке.png|thumb|none|upright=3|Раздел '''Статистика'''. Дашборд '''Активность по разметке'''. Вид 2: диаграмма '''Лидеры по разметке''']]
Пользователю доступны следующие функции:
:1. Просмотр значения диаграммы – для этого наведите курсор на любой графический элемент любой диаграммы.
:2. Выгрузка данных диаграммы в файл формата .csv – для этого нажмите кнопку [[File:Button Download.png|x25px]] в любой диаграмме
:3. В диаграмме '''Активность по разметке''':
::а) Поиск конкретного пользователя – для этого введите фрагмент его логина в поле поиска.
::б) Просмотр статистики за любой другой месяц – для этого выберите год и месяц в раскрывающихся списках вверху диаграммы.
::в) Просмотр активности конкретного пользователя за выбранный месяц – для этого нажмите на его логин.
::Ниже диаграммы '''Активность по разметке''' отобразится список действий по разметке выбранного пользователя. Измененная (неактуальная) разметка отмечена иконкой [[File:Icon archive.png|x25px]].
::[[File:168 Раздел Статистика. Активность по разметке. Выбранный пользователь.png|thumb|none|upright=3|Раздел '''Статистика'''. Дашборд '''Активность по разметке'''. Диаграмма '''Активность по разметке''' и список действий по разметке выбранного пользователя]]
::г) Просмотр активности пользователей в конкретный день месяца – для этого нажмите на число.
::Ниже диаграммы '''Активность по разметке''' отобразится список действий по разметке пользователей за выбранную дату.
::[[File:169 Раздел Статистика. Активность по разметке. Пользователи за дату.png|thumb|none|upright=3|Раздел '''Статистика'''. Дашборд '''Активность по разметке'''. Диаграмма '''Активность по разметке''' и список действий по разметке пользователей за выбранную дату]]
::д) Просмотр активности конкретного пользователя в конкретный день месяца – для этого нажмите ячейку таблицы на пересечении строки с логином пользователя и столбца с числом.
::Ниже диаграммы '''Активность по разметке''' отобразится список действий по разметке выбранного пользователя за выбранную дату.
::[[File:170 Раздел Статистика. Активность по разметке. Одни пользователь за дату.png|thumb|none|upright=3|Раздел '''Статистика'''. Дашборд '''Активность по разметке'''. Диаграмма '''Активность по разметке''' и список действий по разметке выбранного пользователя за выбранную дату]]
::е) Включение и выключение отображения информации о неактуальной (измененной) разметке в списке действий пользователя – для этого воспользуйтесь переключателем '''Исключить активность по неактуальной разметке'''.
::ж) Просмотр маркера в [[Help:UI manual#Работа в режиме разметки|режиме разметки]] – для этого в списке действий нажмите на ссылку с именем файла и номером строки.
::з) Просмотр информации о маркере – для этого в списке действий нажмите кнопку [[File:Button show.png|x25px]] слева от названия маркера.
::В правой части экрана отобразится панель с информацией о маркере.
::[[File:205 Статистика. Активность по разметке. Панель с информацией о маркере.png|thumb|none|upright=3|Панель с информацией о маркере]]
:4. В диаграмме '''Лидеры по разметке''':
::а) Поиск конкретного пользователя – для этого введите фрагмент его логина в поле поиска.
::б) Просмотр статистики за любой другой период времени, кроме текущего месяца – для этого кликните на поле даты вверху диаграммы и вручную введите даты, либо в раскрывшемся календаре выберите диапазон дат: предложенный ('''Сегодня''', '''Вчера''', '''Неделю назад''' и т. п.) или свой.
::[[File:171 Раздел Статистика. Лидеры по разметке. Выбор дат.png|thumb|none|upright=3|Раздел '''Статистика'''. Дашборд '''Активность по разметке'''. Диаграмма '''Лидеры по разметке'''. Выбор диапазона дат]]
::в) Просмотр активности конкретного пользователя за указанный период – для этого нажмите на его логин.
::Ниже диаграммы '''Лидеры по разметке''' отобразится список действий по разметке выбранного пользователя. Измененная (неактуальная) разметка отмечена иконкой [[File:Icon archive.png|x25px]].
::[[File:172 Раздел Статистика. Лидеры по разметке. Выбранный пользователь.png|thumb|none|upright=3|Раздел '''Статистика'''. Дашборд '''Активность по разметке'''. Диаграмма '''Лидеры по разметке''' и список действий по разметке выбранного пользователя]]
::г) Включение и выключение отображения в списке действий пользователя по неактуальной (измененной) разметке – для этого воспользуйтесь переключателем '''Исключить активность по неактуальной разметке'''.
::д) Просмотр маркера в [[Help:UI manual#Работа в режиме разметки|режиме разметки]] – для этого в списке действий нажмите на ссылку с именем файла и номером строки.
::e) Просмотр информации о маркере – для этого в списке действий нажмите кнопку [[File:Button show.png|x25px]] слева от названия маркера.
::В правой части экрана отобразится панель с информацией о маркере.

== Глобальный поиск ==
Глобальный поиск позволяет одновременно по всем доступным пользователю проектам и веткам выполнить поиск в следующих категориях:
* Маркеры;
* Комментарии к маркерам;
* Снимки.

Чтобы воспользоваться глобальным поиском, перейдите в раздел '''Поиск'''.
[[File:173 Раздел Поиск. Начальное состояние.png|thumb|none|upright=3|Раздел '''Поиск'''. Начальное состояние]]

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

=== Поиск маркеров ===
Чтобы воспользоваться поиском маркеров:
:1. Выберите категорию '''Маркеры''' раздела '''Поиск''' (выбран по умолчанию).
:2. Для базового поиска:
::а) Перейдите на вкладку '''Базовый поиск''' (открыта по умолчанию).
::[[File:174 Раздел Поиск. Категория Маркеры. Базовый поиск.png|thumb|none|upright=3|Раздел '''Поиск'''. Категория '''Маркеры'''. Базовый поиск]]
::б) Введите фрагмент названия маркера, детектора, функции или файла.
::в) Выберите (опционально) группу проектов, проект, ветку и снимок, в которых нужно найти маркеры.
::По умолчанию выбраны все группы, проекты, ветки и снимки.
::г) Нажмите кнопку '''Поиск'''.
:Отобразятся результаты поиска.
:[[File:175 Раздел Поиск. Пример результатов поиска в категории Маркеры.png|thumb|none|upright=3|Раздел '''Поиск'''. Пример результатов поиска в категории '''Маркеры''']]
:3. Для поиска по полям:
::а) Перейдите на вкладку '''Поиск по полям'''.
::[[File:176 Раздел Поиск. Категория Маркеры. Поиск по полям.png|thumb|none|upright=3|Раздел '''Поиск'''. Категория '''Маркеры'''. Поиск по полям]]
::б) Заполните поля поиска.
::в) Выберите (опционально) группу проектов, проект, ветку и снимок, в которых нужно найти маркеры.
::По умолчанию выбраны все группы, проекты, ветки и снимки.
::г) Нажмите кнопку '''Поиск'''.
:Отобразятся результаты поиска.
:[[File:177 Раздел Поиск. Пример результатов поиска по полям в категории Маркеры.png|thumb|none|upright=3|Раздел '''Поиск'''. Пример результатов поиска по полям в категории '''Маркеры''']]
:4. Для очистки значений в полях поиска нажмите кнопку '''Очистить'''.
:5. Чтобы перейти к найденному файлу с маркером в [[Help:UI manual#Работа в режиме разметки|режиме разметки]], в результатах поиска кликните на ссылку в имени файла с номером строки исходного кода.
:6. Чтобы посмотреть подробную информацию о найденном маркере, в результатах поиска нажмите кнопку [[File:Button show.png|x25px]].
Отобразится правая панель с открытой вкладкой '''Подробности'''.
:[[File:341 Раздел Поиск. Подробная информация о маркере.png|thumb|none|upright=3|Раздел '''Поиск'''. Пример просмотра подробной информации о найденном маркере]]

=== Поиск комментариев к маркерам ===
Чтобы воспользоваться поиском по комментариям к маркерам:
:1. Выберите категорию '''Комментарии к маркерам''' раздела '''Поиск'''.
:2. Для базового поиска:
::а) Перейдите на вкладку '''Базовый поиск''' (открыта по умолчанию).
::[[File:178 Раздел Поиск. Категория Комментарии к маркерам. Базовый поиск.png|thumb|none|upright=3|Раздел '''Поиск'''. Категория '''Комментарии к маркерам'''. Базовый поиск]]
::б) Введите фрагмент комментария или логина его автора.
::в) Выберите (опционально) группу проектов, проект, ветку и снимок, в которых нужно найти комментарии.
::По умолчанию выбраны все группы, проекты, ветки и снимки.
::г) Нажмите кнопку '''Поиск'''.
:Отобразятся результаты поиска.
:[[File:179 Раздел Поиск. Пример результатов поиска в категории Комментарии к маркерам.png|thumb|none|upright=3|Раздел '''Поиск'''. Пример результатов поиска в категории '''Комментарии к маркерам''']]
:3. Для поиска по полям:
::а) Перейдите на вкладку '''Поиск по полям'''.
::[[File:180 Раздел Поиск. Категория Комментарии к маркерам. Поиск по полям.png|thumb|none|upright=3|Раздел '''Поиск'''. Категория '''Комментарии к маркерам'''. Поиск по полям]]
::б) Заполните поля поиска.
::в) Выберите (опционально) группу проектов, проект, ветку и снимок, в которых нужно найти комментарии.
::По умолчанию выбраны все группы, проекты, ветки и снимки.
::г) Нажмите кнопку '''Поиск'''.
:Отобразятся результаты поиска.
:[[File:181 Раздел Поиск. Пример результатов поиска по полям в категории Комментарии к маркерам.png|thumb|none|upright=3|Раздел '''Поиск'''. Пример результатов поиска по полям в категории '''Комментарии к маркерам''']]
:4. Для очистки поискового запроса нажмите кнопку '''Очистить'''.
:5. Чтобы перейти в [[Help:UI manual#Работа в режиме разметки|режим разметки]] к файлу маркера с найденным комментарием, в результатах поиска кликните на ссылку в имени файла с номером строки исходного кода.
:6. Чтобы посмотреть подробную информацию о маркере с найденным комментарием, в результатах поиска нажмите кнопку [[File:Button show.png|x25px]]. Отобразится правая панель с открытой вкладкой '''Комментарии'''.

=== Поиск снимков ===
Чтобы воспользоваться поиском по снимкам:
:1. Выберите категорию '''Снимки''' раздела '''Поиск'''.
:2. Для базового поиска:
::а) Перейдите на вкладку '''Базовый поиск''' (открыта по умолчанию).
::[[File:182 Раздел Поиск. Категория Снимки. Базовый поиск.png|thumb|none|upright=3|Раздел '''Поиск'''. Категория '''Снимки'''. Базовый поиск]]
::б) Введите фрагмент названия снимка, пользовательского поля снимка (названия или его значения) или логина пользователя, который импортировал снимок.
::в) Выберите (опционально) группу проектов, проект, ветку и снимок, в которых нужно найти снимки.
::По умолчанию выбраны все группы, проекты, ветки и снимки.
::г) Нажмите кнопку '''Поиск'''.
:Отобразятся результаты поиска.
:[[File:183 Раздел Поиск. Пример результатов поиска в категории Снимки.png|thumb|none|upright=3|Раздел '''Поиск'''. Пример результатов поиска в категории '''Снимки''']]

:3. Для поиска по полям:
::а) Перейдите на вкладку '''Поиск по полям'''.
::[[File:184 Раздел Поиск. Категория Снимки. Поиск по полям.png|thumb|none|upright=3|Раздел '''Поиск'''. Категория '''Снимки'''. Поиск по полям]]
::б) Заполните поля поиска.
::в) Выберите (опционально) группу проектов, проект, ветку и снимок, в которых нужно найти снимки.
::По умолчанию выбраны все группы, проекты, ветки и снимки.
::г) Нажмите кнопку '''Поиск'''.
:Отобразятся результаты поиска.
:[[File:185 Раздел Поиск. Пример результатов поиска по полям в категории Снимки.png|thumb|none|upright=3|Раздел '''Поиск'''. Пример результатов поиска по полям в категории '''Снимки''']]
:4. Для очистки поискового запроса нажмите кнопку '''Очистить'''.
:5. Чтобы посмотреть подробную информацию о найденном снимке, в результатах поиска кликните на ссылку в пути размещения снимка.
:Найденный снимок откроется в [[Help:UI manual#Работа в режиме разметки|режиме разметки]] со всеми его маркерами.

=== Просмотр истории поиска ===
Чтобы посмотреть историю поиска, нажмите кнопку '''История поиска''' в разделе '''Поиск'''.

В истории отображаются 100 последних поисковых запросов пользователя.
[[File:186 Раздел Поиск. Пример истории поиска.png|thumb|none|upright=3|Раздел '''Поиск'''. Пример истории поиска]]

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

== Настройка сервера Svacer ==
Перейти в раздел '''Настройки''' можно по нажатии кнопки [[File:Icon settings.png|x25px]] в верхней правой части экрана.

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

=== Управление пользователями, ролями и организациями===
==== Управление пользователями ====
Реестром учетных записей пользователей можно управлять на вкладке '''Пользователи''' в разделе '''Управление пользователями''' страницы '''Настройки'''. 
Для [[LDAP configuration|учетных записей с доступом по LDAP]] рядом с логином отображается индикатор [[File:Icon LDAP.png|x25px]], для учетных записей с доступом по OIDC рядом с логином отображается индикатор [[File:Icon_OIDC.png|x25px]], а для учетных записей с признаком '''Мастер разметки''' – индикатор [[File:Icon markup master.png|x25px]]. 
В разделе доступны:
* поиск по атрибутам учётной записи пользователя;
* фильтрация списка по типам учётных записей:
:* все;
:* системные;
:* LDAP;
:* OIDC;
:* заблокированные;
:* активные;
:* по ролям;
:* по организациям.
* сортировка по колонкам '''Логин''', '''ФИО''' и '''Дата создания''' (по умолчанию).
:[[File:74 Вкладка Пользователи на странице Настройки.png|thumb|none|upright=3|Вкладка '''Пользователи''' в разделе '''Управление пользователями''' страницы '''Настройки''']]
Для управления пользователями:
:1. Создайте учетную запись пользователя:
::а) Нажмите кнопку '''Создать'''.
::Откроется окно добавления учетной записи пользователя.
::[[File:76 Окно Добавить пользователя.png|thumb|none|upright=1.5|Окно '''Создать пользователя''']]
::б) Заполните поля:
::* Логин;
::* Пароль;
::* e-mail;
::* ФИО.
::в) Выберите [[Help:UI manual#Управление организациями|организации]], в которые должен входить пользователь, а также назначьте ему [[Help:UI manual#Управление ролями|роли]] – выберите значения в раскрывающихся списках полей '''Организации''' и '''Роли''' соответственно. Для отмены выбора нажмите на кнопку [[File:Icon cancel.png|x25px]] справа от значения.
::г) Включите опции '''Изменить пароль при первом входе в систему''' и '''Мастер разметки'''. 
::{{Note|type=info|text=''Если для учётной записи активирована опция '''Мастер разметки''', есть разрешение на разметку и этот пользователь разметил маркер в каком-либо снимке, то изменить его разметку может только пользователь, в учётной записи которого также активирована опция '''Мастер разметки''' или которому предоставлен [[#Cерверные доступы|серверный доступ]] '''Изменение любой разметки'''.''}}
::д) Нажмите кнопку '''Создать'''.
: В таблице со списком пользователей добавится новая запись.

:2. Воспользуйтесь функциями в строке учетной записи в крайнем правом столбце – нажмите кнопку [[File:Button menu.png|x25px]] и выберите пункт:
:* '''Редактировать''' – для перехода к редактированию данных профиля;
:* '''Изменить пароль''' – для перехода к изменению пароля;
:* '''Сбросить настройки пользователя''' – для возврата пользовательских настроек к их значениям по умолчанию;
:* '''Заблокировать''' – для блокировки учетной записи. В этом случае для учетной записи пользователя блокируется доступ к системе, а в списке рядом с логином учетной записи отображается индикатор [[File:Icon_Archived.png|x25px]];
:* '''Разблокировать''' – для восстановления доступа пользователя к системе;
:* '''Настройки уведомлений''' – для настройки уведомлений пользователя об операциях со снимками и маркерами – аналогично [[Help:UI manual#Настройка уведомлений|настройке уведомлений в меню пользователя]];
::[[File:219 Настройки Настройка уведомлений выбранного пользователя.png|thumb|none|upright=2|Настройки уведомлений выбранного пользователя]]
:* '''Удалить''' – для удаления учётной записи пользователя;
:* '''Показать доступы пользователя''' – для отображения списка объединенных доступов всех ролей, назначенных пользователю.
::[[File:113 Список доступов пользователя.png|thumb|none|upright=3|Список доступов пользователя]]
::{{Note|type=warn|text=''Функции блокировки и удаления недоступны для системных учетных записей. При изменении логина или списка доступов у авторизованного пользователя, он будет перенаправлен на страницу авторизации.''}}

:3. Воспользуйтесь функциями управления несколькими учётными записями одновременно:
::а) Чтобы выбрать несколько записей, установите флажки в первом столбце списка пользователей.
::б) Чтобы выбрать все отображаемые учётные записи, установите один флажок в заголовке столбцов в первом столбце списка.
::в) Нажмите кнопку '''Действия''' в верхней части списка пользователей и выберите пункт: '''Сбросить настройки пользователя''', '''Заблокировать''', '''Разблокировать''' или '''Удалить'''. В списке активны только действия, доступные всем выбранным учетным записям.
:4. Для [[LDAP configuration|учетной записи с доступом по LDAP]] обновите данные – в окне редактирования данных профиля пользователя нажмите кнопку '''Загрузить из LDAP'''.
:Загрузятся параметры профиля пользователя и его контакты из профиля в службе каталогов, если они там указаны.
:[[File:78 Загрузка данных из LDAP.png|thumb|none|upright=1.5|Загрузка данных из LDAP]]

==== Управление ролями ====
Реестром ролей можно управлять на вкладке '''Роли''' в разделе '''Управление пользователями''' страницы '''Настройки'''.
[[File:79 Переход к управлению ролями.png|thumb|none|upright=3|Вкладка '''Роли''' в разделе '''Управление пользователями''' страницы '''Настройки''']]
{{Note|type=info|text=''Роли [[Help:UI manual#Описание ролевой модели|admin, filter_master и importer]] являются встроенными с особым значением. Их нельзя удалить или изменить.''}}

Доступен поиск по названию роли и сортировка по колонкам '''Название''' (по умолчанию) и '''Пользователи'''. 
Для управления ролями доступны следующие функции:
:1. Создание новой роли:
::а) Нажмите кнопку '''Создать'''.
::[[File:81 Окно добавления роли.png|thumb|none|upright=3|Окно добавления роли]]
::б) Заполните поля появившейся формы:
:::*введите название роли;
:::*в блоке '''Серверные доступы''' выберите доступы – нажмите кнопку '''Выбрать всё''' или установите флажки для активации доступов.
:::При наведении курсора на иконку [[File:Icon question mark2.png|x25px]] отображается пояснение к доступу.
:::*в блоке '''Проектные доступы''' выберите тип доступа: группа проектов или определённый проект или его ветка;
:::*если выбран тип '''Группа проектов''', выберите название группы и установите флажки для активации доступов;
:::*если выбран тип '''Проект / Ветка''', выберите название проекта или ветки проекта, установите флажки для активации доступов.
:::Если выбрано значение '''Все''', то доступы будут предоставлены для всех проектов;
:::*для удаления строки с проектными доступами в блоке '''Проектные доступы''' нажмите кнопку [[File:Icon delete.png|x25px]] в крайнем правом столбце.
::в) Нажмите кнопку '''Создать'''.

:2. Просмотр доступов роли, нажмите на ссылку '''Показать доступы''' в столбце '''Доступы'''.
:[[File:114 Список доступов роли.png|thumb|none|upright=3|Список доступов роли]]

:3. Редактирование роли:
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке роли в крайнем правом столбце.
::б) В меню выберите пункт '''Редактировать''' и внесите изменения.

:4. Создание копии роли:
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке исходной роли в крайнем правом столбце.
::б) В меню выберите пункт '''Создать копию'''.
:В реестр ролей добавится новая запись с именем исходной роли и добавленным порядковым номером копии.

:5. Просмотр информации о роли в JSON-формате:
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке исходной роли в крайнем правом столбце.
::б) В меню выберите пункт '''Просмотреть JSON'''.

:6. Удаление роли:
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке исходной роли в крайнем правом столбце.
::б) В меню выберите пункт '''Удалить'''.
::в) Подтвердите удаление.

:7. Удаление несколько ролей одновременно:
::а) Для выбора нескольких записей установите флажки в первом столбце списка ролей.
::б) Чтобы выбрать все записи, установите один флажок в заголовке столбцов в первом столбце списка ролей.
::в) Нажмите кнопку '''Удалить''' и подтвердите удаление.

==== Управление организациями ====
Пользователи могут быть связаны с организациями. Один пользователь может принадлежать нескольким организациям. Организации носят информационный характер и не влияют на права пользователей в системе. 
Реестром организаций можно управлять на вкладке '''Организации''' в разделе '''Управление пользователями''' страницы '''Настройки'''.
[[File:92 Вкладка Организации на странице Настройки.png|thumb|none|upright=3|Вкладка '''Организации''' в разделе '''Управление пользователями''' страницы '''Настройки''']]
Доступен поиск по названию и сокращенному названию организации и сортировка по колонкам '''Название''' (по умолчанию), '''Сокращенное название''' и '''Пользователи'''.
Для управления организациями, доступны следующие функции:
:1. Создание организации:
::а) Нажмите кнопку '''Создать'''.
::б) Заполните поля появившейся формы.
::в) Нажмите кнопку '''Создать'''.
::[[File:93 Окно добавления организации в реестр.png|thumb|none|upright=1.5|Окно добавления организации в реестр]]

:2. Редактирование организации:
::а) Нажмите кнопку [[File:Icon edit2.png|x25px]] в крайнем правом столбце.
::б) В появившейся форме отредактируйте данные организации.
::в) Нажмите кнопку '''Сохранить'''.

:3. Удаление организации:
::а) Нажмите кнопку [[File:Icon delete.png|x25px]] в крайнем правом столбце.
::б) В появившемся диалоге подтвердите удаление, нажав на кнопку '''Удалить'''.

:4. Удаление несколько организаций одновременно:
::а) Для выбора нескольких записей установите флажки в первом столбце списка организаций.
::б) Чтобы выбрать все организации, установите один флажок в заголовке столбцов в первом столбце списка.
::в) Нажмите кнопку '''Удалить''' и подтвердите удаление.

=== Настройка глобальных фильтров ===
В разделе '''Глобальные фильтры''' страницы '''Настройки''' можно настроить глобальные фильтры, применительно [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|к выбранным проекту или ветке проекта]]: 
{{Note|type=info|text=''По умолчанию выбран контекст (проект, ветка), заданный ранее в режиме '''Разметка''', или '''Код'''.''}}
[[File:82 Вкладка Фильтры на странице Настройки.png|thumb|none|upright=4|Раздел '''Глобальные фильтры''' на странице '''Настройки''']]

В разделе доступен поиск по названию фильтра.

Для настройки фильтров:
:1. Выберите проект и ветку в верхней строке раздела. По умолчанию указаны проект и ветка, выбранные в разделе '''Разметка'''.
:2. Чтобы добавить фильтр, нажмите кнопку '''Создать'''.
:Отобразится новая строка:
:[[File:83 Новая строка с фильтром.png|thumb|none|upright=4|Новая строка с фильтром]]

:3. Чтобы изменить настройки фильтров:
::а) Введите или поменяйте название фильтра
::б) Включите или выключите фильтр – нажмите на значение в столбце '''Статус''', чтобы отобразилась иконка [[File:Icon check2.png|x25px]] (по умолчанию) или [[File:Icon cross 01.png|x25px]].
::в) Выберите область применения фильтра – нажмите на значение в столбце '''Область''' один или два раза, чтобы отобразилось значение '''ветка''' или '''проект'''.
::г) Введите [[Help:UI manual#Использование регулярных выражений|регулярное выражение]] или загрузите его из файла в столбцах '''Включить пути по шаблону''', '''Исключить пути по шаблону''' и '''Детекторы'''.
::{{Note|type=info|text=''Шаблоны регулярных выражений не зависят от регистра и поддерживают следующий синтаксис:''
:* ''; – для разделения списков значений;''
:* ''* – любое количество символов;''
:* ''? – один произвольный символ;''
:* ''re: – включая значения, определяемые регулярным выражением;''
:* ''re!: – исключая значения, определяемые регулярным выражением (только для столбца '''Детекторы''').''}}
::д) Выберите уровни серьезности (критичности) и надежности:
::* [[File:Icon_critical_on.png|x30px]] – уровень выбран;
::* [[File:Icon_critical_off.png|x30px]] – уровень не выбран.
::Для изменения выбора нажмите на название уровня.
:4. Нажмите кнопку [[File:Icon delete.png|x25px]] в крайнем правом столбце, чтобы удалить один фильтр.
:5. Чтобы удалить несколько фильтров:
::а) Для выбора нескольких записей установите флажки в первом столбце списка фильтров.
::б) Чтобы выбрать все записи, установите один флажок в заголовке столбцов в первом столбце списка фильтров.
::в) Нажмите кнопку '''Удалить'''.
:6. Для сохранения и применения изменений нажмите кнопку '''Применить'''.
Если не применить изменения, то при переходе в другой раздел системы отобразится сообщение о том, что изменения не применены:
:[[File:115 Запрос на изменение глобальных фильтров.png|thumb|none|upright=1.5]]

:{{Note|type=warn|text=''После применения глобальных фильтров пользователям, у которых в режиме разметки открыт данный контекст, требуется перезагрузить страницу (нажать клавишу F5) для обновления списка маркеров.''}}

=== Управление блокировками разметки ===
Чтобы посмотреть список всех [[Help:UI manual#Блокировка разметки|блокировок]], перейдите на вкладку '''Блокировки''' страницы '''Настройки''':
[[File:61 Просмотр всех блокировок.png|800px|thumb|none|Раздел '''Блокировки''' страницы '''Настройки''']]
{{Note|type=info|text=''Пользователю отображается список блокировок в контейнерах, к которым у него есть доступ. Удаление не своих блокировок доступно пользователям с соответствующим доступом.''}}

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

Для удаления одной блокировки:
:1. Нажмите кнопку [[File:Icon delete.png|x25px]] в строке проекта в крайнем правом столбце.
:2. Подтвердите удаление.
Для удаления нескольких блокировок:
:1. Чтобы выбрать для удаления все блокировки, установите флажок в заголовке табличного списка.
:2. Чтобы выбрать несколько блокировок, установите флажки в крайнем правом столбце табличного списка.
:3. Нажмите кнопку '''Удалить''' в верхней части списка.

=== Ведение журнала операций ===
В разделе '''Журнал операций''' страницы '''Настройки''' доступны просмотр и откат выполнения групповых операций по разметке и комментированию маркеров, таких как импорт разметки, копирование разметки, импорт снимков и т. п.
[[File:206 Настройки. Журнал операций.png|800px|thumb|none|Раздел '''Журнал операций''' на странице '''Настройки''']]
В разделе доступны:
* поиск по названию контейнера, типу операции и её описанию;
* фильтрация списка:
** по статусу операции: '''Applied''', '''Reverted''', '''Invalid''';
** типу операции;
** генератору операции;
** автору операции;
** диапазону дат создания операции;
* сортировка по всем колонкам, кроме '''Описание'''.

Чтобы откатить выполнение операции, нажмите кнопку [[File:Icon return.png|x25px]] в строке и подтвердите действие в открывшемся окне.
{{Note|type=warn|text=''Откат своих операций доступен пользователям с [[#Проектные доступы|проектными доступами]] '''Разметка маркеров''' и '''Импорт разметки'''. Откат операций других пользователей доступен пользователям с [[#Проектные доступы|проектным доступом]] '''Разметка маркеров''' и [[#Серверные доступы|серверным доступом]] '''Администрирование сервера''' или серверным доступами '''Изменение любой разметки''' и '''Изменение любых комментариев'''.''}}

=== Управление шаблонами разметки ===
Управление шаблонами разметки доступно в разделе '''Шаблоны разметки''' страницы '''Настройки''':
[[File:84 Вкладка Шаблоны на странице Настройки.png|thumb|none|upright=3|Раздел '''Шаблоны разметки''' на странице '''Настройки''']]

Шаблоны разметки нужны для [[Help:UI manual#Импорт разметки|импорта]]/[[Help:UI manual#Экспорт разметки|экспорта разметки]]. С их помощью комментарии в исходном коде будут преобразовываться в разметку на сервере истории и обратно.

Шаблон с именем DEFAULT есть всегда, его нельзя отредактировать или удалить.

{{Note|type=info|text=''Для корректного создания или изменения шаблонов разметки следует обратиться к разработчикам Svacer.''}}

Для управления шаблонами:
:1. Нажмите кнопку '''Создать'''.
:Откроется окно создания шаблона.
:[[File:Добавление шаблона разметки.png|thumb|none|upright=1.5|Окно создания шаблона разметки]]
:2. Введите название шаблона.
:3. Нажмите кнопку '''Создать'''.
:Шаблон появится в списке шаблонов для разметки в правой панели формы
:4. Отредактируйте поля шаблона разметки:
:[[File:85 Поля шаблона, доступные для редактирования.png|thumb|none|upright=2.5|Редактирование шаблона разметки]]
:5. Нажмите '''Сохранить'''.
:6. Чтобы клонировать существующий шаблон разметки, нажмите кнопку [[File:Icon_clone.png|x20px]] в правой части строки шаблона в списке.
:7. Для удаления одного шаблона:
::а) Нажмите кнопку [[File:Icon delete.png|x25px]] в правой части строки шаблона в списке.
::б) Подтвердите удаление.
:8. Для удаления нескольких шаблонов:
::а) Выберите шаблоны для удаления – установите флажки в левой части названий шаблонов или нажмите кнопку '''Выбрать всё'''.
::б) Нажмите кнопку '''Удалить''' в верхней части списка шаблонов и подтвердите удаление.

=== Управление токенами доступа ===
Управление персональными токенами доступа выполняется в разделе '''Токены доступа''' на странице '''Настройки'''.
[[File:207 Настройки. Токены доступа.png|800px|thumb|none|Раздел '''Токены доступа''' на странице '''Настройки''']]
В разделе доступны:
* поиск по названию токена и его описанию, а также по логину пользователя;
* сортировка по всем колонкам, кроме '''Описание'''.
Для управления токенами доступа:
:1. Создайте токен:
::а) Нажмите кнопку '''Создать'''.
::б) В окне '''Создать токен доступа''' введите название и, опционально, описание токена; выберите срок действия.
::По умолчанию срок действия токена 90 дней (минимальный срок 1 день, максимальный – 365).
::в) Нажмите кнопку '''Создать'''.
::[[File:208 Окно Создание токена доступа.png|thumb|none|upright=1.5|Окно '''Создать токен доступа''']]
::Отобразится окно с токеном доступа.
::{{Note|type=warn|text=''Токен отображается только один раз – при создании''}}
::[[File:209 Токен доступа.png|thumb|none|upright=1.5|Пример токена]]
::г) Нажмите кнопку '''Скопировать в буфер обмена''' и сохраните токен в надежном месте.
:2. Для удаления одного токена:
::а) Нажмите кнопку [[File:Icon delete.png|x25px]] в крайнем правом столбце.
::б) Подтвердите удаление.
:3. Для удаления нескольких токенов:
::а) Чтобы выбрать для удаления все токены, установите флажок в заголовке табличного списка.
::б) Чтобы выбрать несколько токенов, установите флажки в крайнем правом столбце табличного списка.
::в) Нажмите кнопку '''Удалить''' в верхней части табличного списка токенов и подтвердите удаление.

=== Управление асинхронными задачами ===
К асинхронным задачам относятся:
* экспорт snap и SARIF файлов (в режиме [[Help:UI manual#Экспорт|'''Разметки''']] и в разделе [[Help:UI manual#Работа со снимками|'''Проекты''']]);
* копирование снимков (см. раздел 4.6.4).
Управление этими задачами выполняется разделе '''Асинхронные задачи''' на странице '''Настройки'''.

В разделе доступны:
* поиск по идентификатору задачи, её типу, описанию, статусу, а также по логину пользователя;
* фильтрация списка:
:* по статусу;
:* типу задачи;
:* пользователю;
:* диапазону дат старта и окончания выполнения задачи;
* сортировка по всем колонкам, кроме '''Описание'''.
[[File:342 Настройки. Асинхронные задачи.png|800px|thumb|none|Раздел '''Асинхронные задачи''' на странице '''Настройки''']]

Для управления асинхронными задачами:
:1. Чтобы посмотреть лог выполнения задачи, нажмите кнопку в крайнем правом столбце.
:Откроется окно с текстом лога (Рисунок 205).
:[[File:343 Окно с текстом лога асинхронной задачи.png|600px|thumb|none|Окно с текстом лога асинхронной задачи]]
:2. Чтобы скачать лог, нажмите кнопку в крайнем правом столбце или откройте окно с текстом лога и нажмите кнопку '''Скачать лог'''.
:3. Для удаления истории об одной задаче:
::а) Нажмите кнопку [[File:Icon delete.png|x25px]] в строке задачи в крайнем правом столбце.
::б) Подтвердите удаление.
:4. Для удаления истории о нескольких задачах:
::а) Чтобы выбрать для удаления все задачи, установите флажок в заголовке табличного списка.
::б) Чтобы выбрать несколько задач, установите флажки в крайнем правом столбце табличного списка.
::в) Нажмите кнопку '''Удалить''' в верхней части списка.

=== Просмотр информации о сервере ===
В разделе '''Информация о сервере''' на странице '''Настройки''' отображаются вкладки:
* '''Параметры''' – параметры, с которыми запущен сервер;
* '''Системный лог''' – журнал событий сервера;
* '''Системный журнал''' – журнал базы данных.
[[File:344 Настройки. Информация о сервере. Вкладка Параметры.png|thumb|none|upright=3|Раздел '''Информация о сервере''' на странице '''Настройки'''. Вкладка '''Параметры''']]
[[File:345 Настройки. Информация о сервере. Вкладка Системный лог.png|thumb|none|upright=3|Раздел '''Информация о сервере''' на странице '''Настройки'''. Вкладка '''Системный лог''']]
[[File:346 Настройки. Информация о сервере. Вкладка Системный журнал.png|thumb|none|upright=3|Раздел '''Информация о сервере''' на странице '''Настройки'''. Вкладка '''Системный журнал''']]

{{Note|type=warn|text=''На вкладке '''Системный лог''' вывод информации ограничен 1 МБ последних данных (значение настраивается в параметрах сервера). При скачивании файл содержит данные лога в полном объеме.''}}

Доступны функции:
* поиск параметров по их имени и значению – на вкладке '''Параметры''';
* копирование записей – на вкладках '''Системный лог''' и '''Системный журнал''';
* выгрузка лога в файлы в формате .log по нажатии кнопки '''Скачать''' – на вкладках '''Системный лог''' и '''Системный журнал'''.

== Выход из системы ==
Для выхода из системы выберите пункт '''Выйти''' в меню пользователя в правом верхнем углу экрана.
[[File:95 Выход из системы —без VSCode.png|thumb|none|upright=1.5|Выход из системы]]

== Использование регулярных выражений ==
Регулярные выражения можно использовать:
* для поиска и фильтрации данных [[Help:UI manual#Функции навигационной панели|в навигационной панели]] [[Help:UI manual#Вкладка «Файлы»|на вкладке '''Файлы''']];
* в окне настройки [[Help:UI manual#Настройка и использование пользовательских фильтров|пользовательских фильтров]] в блоке '''Файлы''';
* при [[Help:UI manual#Экспорт исходного кода с разметкой|экспорте кода с разметкой]];
* при [[Help:UI manual#Настройка глобальных фильтров|настройке глобальных фильтров]];
* в полях [[Help:UI manual#Глобальный поиск|глобального поиска]].

Особенности реализации:
:1. Поиск происходит только по регулярному выражению. Если требуется найти специальный символ в качестве обычного символа, его нужно экранировать (например, точку: <code>\.</code>)
:2. При поиске находятся вхождения подстроки в полном пути к файлу (аналогично grep). Если требуется найти по полной строке, используйте символы начала и конца строки: <code>^</code> и <code>$</code>
:3. Поиск не зависит от регистра символов (case insensitive) и поддерживает следующий синтаксис:
::* ; – для разделения списков значений;
::* * – любое количество символов;
::* ? – один произвольный символ.
:В окне настройки [[Help:UI manual#Настройка и использование пользовательских фильтров|пользовательских фильтров]] в блоке '''Файлы''' можно применить фильтр как для отображения только маркеров из файлов, которые подходят под паттерн, так и для скрытия таких маркеров. Для переключения между этими режимами используйте кнопки [[File:Icon plus 2.png|x20px]] и [[File:Icon minus 3.png|x20px]], которые расположены рядом с полем ввода. В остальных частях интерфейса следует использовать теги re: и re!:

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

== Описание ролевой модели ==
=== Серверные доступы ===
{| class="wikitable"
! Полномочие (доступ) !! Описание !! Влияние на графический интерфейс !! admin !! filter_master !! importer
|-
| Создание проектов
|| Создание и клонирование проектов. Пользователь, создавший проект, имеет полный доступ к управлению этим проектом
|| Наличие полномочия делает доступным:
* раздел [[Help:UI manual#Управление проектами и группами проектов|'''Проекты''']];
* кнопку '''Создать проект''';
* форму создания, клонирования и редактирования проекта.

Наличие доступа предоставляет автору проекта полные права на управление своими проектами, включая разметку (даже при отсутствии у него соответствующего проектного доступа), а также позволяет удалять приложения к снимкам в созданных проектах
|| + || – || –

|-
| Настройка групп проектов
|| Создание, редактирование и удаление групп проектов
|| Наличие полномочия делает доступным:
* раздел [[Help:UI manual#Управление проектами и группами проектов|'''Проекты''']] с кнопкой для перехода к настройке групп;
* панель [[Help:UI manual#Работа с группами проектов|'''Группы проектов''']] с полным списком проектов в группах.
Наличие доступа предоставляет права на просмотр маркеров во всех проектах
|| + || – || –

|-
| Управление пользователями
|| Создание, редактирование и удаление пользователей
|| Наличие полномочия делает доступной вкладку [[Help:UI manual#Управление пользователями|'''Пользователи''']] в разделе [[Help:UI manual#Управление пользователями, ролями и организациями|'''Настройки – Управление пользователями''']] со всеми функциями управления учетными записями пользователей
|| + || – || –

|-
| Управление ролями
|| Создание, редактирование и удаление ролей
|| Наличие полномочия делает доступной вкладку [[Help:UI manual#Управление ролями|'''Роли''']] в разделе [[Help:UI manual#Управление пользователями, ролями и организациями|'''Настройки – Управление пользователями''']] со всеми функциями управления ролями
|| + || – || –

|-
| Управление организациями
|| Создание, редактирование и удаление организаций
|| Наличие полномочия делает доступной вкладку [[Help:UI manual#Управление организациями|'''Организации''']] в разделе [[Help:UI manual#Управление пользователями, ролями и организациями|'''Настройки – Управление пользователями''']] со всеми функциями управления организациями
|| + || – || –

|-
| Управление шаблонами разметки
|| Создание, редактирование и удаление шаблонов разметки
|| Наличие полномочия делает доступным раздел [[Help:UI manual#Управление шаблонами разметки|'''Настройки – Шаблоны разметки''']] со всеми функциями управления учетными записями шаблонами
|| + || – || –

|-
| Удаление блокировок
|| Просмотр и удаление блокировок всех пользователей
|| Наличие полномочия позволяет просматривать и удалять блокировки всех пользователей в разделе [[Help:UI manual#Управление блокировками разметки|'''Настройки – Блокировки''']]
|| + || – || –

|-
| Администрирование сервера
|| Просмотр настроек сервера, системных лог-файлов и выполнение операций по администрированию сервера Svacer, включая активацию лицензии
|| Наличие полномочия делает доступным раздел [[Help:UI manual#Просмотр информации о сервере|'''Настройки – Информация о сервере''']]
Совместно с проектными доступами '''Управление ветками''' и снимками и '''Разметка маркеров''' становится доступна функция очистки разметки и комментариев в ветке
|| + || – || –

|-
| Управление публичными фильтрами
|| Публикация, редактирование и удаление публичных фильтров
|| Наличие полномочия позволяет публиковать сохраненные фильтры, а также редактировать и удалять публичные фильтры
|| + || – || –

|-
| Изменение любой разметки
|| Изменение любой разметки маркеров, включая выполненную пользователями с признаком [[Help:UI manual#Управление пользователями, ролями и организациями|'''Мастер разметки''']]
|| Доступ позволяет переразмечать маркеры (добавлять новую разметку), которые разметили любые пользователи, в том числе те, для которых активирована опция [[Help:UI manual#Управление пользователями, ролями и организациями|'''Мастер разметки''']].
При этом:
# Полномочие не предоставляет доступ ко всем проектам. Т. е. пользователь с таким полномочием может изменять разметку только в проектах, к которым у него имеется доступ.
# Для переразметки маркеров пользователю должен быть предоставлен проектный доступ '''Разметка маркеров'''.
# Чтобы переразметить заблокированный маркер, сначала нужно [[Help:UI manual#Блокировка разметки маркеров|снять его блокировку]]
|| + || – || –

|-
| Изменение любых комментариев
|| Редактирование и удаление любых пользовательских комментариев к маркерам
|| Доступ позволяет изменять/удалять комментарии, которые создали любые пользователи, в том числе те, для которых активирована опция [[Help:UI manual#Управление пользователями, ролями и организациями|'''Мастер разметки''']].
При этом:
# Полномочие не предоставляет доступ ко всем проектам. Т. е. пользователь с таким полномочием может изменять разметку только в проектах, к которым у него имеется доступ.
# Для добавления комментариев пользователю должно быть предоставлено проектное полномочие '''Разметка маркеров'''.
# Чтобы поменять комментарий к заблокированному маркеру, сначала нужно [[Help:UI manual#Блокировка разметки маркеров|снять его блокировку]]
|| + || – || –

|-
| Создание резервных копий
|| Создание, просмотр и восстановление резервных копий в интерфейсе командной строки
|| –
|| + || – || –

|-
| Запуск скриптов
|| Запуск скриптов (hooks) по кнопке, расположенной на вкладке '''Подробности''' в правой панели, содержащей информацию о маркере
|| Наличие полномочия добавляет строку '''Хуки''' на вкладке '''Подробности''' правой панели с возможностью запуска скриптов
|| + || – || –
|}

=== Проектные доступы===
{| class="wikitable"
! Полномочие (доступ) !! Описание !! Влияние на графический интерфейс !! admin !! filter_master !! importer
|-
| Управление проектом и его ветками
|| Редактирование и удаление проекта, включая операции по управлению ветками и снимками проекта, настройке глобальных фильтров, импорту/экспорту разметки и просмотру маркеров
|| Наличие полномочия делает доступным:
* раздел [[Help:UI manual#Управление проектами и группами проектов|'''Проекты''']];
* все функции управления проектом (проектами в группе) и его содержимым (за исключением разметки маркеров) – т. е. все операции с проектом, ветками и снимками.
Наличие полномочия позволяет удалять приложения к снимкам и экспортировать разметку с исходным кодом
|| + || – || –

|-
| Управление ветками и снимками
|| Редактирование и удаление ветки проекта, включая операции по управлению снимками, настройке глобальных фильтров, импорту/экспорту разметки и просмотру маркеров
|| Наличие полномочия делает доступным:
* раздел [[Help:UI manual#Управление проектами и группами проектов|'''Проекты''']];
* все функции управления веткой и снимками проекта (за исключением разметки маркеров) – т. е. доступны все операции с веткой и снимками, но не операции управления проектом.
Наличие полномочия позволяет удалять приложения к снимкам и экспортировать разметку с исходным кодом.
Запрещено клонировать ветку при наличии доступа только к этой ветке
|| + || – || –

|-
| Настройка глобальных фильтров
|| Создание, редактирование и удаление глобальных фильтров
|| Наличие полномочия делает доступным раздел [[Help:UI manual#Настройка глобальных фильтров|'''Настройки – Глобальные фильтры''']].
Список проектов и веток в разделе определяется полномочиями к этим проектам и веткам
|| + || + || –

|-
| Импорт снимков
|| Загрузка, редактирование названия и удаление снимков
|| Наличие полномочия делает доступным:
* раздел [[Help:UI manual#Управление проектами и группами проектов|'''Проекты''']];
* функции просмотра проекта и ветки, управления снимками в указанной ветке (включая импорт .svace-dir, SARIF и *.snap), просмотра маркеров в указанном контейнере
|| + || – || +

|-
| Импорт разметки
|| Импорт разметки из файла и комментариев в исходном коде
|| Наличие полномочия делает доступным импорт разметки из файла, импорт разметки из комментариев исходного кода снимка и просмотр маркеров в указанном контейнере
|| + || – || +

|-
| Экспорт снимков
|| Экспорт данных снимков с разметкой и их открытие в IDE
|| Наличие полномочия позволяет:

* экспортировать разметку с исходными кодами;
* экспортировать снимки в форматах *.snap и SARIF;
* просматривать код с маркерами в Web-IDE
|| + || – || +

|-
| Просмотр маркеров
|| Просмотр маркеров и кода снимков, просмотр блокировок маркеров
|| Наличие полномочия предоставляет доступ к следующим функциям [[Help:UI manual#Работа в режиме разметки|в режиме разметки]]:
* просмотр и выбор снимков в указанном контейнере;
* просмотр содержимого снимков и маркеров (без возможности разметки).
Также наличие полномочия предоставляет доступ к разделу [[Help:UI manual#Управление блокировками разметки|'''Настройки – Блокировки''']], но только в части просмотра блокировок в доступных контейнерах, без возможности их удаления
|| + || + || +

|-
| Разметка маркеров
|| Просмотр и разметка маркеров в снимках, включая добавление комментариев, управление списком блокировок
|| Наличие полномочия позволяет пользователю размечать маркеры в указанном контейнере, добавлять комментарии, управлять своими блокировками, т. е. для собственных блокировок доступны кнопки удаления, а блокировки других пользователей доступны только для просмотра.
При отсутствии полномочия в таблице маркеров недоступны поля для установки флажков, а кнопка групповой разметки – неактивна.
Для разметки маркеров с помощью AI совместно с данным доступом должен быть активен доступ '''Импорт разметки'''
|| + || – || –

|-
| Report API
|| Использование Report API для получения статистических показателей
|| –
|| + || – || –
|}

=== Известные ограничения ===

* Управление ''своими'' проектами для пользователей только c серверной ролью "Create Projects" без дополнительных прав может не работать для проектов, созданных до Release 7-0-0.
: Workaround: добавить пользователю явно проектные доступы на каждый необходимый проект.

Afilters

2025-12-03T11:05:20Z

Akuzmin: review and minor fixes

= Advanced filters =
Поле "Расширенный фильтр" в пользовательских фильтрах предназначено для фильтрации маркеров (предупреждений) по сложным предикатам.
[[File:Image-afilters-prop.png|thumb]]
Предикат может использовать:

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

Формат фильтра определяется следующим шаблоном:

filter(markers, <predicate expr>)

Выражение <code><predicate expr></code> определяет предикат. Объект <code>markers</code> содержит массив маркеров из контекста, функция <code>filter</code> фильтрует данный список по предикату. Таким образом, применение фильтра заключается в фильтрации списка маркеров по указанному предикату.

== Список доступных полей ==

=== Поля маркера (предупреждения) ===

* <code>Comments</code> — список комментариев маркера. Объект типа Comment (смотрите ниже)
* <code>Details</code> — информация, специфичная для анализатора. Ближайший аналог — fingerprint в SARIF
* <code>File</code> — имя файла
* <code>Function</code> — имя функции, может быть mangled для С++
* <code>ID</code> — UUID маркера
* <code>Invariant</code> — инвариант маркера. Используется для автопереноса разметки между снимками
* <code>Lang</code> — язык детектора
* <code>Line</code> — номер строки в файле
* <code>LocID</code> — порядковый номер маркера относительно изначального отчета анализатора
* <code>MTid</code> — шаблон сообщения
* <code>Msg</code> — текст сообщения
* <code>OrigFunc</code> — 'человекочитаемое' имя функции. Может быть недоступно
* <code>Tags</code> — список тегов (меток) маркера
* <code>Tool</code> — модуль анализатора, ответственного за данный детектор
* <code>Traces</code> — список трасс маркера. Объект типа Trace (смотрите ниже)
* <code>WarnClass</code> — название детектора/класса детекторов

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

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

* <code>severity(item) string</code> — серьезность детектора (чекера)

Пример:

filter(markers, severity(#) == "Critical")

'''Внимание:''' использование в предикатах поля <code>Trace</code> может сказаться на скорости применения фильтра, т. к. загрузка большого числа трасс может занять время.

=== Данные о разметке ===
Поддерживаются следующие функции для получения информации о разметке:

* <code>status(item) string</code> — статус разметки текущего маркера. Пример: <code>filter(markers, status(#) == "Confirmed")</code>
* <code>action(item) string</code> — статус поля action текущего маркера. Пример: <code>filter(markers, action(#) == "Ignore")</code>
* <code>mseverity(item) string</code> — статус поля severity текущего маркера (не путать с severity детектора). Пример: <code>filter(markers, mseverity(#) == "Critical")</code>
* <code>triaged(item) bool</code> — возвращает true, если маркер имеет не дефолтную разметку. Пример: <code>filter(markers, triaged(#))</code>
* <code>get_triaged_by(item) UserInfo</code> — возвращает структуру с информацией о пользователе, кто произвел разметку

Поля структуры <code>UserInfo</code>:

* <code>login: string</code> — логин пользователя
* <code>create_ts: Time (UTC)</code> — время разметки в UTC формате (RFC3339)

=== Комментарии ===
Объекты типа <code>Comment</code> содержатся в поле <code>Comments</code> маркера. Объект имеет следующие поля:

* <code>ID</code> — UUID комментария
* <code>Text</code> — текст комментария
* <code>CreatedBy</code> — имя пользователя, кто создал комментарий
* <code>CreateTs</code> — время создания комментария (объект типа <code>time.Time</code>)
* <code>UpdateTs</code> — время обновления комментария (объект типа <code>time.Time</code>), может быть пустым
* <code>UpdatedBy</code> — имя пользователя, кто обновил комментарий

=== Трассы ===
Маркер может содержать трассу маркера в поле <code>Traces</code>. Трасса описывается следующими структурами:
type Trace struct {
Role string
Locations []TraceEntry
}
type TraceEntry struct {
File string
Line uint32
Col uint32
Info string
}

Доступ к полям объекта <code>Trace</code> может выполняться, используя правила языка <code>go-expr</code>, описанные ниже.

Имена полей могут использоваться в виде как описано выше, либо в формате lowercase: <code>role, locations, file, line, col, info</code>

Пример:
filter(markers, any(.Comments, .Text == "Test") &&
any(.Traces, any(.Locations, .Info == "Boolean expression has constant value"))
)

=== Поля снимка ===
Для доступа к полям снимка можно использовать переменную <code>snapshot</code>. Переменная имеет тип структуры со следующими полями

struct {
ID string
Name string
SerialID uint32
BuildObject string
ResultsObject string
ImportTime time.Time
CreatedBy string
CreatedByID string
Details map[string]any
CreateTime time.Time
SourcesAvailable bool
}
Имена полей могут использоваться в виде, где первая буква в lowercase.

Объекты в поле <code>Details</code> можно просмотреть, нажав на кнопку <code>View JSON</code> в WebUI в поле <code>Snapshot Information</code>.

Пример:
filter(markers,
snapshot.buildObject == "5b634b75422bd554a8569cc10bfadc3aea77b73e" &&
.warnClass matches "DEREF"
)

== Описание языка предикатов ==
Для написания предикатов используется язык '''Expr'''. Детальное описание всех возможностей можно найти здесь: https://github.com/expr-lang/expr

Далее описываются конструкции, наиболее подходящие для написания правил фильтрации.

=== Литералы ===
Comment /* */ or //
Boolean true, false
Integer 42, 0x2A, 0o52, 0b101010
Float 0.5, .5
String "foo", 'bar'
Array [1, 2, 3]
Map {a: 1, b: 2, c: 3}
Nil nil

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

Пример однострочного текста:
"Hello\nWorld"

Пример многострочного текста:
`Hello
World`

В многострочном тексте escape-последовательности не поддерживаются.

=== Операторы ===
Arithmetic: +, -, *, /, % (modulus), ^ or ** (exponent)
Comparison: ==, !=, <, >, <=, >=
Logical: not or !, and or &&, or or ||
Conditional: ?: (ternary), ?? (nil coalescing), if {} else {} (multiline)
Membership: [], ., ?., in
String: + (concatenation), contains, startsWith, endsWith
Regex: matches
Range: ..
Slice: [:]
Pipe: |

=== Операторы доступа к полю объекта ===
Можно использовать оператор <code>.</code> и оператор <code>[]</code>:
user.Name
user["Name"]

=== Оператор in ===
Оператор <code>in</code> для проверки наличия объекта в массиве или мэпе:
"John" in ["John", "Jane"]
"name" in {"name": "John", "age": 30}

=== Optional chaining ===
Оператор <code>?.</code> может использоваться для доступа к полю структуры или элементу отображения (map) без необходимости проверки, является ли структура или отображение равными <code>nil</code>. Если структура или отображение имеют значение <code>nil</code>, результатом выражения будет <code>nil</code>.

Пример вида:
author.User?.Name

значит то же самое, что:
author.User != nil ? author.User.Name : nil

=== Nil coalescing ===
Оператор <code>??</code> может использоваться для возврата левого операнда, если он не равен <code>nil</code>, в противном случае возвращается правый операнд.

Пример вида:
author.User?.Name ?? "Anonymous"

значит то же самое, что:
author.User != nil ? author.User.Name : "Anonymous"

=== Оператор конвейера ===
Оператор конвейера <code>|</code> может использоваться для передачи результата выражения левого операнда в качестве первого аргумента выражения правого операнда.

Пример вида:
user.Name | lower() | split(" ")

значит то же самое, что:
split(lower(user.Name), " ")

=== Предикаты ===
Предикат — это выражение. Предикаты можно использовать в функциях, таких как <code>filter, all, any, one, none</code> и других.
filter(0..9, {# % 2 == 0})
filter(tweets, {len(.Content) > 240})

Скобки <code>{ }</code> можно опускать:
filter(tweets, len(.Content) > 240)

=== Операции над строками ===
trim(str[, chars])
trimPrefix(str, prefix)
trimSuffix(str, suffix)
upper(str)
lower(str)
indexOf(str, substring)
lastIndexOf(str, substring)
hasPrefix(str, prefix)
hasSuffix(str, suffix)

Также есть оператор <code>matches</code> для поиска регулярного выражения в строке:
str matches "regular expression"

Для сопоставления целой строки с регулярным выражением следует использовать вариант:
str matches "^regex$"

=== Функции времени ===
Поддерживаются Go типы для времени и интервалов: <code>time.Time</code>, <code>time.Duration</code>.

Можно использовать операции сложения и вычитания над объектами с типом <code>time.Time</code>.

createdAt - now()
createdAt + duration("1h")
createdAt > now() - duration("1h")

date("2023-08-14")
date("15:04:05")
date("2023-08-14T00:00:00Z")
date("2023-08-14 00:00:00", "2006-01-02 15:04:05", "Europe/Zurich")

=== Функции над массивами ===
* <code>all(array, predicate)</code> — все объекты должны удовлетворять предикату
* <code>any(array, predicate)</code> — должен быть по крайней мере один объект, который удовлетворяет предикату
* <code>one(array, predicate)</code> — должен быть только один объект, который удовлетворяет предикату
* <code>none(array, predicate)</code> — ни один объект не должен удовлетворять предикату
* <code>find(array, predicate)</code> — возвращает первый объект, который удовлетворяет предикату
* <code>findLast(array, predicate)</code> — возвращает последний объект, который удовлетворяет предикату
* <code>count(array[, predicate])</code> — возвращает число объектов, удовлетворяющих предикату
* <code>first(array)</code> — первый объект из массива
* <code>last(array)</code> — последний объект из массива

Примеры:
all(tweets, {.Size < 280})
any(tweets, {.Size > 280})
none(tweets, {.Size > 280})
find([1, 2, 3, 4], # > 2) == 3
findLast([1, 2, 3, 4], # > 2) == 4
count(users, .Age > 18)
first([1, 2, 3]) == 1
last([1, 2, 3]) == 3

Help:Backup

2025-12-03T10:40:06Z

Akuzmin: fix installation page link

== Создание и восстановление резервной копии ==
Для переноса Svacer на другой сервер создайте резервные копии БД PostgreSQL и object store как описано ниже и восстановите их на новом сервере.
{{Note|text=Для бэкапов PostgreSQL можно использовать более продвинутые решения, чем входящий в состав PostgreSQL pg_dump, например [https://github.com/postgrespro/pg_probackup pg_probackup]. В нем поддерживаются инкрементальные бэкапы, валидация бэкапа после создания, и прочие полезные возможности. Описание его настройки и использования смотрите в их [https://postgrespro.github.io/pg_probackup/ документации]}}

=== Если PostgreSQL запущен в виде сервиса ===
Если PostgreSQL запущен в виде сервиса, то для создания резервной копии БД перейдите в пользователя postgres и запустите создание дампа

sudo su -l postgres
pg_dump svacer_db > svacer.sql

где svacer_db — имя БД.

В результате дамп БД будет создан в файле svacer.sql

Для восстановления БД из дампа перейдите в пользователя postgres и запустите восстановление

sudo su -l postgres
psql -f svacer.sql svacer_db

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

psql -c 'drop database svacer_db;'
psql -c 'create database svacer_db;'

Если переносите дамп в новый сервер PostgreSQL, создайте пользователя и назначьте ему права на БД, как в [[Help:Installation#Svacer|руководстве по установке]].

=== Если PostgreSQL запущен в docker-контейнере ===
Если PostgreSQL запущен в docker-контейнере, то для создания резервной копии БД выполните следующую команду

docker exec -t svacer-postgres pg_dump -U svace svacer_db > svacer.sql

где:
* svacer-postgres — имя docker-контейнера
* svace — имя пользователя, под учётной записью которого создана БД
* svacer_db — имя БД

Для восстановления БД сначала запустите только контейнер PostgreSQL, восстановите базу из бэкапа, после чего запустите контейнер Svacer

docker compose up -d postgresql
cat svacer.sql | docker exec -i svacer-postgres psql -U svace svacer_db
docker compose up -d

Если база не пустая, для ее очистки перед восстановлением дампа надо остановить контейнер PostgreSQL и удалить docker volume с базой, после чего запустить контейнер

docker compose down
docker volume rm <postgres_volume_name>
docker compose up -d postgresql

=== Бэкап object store в файле ===
Этот способ хорошо подходит, если object store достаточно большой (десятки гигабайт) и не желательно останавливать сервер Svacer.
Резервную копию object store можно создать, использовав следующую команду (доступна только пользователю с ролью admin)

svacer server backup --user admin --password <password> --file <filename>.kvbak

В результате object store будет сохранен в файл '''<filename>.kvbak'''

Для восстановления из резервной копии требуется при запуске сервера указать этот файл в опции '''--load-from-backup'''.

svacer-server run --pg <postgres_url> --store /home/svacer/new-store --load-from-backup <filename>.kvbak

Восстановление возможно только в пустой object store. То есть в данном примере директория '''/home/svacer/new-store''' должна быть пустой.

=== Бэкап object store в сервере PostgreSQL ===
Резервную копию object store можно сохранить в PostgreSQL, который используется сервером Svacer. Данный механизм использует функциональность large object store из PostgreSQL. Этот способ хорошо подходит, если object store не очень большой, в пределах нескольких гигабайт.

Создание бэкапа:

svacer server backup --user admin --password <password> --pg

Бэкап создается в фоновом процессе, пользователь может продолжать работать с сервером. Результат работы команды состоит из ID бэкапа и времени создания. Эти данные печатаются в stdout

ID = 23 CREATE_TS = 2022-10-06T06:04:33Z

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

svacer server backup --user admin --password <password> --list-pg

Результат печатается в stdout и включает ID и время создания бэкапа

<pre>
2022-10-06T09:04:36.929+0300 info Quering server configuration from http://localhost:8080/api/public/server/info
2022-10-06T09:04:36.930+0300 info Server configuration grpc = 3002, rest = 8080
2022-10-06T09:04:36.939+0300 info Logged by user admin
2022-10-06T09:04:36.941+0300 info Backups:
ID = 23 CREATE_TS = 2022-10-06T06:04:33Z
</pre>

Восстановление object store из бэкапа допустимо только при старте сервера. Для этого следует очистить текущий object store (или указать путь на новую директорию) и использовать следующий флаг при старте:

svacer-server run --load-from-pg-backup=<id>

где <id> — ID бэкапа или 0, для использования последнего доступного бэкапа.

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

svacer server backup --user admin --password <password> --drop-pg=<lower>:<upper>

где <lower> и <upper> — нижняя и верхняя граница ID бэкапов.

При запуске сервера можно указать в переменной окружения SVACER_KV_BACKUP_MAX_AGE время хранения таких бэкапов. Задается в формате [https://pkg.go.dev/time#ParseDuration duration], к примеру 24h, 2h30m, 5m30s. По умолчанию 30 дней (720h). Очистка проводится как часть сборки мусора (т. е. периодичность проверки задается через переменную SVACER_GC_PERIOD).

SVACER_GC_PERIOD=2h SVACER_KV_BACKUP_MAX_AGE=720h svacer-server run

=== Бэкап object store вручную ===
Создать бэкап object store можно вручную, просто скопировав директорию object store. Перед этим желательно остановить сервер Svacer для обеспечения целостности данных. Такой способ хорошо подходит, если object store достаточно большой (десятки гигабайт) и возможно остановить сервер Svacer. Для инкрементального бэкапа можно использовать '''rsync'''.

Если директория, где хранить '''object store''' не была явно указана при запуске сервера, по умолчанию он создается в следующей директории:

* ~/.cache/svacer — в OC Linux
* %LocalAppData%\svacer — в ОС Windows (например, С:\Users\myusername\AppData\Local\svacer)

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

* В переменной окружения SVACER_OBJECTS
export SVACER_OBJECTS=/home/user/data/object_store
svacer-server run
* В параметре <code>--store</code>
svacer-server run --store /home/user/data/object_store

При запуске Svacer в docker-контейнере смонтируйте директорию с object store в контейнер как volume и укажите путь к ней в переменной <code>STORE</code> в файле <code>docker-compose.yml</code>

volumes:
- /home/user/data:/data
environment:
- STORE=/data/object_store

При использовании named docker volume, для восстановления данных временно примонтируйте его к другому контейнеру, скопируйте object store, размонтируйте, и после запустите с ним контейнер Svacer. Подробнее и с примерами — в документации [https://docs.docker.com/storage/volumes/#back-up-restore-or-migrate-data-volumes docker volumes]

Help:Import from Svace

2025-12-03T10:37:17Z

Akuzmin: fix page link (installation > configuration)

== CLI команды ==
svacer import --svace <path-to-svace>
svacer upload

Эти две команды импортируют результаты анализа из '''.svace-dir''' в текущей директории и загрузят их на сервер Svacer по адресу '''localhost:8080'''.

== Процесс импорта ==
Процесс импорта результатов работы статического анализатора Svace состоит из двух шагов:
# Дедупликация данных, предобработка, конвертирование во внутренний формат и сохранение результатов в промежуточном хранилище (svacer import).
# Загрузка данных из промежуточного хранилища на сервер (svacer upload).

Можно импортировать результаты и из других статических анализаторов, поддерживающих [[Help:Sarif#Загрузка на сервер из SARIF|формат SARIF]].

=== Промежуточное хранилище ===
Промежуточное хранилище используется для хранения результатов, подготовленных для загрузки на сервер. При импорте данных в промежуточное хранилище снимкам назначается уникальный ID, задается имя проекта и ветки.
Промежуточное хранилище можно использовать для аккумулирования результатов нескольких запусков анализатора, в том числе для различных проектов.
По умолчанию, промежуточное хранилище создается в директории '''.svacer-dir''' рядом с директорией '''.svace-dir.'''
Параллельный доступ к хранилищу из разных экземпляров Svacer '''не допускается'''. Если необходимо использовать разделяемое хранилище и конкурентный доступ, Svacer следует запускать в режиме удаленного промежуточного хранилища.
Процедура импорта c промежуточным хранилищем по умолчанию (размещается в '''<path to project>/.svacer-dir'''):

svacer import --svace <path to svace> [path to project]

где '''<path to svace>''' — путь к исполняемому файлу svace из дистрибутива svace, '''[path to project]''' — путь к проекту (директории, содержащей .svace-dir). Его можно не указывать, тогда в качестве пути к проекту будет использована текущая директория.

Процедура импорта с явным указанием размещения промежуточного хранилища:

svacer import --store <path to store> --svace <path to svace> <path to project>

=== Пользовательские атрибуты ===
При импорте данных можно ассоциировать пользовательские строковые атрибуты со снимком. Значения атрибутов доступно посредством публичного REST API и интерфейса командной строки. Это позволяет связать дополнительные данные с результатами (например commit ID). Пользовательские атрибуты нельзя модифицировать после импорта данных на сервер.
Пользовательские атрибуты экспортируются и импортируются как часть информации при использовании функциональности по экспорту и импорту снимков.

Пользовательский атрибут может быть передан при использовании команды import посредством опции '''--field <name>:<value>'''. Опция может быть указана несколько раз в командной строке.

svacer import ... --field f1:val1 --field f2:val2 ...

Если одно и тоже поле указано несколько раз, то значения поля сохраняются как JSON массив строк.
'''Допустимое имя''' пользовательского атрибута состоит из латинских букв, цифр, знаков подчеркивание или минуса.

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

'''svacer access''' --project <project name> --branch <branch name> --snapshot <name or id> --user <user name> --password <password> '''custom_fields'''

Результат операции выдается как JSON объект в stdout. Объект имеет следующую структуру
{
"field name1":"value",
"field name2": ["value", "value"..]
}
Для получения значения конкретного пользовательского атрибута используется следующая команда

'''svacer access''' --project <project name> --branch <branch name> --snapshot <name or id> --user <user name> --password <password> '''custom_fields --get <field name>'''

Значение атрибута выводится в stdout как JSON строка или массив.
=== Клонирование ветки ===
При импорте данных возможно клонирование ветки (вместе со снимками, разметкой и комментариями) из того же проекта, куда происходит импорт данных.

Для клонирования ветки следует использовать опцию '''--if-no-branch <value>'''

svacer import ... --if-no-branch <value> ...

Значения, которые может принимать опция '''--if-no-branch''':

* '''clone-{name|id}''' — клонировать ветку с заданным именем|id (по умолчанию clone-master)
* '''create-empty''' — создает пустую ветку
* '''return-error''' — возвращает ошибку, если для опции '''--branch <branch_name>''' не существует ветки с именем branch_name

{{Note}} Если не указать данную опцию, то будет автоматически клонироваться ветка master, поэтому для избежания ошибок следует убедиться, что ветка master существует, если данная опция не указана, иначе будет выведена ошибка.

==== Клонирование разметки и комментариев ====
При импорте данных возможно клонирование разметки и комментариев ветки из того же проекта, куда происходит импорт данных.

Для клонирования разметки и комментариев следует использовать опцию '''--clone-review {name|id}'''

svacer import ... --clone-review {name|id} ...

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

Приоритет опции '''--clone-review''' выше, чем у опции '''--if-no-branch''', поэтому возможно клонировать снимки из одной ветки, а разметку и комментарии из другой.

Если ветка с таким именем или id не будет найдена, то при загрузке данных ('''svacer upload ...''', либо '''svacer import --upload ...''') загрузка произойдет, но без склонированной разметки.

=== Прикрепление файлов ===
При импорте данных возможно прикрепление файлов размером до 300Мб к снимку. Файлы будут доступны пользователю в веб-интерфейсе и посредством интерфейса командной строки. Прикрепленные файлы фиксируются в момент операции импорта и не могут быть модифицированы после загрузки на сервер. Удалить файлы может администратор посредством веб интерфейса. Основное назначение данной функциональности прикрепление некоторой иммутабельной информации к результатам анализа для использования в интеграциях со сторонними системами.
Прикрепленные файлы являются частью данных, которые экспортируются и импортируются посредством функциональности экспорта и импорта снимков.

Для прикрепления файлов следует использовать опцию '''--attach <file name>'''

svacer import ... --attach file1.txt --attach file2.txt ...

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

[[File:SnapshotInfo.png|none|alt=Snapshot Info Window]]

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

'''svacer access''' --project <project name> --branch <branch name> --snapshot <name or id> --user <user name> --password <password> '''attachments''' --list

Результат работы команды представляет собой JSON массив объектов вида

[{
"id": 11,
"snapshot_id": "d99c23f7-9fb9-4f4e-85ac-2539328947e0",
"lid": 122885,
"short_name": "Makefile",
"description": "/home/ruseer/static-analysis/svacer/Makefile",
"created_by": "importer",
"updated_by": null,
"create_ts": "2022-10-18T06:41:54.532925Z",
"update_ts": null,
"checksum": "9b1e02a276e810829ac2e38fb775c4ff8d269d0f44fd0fbae40f79a0320389ad"
}]

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

'''svacer access''' --project <project name> --branch <branch name> --snapshot <name or id> --user <user name> --password <password> '''attachments''' --get <id> <output file>

* Если '''<output file>''' не указан, то результат будет напечатан в stdout;
* Если '''<branch>''' не указан, то будет использован ветка master;
* Если '''<snapshot>''' не указан, то будет использован последний снимок на указанной ветке.

=== Загрузка данных на сервер ===
{{Note|type=warn|text=При загрузке данных на сервер, а также при прочих взаимодействиях клиента Svacer с сервером Svacer, крайне рекомендуется, чтобы версия клиента совпадала с версией сервера. В случае несовпадения версий возможны непредсказуемые ошибки.}}

Для загрузки данных из промежуточного хранилища на сервер используется команда '''upload''':

svacer upload --user <user> --password <pwd> --host <host> --port <rest_port> --grpc <grpc_port> <path_to_store>

Если отсутствуют параметры:
* '''--user''' и '''--password''', то используется специальный системный пользователь '''importer''' — он предназначен для импорта данных на сервер;
* '''--host''', то используется '''locahost''';
* '''--port''' и '''--grpc''', то используются их значения по умолчанию;
При загрузке данных на сервер уже загруженные снимки повторно не загружаются. Разделяемая информация (такая как исходные файлы, где один и тот же файл может использоваться в различных анализах и т.п.) также повторно не загружается.
При сбоях в ходе загрузки проводится повторная загрузка, но при этом загружаются только недостающие данные.

В случае если Svacer запущен с поддержкой SSL/TLS или работает за reverse proxy и доступен по протоколу HTTPS, то для загрузки требуется явно указать протокол в параметре '''--host''', либо добавить опцию '''--ssl'''.

svacer upload --host https://<url_without_port> <path_to_store>
svacer upload --ssl --host <url_without_port> <path_to_store>

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

Для информации о загрузке данных на сервер с авторизацией в LDAP см. [[LDAP configuration#Использование CLI сервера Svacer с поддержкой LDAP|Использование CLI Svacer с поддержкой LDAP]].

При загрузке данных на сервер можно включить печать краткой статистики по загруженным результатам. Данная статистика включает информацию о новых и пропущенных предупреждениях, по сравнению с последним ранее загруженным снимком. Выдача краткой статистики возможно в текстовом или JSON виде. Результаты печатаются в stdout.

{{Note|text=Для корректной работы опций <code>--quality-gate</code> и <code>--quick-stats</code> при использовании reverse proxy, в частности Nginx, для gRPC порта Svacer, необходимо в настройках секции http или server добавить инструкцию:
underscores_in_headers on;
См. [[Help:Configuration#Nginx|пример конфига]]}}

svacer upload ... --quick-stats --out-format text ...

Пример вывода
Quick Stats:
Previous snapshot : Snapshot 2022-11-16 10:11:37 +0300
Current snapshot : Snapshot 2022-11-16 10:23:08 +0300
New : 1
Missing : 0
Matched : 1
Same : 0

svacer upload ... --quick-stats --out-format json ...

Пример вывода
{"branch":"391f21d1-2173-449c-9d1a-dd846d2a6471","snapshot":"34a1125d-86a3-45d3-9b41-cb5da24ab96e","snapshotName":"Snapshot 2022-11-21 10:19:06 +0300","lastSnapshot":"59657ae8-c3b6-48bc-b586-a6c0580cdb50","lastSnapshotName":"Snapshot 2022-11-21 10:18:09 +0300","same":2}

Формат JSON определяется protobuf3 схемой (ряд полей носит внутренний характер):
message ImportSummaryContext {
string branch = 1;
string snapshot = 2;
string snapshotName = 9;
string lastSnapshot = 3;
string lastSnapshotName = 4;
int64 new = 5;
int64 missing = 6;
int64 matched = 7;
int64 same = 8;
string qualityGate = 10;
string baseline_branch_name = 11;
string baseline_project_name = 12;
string branch_name = 13;
string project_name = 14;
string project_id = 15;
string baseline_snapshot_id = 16;
string baseline_branch_id = 19;
string baseline_project_id = 20;
string baseline_snapshot_name = 21;
}

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

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

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

svacer container snapshot rename --host <host> --port <port> --user <user name> --password <pwd> --id <snapshot id> --name <snapshot name>

Идентификатор снимка можно посмотреть в веб-интерфейсе или получить посредством public API.

=== Модификация путей в разметке при импорте ===

==== Обычное поведение ====
По умолчанию пути к файлам не меняются, за исключением пути к папки '''.svace-dir''', он будет заменён на '''.build'''. Эту информацию можно увидеть при импорте проекта:

svacer import --clean .svacer-dir
...
info The path prefix of .svace-dir 'C:\work\generate_files\gen_exp' will be trimmed when converting file paths
...

После этого все маркеры из этой папки и дочерних будут в '''Review''' показывать путь вида '''/.build/test500_1.c''' вместо полного пути для файла '''C:\work\generate_files\gen_exp\test500_1.c'''.

[[File:SimpleSourceCode.png|none|alt=Simple Source Code Window]]

==== Использование --path-prefix ====
При необходимости модификацию по умолчанию можно заменить через '''--path-prefix'''.
Значения опции передаются в виде:

--path-prefix "prefix_for_replace1:value1;prefix_for_replace2:value2; ..."

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

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

svacer --debug import --clean --upload --path-prefix "C::\work:work" .svacer-dir
...
INFO Creating regular object store
DEBUG Creating path mapping rule 'C:\work' => 'work'
DEBUG Creating path mapping rule 'C:/work' => 'work'
DEBUG Creating path mapping rule '/C_/work' => 'work'
...

После импорта на сервере можно увидеть файл: '''/work/generate_files/gen_exp/test500_1.c'''

[[File:PathPrefixSourceCode.png|none|alt=PathPrefixSourceCode]]

==== Использование --build-object @auto ====
При импорте конкретного файла *.svres исходный код может быть загружен, при указании опции '''--build-object @auto'''. В случае, если этот файл лежит в папке .svace-dir, исходный код будет взят из нее. При отсутствии папки .svace-dir файлы будут браться по абсолютным путям из файла *.svres.
Для указания конкретных директорий поиска подходящих файлов из *.svres следует использовать опцию '''--source-tree''', которую можно указать несколько раз, чтобы задать несколько корневых директорий. Поиск в этих директориях будет происходить только в случае, когда по путям из файла *.svres были найдены не все файлы. В случае успешного сопоставления, на сервер будут загружены соответствующие файлы из директории source tree.

==== Использование --full-paths ====
Допустимо также полное отключение модификаций путей, для этого импорт надо производить с опцией '''--full-paths'''. Опция блокирует как модификацию по умолчанию '''.build''', так и явные указания через '''--path-prefix'''.

svacer --debug import --clean --upload --full-paths .svacer-dir

После загрузки на сервере будет виден только полный путь: '''/C_/work/generate_files/gen_exp/test500_1.c'''.

[[File:FullPathsSourceCode.png|none|alt=FullPathsSourceCode window]]

Пути из Windows преобразуются в стиль Linux с небольшим преобразованием символов.

=== Использование quality gate ===

Возможна проверка новых, пропущенных, одинаковых, измененных предупреждений, для этого надо производить импорт с опцией '''--quality-gate'''.

--quality-gate value Specify a quality gate. Format: stat_1:severity_1:N_1:[statuses_1],...,stat_k:severity_k:N_k:[statuses_k], stat takes values: new, missing, matched, same, total; severity takes the following values: all, critical, major, normal, minor, undefined, <detector name part>; N is a natural number; statuses - an optional field, specified in square brackets with a separator ";" possible values - confirmed, false_positive, wont_fix, unclear, undecided, when specifying statuses, the quality gate will be searched only for markers that have exactly these statuses, for example [confirmed;wont_fix;undecided]. If the severity of the number N is exceeded, it will out a warning. Also, as a value, you can specify a json or yaml file in which the quality gate is specified.

Флаг принимает на вход тип предупреждений (stat), severity, их количество (N) и их статусы (statuses).

* stat задает тип предупреждений. Возможные значения:
** '''new''' — присутствует в новом снимке, но отсутствует в старом
** '''missing''' — присутствует в старом снимке, но отсутствует в новом
** '''matched''' — присутствуют изменения в файлах, не повлиявшие на выданное предупреждение
** '''same''' — одинаковые
** '''total''' — сумма всех вышеперечисленных (то есть количество предупреждений в объединении старого и нового снимков)
* severity задается либо непосредственным его указанием ('''critical''', '''major''', '''normal''', '''minor''', '''undefined'''), либо '''all''' (все severity), либо частью имени детектора в формате [https://www.postgresql.org/docs/current/functions-matching.html postgres ILIKE]
* N — порог, после которого вызывается срабатывание. Не включает данное число (т. е. если указать 5, то при нахождении 6 и более вызывается срабатывание quality-gate)
* statuses — '''опциональное''' поле, в котором можно указать какие статусы (разметку) учитывать при нахождении предупреждений. Возможные значения '''confirmed''', '''false_positive''', '''wont_fix''', '''unclear''', '''undecided'''. Задаются в квадратных скобках с разделителем <code>;</code>. Например <code>[confirmed;wont_fix]</code>. Если не указать данное поле, то будут учитываться все статусы. При указании в command line рекомендуется значение опции <code>--quality-gate</code> экранировать в двойные кавычки. Принципы учета статусов:
** Если предупреждение размечено в новом снимке (значение не '''undecided'''), разметка берется из нового предупреждения
** Если в новом снимке нет разметки у данного предупреждения, а в старом есть, то берется разметка из старого предупреждения
** В остальных случаях у данного предупреждения разметка равна '''undecided'''.

Пример:
--quality-gate "total:critical:0:[confirmed;wont_fix],new:all:10"

Тогда опция сработает, если либо:

# Cтатическим анализатором будут найдены общее количество предупреждений (новых, пропущенных, одинаковых, измененных) с '''severity:critical''' и статусами '''confirmed''' и '''won't fix'''
# Cтатическим анализатором будут найдены новые предупреждения с любым статусом и severity

Пример вывода:
Quality gate exceed:
Previous snapshot : Snapshot 2025-06-16 15:37:09 +0300
Current snapshot : Snapshot 2025-06-16 15:37:39 +0300
Stat : total
Severity : Critical
Severity Statuses : confirmed wont_fix
Severity Threshold : 0
Found Severity : 3

Также quality-gate можно задать файлом в формате json или yaml (не yml).

Пример json файла:

<code>["total:all:1", "total:proc:1"]</code>

Пример yaml файла:
- "total:all:1"
- "total:proc:1"

{{Note|text=Для корректной работы опций <code>--quality-gate</code> и <code>--quick-stats</code> при использовании reverse proxy, в частности Nginx, для gRPC порта Svacer, необходимо в настройках секции http или server добавить инструкцию:
underscores_in_headers on;
См. [[Help:Configuration#Nginx|пример конфига]]}}

==== Флаг --quality-gate-exit-code ====
В случае срабатывания quality gate можно указать какой exit code от 0 до 125 будет возвращен.

--quality-gate-exit-code value Specify the exit code of the application in the range from 0 to 125, which will be issued when the quality-gate is exceeded. The default is 0.

{{Note|text=Значение по умолчанию 0, поэтому без явного задания exit code срабатывание quality-gate не вернет ненулевой статус и при использовании в CI/CD pipeline не будет помечен как failed. Так сделано для упрощения внедрения quality-gate опции в существующий CI/CD. Вначале можно проанализировать логи и если данные корректны, добавить опцию <code>--quality-gate-exit-code</code> с ненулевым значением.}}

==== Флаг --quality-gate-verbose ====
Если необходимо выводить информацию и об успешно прошедших quality gate, то нужно добавить флаг <code>--quality-gate-verbose</code>

Пример вывода:
Quality gate exceed:
Previous snapshot : Snapshot 2025-06-16 15:37:39 +0300
Current snapshot : Snapshot 2025-06-16 16:10:33 +0300
Stat : total
Severity : Critical
Severity Statuses : confirmed wont_fix
Severity Threshold : 0
Found Severity : 3
The result of comparison of those who have completed quality gate:
Previous snapshot : Snapshot 2025-06-16 15:37:39 +0300
Current snapshot : Snapshot 2025-06-16 16:10:33 +0300
Stat : new
Severity : All
Severity Threshold : 10
Found Severity : 0

==== Флаг --baseline ====
Если сравнение необходимо проводить не с предыдущим снимком в этой же ветке, то можно указать флаг <code>--baseline</code> (также работает для флага <code>--quick-stats</code>).

--baseline value A snapshot to compare (--quality-gate and/or --quick-stats). Format: {project}:::{branch}:::{snapshot} or {project}:::{branch} or {project} use UUID or name. By default, snapshot is the last added, branch is master. If the flag is not specified, then the comparison will be with the latest snapshot from the branch where the snapshot is loaded.

Указывается в формате <code>{project}:::{branch}:::{snapshot}</code> или <code>{project}:::{branch}</code> или <code>{project}</code>, используя имена или UUID. По умолчанию используется ветка master (если указан только проект) и последний добавленный снимок (если снимок не указан).

При указании данного флага меняется вывод:

* В текстовом формате добавляются строки об имени проекта, ветки и снимка, с которым сравнивался загружаемый снимок
* В json формате добавляются имена и id проекта, ветки и снимка, с которым сравнивался загружаемый снимок

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

==== Флаг --out-file ====

Для указания файла, в который необходимо вывести результаты quality gate, используйте опцию <code>--out-file</code> (по умолчанию вывод идет в stdout).

==== Флаг --out-format ====

Для указания в каком формате вывести результаты quality gate используйте опцию <code>--out-format</code>. Принимает значения text (человекочитаемый) и json. По умолчанию text.

Help:UI manual

2025-12-03T10:35:33Z

Akuzmin: fix page link (installation > configuration)

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

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

Для авторизации в пользовательском интерфейсе сервера Svacer введите логин и пароль на странице ввода учётных данных. Учётные данные по умолчанию — admin / admin.
[[File:Авторизация 01.png|thumb|none|x300px|alt=AutorizationMain|Страница ввода учетных данных]]

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

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

[[File:Авторизация LDAP 02.png|thumb|none|x300px|alt=AutorizationLDAP|Страница входа по протоколу LDAP]]

После успешного входа отобразится пользовательский интерфейс сервера Svacer. При этом, если в прошлой сессии пользователь [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выбрал проект, его ветку и снимок]] или [[Help:UI manual#Использование фильтров|применил фильтры]], отобразятся эти проект, ветка и фильтры.

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

{{Note|type=info|text=''Чтобы после обновления системы в пользовательском веб-интерфейсе корректно отображались изменения, после авторизации обновите страницу в браузере – нажмите клавишу F5.''}}

== Описание основных элементов пользовательского интерфейса ==
Все страницы пользовательского интерфейса сервера Svacer устроены единообразно и состоят из двух частей:
# Верхняя панель – отображается на всех страницах пользовательского интерфейса. Содержит:
#* логотип сервера Svacer;
#* кнопки меню:
#** '''Разметка''' – [[Help:UI manual#Работа в режиме просмотра кода|просмотр и разметка найденных маркеров]], а также [[Help:UI manual#Сравнение снимков и маркеров|сравнение снимков или отдельных маркеров]];
#** '''Код''' – [[Help:UI manual#Работа в режиме разметки|просмотр снимков исходного кода]], связанного с результатами анализатора Svace;
#** '''Проекты''' – [[Help:UI manual#Управление проектами и группами проектов|управление проектами]] (режим доступен только пользователям с ролью admin);
#** '''Детекторы''' – [[Help:UI manual#Просмотр детекторов|просмотр списка детекторов]];
#** '''Статистика''' – [[Help:UI manual#Просмотр статистики|просмотр статистики разметки]] по всем проектам, веткам и снимкам, доступным пользователю;
#** '''Поиск''' – [[Help:UI manual#Глобальный поиск|глобальный поиск]] снимков, маркеров и комментариев к ним;
#* [[File:Icon settings.png|x25px]] – кнопка для перехода к [[Help:UI manual#Настройка сервера Svacer|настройке системы]];
#* [[File:Icon RuEng.png|x25px]] – переключатель языка пользовательского интерфейса;
#* [[File:Icon question mark.png|x25px]] – кнопка для перехода на страницу документации к системе;
#* [[File:Icon bell.png|25px]] – кнопка для перехода к [[Help:UI manual#Просмотр уведомлений в интерфейсе Системы|уведомлениям]];
#* [[File:Icon profile.png|x25px]] – кнопка меню пользователя, которое предоставляет следующие функции:
#** [[Help:UI manual#Настройка профиля пользователя|настройка профиля пользователя]];
#** [[Help:UI manual#Настройка интерфейса|настройка интерфейса]];
#** [[Help:UI manual#Настройка уведомлений|настройка уведомлений]];
#** [[Help:UI manual#Управление лицензией|управление лицензией]];
#** [[Help:UI manual#Просмотр информации о программе|просмотр информации о программе]];
#** [[Help:UI manual#Выход из системы|выход из системы]].
# Рабочая область – область экрана для просмотра информации и ввода, которая соответствует выбранному режиму работы или странице настроек.

:[[File:03 Основные элементы интерфейса – без VSCode.png|thumb|none|upright=3]]

== Базовые функции системы ==
=== Просмотр уведомлений в интерфейсе Системы===
Чтобы посмотреть уведомления, нажмите кнопку [[File:Icon bell.png|25px]] в правом верхнем углу экрана.

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

[[File:Notifications new.png|thumbnone|x300px|alt=NotificationList|Панель уведомлений]]

Нажмите кнопку [[File:Icon cross 01.png|15px]] для удаления уведомления.

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

=== Настройка профиля пользователя ===
Для перехода в профиль выберите пункт '''Профиль''' в меню пользователя в правом верхнем углу экрана:
[[File:06 Меню пользователя — без VSCode.png|thumb|none|250px|alt=UserMenu|Меню пользователя. Переход к настройке профиля]]

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

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

=== Изменение пароля ===
Для изменения пароля:
:1. Выберите пункт '''Профиль''' в меню пользователя.
:2. В разделе '''Профиль пользователя''' нажмите на ссылку '''Изменить пароль''':
:[[File:10_Профиль_изменение пароля.png|thumb|none|450px|Переход к изменению пароля в профиле пользователя]]
:3. В открывшемся окне:
::а) Введите текущий пароль.
::б) Дважды введите новый пароль.
::в) Нажмите кнопку '''Изменить'''.
::[[File:11_Профиль_ввод нового пароля.png|thumb|none|350px|Окно изменения пароля]]

=== Настройка интерфейса ===
Для перехода к настройкам выберите пункт '''Настройки интерфейса''' в меню пользователя в правом верхнем углу экрана:
[[File:187 Меню пользователя интерфейс.png|thumb|none|250px|alt=UserMenu|Меню пользователя. Переход к настройке интерфейса]]

В правой части экрана отобразится панель '''Настройки интерфейса''' с тремя группами параметров:
:1. '''Общие'''. Параметры этой группы позволяют:
::а) Выбрать фильтры, которые будут по умолчанию применяться при повторном входе в систему:
::*фильтры, установленные в предыдущей сессии (выбрано по умолчанию);
::*сохраненный пользовательский фильтр.
::б) Включить или выключить (выбрано по умолчанию) замену снимка на последний загруженный в БД Svacer снимок при открытии сохраненного контекста.
::Если параметр в состоянии «Выключен», при выборе проекта и ветки открывается последний импортированный снимок.
::в) Включить или выключить (выбрано по умолчанию) сохранение вкладок с открытыми файлами в каждом контексте.
::г) Включить (выбрано по умолчанию) или выключить сохранение применённой сортировки значений в таблице маркеров при [[Help:UI manual#Выход из системы|выходе из системы]].
::д) Включить или выключить (выбрано по умолчанию) механизм генерации PDF-файла на основе HTML при выгрузке отчета с [[Help:UI manual#Таблица маркеров|информацией о маркерах]].
{{Note|type=warn|text=''Для использования генерации PDF на основе HTML на сервере Svacer должен быть [[Help:Installation#Браузер для PDF-отчетов|установлен браузер Chromium или Google Chrome]].''}}
:[[File:08 общие настройки интерфейса.png|thumb|none|600px|alt=UserInterfaceSettings|Настройки интерфейса. Группа параметров «Общие»]]
:2. '''Навигационная панель'''. Параметры этой группы позволяют:
::а) Выбрать отображение по умолчанию данных [[Help:UI manual#Вкладка «Детекторы»|на вкладке '''Детекторы''']] навигационной панели:
::*группировка детекторов по уровням серьезности (выбрано по умолчанию);
::*отображение детекторов в виде списка.
:::Выбранное отображение будет применяться [[Help:UI manual#Вкладка «Детекторы»|на вкладке '''Детекторы''']] каждый раз после входа в систему.
::б) Выбрать отображение по умолчанию данных [[Help:UI manual#Вкладка «Файлы»|на вкладке '''Файлы''']] навигационной панели:
::*только имя файла (выбрано по умолчанию);
::*полный путь к файлу.
::в) Выбрать способ сортировки в колонке '''Маркеры''' [[Help:UI manual#Вкладка «Файлы»|на вкладке '''Файлы''']] панели навигации:
::*по общему количеству маркеров (выбрано по умолчанию);
::*по количеству размеченных маркеров.
:[[File:08_настройки навигационной панели.png|thumb|none|600px|alt=UserInterfaceSettings|Настройки интерфейса. Группа параметров «Навигационная панель»]]
:3. '''Просмотр кода'''. Параметры этой группы позволяют:
::а) Включить (выбрано по умолчанию) или выключить использование темной темы (темный фон, светлый текст) при просмотре файлов с исходным кодом.
::б) Включить или выключить (выбрано по умолчанию) переиспользование [[Help:UI manual#Вкладка с исходным кодом|вкладки с исходным кодом]] в редакторе кода.
::в) Включить или выключить (выбрано по умолчанию) отображение всех элементов трассы маркера по нажатии на ссылку '''Показать трассу''' [[Help:UI manual#Вкладка с исходным кодом|в виджете маркера]].
::Если параметр находится в состоянии «Выключен», то будет отображаться только первый элемент трассы.
::г) Выбрать отображение виджета относительно строки кода, с которой он связан:
::* над строкой кода (выбрано по умолчанию);
::* под строкой кода.
:[[File:08 настройки просмотра кода.png|thumb|none|600px|alt=UserInterfaceSettings|Настройки интерфейса. Группа параметров «Просмотр кода»]]
:Эти настройки сохраняются для учётной записи пользователя и не сбрасываются при новой сессии.
:Чтобы сбросить параметры любой группы к значениям по умолчанию, нажмите на ссылку '''Сбросить настройки''' внизу панели '''Настройки интерфейса'''.

=== Настройка уведомлений ===
Система может уведомлять пользователей по каналам E-mail и Telegram о следующих типах операций:
* добавление (при импорте, копировании, клонировании) и удаление снимков;
* изменение разметки маркеров;
* добавление комментариев к маркерам.

Для перехода к настройкам выберите пункт '''Настройки уведомлений''' в меню пользователя в правом верхнем углу экрана:
[[File:188 Меню пользователя - уведомления.png|thumb|none|250px|Меню пользователя. Переход к настройке уведомлений]]

В правой части экрана отобразится панель '''Настройки уведомлений''' с двумя группами параметров:
:1. '''Типы уведомлений'''. Параметры этой группы позволяют выбрать канал, по которому будут приходить уведомления, настроить и проверить его. Для этого:
::а) Включите опцию '''E-mail''' и (или) '''Telegram chat ID'''.
::При выборе уведомления по '''E-mail''' используется адрес электронной почты, указанный [[Help:UI manual#Настройка профиля пользователя|в профиле пользователя]].
::б) При выборе уведомления по '''Telegram''' введите '''Telegram chat ID'''.
::в) Чтобы проверить подключение к каналу нажмите кнопку '''Проверить'''.
::Отправится тестовое сообщение по указанным реквизитам:
::[[File:189 Настройки уведомлений.png|thumb|thumb|none|600px|alt=UserInterfaceSettings|Настройки уведомлений]]
:2. '''Подписки'''. Позволяют выбрать проекты, ветки и события, при возникновении которых будут приходить уведомления. Для этого:
::а) Для добавления подписки нажмите кнопку '''Добавить''' и в появившейся строке в раскрывающемся списке выберите проект и/или его ветку.
::Чтобы уведомления приходили при изменениях во всех проектах, доступных пользователю, выберите значение '''Все''' в раскрывающемся списке проектов.
::[[File:190 Настройки уведомлений. Выбор ветки.png|thumb|thumb|none|600px|alt=UserInterfaceSettings|Настройки уведомлений. Выбор ветки]]
::б) Выберите объекты, при изменении которых будут приходить уведомления – установите флажки в столбцах '''Снимки''', '''Разметка''', '''Комментарии'''.
::в) Если требуется получать уведомления о разметке и/или комментариях только в маркерах, в которых пользователь принимал участие, установите флажок в столбце '''Участие''' (доступен, только если установлены флажки в столбцах '''Разметка''' и/или '''Комментарии''').
::г) Для настройки исключения из подписки на уведомления нажмите кнопку [[File:Icon plus.png|x25px]].
::Кнопка примет вид [[File:Icon minus.png|x25px]].
::д) Для удаления подписки на уведомления нажмите кнопку [[File:Icon minus.png|x25px]].
::По окончании настройки уведомлений нажмите кнопку '''Сохранить'''.

=== Управление лицензией ===
{{Note|type=info|text=''В версии сервера Svacer 12.0.0 лицензия встроена в дистрибутив и не ограничивает функции системы. Срок действия встроенной лицензии – до 31.12.2027 г.''}}

Чтобы посмотреть текст лицензии системы и копировать его, а также для активации новой лицензии, выберите пункт '''Лицензия''' в меню пользователя в правом верхнем углу экрана.
В правой части экрана отобразится панель '''Лицензия'''.
[[File:231 Меню пользователя Переход к просмотру лицензии.png|thumb|none|450px|Меню пользователя. Переход к просмотру лицензии]]
[[File:232 Панель Лицензия.png|thumb|none|x400px|Панель «Лицензия»]]

Чтобы скопировать текст лицензии, нажмите кнопку [[File:Icon copy link.png|x15px]].
Чтобы активировать лицензию:
:1. Нажмите на ссылку '''Активировать новую'''.
:2. В открывшемся окне '''Активация лицензии''' введите лицензионный ключ и нажмите кнопку '''Активировать'''.
{{Note|type=warn|text=''Функция активации лицензии доступна пользователям с [[#Серверные доступы|серверным доступом]] '''Администрирование сервера'''.''}}
[[File:233 Окно Лицензия.png|thumb|none|600px|Окно «Активация лицензии»]]

=== Просмотр информации о программе ===
Чтобы посмотреть информацию о программе, выберите пункт '''О программе''' в меню пользователя в правом верхнем углу экрана.
[[File:12_Меню пользователя_о программе — без VSCode.png|thumb|none|250px|Меню пользователя. Переход к просмотру информации о программе]]

Откроется окно с информацией о программе
[[File:13 1 О программме.png|none|thumb|600x600px|Информация о программе]]
Нажмите на ссылку в строке '''Документация и релизы''' для перехода на страницу документации к системе и ссылкам для скачивания дистрибутивов релизов Svacer.

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

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

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

== Выбор контекста (проекта, ветки и снимка) ==
Для работы [[Help:UI manual#Работа в режиме разметки|в режиме разметки]] или [[Help:UI manual#Работа в режиме просмотра кода|режиме просмотра кода]] требуется выбрать проект, ветку и снимок с результатами работы анализатора Svace.

При необходимости список проектов можно отфильтровать по группе проектов. Это можно сделать в блоке, который расположен под [[Help:UI manual#Описание основных элементов пользовательского интерфейса|верхней панелью]].

[[File:14_Выбор проекта, верки, снимка.png|800px]]

По умолчанию после выбора проекта автоматически выбирается ветка master и последний импортированный снимок, если [[Help:UI manual#Настройка интерфейса|параметр '''При открытии сохраненного контекста заменить снимок на последний загруженный''']] находится в состоянии '''Выключен'''. Если master отсутствует, то ветку нужно выбрать вручную.

== Работа в режиме разметки ==
Режим разметки предоставляет следующий набор элементов управления:
:1. Навигационная панель:
:* [[Help:UI manual#Вкладка «Детекторы»|вкладка '''Детекторы''']];
:* [[Help:UI manual#Вкладка «Файлы»|вкладка '''Файлы''']].
:Эту панель можно скрыть. Для этого нажмите кнопку [[File:Button Скрыть навигацию.png|x25px]] в правом верхнем её углу. Чтобы панель раскрыть, нажмите кнопку [[File:Button Паказать навигацию.png|x25px]].
:2. Центральная панель:
:* [[Help:UI manual#Вкладка «Информация о снимке»|вкладка '''Информация о снимке''']] – открывается по нажатии кнопки [[File:Icon Information.png|25x25px]];
:* одна или несколько [[Help:UI manual#Вкладка с исходным кодом|вкладок с исходным кодом''']] (отображаются после выбора файлов в таблице маркеров или навигационной панели);
:* [[Help:UI manual#Таблица маркеров|таблица маркеров]];
:3. [[Help:UI manual#Функции правой панели|Правая панель]] с информацией о маркере.
:Эту панель можно скрыть. Для этого нажмите кнопку [[File:Button Паказать навигацию.png|x25px]] в левом верхнем её углу. Чтобы панель раскрыть, нажмите кнопку [[File:Button Скрыть навигацию.png|x25px]].

[[File:96 Режим разметки. Набор элементов управления.png|800px|thumb|none|Режим разметки. Набор элементов управления]]

=== Функции навигационной панели ===
==== Вкладка «Детекторы» ====
На этой вкладке отображается список детекторов Svace, которые сработали в выбранном снимке.

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

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

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

[[File:17 Файлы.png|thumb|none|300px|Вкладка '''Файлы''']]

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

На вкладке '''Файлы''' пользователю доступны следующие функции:
:1. Просмотр на [[Help:UI manual#Вкладка с исходным кодом|вкладке с исходным кодом]]: содержимого файла, места и содержания маркера, а также подробной информации о маркере [[Help:UI manual#Функции правой панели|на правой панели]] – без включения фильтрации по этому файлу. Для этого нажмите на имя файла.
:2. Применение фильтра по файлам [[Help:UI manual#Таблица маркеров|в таблице маркеров]] – для этого нажмите кнопку [[File:Icon plus.png|x25px]] в одной или нескольких строках.
:Фильтр применится, кнопка [[File:Icon plus.png|x25px]] в списке файлов поменяется на [[File:Icon minus.png|x25px]].
:3. Исключение файла из фильтра по файлам [[Help:UI manual#Таблица маркеров|в таблице маркеров]] – для этого нажмите кнопку [[File:Icon minus.png|x25px]] в строке файла.
:4. Отмена фильтрации [[Help:UI manual#Таблица маркеров|в таблице маркеров]] для всех выбранных файлов – для этого нажмите кнопку [[File:Icon minus 3.png|x25px]] или кнопку [[File:icon_return.png|x25px]] [[Help:UI manual#Вкладка «Детекторы»|на вкладке '''Детекторы''']].
:5. [[Help:UI manual#Блокировка разметки|Блокировка всех маркеров]] в файле для разметки другими пользователями – для этого нажмите кнопку [[File:icon_unlocked.png|x25px]] справа от названия файла (отображается при наведении курсора).
:6. Поиск по имени/пути файла в поле '''Поиск по полному пути'''. Поддерживается поиск с использованием [[Help:UI manual#Использование регулярных выражений|регулярных выражений]].
:7. Сортировка файлов по количеству маркеров – для этого нажмите кнопку [[File:Icon-expand-all.png|x25px]]
:8. Выгрузка списка отображаемых на панели файлов в файл формата .csv – для этого нажмите кнопку [[File:button_Скачать CSV.png|25px]]
:9. Настройка отображения файлов и сортировки в колонке '''Маркеры''' на вкладке '''Файлы''' – для этого нажмите кнопку [[File:icon_gear.png|x25px]] и поменяйте настройки.
:[[File:18 Временная настройка панели навигации.png|thumb|none|800px|Настройка отображения файлов и сортировки полей]]

=== Функции центральной панели ===
==== Вкладка «Информация о снимке» ====
На этой вкладке отображается информация о выбранном снимке.

[[File:19 Информация о снимке.png|thumb|left|600px|Вкладка '''Информация о снимке''']]
 
На вкладке '''Информация о снимке''' пользователю доступны следующие функции:
:1. Просмотр подробной информации о снимке во всплывающем окне – для этого нажмите кнопку '''Просмотреть JSON'''.
:2. Экспорт [[Help:UI manual#Экспорт|исходного кода, снимков и разметки]] – для этого нажмите кнопку '''Экспорт''' и выберите подходящий вариант.
:3. [[Help:UI manual#Импорт разметки|Импорт разметки]] – для этого нажмите кнопку '''Импорт''' и выберите подходящий вариант.
:4. Переход к более продвинутой навигации по исходному коду с подсветкой маркеров во встроенном Web-IDE Theia – для этого нажмите кнопку '''Открыть в IDE''' .
:{{Note|type=warn|text=''Функциональность является экспериментальной, доступна при наличии проектного доступа '''Экспорт снимков''' и запуске веб-приложения Svacer по протоколу HTTPS или на локальном хосте. Список доступных IDE определяется при инсталляции. Если доступна только одна IDE, то раскрывающийся список отсутствует, а IDE открывается сразу по нажатию кнопки '''Открыть в IDE'''. Если функциональность недоступна, кнопка '''Открыть в IDE''' неактивна и отображается иконка'' [[File:Icon attention.png|23x23px]]''.''}}
:5. Просмотр списка приложенных файлов — по нажатии кнопки '''Показать''', но только при наличии приложенных файлов.
:6. Скрытие списка приложенных файлов (возможно только при наличии приложенных файлов) – для этого нажмите на ссылку '''Скрыть'''.
:7. Удаление приложенного файла (возможно только при наличии приложенных файлов) — для этого нажмите кнопку [[File:icon_delete.png|x25px]].
:8. Просмотр пользовательских полей, которые пользователь указал при импорте – доступен по нажатии кнопки '''Показать''', но только при наличии этих полей.
:9. Просмотр параметров анализа во всплывающем окне – для этого нажмите кнопку '''Показать''' в строке '''Параметры анализа'''.
:10. Экспорт параметров анализа в формате .txt – для этого нажмите кнопку '''Скачать''' в строке '''Параметры анализа'''.
:11. [[Help:UI manual#Работа с таблицей статистики|Просмотр таблицы статистики]] – для этого нажмите кнопку '''Показать''' в строке '''Статистика по детекторам'''.
:Информация в таблице сгруппирована по параметрам детекторов, найденным маркерам и статусу их разметки.

==== Вкладка с исходным кодом ====
Вкладка открывается только после выбора файла [[Help:UI manual#Вкладка «Детекторы»|на вкладке '''Детекторы''']] или [[Help:UI manual#Вкладка «Файлы»|'''Файлы''']], а также [[Help:UI manual#Таблица маркеров|в таблице маркеров]]. Одновременно может быть открыто несколько вкладок с исходным кодом, если выключена [[Help:UI manual#Настройка профиля пользователя|настройка '''Переиспользование вкладки в редакторе кода''']].

В верхней части вкладки отображаются панель инструментов для работы с файлом [1] и полный путь к файлу [2]. Если в строке кода установлен курсор, то в нижнем правом углу вкладки отображается его позиция [3]:
[[File:20 Исходный код.png|thumb|none|600px|Полный путь к файлу и позиционирование курсора]]

На вкладке с исходным кодом пользователю доступны следующие функции:
:1. Отображение кода на весь экран – для этого нажмите кнопку [[File:Icon expand.png|23x23px]] или дважды кликните на вкладку файла.
:
:Для возврата к обычному отображению нажмите кнопку [[File:Icon minimize.png|24x24px]] или дважды кликните на вкладку файла.
:2. Переход к предыдущей или следующей строке, в которую пользователь установил курсор, – для этого используйте кнопки [[File:Button left.png|23x23px]] и [[File:Button right.png]] или сочетания клавиш '''Ctrl + <''' и '''Ctrl + >'''.
:3. Просмотр и открытие маркеров из списка всех маркеров в данном файле – для этого нажмите кнопку [[File:Icon list 2.png|x25px]].
:[[File:21 Исходный код Отображение списка маркеров.png|thumb|none|300px|right|Cписок маркеров в файле]]
:4. Отображение всех маркеров – для этого нажмите кнопку [[File:Icon Скрыть маркеры.png|24x24px]].
:Кнопка недоступна, если она уже нажата; все маркеры уже отображаются.
:5. Скрытие всех маркеров и трасс – для этого нажмите кнопку [[File:Icon Показать маркеры.png|24x24px]].
:Кнопка недоступна, если она уже нажата; все маркеры уже скрыты.
:6. Добавление комментария к строке кода – можно сделать двумя способами:
::а) Нажмите кнопку [[File:Button Comment Add.png|x25px]] в левой части строки, рядом с её номером (отображается только если в строке установлен курсор) и введите комментарий.
::ИЛИ
::б) Нажмите правой кнопкой мыши на строку и выберите пункт '''Добавить комментарий'''. Этим способом можно добавить несколько комментариев к одной строке.
:7. Просмотр комментария к строке – можно сделать двумя способами:
::а) Нажмите кнопку [[File:Button Comment view.png|x25px]] в левой части строки, рядом с её номером.
::ИЛИ
::б) Нажмите кнопку [[File:Button Comment view.png|x25px]] на панели инструментов и выберите в списке строку комментария.
::Отобразится виджет комментария, в котором доступны следующие функции:
::*добавление дополнительного комментария к этой строке кода по нажатии кнопки [[File:Button Comment Add.png|x25px]];
::*редактирование текста комментария по нажатии кнопки [[File:icon_edit3.png|x25px]];
::*удаление комментария по нажатии кнопки [[File:icon_delete 2.png|x25px]].
:[[File:118 Виджет комментария к строке кода.png|thumb|none|600px|Виджет комментария к строке кода]]
:8. Просмотр и открытие комментариев из списка всех комментариев в коде – для этого нажмите кнопку [[File:Button Comment view.png|x25px]] справа.
:9. Отображение всех комментариев в коде – для этого нажмите кнопку [[File:Button_Comment_view_all.png|x25px]] в панели инструментов.
:Кнопка недоступна, если она уже нажата; все комментарии уже отображаются.
:10. Скрытие всех комментариев в коде – для этого нажмите кнопку [[File:Button_Comment_hide_all.png|x25px]] в панели инструментов.
:Кнопка недоступна, если она уже нажата; все комментарии уже скрыты.
:11. Добавление открытого файла в [[Help:UI manual#Использование фильтров|фильтр]] [[Help:UI manual#Таблица маркеров|таблицы маркеров]] – для этого нажмите кнопку [[File:Icon filter add.png|x25px]] в панели инструментов.
:Фильтрация применится, вид кнопки поменяется на [[File:Icon filter remove.png|x25px]].
:12. Исключение файла из [[Help:UI manual#Использование фильтров|фильтра]] [[Help:UI manual#Таблица маркеров|таблицы маркеров]] – для этого нажмите кнопку [[File:Icon filter remove.png|x25px]] в панели инструментов.
:Фильтрация по этому файлу отменится, вид кнопки поменяется на [[File:Icon filter add.png|x25px]].
:13. Возврат к исходному маркеру (например, если был выбран другой связанный маркер на вкладке '''Трасса''' [[Help:UI manual#Функции правой панели|правой панели]]) – для этого нажмите кнопку [[File:Icon target.png|x25px]] в верхней части виджета маркера.
:14. [[Help:UI manual#Разметка маркера|Разметка маркера]] – установите '''Статус''', '''Серьезность''' и '''Действия''' в верхней части виджета маркера.
:15. Отображение блока элементов трассы в виджете маркера для строки кода – нажмите ссылку '''Показать трассу''' (доступна, если все блоки элементов трассы скрыты).
::Для последовательного перехода к другим элементам трассы воспользуйтесь кнопками [[File:Button up.png|x25px]] и [[File:Button down.png|x25px]].
::{{Note|type=info|text=''Отображение только первого элемента трассы или всех элементов трассы маркера по нажатии кнопки '''Показать трассу''' настраивается с помощью [[Help:UI manual#Настройка интерфейса|параметра '''Показывать всю трассу маркера''']].''}}
::[[File:97 Блок информации о элементе трассы.png|thumb|none|600px|Виджет маркера с блоком элемента трассы]]
:16. Скрытие блоков элементов трассы в виджете маркера для строки кода – нажмите ссылку '''Скрыть трассу''' (доступна, если хотя бы один блок элемента трассы отображается).
::Все открытые блоки элементов трассы маркера скроются.
:17. Переход к строке, в которой объявлена/определена переменная – нажмите правую кнопку мыши на строке исходного кода и выберите пункт '''Перейти к объявлению / Перейти к определению'''.
:{{Note|type=info|text=''Если для выделенного элемента кода нет объявления или определения, то отобразится сообщение: [[File:150 Объявление не найдено.png|247x247px]] или [[File:151 Определение не найдено.png|254x254px]].''}}

:18. Просмотр ссылок на панели внизу экрана – нажмите правую кнопку мыши на строке исходного кода и выберите пункт '''Найти ссылки'''. На этой панели отображается иерархический список файлов с номерами строк, в которых найдены ссылки:
:[[File:Исходный_код_Референсы.png|thumb|none|600px|Cписок файлов с номерами строк, в которых найдены ссылки]]

:* Чтобы перейти к строке кода, на которую найдена ссылка, нажмите на ссылку с номером строки на панели [1].
:* Чтобы посмотреть фрагмент кода, на который найдена ссылка, в режиме предпросмотра, нажмите кнопку [[File:icon_preview_code.png|x25px]] [2].
:{{Note|type=info|text=''Если для выделенного элемента кода нет ссылок, то отобразится сообщение: [[File:152 Ссылки не найдены.png|213x213px]].''}}

:19. Переход к просмотру выбранного файла [[Help:UI manual#Работа в режиме просмотра кода|в режиме просмотра кода]] – нажмите правую кнопку мыши на строке исходного кода и выберите пункт '''Открыть в режиме Код'''.
:20. Копирование ссылки на строку кода в буфер обмена – нажмите правую кнопку мыши на строке исходного кода и выберите пункт '''Копировать прямую ссылку'''.
::При переходе по этой ссылке будет открываться файл в режиме разметки с курсором на той строке кода, для которой была скопирована ссылка.
:21. Увеличение и уменьшение размера шрифта кода вместе с отображаемыми виджетами – нажмите правую кнопку мыши на любой строке исходного кода и выберите пункт '''Уменьшить''' или '''Увеличить''', либо установите курсор в любую строку и нажмите сочетание клавиш '''Ctrl + Alt + -''' или '''Ctrl + Alt + ='''
:22. Копирование строки кода – нажмите правую кнопку мыши на строке исходного кода и выберите пункт '''Copy'''.
:23. Вызов командной строки – нажмите правую кнопку мыши на строке исходного кода и выберите пункт '''Command Palette'''.
:[[File:25 Исходный код Вызов командной строки.png|thumb|none|600px|Командная строка]]

==== Таблица маркеров ====
Для раскрытия таблицы маркеров нажмите кнопку [[File:Button Показать таблицу.png|x25px]] в верхней части [[Help:UI manual#Функции центральной панели|центральной панели]], а для её скрытия – [[File:Button Скрыть таблицу.png|x25px]].

В верхней части таблицы находится панель, которая содержит:
* [[File:Field Детектор.png|x25px]] – поле с информацией [[Help:UI manual#Использование фильтров|о примененных фильтрах]]: как назначенных [[Help:UI manual#Функции навигационной панели|в навигационной панели]], так и с помощью [[Help:UI manual#Настройка и использование пользовательских фильтров|пользовательских фильтров]] и запросов;
* кнопка [[File:Icon download.png|x25px]] – выгрузка маркеров в файл формата .csv или .pdf: только для [[Help:UI manual#choice|выбранных]] или всех отображаемых маркеров, если ничего не выбрано. Отчет в формате .pdf может быть сгенерирован на основе HTML, так и существующим (нативным) способом. В PDF-отчете, сгенерированном на основе HTML, усовершенствованы стили, доработан титульный лист, актуализирован набор параметров для выгружаемых маркеров и пр.;
:{{Note|type=warn|text='''''Примечания:'''''
:* ''если в таблице не отображаются маркеры из-за примененных пользовательских фильтров, то в сгенерированном PDF-отчете будет указано «Нет маркеров (применены фильтры)»;''
:* ''для использования механизма генерации PDF-отчёта на основе HTML должна быть включена [[Help:UI manual#Настройка интерфейса|одноименная настройка]];''
:* ''генерация PDF-отчета на основе HTML может занимать больше времени, чем нативная генерация;''
:* ''спецсимволы (иконки), добавленные в комментариях к маркерам, не отображаются в выгруженном PDF-отчете.''}}

* кнопка [[File:Icon edit.png|x25px]] – переход [[Help:UI manual#Групповая разметка маркеров|к групповой разметке]] выбранных маркеров (доступна, если выбраны маркеры в таблице);
* кнопка [[File:Button_Comment_Add.png|x25px]] – переход к [[Help:UI manual#Добавление общего комментария к нескольким маркерам|добавлению общего комментария к нескольким выбранным маркерам]].

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

В таблице маркеров пользователю доступны следующие функции:
:1. Сортировка по значениям столбцов.
:2. Выбор маркеров для [[Help:UI manual#dwl pdf|выгрузки отчета]], [[Help:UI manual#Групповая разметка маркеров|групповой разметки]] или [[Help:UI manual#Добавление общего комментария к нескольким маркерам|добавления общего комментария к нескольким маркерам]] – для этого установите флажок в строке маркера.
:3. Просмотр подробной информации о маркере [[Help:UI manual#Функции правой панели|в правой панели]] и его места и содержания [[Help:UI manual#Вкладка с исходным кодом|на вкладке с исходным кодом]] – для этого дважды кликните на строку маркера или нажмите на имя файла в столбце '''Файл'''. Также для выбора можно использовать клавиши ↑ и ↓ – для перемещения по строкам, и Enter – для подтверждения выбора.
:4. Просмотр детальной информации о маркере в JSON-формате – для этого нажмите правой кнопкой мыши на маркер и выберите пункт '''Просмотреть JSON'''.
:5. Копирование детальной информации о маркере (JSON маркера) в буфер обмена – для этого нажмите правой кнопкой мыши на маркер и выберите пункт '''Копировать JSON'''.
:При переходе по этой ссылке будет открываться список маркеров в режиме разметки с открытым маркером (в правой панели и на вкладке с исходным кодом), для которого была скопирована ссылка.
:6. Копирование ссылки на маркер в буфер обмена – для этого нажмите правой кнопкой мыши на маркер и выберите пункт '''Копировать ссылку на маркер'''.
:7. Переход к [[Help:UI manual#Сравнение маркеров|сравнению одного маркера с другим]] – для этого нажмите правой кнопкой мыши на маркер и выберите пункт '''Сравнить с ...'''

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

На правой панели пользователю доступны следующие функции:
:1. Копирование ссылки на маркер – для этого нажмите кнопку [[File:Icon copy link.png|x25px]].
:2. [[Help:UI manual#Блокировка разметки|Блокировка маркера]] для разметки другими пользователями – для этого нажмите кнопку [[File:icon_unlocked.png|x25px]] в верхней части правой панели.
:3. [[Help:UI manual#Разметка маркера|Разметка маркера]] – для этого установите '''Статус''', '''Серьезность''' и '''Действие''' в верхней части правой панели.
:4. Просмотр истории разметки со связанными комментариями – для этого нажмите кнопку [[File:Icon history.png|x25px]] в верхней части правой панели.
:[[File:28 История изменения маркера.png|thumb|none|upright=2.5|Пример истории изменения разметки маркера]]

:5. Отображение маркера [[Help:UI manual#Вкладка с исходным кодом|на вкладке с исходным кодом]] нажмите кнопку с именем файла и номером строки в верхней части правой панели.
:6. Отображение элемента трассы [[Help:UI manual#Вкладка с исходным кодом|на вкладке с исходным кодом]] – для этого нажмите на ссылку с именем файла и номером строки на вкладке '''Трасса''' [1].
:7. Отображение кода, который соответствует строке трассы, в отдельном окне в режиме предпросмотра – для этого на вкладке '''Трасса''' нажмите кнопку [[File:Icon preview code.png|x25px]] рядом с именем файла и номером строки [2].
:[[File:31 Предпросмотр кода.png|thumb|none|upright=2.5|Элементы управления для работы с элементом трассы]]
:8. Просмотр и добавление комментариев к маркеру на вкладке '''Комментарии'''.
:Комментарии для каждого маркера уникальны. Добавление одинаковых комментариев недоступно.
:Редактор комментариев поддерживает синтаксис Markdown.
:Для упоминания пользователя, вставьте '''@''' и введите или выберите его логин. После добавления комментария по нажатии кнопки '''Применить''' указанному пользователю придет [[Help:UI manual#Просмотр уведомлений в интерфейсе Системы|уведомление в интерфейсе системы]] об упоминании с возможностью перехода к маркеру с этим комментарием.
:9. Редактирование и удаление комментариев на вкладке '''Комментарии''' с помощью кнопок [[File:Icon edit2.png|x25px]] и [[File:Icon delete.png|x25px]].
:Если [[Help:UI manual#Работа с проектами|для проекта]] установлен флажок '''Обязательный комментарий при разметке''', то удаление связанного с разметкой комментария недоступно. Его можно только отредактировать.
:[[File:32 Комментарии.png|thumb|none|upright=1.3|Вкладка '''Комментарии''']]
:{{Note|type=info|text='''''Примечания''':''
:* ''Пользователь может отредактировать и удалить только свои комментарии. Пользователю с доступом '''Изменение любых комментариев''' доступно редактирование и удаление комментариев всех пользователей. Если такой пользователь внёс изменения, то изначальный автор теряет возможность изменять свой комментарий (если у него нет доступа '''Изменение любых комментариев'''), так как авторство передаётся пользователю, который последним внёс изменения.''
:* ''Для отредактированного комментария отображается слово '''изменено''', при наведении курсора на которое отображается сообщение с логином пользователя, изменившего комментарий, и датой редактирования. Текст несохраненного комментария в поле добавления комментария не пропадает при переключении на другой маркер.''
:* ''Если открыт режим редактирования комментария, то при переключении на другой маркер режим редактирования закрывается и изменения не сохраняются.''}}
:10. Ввод, просмотр и редактирования комментария в отдельном диалоговом окне – для этого нажмите кнопку [[File:Button Comment Zoom.png|x25px]] рядом с полем ввода нового комментария или в поле существующего комментария.
:[[File:120 Окно создания, просмотра и редактирования комментария в отдельном диалоговом окне.png|thumb|none|upright=2|Окно создания, просмотра и редактирования комментария в отдельном диалоговом окне]]
:11. Просмотр подробной информации на вкладке '''Подробности'''. Содержит два блока:
:* информация о сработавшем детекторе: серьезность и надежность, а также связанные с ним коды CWE, которые содержат ссылки на описание дефектов безопасности на сайте [https://cwe.mitre.org cwe.mitre.org];
:* информацией о маркере: текстовые метки маркера, названия снимка и функции, инструмент, язык, текстовое описание и степень доверия, а также кнопки для перехода к просмотру истории маркера и запуску хуков.
::{{Note|type=info|text=''Svace, начиная с версии 4.0, для некоторых языков поставляется с моделью искусственного интеллекта, которая предсказывает истинность срабатывания маркера на основе предупреждений и собранных метрик. Это значение в Svacer отображается в параметре '''Степень доверия'''.''}}
::По нажатии на иконку [[File:icon_question_mark2.png|x25px]] справа от названия детектора отображается дополнительная информация о нём. Иконка не отображается, если дополнительная информация отсутствует.
:[[File:33 Подробная информация о маркере.png|thumb|none|upright=2|Вкладка '''Подробности''']]
:[[File:121 Окно с дополнительной информацией о детекторе.png|thumb|none|upright=2|Окно с дополнительной информацией о детекторе]]

:12. Просмотр истории обнаружения маркера в снимках данной ветки проекта – для этого на вкладке '''Подробности''' нажмите кнопку '''Показать''' в блоке информации о маркере в строке '''История'''.
:В окне просмотра истории доступна сортировка записей.
:[[File:35 История маркера.png|thumb|none|upright=2.5|Пример истории маркера]]
:13. Просмотр маркера в JSON-формате – для этого на вкладке '''Подробности''' нажмите кнопку '''Показать''' в блоке '''JSON'''.
:[[File:234 Пример JSON маркера.png|thumb|none|upright=2|Пример JSON маркера]]
:14. Запуск хуков (скриптов) – для этого нажмите кнопку '''Запустить''' на вкладке '''Подробности''' и в раскрывающемся списке доступных хуков выберите тот, который требуется запустить.
 

=== Использование фильтров ===
==== Общая информация ====
Настройка и использование фильтров доступны [[Help:UI manual#Работа в режиме разметки|в режиме разметки]].

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

# Фильтры [[Help:UI manual#Функции навигационной панели|навигационной панели]] [1]: детекторы, файлы или серьезность.
# Доступные для разметки – позволяют отобразить только маркеры, которые доступны пользователю для разметки, т. е. при использовании этого фильтра в списке не будут отображаться маркеры, заблокированные другими пользователями. Фильтр применяется по нажатии кнопки [[File:Icon view2.png|x25px]] [2] в правой части блока [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выбора проекта, ветки и снимка]].
# Размеченный – позволяют отобразить только размеченные маркеры. Фильтр применяется по нажатии кнопки [[File:Icon view.png|x25px]] [3] в правой части блока [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выбора проекта, ветки и снимка]].
# [[Help:UI manual#Настройка и использование пользовательских фильтров|Пользовательские фильтры]] – доступны по нажатии кнопки [[File:Button Фильтры.png|x25px]] [4] в правой части блока [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выбора проекта, ветки и снимка]].
# Запрос – фильтр, указанный в поле в верхней части [[Help:UI manual#Таблица маркеров|таблицы маркеров]] [5].

:[[File:36 Фильтры.png|thumb|none|upright=3|Существующие фильтры]]

Увидеть примененные фильтры (кроме '''Доступные для разметки''') и последовательность их применения можно в поле [[File:field Детектор.png|x25px]] в верхней части [[Help:UI manual#Таблица маркеров|таблицы маркеров]].

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

По нажатию кнопки [[File:Button Фильтры 2.png|x25px]] в правой части блока [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выбора контекста]] можно отменить примененные фильтры: пользовательский или все.

==== Настройка и использование пользовательских фильтров ====
Настроить пользовательские фильтры можно [[Help:UI manual#Работа в режиме разметки|в режиме разметки]]. Для этого:
:1. Нажмите кнопку [[file:button Фильтры.png|x25px]] в правой части блока [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выбора контекста]].
:В правой части экрана отобразится панель пользовательских фильтров, которая содержит три вкладки:
:* '''Пользовательский''' – параметры фильтрации, которые разделены на три группы:
::* параметры детекторов;
::* параметры маркеров;
::* файлы;
::* расширенный фильтр;
:* '''Сохраненные''' – список [[Help:UI manual#Работа с сохраненными фильтрами|сохраненных фильтров]];
:* '''Публичные''' – [[Help:UI manual#Работа с публичными фильтрами|список фильтров, доступных всем пользователям]].

:2. Настройте параметры фильтрации на вкладке '''Пользовательский''' – выберите значения в списках полей, нажмите кнопки со значениями, или введите значения.
:3. Нажмите на кнопку [[File:Icon cancel.png|x15px]] справа от значения в списке, чтобы отменить его выбор.
:4. Если параметры нужно исключить из поиска, нажмите на кнопку [[File:Icon plus 2.png|x25px]].
:Кнопка поменяется на [[File:Icon minus 3.png|x25px]].
:5. Если параметры нужно включить в поиск, нажмите на кнопку [[File:Icon minus 3.png|x25px]].
:Кнопка поменяется на [[File:Icon plus 2.png|x25px]].
:6. Если в полях '''Метки''', '''Функции''' и '''Файлы''' нужно использовать регулярные выражения:
::а) Нажмите на кнопку [[File:Button TextTempl.png|x25px]].
::Кнопка поменяется на [[File:Button Reg.png|x25px]].
::б) Введите [[Help:UI manual#Использование регулярных выражений|регулярные выражения]]. Используйте новую строку для разделения значений.
:7. Если в полях '''Метки''', '''Функции''' и '''Файлы''' нужно использовать текстовые шаблоны:
::а) Нажмите на кнопку [[File:Button Reg.png|x25px]].
::Кнопка поменяется на [[File:Button TextTempl.png|x25px]].
::б) Введите текстовые шаблоны. Используйте новую строку для разделения значений.
:8. Для создания сложного фильтра с поиском по предикатам задайте в поле '''Расширенный фильтр''' параметры в формате <code>filter(markers, <predicate expr> )</code>, где:
::* <code>filter ()</code> – функция, которая фильтрует список по предикату;
::* <code>markers</code> – объект, который содержит массив маркеров из контекста;
::* <code><predicate expr></code> – выражение, которое определяет предикат.
::Описание используемых в этом фильтре функций, объектов и выражений, а также языка предикатов доступно по нажатии на иконку [[File:Icon question mark2.png|x25px]].
:9. Нажмите кнопку [[File:Button Очистить.png|x25px]], чтобы очистить все параметры фильтрации.
:10. Нажмите кнопку [[File:Button Сохранить как.png|x25px]], в открывшемся диалоге введите название и нажмите кнопку '''Сохранить'''.
:Фильтр сохранится и отобразится на [[Help:UI manual#Работа с сохраненными фильтрами|вкладке '''Сохраненные''']].
:11. Нажмите кнопку [[File:Button Применить.png|x25px]], чтобы применить фильтр.
:После применения кнопка фильтра станет зеленой, а ее название поменяется на название сохраненного фильтра.
::[[File:36 Пользовательские фильтры.png|thumb|none|upright=2|Пользовательские фильтры. Вкладка '''Пользовательский''']]

==== Работа с сохраненными фильтрами ====
На вкладке '''Сохраненные''' отображаются фильтры, [[Help:UI manual#filters saved|сохраненные на вкладке '''Пользовательский''']], а также [[Help:UI manual#filters published|скопированные с вкладки '''Публичные''']].
:[[File:37 Фильтры сохраненные.png|thumb|none|upright=2|Пользовательские фильтры. Вкладка '''Сохраненные''']]

Воспользуйтесь функциями управления фильтрами на вкладке '''Сохраненные''':
:1. Для поиска фильтра введите его название в строке поиска.
:2. Для сортировки фильтров по названию нажмите кнопку [[File:Button Sort.png|x25px]].
:3. Для редактирования сохраненного фильтра нажмите кнопку [[File:Icon edit3.png|x25px]] и [[Help:UI manual#Настройка и использование пользовательских фильтров|внесите изменения]].
:4. Создайте дубликат фильтра – нажмите кнопку [[File:Icon duplicate.png|x25px]].
:5. Для публикации фильтра нажмите кнопку [[File:Button share.png|x25px]].
:Копия сохраненного фильтра отобразится [[Help:UI manual#Работа с публичными фильтрами|на вкладке '''Публичные''']] и станет доступна другим пользователям.
:{{Note|type=warn|text=''Функция доступна только пользователям с [[#Серверные доступы|серверным доступом]] '''Управление публичными фильтрами'''''.}}
:6. Для удаления одного фильтра нажмите кнопку [[File:Icon delete 2.png|x25px]].
:7. Для удаления нескольких фильтров:
::а) Выберите фильтры для удаления – установите флажки в левой части названий фильтров или нажмите кнопку '''Выбрать всё'''.
::б) Нажмите кнопку '''Удалить'''.
:8. Примените фильтр – нажмите на его название и нажмите кнопку [[File:Button Применить.png|x25px]].

После применения:
* примененный фильтр будет отмечен [[File:Icon check.png|x25px]];
* кнопка фильтра станет зеленой, а ее название поменяется на название сохраненного фильтра.

==== Работа с публичными фильтрами ====
{{Note|type=warn|text=''Создание (публикация), изменение и удаление публичных фильтров доступны пользователям с [[#Серверные доступы|серверным доступом]] '''Управление публичными фильтрами'''''.}}

На вкладке '''Публичные''' отображаются фильтры, [[Help:UI manual#filters publishing|опубликованные на вкладке '''Сохраненные''']].
<gallery mode="packed" heights="300px" style="float:left; clear:right; margin-right:1em; margin-left:1em">
153 Пользовательские фильтры. Публичные без доступа.png|Пользовательские фильтры. Вкладка '''Публичные'''. Вид для пользователя без серверного доступа '''Управление публичными фильтрами'''
154 Пользовательские фильтры. Публичные с доступом.png|Пользовательские фильтры. Вкладка '''Публичные'''. Вид для пользователя с серверным доступом '''Управление публичными фильтрами'''
</gallery>
 
Воспользуйтесь функциями управления фильтрами на вкладке '''Публичные''':
:1. Для поиска фильтра введите его название в строке поиска.
:2. Для сортировки фильтров по названию нажмите кнопку [[File:Button Sort.png|x25px]].
:3. Чтобы посмотреть параметры фильтра, нажмите кнопку [[File:Button show.png|x25px]].
:{{Note|type=warn|text=''Функция доступна только пользователям БЕЗ [[#Серверные доступы|серверного доступа]] '''Управление публичными фильтрами.'''''}}
:4. Для редактирования публичного фильтра нажмите кнопку [[File:Icon edit3.png|x25px]] и [[Help:UI manual#Настройка и использование пользовательских фильтров|внесите изменения]].
:5. Скопируйте публичный фильтр – нажмите кнопку [[File:Icon duplicate.png|x25px]].
:Фильтр сохранится и отобразится [[Help:UI manual#Работа с сохраненными фильтрами|на вкладке '''Сохраненные''']].
:6. Для удаления одного фильтра нажмите кнопку [[File:Icon delete 2.png|x25px]].
:7. Для удаления нескольких фильтров:
::а) Выберите фильтры для удаления – установите флажки в левой части названий фильтров или нажмите кнопку '''Выбрать всё'''.
::б) Нажмите кнопку '''Удалить'''.
:8. Примените фильтр – нажмите на его название и нажмите кнопку [[File:Button Применить.png|x25px]].

После применения:
* примененный фильтр будет отмечен [[File:Icon check.png|x25px]];
* кнопка фильтра станет зеленой, а ее название поменяется на название сохраненного фильтра.

=== Сравнение снимков и маркеров ===
Чтобы сравнить снимки и маркеры в них:
:1. [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|Выберите исходный контекст]] – проект, ветку, снимок.
:2. [[Help:UI manual#Работа в режиме разметки|В режиме разметки]] нажмите кнопку [[File:Button Сравнить с.png|x25px]] и в раскрывшемся списке выберите пункт '''Сравнить с…'''.
:3. В открывшемся окне выберите проект, ветку и снимок для сравнения; нажмите кнопку [[File:Button Применить.png|x25px]].
:[[File:38 Выбор снимка для сравнения.png|thumb|none|upright=1.5|Выбор проекта, ветки и снимка для сравнения]]
:Результат сравнения отобразится [[Help:UI manual#Функции навигационной панели|в навигационной панели]] и [[Help:UI manual#Функции центральной панели|центральной панели]], причем:
:* вкладка '''Информация о снимке''' поменяется на вкладку '''Информация о различиях''' с информацией о двух сравниваемых снимках;
:* применится первый режим сравнения, в котором найдены результаты.
:4. Выберите режим сравнения.
:[[File:39 Выбор режима сравнения.png|800px|thumb|none|Выбор режима сравнения]]
:[[Help:UI manual#Функции навигационной панели|В навигационной панели]] и [[Help:UI manual#Функции центральной панели|центральной панели]] отобразятся только результаты выбранного режима сравнения. В режимах '''Сопоставленные''' и '''Одинаковые''' [[Help:UI manual#Таблица маркеров|в таблице маркеров]] добавится столбец с номером версии: V1 – маркер в файле текущего снимка, V2 – маркер в файле целевого снимка.
:{{Note|type=info|text=''Если при просмотре кода файла целевого снимка перейти к просмотру файла [[Help:UI manual#Работа в режиме просмотра кода|в режиме '''Код''']] (команда '''Открыть в режиме код'''), то режим сравнения закроется, отобразится контекст целевого снимка.''}}
<gallery heights="210" perrow="2" mode="packed" style="float:left; clear:right; margin-right:1em; margin-left:2em" "="">
File:40 Пример сравнения новые.png|Пример результатов сравнения в режиме '''Только в V1'''
File:41 Пример сравнения Отсутствующие.png|Пример результатов сравнения в режиме '''Только в V2'''
File:42 Пример сравнения Сопоставленные.png|Пример результатов сравнения в режиме '''Сопоставленные'''
File:43 Пример сравнения Одинаковые.png|Пример результатов сравнения в режиме '''Одинаковые'''
</gallery>
 
:5. Посмотрите различия в параметрах анализа – нажмите кнопку '''Показать различия''' на вкладке '''Информация о различиях'''.
:[[File:44 Различия в результатах анализа.png|600px|thumb|none|Сравнение настроек анализа]]
:6. Посмотрите различия в статистике разметки – нажмите кнопку '''Различия разметок'''.
:[[File:45 Различия в статистике по детекторам.png|thumb|none|600px|Сравнение статистики разметок]]
:7. Нажмите кнопку [[File:Icon download CSV.png|x25px]] или [[File:Icon download PDF.png|x25px]], чтобы скачать статистику в формате CSV или PDF.
:8. Отмените сравнение – нажмите кнопку [[File:Icon cancel 2.png|x25px]] в блоке выбора проекта, ветки и снимка.
 

=== Сопоставление маркеров ===
{{Note|type=warn|text=''Функциональность доступна пользователям с [[#Проектные доступы|проектным доступом]] '''Разметка маркеров''' и [[#Серверные доступы|серверным доступом]] '''Администрирование сервера'''''}}

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

Результат сопоставления, выполненного вручную, можно отменить.
==== Сопоставление маркеров вручную ====
Сопоставление маркеров вручную проводится в два этапа:
:а) Выбор пар маркеров и их сопоставление, без сохранения в БД.
:б) Просмотр выбранных пар и подтверждение операции.

Чтобы вручную сопоставить маркеры:
:1. [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|Выберите исходный контекст]].
:2. [[Help:UI manual#Работа в режиме разметки|В режиме разметки]] нажмите кнопку [[File:Button Сравнить с.png|x25px]] и в раскрывшемся списке выберите пункт '''Сопоставить маркеры'''.
:Откроется окно '''Сопоставить маркеры'''.

:3. Этап 1. На вкладке '''Сопоставление маркеров''':
::а) Выберите снимок, маркеры которого нужно сопоставить с исходным.
::Отобразятся две таблицы маркеров: слева – для исходного снимка, а справа – для выбранного.
::б) Чтобы перед сопоставлением сравнить маркеры, выберите маркеры – по одному в каждой таблице и нажмите кнопку '''Сравнить''' (расположена над таблицей).
::Отобразится окно сравнения выбранных маркеров.
::Если требуется, повторите операцию для других пар маркеров.
::в) Выберите маркеры для сопоставления – по одному в каждой таблице и нажмите кнопку '''Сопоставить''' (расположена над таблицей). Если требуется, повторите операцию для других пар маркеров.
::Для сопоставленных маркеров справа от названия будет отображаться номер сопоставленной пары.
::г) Для отмены сопоставления пары маркеров выберите любой сопоставленный маркер и нажмите '''Отменить сопоставление''' (расположена над таблицей). Если требуется, повторите операцию для других пар маркеров.
::д) Для просмотра фрагмента кода, в котором находится маркер – нажмите кнопку [[File:icon_preview_code.png|x25px]].
::е) Для отказа от дальнейшего сопоставления и отмены всех изменений нажмите кнопку '''Отмена'''.
::ж) Для перехода к подтверждению выбора нажмите кнопку '''Далее'''.

:[[File:122 Выбор снимка и сопоставление пар маркеров.png|800px|thumb|none|Окно '''Сопоставить маркеры'''. Выбор снимка и сопоставление пар маркеров]]
:[[File:48 Различия исходного кода.png|800px|thumb|none|Окно '''Сравнение маркеров''']]

:4. Этап 2. В открывшейся форме:
::а) Проверьте список сопоставленных пар маркеров для применения операций сопоставления.
::б) Для корректировки списка сопоставленных пар маркеров нажмите кнопку '''Назад''' и выполните операции [[Help:UI manual#MarksStep1|Этапа 1]].
::в) Для отказа от дальнейшего сопоставления и отмены всех изменений нажмите кнопку '''Отмена'''.
::г) Для запуска операции сопоставления нажмите кнопку '''Подтвердить'''.

:[[File:123 Подтверждение сопоставления.png|800px|thumb|none|Окно «Сопоставить маркеры». Подтверждение сопоставления]]

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

:[[File:124 Сообщение об окончании сопоставления отмены.png|800px|thumb|none|Сообщение об окончании операции сопоставления]]
:{{Note|type=info|text=''При сопоставлении метки маркеров удаляются.''}}

==== Отмена операций сопоставления ====
Отмена операций ручного сопоставления маркеров проводится в два этапа:
:а) Выбор операций ручного сопоставления для отмены (отката).
:б) Просмотр списка всех операций, которые будут отменены, и подтверждение отмены операций сопоставления.

Чтобы отменить (откатить) операции сопоставления:
:1. [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|Выберите исходный контекст]].
:2. [[Help:UI manual#Работа в режиме разметки|В режиме разметки]] нажмите кнопку [[File:Button Сравнить с.png|x25px]] и в раскрывшемся списке выберите пункт '''Сопоставить маркеры'''.
:Откроется окно '''Сопоставить маркеры'''.
:3. Этап 1. На вкладке '''Отмена операций сопоставления''':
::а) Выберите операции сопоставления маркеров, которые нужно отменить.
::В списке отображаются операции ручного сопоставления маркеров в исходной ветке проекта.
::б) Для отказа от продолжения операции нажмите кнопку '''Отмена'''.
::в) Для перехода к подтверждению выбора нажмите кнопку '''Далее'''.

:[[File:125 Выбор маркеров для отмены сопоставления.png|800px|thumb|none|Окно «Сопоставить маркеры». Выбор операций сопоставления маркеров для отмены]]

:4. Этап 2. В открывшейся форме:
::а) Проверьте список операций сопоставления, которые будут отменены. Список операций, помимо выбранных пользователем операций сопоставления, может дополнительно включать другие связанные операции, которые также будут отменены.
::б) Для корректировки выбранных операций сопоставления маркеров нажмите кнопку '''Назад''' и измените выбор маркеров.
::в) Для отказа от продолжения операции нажмите кнопку '''Отмена'''.
::г) Для запуска операции отмены сопоставления маркеров нажмите кнопку '''Подтвердить'''.

:[[File:126 Подтверждение отмены сопоставления.png|800px|thumb|none|Окно «Сопоставить маркеры». Подтверждение отмены операций сопоставления]]

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

:[[File:124 Сообщение об окончании сопоставления отмены.png|800px|thumb|none|Сообщение об окончании операции отмены сопоставления]]
:{{Note|type=info|text=''При отмене операции сопоставления метки маркеров удаляются.''}}

=== Сравнение маркеров ===
Чтобы сравнить два маркера:
:1. [[Help:UI manual#Работа в режиме разметки|В режиме разметки]] [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выберите исходный контекст]].
:2. Раскройте [[Help:UI manual#Таблица маркеров|таблицу маркеров]].
:3. Нажмите правой кнопкой мыши на строке маркера и выберите пункт '''Сравнить с ...'''
:[[File:155 Переход к сравнению маркеров.png|thumb|none|upright=2|Переход к сравнению маркеров]]
:Откроется окно выбора маркера для сравнения.
:[[File:46 Выбор маркера для сравнения.png|thumb|none|upright=3|Окно выбора маркера для сравнения]]
:{{Note|type=info|text=''При сравнении снимков для режимов '''Сопоставленные''' и '''Одинаковые''' в таблице маркеров по клику правой кнопкой мыши на строке маркера доступен пункт '''Сравнение с другой версией'''. При выборе данной команды происходит сравнение маркера с его версией из сравниваемого снимка.''}}
:4. Выберите проект, ветку и снимок.
:Отобразится список маркеров в выбранном снимке, где можно ввести запрос для поиска маркеров.
:[[File:47 Результат сравнения маркеров.png|thumb|none|upright=3|Выбор маркера для сравнения]]
:5. Дважды кликните на строке маркера или нажмите кнопку '''Сравнить''', чтобы перейти в окно сравнения маркеров.
:[[File:48 Различия исходного кода.png|thumb|none|upright=3|Окно сравнения маркеров]]

=== Разметка маркера ===
Разметка маркера заключается в установке статуса, а также опционально серьезности (критичности) и требуемого действия.
Установка серьезности и действия доступны только после установки статуса.
Разметить маркер можно [[Help:UI manual#Работа в режиме разметки|в режиме разметки]].
==== Разметка маркера вручную ====
Вручную маркер можно разметить тремя способами:
:1. '''''Способ 1'''''. С помощью кнопок в верхней части [[Help:UI manual#Функции правой панели|правой панели]].
:2. '''''Способ 2'''''. С помощью кнопок в виджете маркера [[Help:UI manual#Вкладка с исходным кодом|на вкладке с исходным кодом]].
:Если [[Help:UI manual#Работа с проектами|для проекта]] установлен флаг '''Обязательный комментарий при разметке''', то при разметке с помощью способов [[Help:UI manual#Marking1|1]] и [[Help:UI manual#Marking2|2]] откроется [[Help:UI manual#Marking3|окно разметки]], в котором обязательно нужно ввести комментарий.
<gallery mode="packed" heights="180px" style="float:left; clear:right; margin-right:1em; margin-left:0">
49 Разметка Статус.png|Выбор статуса разметки маркера
50 Разметка Серьезность.png|Выбор серьезности разметки маркера
51 Разметка Действие.png|Выбор действия разметки маркера
127 Кнопки разметки в виджете маркера.png|Кнопки разметки в виджете маркера на вкладке с исходным кодом
</gallery>
 
:3. '''''Способ 3'''''. В отдельном окне разметки вручную. Для этого:
::а) Нажмите кнопку [[File:Icon edit.png|x25px]] в верхней части правой панели или в виджете маркера на вкладке с исходным кодом.
::Откроется окно '''Разметка'''.
<gallery heights="200" perrow="2" mode="packed" style="float:left; clear:right; margin-right:1em; margin-left:1em">
235 Окно Разметка.png|Окно «Разметка»
File:99 Окно разметки.png|Окно разметки. Поле '''Комментарий''' – обязательное
</gallery>
 
::б) Выберите статус, а также опционально серьезность (критичность) и требуемое действие.
::в) Введите комментарий.
::Если [[Help:UI manual#Работа с проектами|для проекта]] установлен флаг '''Обязательный комментарий при разметке''', то добавление комментария обязательно.
::Редактор комментариев поддерживает синтаксис Markdown.
::Для упоминания пользователя, вставьте '''@''' и введите или выберите его логин. После добавления комментария по нажатии кнопки '''Применить''' указанному пользователю придет [[Help:UI manual#Просмотр уведомлений в интерфейсе Системы|уведомление в интерфейсе системы]] об упоминании с возможностью перехода к маркеру с этим комментарием.
::г) Нажмите кнопку '''Применить'''.

Результаты разметки со связанными комментариями отображаются [[Help:UI manual#Функции правой панели|в правой панели]] на вкладке '''Комментарии'''. При этом можно поменять текст комментария, но не результат разметки. Для её изменения нужно заново установить статус, серьёзность и действие.
:[[File:100 Правая панель Комментарии с разметкой.png|300px|thumb|none|Правая панель. Комментарии, добавленные при разметке]]

==== Разметка маркера с помощью ассистента AI ====
{{Note|type=warn|text=''Функциональность доступна пользователям с [[#Проектные доступы|проектными доступами]] '''Разметка маркеров''' и '''Импорт разметки'''''}}
Чтобы разметить маркер с помощью ассистента AI:
:1. Нажмите кнопку [[File:Icon edit.png|x25px]] в верхней части правой панели или в виджете маркера на вкладке с исходным кодом.
Откроется окно '''Разметка'''.
:2. Смените режим разметки с помощью переключателя '''Режим разметки с помощью AI'''.
:3. В отобразившемся режиме разметки выберите '''Модель AI''', с помощью которой ассистент AI рассчитает статус разметки.
:Спрогнозированный статус и уровень доверия прогнозу отобразятся в этом же окне. Если модель AI не смогла предсказать статус разметки, то отобразится значение '''n/a''' и кнопка '''Применить''' будет неактивна.
:Если маркер уже размечен и его статус совпадает с прогнозным, то в окне отобразится сообщение об этом и дальнейшая разметка станет недоступна.
:[[File:236 Окно Разметка AI.png|400px|thumb|none|Окно «Разметка». Режим разметки с помощью ассистента AI]]
:4. Введите комментарий.
:5. Нажмите кнопку '''Применить'''.
Результаты разметки со связанными комментариями отображаются [[Help:UI manual#Функции правой панели|в правой панели]] на вкладке '''Комментарии'''. При этом можно поменять текст комментария, но не результат разметки. Для её изменения нужно заново установить статус, серьёзность и действие.
Комментарий, добавленный при разметке с помощью ассистента AI, дополнительно содержит информацию о проведенной разметке: время, имя модели машинного обучения, уровень доверия прогнозу. Также для такого маркера в правой панели на вкладке '''Подробности''' присвоена метка '''AI'''.
<gallery heights="210" perrow="2" mode="packed" style="float:left; clear:right; margin-right:1em; margin-left:1em">
237 Разметка комментарий AI.png|Правая панель.Комментарий, добавленный при разметке с помощью ассистента AI
238 Разметка метка AI.png|Правая панель.Метка AI на вкладке «Подробности»
</gallery>
 

=== Групповая разметка маркеров ===
==== Групповая разметка маркеров вручную ====
Для групповой разметки маркеров вручную:
:1. [[Help:UI manual#Работа в режиме разметки|В режиме разметки]] [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выберите исходные проект, ветку и снимок]].
:2. Включите отображение [[Help:UI manual#Таблица маркеров|таблицы маркеров]].
:3. Выберите маркеры для разметки – установите флажки в строках таблицы.
:4. Нажмите кнопку [[File:icon edit.png|x25px]] (доступна, если выбраны маркеры в таблице).
:[[File:53 Выбор маркеров для группразметки.png|thumb|none|upright=2.5|Выбор маркеров для групповой разметки]]
:Отобразится окно для групповой разметки.
:[[File:54 Окно групповой разметки.png|thumb|none|upright=2.5|Окно групповой разметки]]
:5. Выберите статус разметки, а затем (опционально) статус серьезности (критичности) и требуемое действие – нажмите кнопки со значениями.
:6. Добавьте общий комментарий для выбранных маркеров. 
:Редактор комментариев поддерживает синтаксис Markdown.
:Для упоминания пользователя, вставьте '''@''' и введите или выберите его логин. После добавления комментария по нажатии кнопки '''Применить''' указанному пользователю придет [[Help:UI manual#Просмотр уведомлений в интерфейсе Системы|уведомление в интерфейсе системы]] об упоминании с возможностью перехода к этому комментарию.
:После того, как пользователь или ассистент AI присвоил статусы и (или) написал комментарий, станет доступной кнопка '''Применить'''. 
:{{Note|type=info|text=''Ввод комментария обязателен, если [[Help:UI manual#Работа с проектами|для проекта]] установлен флаг '''Обязательный комментарий при разметке'''''.}}
:7. Если требуется отменить изменения, нажмите [[File:icon cross 01.png|x15px]] в правом верхнем углу окна или кнопку '''Отмена'''. Диалоговое окно закроется, изменения не будут применены, выделение с выбранных для разметки маркеров не снимается.
:8. Нажмите кнопку '''Применить''', чтобы запустить процесс разметки. 
Прогресс разметки отображается в соответствующем окне. Запущенный процесс можно полностью отменить нажатием кнопки '''Отмена'''. 
В результате применения разметки текст маркеров [[Help:UI manual#Таблица маркеров|в таблице маркеров]] окрасится в цвет, соответствующий выставленному статусу.

<gallery widths="400" mode="nolines" style="float:center; clear:center; margin-right:1em; margin-left:0">
56 Окно прогресса разметки.png|Окно прогресса разметки
57 Результат групповой разметки.png|Пример таблицы маркеров после применения групповой разметки
</gallery>
 

==== Групповая разметка маркеров с помощью ассистента AI ====
{{Note|type=warn|text=''Функциональность доступна пользователям с [[#Проектные доступы|проектными доступами]] '''Разметка маркеров''' и '''Импорт разметки'''''}}
Чтобы разметить группу маркеров с помощью ассистента AI:
:1. [[Help:UI manual#Работа в режиме разметки|В режиме разметки]] [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выберите исходные проект, ветку и снимок]].
:2. Включите отображение [[Help:UI manual#Таблица маркеров|таблицы маркеров]].
:3. [[Help:UI manual#GroupMark1|Выберите маркеры для разметки]] – установите флажки в строках таблицы.
:4. Нажмите кнопку [[File:icon edit.png|x25px]] (доступна, если выбраны маркеры в таблице).
:[[File:53 Выбор маркеров для группразметки.png|thumb|none|upright=2.5|Выбор маркеров для групповой разметки]]
:Отобразится [[Help:UI manual#GroupMark2|окно для групповой разметки]].
:5. Смените режим разметки с помощью переключателя '''Режим разметки с помощью AI'''.
:6. В отобразившемся режиме разметки выберите '''Модель AI''', с помощью которой ассистент AI рассчитает статус разметки.
:Спрогнозированный статус и уровень доверия прогнозу отобразятся в этом же окне в строке каждого выбранного маркера. Если модель AI не смогла предсказать статус разметки, то отобразится значение '''n/a''' и установка флажка столбце '''Статус разметки''' будет недоступна.
:7. Выберите маркеры для разметки – установите флажки в столбце '''Статус разметки'''.
:Если маркер уже размечен и его статус совпадает с прогнозным, то установка флажка в его строке недоступна.
:[[File:239 Групповая разметка AI.png|thumb|none|upright=2.5|Окно групповой разметки. Режим разметки с помощью ассистента AI]]
:8. Добавьте общий комментарий для выбранных маркеров. 
:Редактор комментариев поддерживает синтаксис Markdown.
:Для упоминания пользователя, вставьте '''@''' и введите или выберите его логин. После добавления комментария по нажатии кнопки '''Применить''' указанному пользователю придет [[Help:UI manual#Просмотр уведомлений в интерфейсе Системы|уведомление в интерфейсе системы]] об упоминании с возможностью перехода к этому комментарию.
:После того, как пользователь или ассистент AI присвоил статусы и (или) написал комментарий, станет доступной кнопка '''Применить'''. 
:{{Note|type=info|text=''Ввод комментария обязателен, если [[Help:UI manual#Работа с проектами|для проекта]] установлен флаг '''Обязательный комментарий при разметке'''''.}}
:9. Если требуется отменить изменения, нажмите [[File:icon cross 01.png|x15px]] в правом верхнем углу окна или кнопку '''Отмена'''. Диалоговое окно закроется, изменения не будут применены, выделение с выбранных для разметки маркеров не снимается.
:10. Нажмите кнопку '''Применить''', чтобы запустить процесс разметки. 
Прогресс разметки отображается в [[Help:UI manual#GroupMark3|соответствующем окне]]. Запущенный процесс можно полностью отменить нажатием кнопки '''Отмена'''. 
В результате применения разметки текст маркеров [[Help:UI manual#Таблица маркеров|в таблице маркеров]] окрасится в цвет, соответствующий выставленному статусу.

=== Блокировка разметки маркеров===
Пользователь может заблокировать другим пользователям возможность [[Help:UI manual#Разметка маркера|размечать маркер]] или [[Help:UI manual#Групповая разметка маркеров|группу маркеров]]. Это позволяет избежать коллизий при разметке маркеров несколькими пользователями.

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

<gallery mode="packed" heights="200px" perrow="2" style="float:left; clear:right; margin-right:1em; margin-left:1em">
58 Блокировка на вкладке Детекторы.png|Блокировка маркера на вкладке '''Детекторы'''
File:59_Блокировка_на_вкладке_Файлы.png|Блокировка маркера на вкладке '''Файлы'''
60_Блокировка_на_правой_панели.png|Блокировка маркера на правой панели
</gallery>
 

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

Чтобы посмотреть все блокировки, перейдите в раздел [[Help:UI manual#Настройка сервера Svacer|'''Настройки''']] на [[Help:UI manual#Управление блокировками разметки|вкладку '''Блокировки''']]:

[[File:61 Просмотр всех блокировок.png|thumb|none|upright=3.5|Таблица блокировок]]

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

=== Добавление комментария к нескольким маркерам ===
Для добавления комментария к нескольким маркерам одновременно:
:1. В режиме разметки [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выберите исходный контекст]] – проект, ветку, снимок.
:2. Включите отображение [[Help:UI manual#Таблица Маркеров|таблицы маркеров]].
:3. Выберите маркеры для разметки – установите флажки в строках таблицы.
:4. Нажмите кнопку [[File:Button Comment Add.png|x25px]] (доступна, если выбраны маркеры в таблице).

:[[File:128 Добавление общего комментария 1.png|400px|thumb|none|Выбор маркеров для добавления комментария к нескольким маркерам одновременно]]
:5. Отобразится окно для добавления комментария к нескольким маркерам одновременно.

:[[File:129 Добавление общего комментария 2.png|600px|thumb|none|Окно добавления комментария к нескольким маркерам одновременно]]
:6. Введите комментарий.
:Редактор комментариев поддерживает синтаксис Markdown.
:Для упоминания пользователя, вставьте '''@''' и введите или выберите его логин. После добавления комментария по нажатии кнопки '''Применить''' указанному пользователю придет [[Help:UI manual#Просмотр уведомлений в интерфейсе Системы|уведомление в интерфейсе системы]] об упоминании с возможностью перехода к маркеру с этим комментарием.
:8. Нажмите кнопку '''Сохранить'''.

=== Экспорт ===
В режиме разметки можно выполнить экспорт:
* [[Help:UI manual#Экспорт исходного кода с разметкой|исходного кода с разметкой]];
* [[Help:UI manual#Экспорт снимка в формате snap|снимка в формате snap]];
* [[Help:UI manual#Экспорт разметки и снимка в SARIF|снимка в формате SARIF]];
* [[Help:UI manual#Экспорт разметки|разметки в файл]].
{{Note|type=warn|text=''Функциональность доступна пользователям с [[#Проектные доступы|проектным доступом]] '''Экспорт снимков'''''}}

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

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

::При экспорте можно исключить файлы, соответствующие [[Help:UI manual#Использование регулярных выражений|регулярным выражениям]] в поле '''Исключить пути'''.
:4. Нажмите кнопку '''Экспортировать'''.
В итоге создастся архив файлов с исходным кодом и, если был выбран шаблон разметки, то в исходный код будет добавлена актуальная разметка, в соответствии с выбранным шаблоном.

==== Экспорт снимка в формате snap ====
Чтобы экспортировать с сервера исходный код снимка в формате .snap:
:1. [[Help:UI manual#Работа в режиме разметки|В режиме разметки]] [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выберите исходный контекст]] – проект, ветку и снимок.
:2. На вкладке '''Информация о снимке''' нажмите кнопку '''Экспорт''' и выберите пункт '''Снимок (*.snap)'''.
:[[File:192 Разметка. Переход к экспорту снимка в формате snap.png|600px|thumb|none|Переход к экспорту снимка в формате snap]]
:Запустится формирование файла. При старте и по окончании экспорта пользователю отобразится соответствующее всплывающее сообщение.
:[[File:193 Сообщение. Экспорт снимка.png|thumb|600px|thumb|none|Пример всплывающих сообщений при старте и окончании экспорта снимка]]

==== Экспорт разметки и снимка в SARIF ====
Чтобы экспортировать разметку и при необходимости исходный код снимка в файл формата SARIF:
:1. [[Help:UI manual#Работа в режиме разметки|В режиме разметки]] [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выберите исходный контекст]] – проект, ветку и снимок.
:2. На вкладке '''Информация о снимке''' нажмите кнопку '''Экспорт''' и выберите пункт '''SARIF'''.
:[[File:194 Разметка. Переход к экспорту снимка SARIF.png|thumb|600px|thumb|none|Переход к экспорту снимка SARIF]]
:3. В открывшемся окне:
::а) Выключите (опционально) формирование название файла по умолчанию – снимите соответствующий флажок и введите название снимка.
::б) Опционально включите или выключите экспорт исходных файлов.
::в) Нажмите кнопку '''Экспортировать'''.
:[[File:195 Окно экспорта SARIF.png|thumb|600px|thumb|none|Окно экспорта снимка SARIF]]
:Запустится формирование файла. При старте и по окончании экспорта пользователю отобразится всплывающее сообщение.
:[[File:220 Сообщение. Экспорт SARIF.png|thumb|400px|thumb|none|Пример всплывающих сообщений при старте и окончании экспорта снимка в SARIF]]

==== Экспорт разметки ====
Чтобы из ветки проекта экспортировать в файл разметку и/или комментарии:
:1. [[Help:UI manual#Работа в режиме разметки|В режиме разметки]] [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выберите исходный контекст]] – проект, ветку и снимок.
:2. На вкладке '''Информация о снимке''' нажмите кнопку '''Экспорт''' и выберите пункт '''Разметка'''.
:[[File:196 Разметка. Переход к экспорту разметки.png|thumb|thumb|thumb|600px|none|Переход к экспорту разметки]]
:3. В открывшемся окне:
::а) Выберите вариант экспорта.
::б) Если требуется экспортировать неразмеченные маркеры, установите флажок '''Включая разметку со статусом "Undecided"'''.
::в) Нажмите кнопку '''Экспортировать'''.
:[[File:197 Окно экспорта разметки.png|thumb|thumb|thumb|600px|none|Окно экспорта разметки]]

=== Импорт разметки ===
В режиме разметки можно импортировать разметку из двух источников:
* [[Help:UI manual#Импорт разметки из файла|из файла]];
* [[Help:UI manual#Импорт разметки из исходного кода|из исходного кода снимка]].
{{Note|type=warn|text=''Функциональность доступна пользователям с [[#Проектные доступы|проектным доступом]] '''Импорт разметки'''''}}

==== Импорт разметки из файла ====
Чтобы импортировать файл с разметкой:
:1. [[Help:UI manual#Работа в режиме разметки|В режиме разметки]] [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выберите исходный контекст]] – проект, ветку и снимок.
:2. На вкладке '''Информация о снимке''' нажмите кнопку '''Импорт''' и выберите пункт '''Разметка из файла'''.
:[[File:198 Разметка. Переход к импорту разметки из файла.png|thumb|thumb|thumb|600px|none|Переход к импорту файла с разметкой]]
:3. В открывшемся окне:
::а) Выберите файл архива в формате .gz.
::б) Выберите варианты импорта и действия при наличии конфликта разметки.
::в) Нажмите кнопку '''Импортировать'''.
:[[File:199 Окно импорта файла с разметкой.png|thumb|600px|thumb|none|Окно импорта файла с разметкой]]
:По окончании пользователю отобразится всплывающее сообщение с информацией о выполненной операции.
:[[File:200 Сообщение. Импорт разметки из файла.png|thumb|thumb|thumb|600px|none|Пример всплывающего сообщения об окончании импорта разметки из файла]]

==== Импорт разметки из исходного кода ====
Чтобы импортировать разметку из исходного кода снимка в ветку проекта:
:1. [[Help:UI manual#Работа в режиме разметки|В режиме разметки]] [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выберите исходный контекст]] – проект, ветку и снимок.
:2. На вкладке '''Информация о снимке''' нажмите кнопку '''Импорт''' и выберите пункт '''Разметка из исходного кода'''.
:[[File:201 Разметка. Переход к импорту разметки из кода.png|thumb|thumb|thumb|thumb|600px|none|Переход к импорту исходного кода с разметкой]]
:3. В открывшемся окне выберите шаблон разметки и нажмите кнопку '''Импортировать'''.
:[[File:134_Импорт_разметки.png|thumb|thumb|thumb|600px|none|Окно импорта исходного кода с разметкой]]
:По окончании пользователю отобразится всплывающее сообщение с информацией о выполненной операции.
:[[File:203 Сообщение. Импорт разметки из кода.png|thumb|thumb|thumb|thumb|600px|none|Пример всплывающего сообщения об окончании импорта разметки из исходного кода снимка]]

=== Работа с таблицей статистики ===
Чтобы посмотреть краткую статистику о разметке маркеров:
:1. [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|Выберите исходный контекст]].
:2. Перейдите [[Help:UI manual#Работа в режиме разметки|в режим разметки]].
:3. На вкладке '''Информация о снимке''' в строке свойства '''Статистика по детекторам''' нажмите кнопку '''Показать'''.

:[[File:64 Переход к просмотру статистики.png|600px|thumb|none|Переход к просмотру статистики]]

:Отобразится таблица статистики:
:[[File:65 Таблица статистики.png|600px|thumb|none|Таблица статистики]]
:4. Нажмите кнопку [[File:Icon download CSV.png|x20px]] или [[File:Icon download PDF.png|x20px]], чтобы выгрузить статистику в соответствующем формате.
:5. Нажмите кнопку [[File:Icon filter.png|x20px]] в строке статистики, чтобы применить [[Help:UI manual#Настройка и использование пользовательских фильтров|пользовательский фильтр]] с параметрами, которые соответствуют выбранному значению.

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

Для этого:
:1. Перейдите в режим просмотра кода по кнопке меню [[File:Button Код.png|x25px]] в верхней части экрана.
:2. [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|Выберите исходный контекст]]. 
:{{Note|type=info|text=''По умолчанию выбран контекст (проект, ветка), заданный ранее в режиме [[Help:UI manual#Работа в режиме разметки|'''Разметка''']]. Если Пользователь перешел в раздел '''Кoд''' из режима сравнения снимков раздела [[Help:UI manual#Работа в режиме разметки|'''Разметка''']], то для изменения контекста требуется отменить режим сравнения.''}}
:В левой части экрана отобразится иерархический список файлов снимка, а в правой – поле для отображения исходного кода файла.
:[[File:67 Режим просмотра кода.png|600px|thumb|none|Режим просмотра кода. Начальное состояние]]
:3. Для поиска файла:
::а) Кликните на поле поиска или нажмите комбинацию клавиш '''Ctrl+Shift+O'''.
::б) В открывшемся окне введите поисковый запрос и выберите файл.
:4. В левой части экрана раскройте группу файлов и нажмите на имя файла.
:В правой части отобразится исходный код файла.
:[[File:68 Режим просмотра кода открыт один файл.png|600px|thumb|none|Пример одного открытого файла]]
:5. Если требуется, откройте другие файлы.
:Они отобразятся на отдельных вкладках, если выключена [[Help:UI manual#Настройка профиля пользователя|настройка '''Переиспользование вкладки в редакторе кода''']].
:[[File:69 Режим просмотра кода открыто три файла.png|600px|thumb|none|Пример трёх открытых файлов]]
:6. Для перехода к предыдущей или следующей строке, в которую пользователь устанавливал курсор, используйте кнопки [[File:Button left.png|x25px]] и [[File:Button right.png|x25px]] или сочетания клавиш '''Ctrl+< и Ctrl+>'''.
:7. Вызовите функции, доступные по нажатии правой кнопки мыши на строке исходного кода
:* '''Перейти к объявлению''' – для перехода к строке, в которой объявлена переменная;
:* '''Перейти к определению''' – для перехода к строке, в которой определена переменная и функция;
:* '''Найти ссылки''' – для просмотра ссылок в панели с иерархическим списком файлов, именами файлов и номерами строк, в которых найдены ссылки;
::{{Note|type=info|text=''Если для выделенного элемента кода нет объявления, определения или ссылок, то отобразится сообщение: [[File:150 Объявление не найдено.png|x25px]], [[File:151 Определение не найдено.png|x25px]] или [[File:152 Ссылки не найдены.png|x25px]].''}}
::[[File:24 Исходный код Cписок файлов со ссылками.png|thumb|none|600px|Cписок файлов с номерами строк, в которых найдены ссылки]]
:* '''Копировать прямую ссылку''' – копирование ссылки на строку кода в буфер обмена.
::При переходе по этой ссылке будет открываться файл в режиме просмотра кода с курсором на той строке кода, для которой была скопирована ссылка;
:* '''Уменьшить''' и '''Увеличить''' – увеличение и уменьшение размера шрифта кода (эти функции также можно вызвать с помощью сочетаний клавиш '''Ctrl+Alt+-''' или '''Ctrl+Alt+=''').
:* '''Copy''' – для копирования строки в буфер обмена;
:* '''Command Palette''' – для вызова командной строки.
:6. Установите курсор в строке кода, чтобы отобразилось его позиционирование в правом нижнем углу.
:[[File:130 Позиционирование к коде.png|600px|thumb|none|Отображение позиционирования курсора в коде]]
:7. Сравните файлы – для этого:
::а) Нажмите правой кнопки мыши на имени файла и выберите пункт '''Сравнить с…'''
::[[File:156 Переход к сравнению файлов.png|thumb|none|600px|Переход к сравнению файлов]]
::б) В открывшемся окне выберите файл для сравнения. Для этого выберите проект, ветку и снимок, а затем раскройте группы файлов или воспользуйтесь поисковой строкой, нажмите на имя файла.
::По умолчанию выбраны проект и ветка исходного контекста.
::в) Нажмите кнопку '''Сравнить'''.
:Откроется окно сравнения файлов.

:[[File:Code compare 2.png|600px|thumb|none|Окно выбора файла для сравнения]]

:[[File:Code_compare_3.png|600px|thumb|none|Окно сравнения файлов]]

==Управление проектами и группами проектов==
В разделе '''Проекты''' отображаются все проекты со всеми ветками и снимками.
Для удобства работы проекты могут быть [[Help:UI manual#Работа с группами проектов|сгруппированы]]. Один проект может быть включен в несколько групп проектов.
[[File:101 Раздел Проекты.png|thumb|none|upright=3|Раздел '''Проекты''']]

===Работа с проектами===
Список проектов отображается в левой части экрана и организован в виде иерархии. При этом:
* для проектов, разметку маркеров которых нужно в обязательном порядке снабжать комментариями, отображается иконка [[File:Icon comment.png|x25px]];
* в нижней части списка отображается общее количество проектов и веток с учетом примененных фильтров, а также выбранных проектов и веток.
В списке доступны:
* поиск по имени проекта;
* фильтрация списка по группам проектов;
* сортировка по названию или дате создания (по умолчанию – по названию).
При работе с проектами пользователю доступны следующие функции:
:1. Загрузка актуальных данных с сервера – для этого нажмите кнопку [[File:Icon refresh.png|x25px]].
:2. Просмотр списка веток – для этого нажмите на название проекта.
:Ветки отобразятся в этом же списке проекта на втором уровне.
:3. Просмотр списка снимков – для этого нажмите на название ветки.
:Список снимков отобразится в виде таблицы в правой части экрана.
:4. [[Help:UI manual#Работа с группами проектов|Группировка проектов]].
:5. Создание проекта:
::а) Нажмите кнопку '''Создать проект'''.
::Откроется окно создания проекта.
::[[File:102 Создание проекта.png|thumb|none|upright=1.5|Окно создания проекта]]
::б) Введите название проекта.
::в) Для выбора одной или нескольких существующих групп кликните на поле '''Группы''' и выберите одно или несколько значений в списке:
::[[File:157 Окно создания проекта. Выбор существующей группы.png|thumb|none|upright=1.5|Окно создания проекта. Пример выбора существующей группы]]
::г) Для создания одной новой группы введите ее название и нажмите кнопку '''Создать''' в появившейся форме:
::[[File:158 Окно создания проекта.Создание одной группы.png|thumb|none|upright=1.5|Окно создания проекта. Пример создания одной группы]]
::д) Для создания нескольких новых групп введите их названия через запятую и нажмите кнопку '''Создать''' в появившейся форме:
::[[File:159 Окно создания проекта. Создание нескольких групп.png|thumb|none|upright=1.5|Окно создания проекта. Пример создания двух групп]]
::е) Установите флажок, если требуется при разметке маркеров обязательно добавлять комментарий.
::ж) Нажмите кнопку '''Создать'''.
:При создании проекта автоматически создается ветка '''master'''.
:При импорте снимка в интерфейсе командной строки проект, при его отсутствии, добавляется автоматически.
:6. Добавление ветки: [[File:103 Создание ветки.png|thumb|right|none|upright=1.5|Окно добавления ветки в проект]]
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке проекта.
::б) В меню выберите пункт '''Создать ветку'''.
::в) В открывшемся окне введите название ветки и нажмите кнопку '''Создать'''.
:При импорте снимка в интерфейсе командной строки ветка, при ее отсутствии, добавляется автоматически.

:7. Клонирование проекта со всеми ветками и снимками: [[File:132 Окно клонирования проекта.png|thumb|right|none|upright=1.5|Окно клонирования проекта]]
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке проекта.
::б) В меню выберите пункт '''Клонировать'''.
::в) В открывшемся окне введите название нового проекта, при необходимости скорректируйте группы, в которые будет входить клонированный проект (по умолчанию, группы исходного проекта) и нажмите кнопку '''Клонировать'''.

:9. Редактирование параметров проекта:
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке проекта.
::б) В меню выберите пункт '''Редактировать'''.
::в) В открывшемся окне измените название проекта, скорректируйте список групп, в которые включен проект, и установите или снимите флажок обязательности комментария при разметке и нажмите кнопку '''Сохранить'''.
:10. Удаление одного проекта:
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке проекта.
::б) В меню выберите пункт '''Удалить'''.
::в) Подтвердите удаление.
:11. Удаление нескольких проектов с ветками:
::а) Выберите проекты для удаления – установите флажки в левой части названий проектов и веток или нажмите кнопку '''Выбрать всё'''.
::б) Нажмите кнопку '''Удалить''' в верхней части списка проектов и подтвердите удаление.
При удалении проекта удаляются все его ветки и снимки, разрывается связь проекта с группами.

===Работа с группами проектов===
Работа с группами проектов доступна на отдельной панели '''Группы проектов''', которая отрывается по нажатии кнопки [[File:Icon gear.png|x25px]] в списке проектов. При этом в нижней части списка отображается общее количество групп.

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

[[File:104 Панель групп.png|thumb|none|upright=3|Панель '''Группы проектов''']]
При работе с группами проектов пользователю доступны следующие функции:
:1. Просмотр списка связанных с группой проектов – для этого нажмите на название группы.
:Проекты отобразятся в этом же списке групп на втором уровне.
 
:2. Добавление группы: [[File:105 Создание группы.png|thumb|right|none|upright=1.5|Окно '''Создать группу''']]
::а) Нажмите кнопку '''Создать группу'''.
::б) В открывшемся окне введите название группы и выберите проекты, которые в неё войдут, нажмите кнопку '''Создать'''.
:Созданная группа отобразится в списке на панели '''Группы проектов'''.
 
:3. Редактирование параметров группы: [[File:106 Редактирование группы.png|thumb|right|none|upright=1.5|Окно Редактировать группу]]
::а) Нажмите кнопку [[File:Icon edit2.png|x25px]] в строке группы.
::б) В открывшемся окне измените название группы, скорректируйте состав включенных в группу проектов.
::в) Нажмите на кнопку [[File:Icon cancel.png|x25px]] справа от названия проекта в списке, чтобы исключить его из группы.
::г) Нажмите кнопку '''Сохранить'''.
 
:4. Исключение одного проекта из группы – для этого нажмите кнопку [[File:Icon hide marks.png|x25px]] в правой части списка проектов группы.
:5. Удаление одной группы – для этого нажмите кнопку [[File:Icon delete.png|x25px]] в правой части списка групп и подтвердите удаление.
:6. Удаление нескольких групп:
::а) Выберите группы для удаления – установите флажки в левой части названий групп или нажмите кнопку '''Выбрать всё'''.
::б) Нажмите кнопку '''Удалить''' в верхней части списка групп проектов и подтвердите удаление.
:При удалении группы разрывается связь проекта с группой. Сами проекты не удаляются.

===Работа с ветками===
При работе с ветками проекта пользователю доступны следующие функции:
:1. Просмотр списка снимков – для этого нажмите на название ветки в списке проектов.
:Список снимков отобразится в виде таблицы в правой части экрана.
:2. Редактирование ветки: [[File:107 Редактирование ветки.png|thumb|right|upright=1.5|Окно редактирования ветки]]
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке ветки.
::б) В меню выберите пункт '''Редактировать'''.
::в) В открывшемся окне измените название ветки и нажмите кнопку '''Сохранить'''.
 
:3. Клонирование ветки проекта: [[File:108 Клонирование ветки.png|thumb|right|upright=1.5|Окно клонирования ветки]]
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке ветки.
::б) В меню выберите пункт '''Клонировать'''.
::в) В открывшемся окне введите название новой ветки и нажмите кнопку '''Клонировать'''.
 
:4. Экспорт разметки в файл: [[File:197 Окно экспорта разметки.png|thumb|right|upright=1.5|Окно экспорта разметки]]
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке ветки.
::б) В меню выберите пункт '''Экспорт разметки'''.
::Откроется окно экспорта разметки.
::в) Выберите вариант экспорта.
::г) Если требуется экспортировать неразмеченные маркеры, установите флажок '''Включая разметку со статусом "Undecided"'''.
::д) Нажмите кнопку '''Экспортировать'''.
::{{Note|type=warn|text=''Функциональность доступна пользователям с [[#Проектные доступы|проектным доступом]] '''Экспорт снимков'''''}}
 
:5. Импорт разметки из файла: [[File:199 Окно импорта файла с разметкой.png|thumb|right|upright=1.5|Окно импорта разметки]]
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке ветки.
::б) В меню выберите пункт '''Импорт разметки'''.
::Откроется окно импорта разметки.
::в) Выберите файл архива в формате .gz.
::г) Выберите варианты импорта и действия при наличии конфликта разметки.
::д) Нажмите кнопку '''Импортировать'''.
::{{Note|type=warn|text=''Функциональность доступна пользователям с [[#Проектные доступы|проектным доступом]] '''Импорт снимков'''''}}
 
:6. Удаление ветки:
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке ветки.
::б) В меню выберите пункт '''Удалить'''.
::в) Подтвердите удаление.
::При удалении ветки удаляются все ее снимки.
 
:7. Очистка разметки: [[File:160 Окно очистки разметки.png|thumb|right|upright=1.5|Окно очистки разметки]]
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке ветки.
::б) В меню выберите пункт '''Очистить разметку'''.
::в) В открывшемся окне выберите вариант очистки.
::г) Нажмите кнопку '''Очистить'''.
::{{Note|type=warn|text=''Функциональность доступна пользователям с [[#Проектные доступы|проектными доступами]] '''Управление ветками и снимками''', '''Разметка маркеров''' и [[#Cерверные доступы|серверным доступом]] '''Администрирование сервера'''.''}}
 
:8. Копирование разметки в другой контейнер (проект и ветку): [[File:Image.png|thumb|right|upright=1.5|Окно копирования разметки в другой контейнер]]
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке ветки и в меню выберите пункт '''Копировать разметку'''.
::б) В открывшемся окне выберите проект и ветку, в которые нужно скопировать разметку, а также действия, которые нужно выполнить при наличии разметки.
::в) Нажмите кнопку '''Копировать'''.
 
Разметка в контейнере состоит из множества размеченных маркеров. В целевой ветке уже может находиться разметка. Все множество маркеров в исходной ветке можно разбить на два:
* «Уникальные» – маркеры, которые есть только в исходной ветке;
* «Общие» – маркеры, которые есть как в ветке-источнике, так и в ветке-приемнике.
При выполнении операции копирования разметка в уникальных маркерах всегда копируется в ветку-приемник. Для «Общих» маркеров возможны несколько вариантов продолжения копирования, но по умолчанию выбран пункт '''Не копировать''' – в этом случае разметка в «Общих» маркерах в ветке-приемнике не изменяется.

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

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

'''Пример'''
:Есть несколько контейнеров:
:* 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.
:При выполнении копирования наличие маркера в ветке-приемнике не проверяется.
:При успешном копировании выводится всплывающее сообщение с описанием выполненных операций:
:[[File:161 Сообщение об успешном копировании разметки.png|thumb|none|upright=2|Пример всплывающего сообщения об успешном копировании разметки]]

===Работа со снимками===
Список снимков отображается в правой части экрана в виде таблицы после выбора ветки проекта. При этом в нижней части списка отображается общее количество снимков в выбранной ветке и количество выбранных снимков.
В списке доступны:
* поиск по названию снимка;
* сортировка по значениям столбцов (по умолчанию — по дате создания).
При работе со снимками пользователю доступны следующие функции:
:1. Импорт снимка из файла – для этого нажмите кнопку '''Импорт''' в верхней части табличного списка снимков и в открывшемся списке выберите один из вариантов импорта: '''Снимок (*.snap)''', '''Архив .svace-dir''' или '''SARIF'''.
:{{Note|type=warn|text=''Функциональность доступна пользователям с [[#Проектные доступы|проектным доступом]] '''Импорт снимков'''''}}
:После этого:
[[File:110 Импорт снимка.png|thumb|right|upright=1.5|Окно импорта снимка из файла в формате snap]]
::а) Если выбран импорт из файла в формате snap, то в открывшемся окне:
::* выберите файл в формате .snap;
::* введите название снимка (опционально);
::* Задайте [[Edit markers (command line)|правила трансформации, пропуска и дедупликации маркеров]] в поле '''Редактировать маркеры''' – загрузите JSON-файл с правилами или введите их;
::* нажмите кнопку '''Импортировать'''.
::{{Note|type=info|text=''Если при импорте снимка из snap-файла название не введено, то будет использовано название исходного снимка (параметр «name» в JSON с информацией о снимке).''}}
[[File:133 Импорт снимка из архива svace-dir.png|thumb|right|upright=1.5|Окно импорта снимка из архива в формате svace-dir]]
[[File:133.1_Импорт_снимка_из_архива_svace-dir_-_Поля_опций.png|thumb|right|upright=1.5|Окно импорта снимка из архива в формате svace-dir. Поля опций для расширенных настроек]]
 
::б) Если выбран импорт архива .svace-dir, то в открывшемся окне:
::* выберите архив .svace-dir;
::* введите название снимка (опционально);
::* выберите шаблон разметки (опционально);
::* укажите правила префикса пути (опционально);
::* укажите расширенные настройки (опционально): для каждой настройки нажмите кнопку '''Добавить''', в появившихся полях выберите опцию и введите её значение; для удаления настройки нажмите кнопку [[File:Icon delete.png|x25px]].
::После выбора параметра в поле появляется иконка [[File:Icon question mark2.png|x15px]], по наведении курсора на которую можно посмотреть описание;
::* нажмите кнопку '''Импортировать'''.
::При старте операции и по ее окончании пользователю отобразятся соответствующие всплывающие сообщения.
::[[File:210 Сообщение. Импорт svace-dir.png|thumb|none|upright=1.5|Пример всплывающих сообщений при старте и окончании импорта снимка из архива в формате svace-dir]]
 
[[File:217 Импорт снимка SARIF.png|thumb|right|upright=1.5|Окно импорта снимка из файла в формате SARIF]]
[[File:218 Импорт снимка SARIF - поля опций.png|thumb|right|upright=1.5|Окно импорта снимка из архива в формате SARIF. Поля опций для расширенных настроек]]
::в) Если выбран импорт из файла в формате SARIF, то в открывшемся окне:
::* выберите файл в формате .sarif или .json, либо архив в одном из форматов: .tar, tar.bz2, tar.gz, zip;
::* введите название снимка (опционально);
::* укажите правила префикса пути (опционально);
::* укажите расширенные настройки (опционально): для каждой настройки нажмите кнопку '''Добавить''', в появившихся полях выберите опцию и введите её значение; для удаления настройки нажмите кнопку [[File:Icon delete.png|x25px]].
::После выбора параметра в поле появляется иконка [[File:Icon question mark2.png|x15px]], по наведении курсора на которую можно посмотреть описание;
::* нажмите кнопку '''Импортировать'''.
::При старте операции и по ее окончании пользователю отобразятся соответствующие всплывающие сообщения.
::[[File:211 Сообщение. Импорт SARIF.png|thumb|none|upright=1.5|Пример всплывающих сообщений при старте и окончании импорта снимка из архива в формате SARIF]]
:{{Note|type=info|text='''''Примечание:'''''
:* ''для импорта поддерживаются архивы папки .svace-dir, заархивированные с помощью tar, gz, bz2 или zip (*.tar, *.tar.gz, *.tar.bz2, *.zip);''
:* ''если при импорте архива .svace-dir название снимка не введено, то оно будет соответствовать времени импорта результатов анализа из Svace;''
:* ''в поле '''Расширенные настройки''' поддерживается ввод дополнительных опций команды <code>svacer import</code> – как в интерфейсе командной строки (например, <code>--attach value</code>). В аргументах дополнительных опций требуется указывать пути относительно архивированной папки. Описание опций можно найти, запустив команду <code>svacer import --help</code>''.
:* ''для импорта снимка из snap-файла, .svace-dir или SARIF может потребоваться много времени: как на загрузку, так и на обработку данных после загрузки. При работе сервера Svacer за reverse proxy их дефолтных значений таймаутов или ограничений на размер загружаемых данных может быть недостаточно, поэтому рекомендуется увеличить эти значения в конфигурационных файлах reverse proxy, см. [[Help:Configuration#Nginx|пример для Nginx]]''}}
:2. Экспорт снимка – для этого нажмите кнопку [[File:Icon export.png|x25px]]в крайнем правом столбце строки снимка и в открывшемся списке выберите один из вариантов экспорта: '''Экспорт (*.snap)''', '''Экспорт SARIF''' или '''Экспорт кода с разметкой'''.
:После этого:
::а) Если выбран экспорт в файл в формате snap, то по окончании его формирования во всплывающем сообщении нажмите кнопку '''Скачать'''.
::[[File:193 Сообщение. Экспорт снимка.png|thumb|none|upright=1.5|Пример всплывающих сообщений при старте и окончании экспорта снимка]]
:[[File:195 Окно экспорта SARIF.png|thumb|right|upright=1.5|Окно экспорта снимка SARIF]]
::б) Если выбран экспорт файла формата SARIF, то в открывшемся окне:
::* Выключите (опционально) формирование название файла по умолчанию – снимите соответствующий флажок и введите название снимка.
::* Опционально включите или выключите экспорт исходных файлов.
::* Нажмите кнопку '''Экспортировать'''.
::Запустится формирование файла. При старте и по окончании экспорта пользователю отобразится всплывающее сообщение.
::[[File:220 Сообщение. Экспорт SARIF.png|thumb|none|upright=1.5|Пример всплывающих сообщений при старте и окончании экспорта снимка в SARIF]]
:[[File:340 Проекты Окно экспорта кода с разметкой.png||thumb|right|upright=1.5|Окно экспорта кода с разметкой]]
::в) Если выбран экспорт кода с разметкой, то в открывшемся окне:
::* Если требуется экспортировать разметку, установите флажок параметра '''Шаблон разметки''' и выберите шаблон для экспорта в списке справа.
::* Опционально включите или выключите очистку старых комментариев.
::* Опционально заполните поля для удаления префиксов и исключения путей.
::* Опционально введите регулярные выражения для очистки дополнительных строк (доступен, если включена очистка старых комментариев).::
::Пример удаления префиксов путей: <code>/.build/</code>

::При экспорте можно исключить файлы, соответствующие [[Help:UI manual#Использование регулярных выражений|регулярным выражениям]] в поле '''Исключить пути'''.
::* Нажмите кнопку '''Экспортировать'''.
::В итоге создастся архив файлов с исходным кодом и, если был выбран шаблон разметки, то в исходный код будет добавлена актуальная разметка, в соответствии с выбранным шаблоном.
:3. Переход к разметке маркеров снимка:
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в крайнем правом столбце строки снимка.
::б) В меню выберите пункт '''Разметить'''.
[[File:111 Редактирование снимка.png|thumb|right|upright=1.5|Окно редактирования снимка]]
:4. Редактирование названия снимка:
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в крайнем правом столбце строки снимка.
::б) В меню выберите пункт '''Редактировать'''.
::в) Поменяйте название и нажмите кнопку '''Сохранить'''.
[[File:212 Окно Копирование снимков.png|thumb|right|upright=1.5|Окно копирования снимка. Пример для одного снимка]]
:5. Копирование одного снимка в другой проект и ветку:
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в крайнем правом столбце строки снимка.
::б) В меню выберите пункт '''Копировать'''.
::в) В открывшемся окне выберите проект и ветку, в которые нужно добавить копию снимка, нажмите кнопку '''Копировать'''.
::При старте операции и по ее окончании пользователю отобразятся соответствующие всплывающие сообщения.
::[[File:213 Сообщение. Копирование снимков.png|thumb|none|upright=1.5|Пример всплывающих сообщений при старте и окончании копирования одного снимка]]
[[File:214 Окно Копирование нескольких снимков.png|thumb|right|upright=1.5|Окно копирования снимка. Пример для двух снимков]]
:6. Копирование нескольких снимков в другой проект и ветку:
::а) Чтобы выбрать для копирования все снимки, установите флажок в заголовке табличного списка снимков.
::б) Чтобы выбрать несколько снимков, установите флажки в крайнем правом столбце табличного списка.
::в) Нажмите кнопку '''Копировать''' в верхней части табличного списка снимков.
::г) В открывшемся окне выберите проект и ветку, в которые нужно добавить копии выбранных снимков, нажмите кнопку '''Копировать'''.
::При старте операции и по ее окончании пользователю отобразятся соответствующие всплывающие сообщения.
::[[File:215 Сообщение. Копирование двух снимков.png|thumb|none|upright=1.5|Пример всплывающих сообщений при старте и окончании копирования двух снимков]]
:[[File:134 Импорт разметки.png|thumb|right|upright=1.5|Окно импорта разметки]]
:7. Импорт разметки из комментариев исходного кода снимка в активную ветку проекта:
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в крайнем правом столбце строки снимка.
::б) В меню выберите пункт '''Импорт разметки из исходного кода'''.
::в) В открывшемся окне выберите шаблон разметки и нажмите кнопку '''Импортировать'''.
::По окончании пользователю отобразится всплывающее сообщение с информацией о выполненной операции.
::[[File:216 Сообщение. Импорт разметки из кода.png|thumb|none|upright=1.5|Пример всплывающего сообщения об окончании импорта разметки из файла]]

:8. Просмотр информации о снимке в JSON-формате:
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке снимка крайнем правом столбце.
::б) В меню выберите пункт '''Просмотреть JSON'''.
:[[File:112 Просмотр JSON снимка.png|thumb|none|upright=3|Окно просмотра информации о снимке в JSON-формате]]
:9. Удаление одного снимка:
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке снимка крайнем правом столбце.
::б) В меню выберите пункт '''Удалить'''.
::в) Подтвердите удаление.
:10. Удаление нескольких снимков:
::а) Чтобы выбрать для удаления все снимки, установите флажок в заголовке табличного списка снимков.
::б) Чтобы выбрать несколько снимков, установите флажки в крайнем правом столбце табличного списка.
::в) Нажмите кнопку '''Удалить''' в верхней части табличного списка снимков и подтвердите удаление.

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

[[File:135 Раздел Детекторы.png|thumb|none|upright=3|Раздел «Детекторы»]]

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

{{Note|type=info|text=''При обновлении списка детекторов и их параметров в Svace изменения попадают в Svacer при выпуске новой версии системы!''}}

В разделе '''Детекторы''' пользователю доступны следующие функции:
:1. Поиск детектора по его названию, серьезности, надежности и коду дефекта безопасности CWE.
:2. Сортировка по значениям столбцов (по умолчанию – по названию детектора).
:3. Переход к просмотру описания дефекта безопасности на сайте [https://cwe.mitre.org cwe.mitre.org] (открывается в отдельном окне) – для этого нажмите на ссылку в столбце '''CWE'''.
:4. Просмотр дополнительной информации о детекторе при её наличии – для этого нажмите на иконку [[File:icon_question_mark2.png|x25px]] справа от названия детектора.

:[[File:121_Окно с дополнительной информацией о детекторе.png|thumb|none|upright=2|Раздел «Детекторы». Пример окна с дополнительной информацией о детекторе]]

:5. Фильтрация списка – для этого:
::а) Нажмите кнопку [[File:Button Фильтр.png|x25px]].
::б) В открывшемся окне '''Фильтр''' настройте параметры фильтрации – выберите значения в списках полей или нажмите кнопки со значениями.
::в) Нажмите кнопку [[File:button_Очистить.png|x25px]], чтобы очистить все параметры фильтрации.
::г) Нажмите кнопку [[File:button_Применить.png|x25px]], чтобы применить фильтр.

:[[File:137 Детекторы.Фильтр.png|thumb|none|upright=2|Раздел «детекторы». Окно «Фильтр»]]

:6. Отмена примененных фильтров – для этого нажмите кнопку [[File:Button Фильтр отмена.png|x25px]].
:7. Выбор отображаемых столбцов – для этого нажмите на кнопку '''Столбцы''' и в открывшемся списке установите или снимите флажки рядом с названиями столбцов.
:Для настройки скрытия или показа доступны все столбцы, кроме '''Детектор'''. Столбцы '''Статус''' и '''Инструменты''' по умолчанию скрыты.
:Пользовательская настройка отображения столбцов сохраняется и не сбрасывается при повторном входе пользователя в систему.

:[[File:138 Детекторы выбор столбцов.png|thumb|none|upright=1.5|Раздел «Детекторы». Выбор отображаемых столбцов]]

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

== Просмотр статистики ==
В разделе '''Статистика''' пользователь может посмотреть статистические данные о разметке по всем проектам, веткам и снимкам, доступным пользователю. Все статистические данные разделены на три группы и отображаются в отдельных дашбордах:
* [[Help:UI manual#Работа с дашбордом «Общая статистика»|'''Общая статистика''']] – показатели по последним импортированным снимкам в ветках проектов;
* [[Help:UI manual#Работа с дашбордом «Распределение маркеров»|'''Распределение маркеров''']] – диаграммы с информацией о количестве маркеров и их распределении по серьезности, статусу разметки и языкам;
* [[Help:UI manual#Работа с дашбордом «Активность по разметке»|'''Активность по разметке''']] – информация об активности пользователей при разметке маркеров.

[[File:162 Раздел Статистика. Начальное состояние.png|thumb|none|upright=3|Раздел '''Статистика'''. Начальное состояние]]
Чтобы посмотреть информацию:
:1. Выберите дашборд – нажмите кнопку с его названием в верхней части экрана.
:2. Выберите [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|контекст]] (опционально). В дашборде '''Общая статистика''' выбор снимка недоступен.
:2. Нажмите кнопку [[File:Button Play.png|x25px]].
:Если контекст не был выбран, отобразится статистика по всем проектам, веткам и снимкам, доступным пользователю. При этом информация об их количестве отображается в верхней части каждого дашборда.
:[[File:163 Раздел Статистика. Контекст не выбран.png|thumb|none|upright=2.5|Раздел '''Статистика'''. Пример дашборда '''Общая статистика'''. Контекст не выбран]]
:Если контекст был выбран, то отобразится статистика только для выбранных проектов, веток и снимков (кроме '''Общая статистика'''). При этом информация об их количестве отображается в верхней части каждого дашборда.
:[[File:164 Раздел Статистика. Контекст выбран.png|thumb|none|upright=2.5|Раздел '''Статистика'''. Пример дашборда '''Общая статистика'''. Контекст выбран]]

=== Работа с дашбордом «Общая статистика» ===
На дашборде '''Общая статистика''' отображается информация о разметке маркеров в последних импортированных снимках в разрезе проектов и веток. Информация представлена в виде блоков со следующими данными:
* общая информация:
** названия проекта и ветки;
** количество снимков в ветке и дата последнего импорта;
** дата последней разметки маркеров;
* показатели последнего импортированного снимка:
** количество строк кода;
** количество маркеров;
** плотность маркеров – процентное отношение количества маркеров на тысячу строк кода;
** процент и количество размеченных маркеров;
** процент и количество подтвержденных маркеров – со статусом Confirmed;
** процент и количество критичных маркеров – с серьезностью детектора Critical.
:[[File:204 Статистика. Общая статистика.png|thumb|none|upright=2.5|Раздел '''Статистика'''. Дашборд '''Общая статистика''']]
Пользователю доступны следующие функции:
:1. Поиск информации по названиям проектов и веток.
:2. Сортировка данных – для этого в поле справа выберите показатель, по которому требуется сортировать информацию:
:* по датам последних разметки и импорта;
:* по показателям последнего импортированного снимка.
:Для изменения порядка сортировки используйте кнопки [[File:Button Sort.png|x25px]] и [[File:Button Sort UP.png|x25px]].
:3. Переход к последнему импортированному снимку в режиме разметки – нажмите на названия проекта и ветки в блоке.

=== Работа с дашбордом «Распределение маркеров» ===
На дашборде '''Распределение маркеров''' отображаются три диаграммы:
* Количество маркеров по серьезности;
* Количество маркеров по статусу разметки;
* Распределение маркеров по языкам.
[[File:165 Раздел Статистика. Информация о выбранном контексте.png|thumb|none|upright=2.5|Раздел '''Статистика'''. Дашборд '''Распределение маркеров''']]
Пользователю доступны следующие функции:
:1. Просмотр значения диаграммы – для этого наведите курсор на любой графический элемент любой диаграммы.
:2. Выгрузка данных диаграммы в файл формата .csv – для этого нажмите кнопку [[File:Button Download.png|x25px]] в любой диаграмме.

=== Работа с дашбордом «Активность по разметке» ===
На дашборде Активность по разметке отображается информация о действиях пользователей [[Help:UI manual#Работа в режиме разметки|по разметке маркеров]], которая может быть представлена в двух видах:
* диаграмма '''Активность по разметке''' – отражает активность пользователей по разметке маркеров за выбранный месяц (по умолчанию – текущий месяц). Цвет ячеек на диаграмме отражает количество действий пользователя, выполненных в указанную дату: чем темнее цвет, тем больше действий выполнил пользователь. Эта диаграмма отображается по умолчанию; если вид был переключен, то для возврата к этой диаграмме нажмите кнопку [[File:Button ChangeDiagram1.png|x25px]];
* диаграмма '''Лидеры по разметке''' – отражает количество действий пользователей при разметке за выбранный период (по умолчанию – период соответствует месяцу, указанному на диаграмме '''Активность по разметке''') с сортировкой по лидерам. Цвет строк на диаграмме отражает количество действий пользователя: чем темнее цвет, тем больше действий выполнил пользователь. Диаграмма отображается по нажатии кнопки [[File:Button ChangeDiagram2.png|x25px]];
[[File:166 Раздел Статистика. Активность по разметке.png|thumb|none|upright=3|Раздел '''Статистика'''. Дашборд '''Активность по разметке'''. Вид 1: диаграмма '''Активность по разметке''']]
[[File:167 Раздел Статистика. Лидеры по разметке.png|thumb|none|upright=3|Раздел '''Статистика'''. Дашборд '''Активность по разметке'''. Вид 2: диаграмма '''Лидеры по разметке''']]
Пользователю доступны следующие функции:
:1. Просмотр значения диаграммы – для этого наведите курсор на любой графический элемент любой диаграммы.
:2. Выгрузка данных диаграммы в файл формата .csv – для этого нажмите кнопку [[File:Button Download.png|x25px]] в любой диаграмме
:3. В диаграмме '''Активность по разметке''':
::а) Поиск конкретного пользователя – для этого введите фрагмент его логина в поле поиска.
::б) Просмотр статистики за любой другой месяц – для этого выберите год и месяц в раскрывающихся списках вверху диаграммы.
::в) Просмотр активности конкретного пользователя за выбранный месяц – для этого нажмите на его логин.
::Ниже диаграммы '''Активность по разметке''' отобразится список действий по разметке выбранного пользователя. Измененная (неактуальная) разметка отмечена иконкой [[File:Icon archive.png|x25px]].
::[[File:168 Раздел Статистика. Активность по разметке. Выбранный пользователь.png|thumb|none|upright=3|Раздел '''Статистика'''. Дашборд '''Активность по разметке'''. Диаграмма '''Активность по разметке''' и список действий по разметке выбранного пользователя]]
::г) Просмотр активности пользователей в конкретный день месяца – для этого нажмите на число.
::Ниже диаграммы '''Активность по разметке''' отобразится список действий по разметке пользователей за выбранную дату.
::[[File:169 Раздел Статистика. Активность по разметке. Пользователи за дату.png|thumb|none|upright=3|Раздел '''Статистика'''. Дашборд '''Активность по разметке'''. Диаграмма '''Активность по разметке''' и список действий по разметке пользователей за выбранную дату]]
::д) Просмотр активности конкретного пользователя в конкретный день месяца – для этого нажмите ячейку таблицы на пересечении строки с логином пользователя и столбца с числом.
::Ниже диаграммы '''Активность по разметке''' отобразится список действий по разметке выбранного пользователя за выбранную дату.
::[[File:170 Раздел Статистика. Активность по разметке. Одни пользователь за дату.png|thumb|none|upright=3|Раздел '''Статистика'''. Дашборд '''Активность по разметке'''. Диаграмма '''Активность по разметке''' и список действий по разметке выбранного пользователя за выбранную дату]]
::е) Включение и выключение отображения информации о неактуальной (измененной) разметке в списке действий пользователя – для этого воспользуйтесь переключателем '''Исключить активность по неактуальной разметке'''.
::ж) Просмотр маркера в [[Help:UI manual#Работа в режиме разметки|режиме разметки]] – для этого в списке действий нажмите на ссылку с именем файла и номером строки.
::з) Просмотр информации о маркере – для этого в списке действий нажмите кнопку [[File:Button show.png|x25px]] слева от названия маркера.
::В правой части экрана отобразится панель с информацией о маркере.
::[[File:205 Статистика. Активность по разметке. Панель с информацией о маркере.png|thumb|none|upright=3|Панель с информацией о маркере]]
:4. В диаграмме '''Лидеры по разметке''':
::а) Поиск конкретного пользователя – для этого введите фрагмент его логина в поле поиска.
::б) Просмотр статистики за любой другой период времени, кроме текущего месяца – для этого кликните на поле даты вверху диаграммы и вручную введите даты, либо в раскрывшемся календаре выберите диапазон дат: предложенный ('''Сегодня''', '''Вчера''', '''Неделю назад''' и т. п.) или свой.
::[[File:171 Раздел Статистика. Лидеры по разметке. Выбор дат.png|thumb|none|upright=3|Раздел '''Статистика'''. Дашборд '''Активность по разметке'''. Диаграмма '''Лидеры по разметке'''. Выбор диапазона дат]]
::в) Просмотр активности конкретного пользователя за указанный период – для этого нажмите на его логин.
::Ниже диаграммы '''Лидеры по разметке''' отобразится список действий по разметке выбранного пользователя. Измененная (неактуальная) разметка отмечена иконкой [[File:Icon archive.png|x25px]].
::[[File:172 Раздел Статистика. Лидеры по разметке. Выбранный пользователь.png|thumb|none|upright=3|Раздел '''Статистика'''. Дашборд '''Активность по разметке'''. Диаграмма '''Лидеры по разметке''' и список действий по разметке выбранного пользователя]]
::г) Включение и выключение отображения в списке действий пользователя по неактуальной (измененной) разметке – для этого воспользуйтесь переключателем '''Исключить активность по неактуальной разметке'''.
::д) Просмотр маркера в [[Help:UI manual#Работа в режиме разметки|режиме разметки]] – для этого в списке действий нажмите на ссылку с именем файла и номером строки.
::e) Просмотр информации о маркере – для этого в списке действий нажмите кнопку [[File:Button show.png|x25px]] слева от названия маркера.
::В правой части экрана отобразится панель с информацией о маркере.

== Глобальный поиск ==
Глобальный поиск позволяет одновременно по всем доступным пользователю проектам и веткам выполнить поиск в следующих категориях:
* Маркеры;
* Комментарии к маркерам;
* Снимки.

Чтобы воспользоваться глобальным поиском, перейдите в раздел '''Поиск'''.
[[File:173 Раздел Поиск. Начальное состояние.png|thumb|none|upright=3|Раздел '''Поиск'''. Начальное состояние]]

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

=== Поиск маркеров ===
Чтобы воспользоваться поиском маркеров:
:1. Выберите категорию '''Маркеры''' раздела '''Поиск''' (выбран по умолчанию).
:2. Для базового поиска:
::а) Перейдите на вкладку '''Базовый поиск''' (открыта по умолчанию).
::[[File:174 Раздел Поиск. Категория Маркеры. Базовый поиск.png|thumb|none|upright=3|Раздел '''Поиск'''. Категория '''Маркеры'''. Базовый поиск]]
::б) Введите фрагмент названия маркера, детектора, функции или файла.
::в) Выберите (опционально) группу проектов, проект, ветку и снимок, в которых нужно найти маркеры.
::По умолчанию выбраны все группы, проекты, ветки и снимки.
::г) Нажмите кнопку '''Поиск'''.
:Отобразятся результаты поиска.
:[[File:175 Раздел Поиск. Пример результатов поиска в категории Маркеры.png|thumb|none|upright=3|Раздел '''Поиск'''. Пример результатов поиска в категории '''Маркеры''']]
:3. Для поиска по полям:
::а) Перейдите на вкладку '''Поиск по полям'''.
::[[File:176 Раздел Поиск. Категория Маркеры. Поиск по полям.png|thumb|none|upright=3|Раздел '''Поиск'''. Категория '''Маркеры'''. Поиск по полям]]
::б) Заполните поля поиска.
::в) Выберите (опционально) группу проектов, проект, ветку и снимок, в которых нужно найти маркеры.
::По умолчанию выбраны все группы, проекты, ветки и снимки.
::г) Нажмите кнопку '''Поиск'''.
:Отобразятся результаты поиска.
:[[File:177 Раздел Поиск. Пример результатов поиска по полям в категории Маркеры.png|thumb|none|upright=3|Раздел '''Поиск'''. Пример результатов поиска по полям в категории '''Маркеры''']]
:4. Для очистки значений в полях поиска нажмите кнопку '''Очистить'''.
:5. Чтобы перейти к найденному файлу с маркером в [[Help:UI manual#Работа в режиме разметки|режиме разметки]], в результатах поиска кликните на ссылку в имени файла с номером строки исходного кода.
:6. Чтобы посмотреть подробную информацию о найденном маркере, в результатах поиска нажмите кнопку [[File:Button show.png|x25px]].
Отобразится правая панель с открытой вкладкой '''Подробности'''.
:[[File:341 Раздел Поиск. Подробная информация о маркере.png|thumb|none|upright=3|Раздел '''Поиск'''. Пример просмотра подробной информации о найденном маркере]]

=== Поиск комментариев к маркерам ===
Чтобы воспользоваться поиском по комментариям к маркерам:
:1. Выберите категорию '''Комментарии к маркерам''' раздела '''Поиск'''.
:2. Для базового поиска:
::а) Перейдите на вкладку '''Базовый поиск''' (открыта по умолчанию).
::[[File:178 Раздел Поиск. Категория Комментарии к маркерам. Базовый поиск.png|thumb|none|upright=3|Раздел '''Поиск'''. Категория '''Комментарии к маркерам'''. Базовый поиск]]
::б) Введите фрагмент комментария или логина его автора.
::в) Выберите (опционально) группу проектов, проект, ветку и снимок, в которых нужно найти комментарии.
::По умолчанию выбраны все группы, проекты, ветки и снимки.
::г) Нажмите кнопку '''Поиск'''.
:Отобразятся результаты поиска.
:[[File:179 Раздел Поиск. Пример результатов поиска в категории Комментарии к маркерам.png|thumb|none|upright=3|Раздел '''Поиск'''. Пример результатов поиска в категории '''Комментарии к маркерам''']]
:3. Для поиска по полям:
::а) Перейдите на вкладку '''Поиск по полям'''.
::[[File:180 Раздел Поиск. Категория Комментарии к маркерам. Поиск по полям.png|thumb|none|upright=3|Раздел '''Поиск'''. Категория '''Комментарии к маркерам'''. Поиск по полям]]
::б) Заполните поля поиска.
::в) Выберите (опционально) группу проектов, проект, ветку и снимок, в которых нужно найти комментарии.
::По умолчанию выбраны все группы, проекты, ветки и снимки.
::г) Нажмите кнопку '''Поиск'''.
:Отобразятся результаты поиска.
:[[File:181 Раздел Поиск. Пример результатов поиска по полям в категории Комментарии к маркерам.png|thumb|none|upright=3|Раздел '''Поиск'''. Пример результатов поиска по полям в категории '''Комментарии к маркерам''']]
:4. Для очистки поискового запроса нажмите кнопку '''Очистить'''.
:5. Чтобы перейти в [[Help:UI manual#Работа в режиме разметки|режим разметки]] к файлу маркера с найденным комментарием, в результатах поиска кликните на ссылку в имени файла с номером строки исходного кода.
:6. Чтобы посмотреть подробную информацию о маркере с найденным комментарием, в результатах поиска нажмите кнопку [[File:Button show.png|x25px]]. Отобразится правая панель с открытой вкладкой '''Комментарии'''.

=== Поиск снимков ===
Чтобы воспользоваться поиском по снимкам:
:1. Выберите категорию '''Снимки''' раздела '''Поиск'''.
:2. Для базового поиска:
::а) Перейдите на вкладку '''Базовый поиск''' (открыта по умолчанию).
::[[File:182 Раздел Поиск. Категория Снимки. Базовый поиск.png|thumb|none|upright=3|Раздел '''Поиск'''. Категория '''Снимки'''. Базовый поиск]]
::б) Введите фрагмент названия снимка, пользовательского поля снимка (названия или его значения) или логина пользователя, который импортировал снимок.
::в) Выберите (опционально) группу проектов, проект, ветку и снимок, в которых нужно найти снимки.
::По умолчанию выбраны все группы, проекты, ветки и снимки.
::г) Нажмите кнопку '''Поиск'''.
:Отобразятся результаты поиска.
:[[File:183 Раздел Поиск. Пример результатов поиска в категории Снимки.png|thumb|none|upright=3|Раздел '''Поиск'''. Пример результатов поиска в категории '''Снимки''']]

:3. Для поиска по полям:
::а) Перейдите на вкладку '''Поиск по полям'''.
::[[File:184 Раздел Поиск. Категория Снимки. Поиск по полям.png|thumb|none|upright=3|Раздел '''Поиск'''. Категория '''Снимки'''. Поиск по полям]]
::б) Заполните поля поиска.
::в) Выберите (опционально) группу проектов, проект, ветку и снимок, в которых нужно найти снимки.
::По умолчанию выбраны все группы, проекты, ветки и снимки.
::г) Нажмите кнопку '''Поиск'''.
:Отобразятся результаты поиска.
:[[File:185 Раздел Поиск. Пример результатов поиска по полям в категории Снимки.png|thumb|none|upright=3|Раздел '''Поиск'''. Пример результатов поиска по полям в категории '''Снимки''']]
:4. Для очистки поискового запроса нажмите кнопку '''Очистить'''.
:5. Чтобы посмотреть подробную информацию о найденном снимке, в результатах поиска кликните на ссылку в пути размещения снимка.
:Найденный снимок откроется в [[Help:UI manual#Работа в режиме разметки|режиме разметки]] со всеми его маркерами.

=== Просмотр истории поиска ===
Чтобы посмотреть историю поиска, нажмите кнопку '''История поиска''' в разделе '''Поиск'''.

В истории отображаются 100 последних поисковых запросов пользователя.
[[File:186 Раздел Поиск. Пример истории поиска.png|thumb|none|upright=3|Раздел '''Поиск'''. Пример истории поиска]]

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

== Настройка сервера Svacer ==
Перейти в раздел '''Настройки''' можно по нажатии кнопки [[File:Icon settings.png|x25px]] в верхней правой части экрана.

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

=== Управление пользователями, ролями и организациями===
==== Управление пользователями ====
Реестром учетных записей пользователей можно управлять на вкладке '''Пользователи''' в разделе '''Управление пользователями''' страницы '''Настройки'''. 
Для [[LDAP configuration|учетных записей с доступом по LDAP]] рядом с логином отображается индикатор [[File:Icon LDAP.png|x25px]], для учетных записей с доступом по OIDC рядом с логином отображается индикатор [[File:Icon_OIDC.png|x25px]], а для учетных записей с признаком '''Мастер разметки''' – индикатор [[File:Icon markup master.png|x25px]]. 
В разделе доступны:
* поиск по атрибутам учётной записи пользователя;
* фильтрация списка по типам учётных записей:
:* все;
:* системные;
:* LDAP;
:* OIDC;
:* заблокированные;
:* активные;
:* по ролям;
:* по организациям.
* сортировка по колонкам '''Логин''', '''ФИО''' и '''Дата создания''' (по умолчанию).
:[[File:74 Вкладка Пользователи на странице Настройки.png|thumb|none|upright=3|Вкладка '''Пользователи''' в разделе '''Управление пользователями''' страницы '''Настройки''']]
Для управления пользователями:
:1. Создайте учетную запись пользователя:
::а) Нажмите кнопку '''Создать'''.
::Откроется окно добавления учетной записи пользователя.
::[[File:76 Окно Добавить пользователя.png|thumb|none|upright=1.5|Окно '''Создать пользователя''']]
::б) Заполните поля:
::* Логин;
::* Пароль;
::* e-mail;
::* ФИО.
::в) Выберите [[Help:UI manual#Управление организациями|организации]], в которые должен входить пользователь, а также назначьте ему [[Help:UI manual#Управление ролями|роли]] – выберите значения в раскрывающихся списках полей '''Организации''' и '''Роли''' соответственно. Для отмены выбора нажмите на кнопку [[File:Icon cancel.png|x25px]] справа от значения.
::г) Включите опции '''Изменить пароль при первом входе в систему''' и '''Мастер разметки'''. 
::{{Note|type=info|text=''Если для учётной записи активирована опция '''Мастер разметки''', есть разрешение на разметку и этот пользователь разметил маркер в каком-либо снимке, то изменить его разметку может только пользователь, в учётной записи которого также активирована опция '''Мастер разметки''' или которому предоставлен [[#Cерверные доступы|серверный доступ]] '''Изменение любой разметки'''.''}}
::д) Нажмите кнопку '''Создать'''.
: В таблице со списком пользователей добавится новая запись.

:2. Воспользуйтесь функциями в строке учетной записи в крайнем правом столбце – нажмите кнопку [[File:Button menu.png|x25px]] и выберите пункт:
:* '''Редактировать''' – для перехода к редактированию данных профиля;
:* '''Изменить пароль''' – для перехода к изменению пароля;
:* '''Сбросить настройки пользователя''' – для возврата пользовательских настроек к их значениям по умолчанию;
:* '''Заблокировать''' – для блокировки учетной записи. В этом случае для учетной записи пользователя блокируется доступ к системе, а в списке рядом с логином учетной записи отображается индикатор [[File:Icon_Archived.png|x25px]];
:* '''Разблокировать''' – для восстановления доступа пользователя к системе;
:* '''Настройки уведомлений''' – для настройки уведомлений пользователя об операциях со снимками и маркерами – аналогично [[Help:UI manual#Настройка уведомлений|настройке уведомлений в меню пользователя]];
::[[File:219 Настройки Настройка уведомлений выбранного пользователя.png|thumb|none|upright=2|Настройки уведомлений выбранного пользователя]]
:* '''Удалить''' – для удаления учётной записи пользователя;
:* '''Показать доступы пользователя''' – для отображения списка объединенных доступов всех ролей, назначенных пользователю.
::[[File:113 Список доступов пользователя.png|thumb|none|upright=3|Список доступов пользователя]]
::{{Note|type=warn|text=''Функции блокировки и удаления недоступны для системных учетных записей. При изменении логина или списка доступов у авторизованного пользователя, он будет перенаправлен на страницу авторизации.''}}

:3. Воспользуйтесь функциями управления несколькими учётными записями одновременно:
::а) Чтобы выбрать несколько записей, установите флажки в первом столбце списка пользователей.
::б) Чтобы выбрать все отображаемые учётные записи, установите один флажок в заголовке столбцов в первом столбце списка.
::в) Нажмите кнопку '''Действия''' в верхней части списка пользователей и выберите пункт: '''Сбросить настройки пользователя''', '''Заблокировать''', '''Разблокировать''' или '''Удалить'''. В списке активны только действия, доступные всем выбранным учетным записям.
:4. Для [[LDAP configuration|учетной записи с доступом по LDAP]] обновите данные – в окне редактирования данных профиля пользователя нажмите кнопку '''Загрузить из LDAP'''.
:Загрузятся параметры профиля пользователя и его контакты из профиля в службе каталогов, если они там указаны.
:[[File:78 Загрузка данных из LDAP.png|thumb|none|upright=1.5|Загрузка данных из LDAP]]

==== Управление ролями ====
Реестром ролей можно управлять на вкладке '''Роли''' в разделе '''Управление пользователями''' страницы '''Настройки'''.
[[File:79 Переход к управлению ролями.png|thumb|none|upright=3|Вкладка '''Роли''' в разделе '''Управление пользователями''' страницы '''Настройки''']]
{{Note|type=info|text=''Роли [[Help:UI manual#Описание ролевой модели|admin, filter_master и importer]] являются встроенными с особым значением. Их нельзя удалить или изменить.''}}

Доступен поиск по названию роли и сортировка по колонкам '''Название''' (по умолчанию) и '''Пользователи'''. 
Для управления ролями доступны следующие функции:
:1. Создание новой роли:
::а) Нажмите кнопку '''Создать'''.
::[[File:81 Окно добавления роли.png|thumb|none|upright=3|Окно добавления роли]]
::б) Заполните поля появившейся формы:
:::*введите название роли;
:::*в блоке '''Серверные доступы''' выберите доступы – нажмите кнопку '''Выбрать всё''' или установите флажки для активации доступов.
:::При наведении курсора на иконку [[File:Icon question mark2.png|x25px]] отображается пояснение к доступу.
:::*в блоке '''Проектные доступы''' выберите тип доступа: группа проектов или определённый проект или его ветка;
:::*если выбран тип '''Группа проектов''', выберите название группы и установите флажки для активации доступов;
:::*если выбран тип '''Проект / Ветка''', выберите название проекта или ветки проекта, установите флажки для активации доступов.
:::Если выбрано значение '''Все''', то доступы будут предоставлены для всех проектов;
:::*для удаления строки с проектными доступами в блоке '''Проектные доступы''' нажмите кнопку [[File:Icon delete.png|x25px]] в крайнем правом столбце.
::в) Нажмите кнопку '''Создать'''.

:2. Просмотр доступов роли, нажмите на ссылку '''Показать доступы''' в столбце '''Доступы'''.
:[[File:114 Список доступов роли.png|thumb|none|upright=3|Список доступов роли]]

:3. Редактирование роли:
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке роли в крайнем правом столбце.
::б) В меню выберите пункт '''Редактировать''' и внесите изменения.

:4. Создание копии роли:
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке исходной роли в крайнем правом столбце.
::б) В меню выберите пункт '''Создать копию'''.
:В реестр ролей добавится новая запись с именем исходной роли и добавленным порядковым номером копии.

:5. Просмотр информации о роли в JSON-формате:
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке исходной роли в крайнем правом столбце.
::б) В меню выберите пункт '''Просмотреть JSON'''.

:6. Удаление роли:
::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке исходной роли в крайнем правом столбце.
::б) В меню выберите пункт '''Удалить'''.
::в) Подтвердите удаление.

:7. Удаление несколько ролей одновременно:
::а) Для выбора нескольких записей установите флажки в первом столбце списка ролей.
::б) Чтобы выбрать все записи, установите один флажок в заголовке столбцов в первом столбце списка ролей.
::в) Нажмите кнопку '''Удалить''' и подтвердите удаление.

==== Управление организациями ====
Пользователи могут быть связаны с организациями. Один пользователь может принадлежать нескольким организациям. Организации носят информационный характер и не влияют на права пользователей в системе. 
Реестром организаций можно управлять на вкладке '''Организации''' в разделе '''Управление пользователями''' страницы '''Настройки'''.
[[File:92 Вкладка Организации на странице Настройки.png|thumb|none|upright=3|Вкладка '''Организации''' в разделе '''Управление пользователями''' страницы '''Настройки''']]
Доступен поиск по названию и сокращенному названию организации и сортировка по колонкам '''Название''' (по умолчанию), '''Сокращенное название''' и '''Пользователи'''.
Для управления организациями, доступны следующие функции:
:1. Создание организации:
::а) Нажмите кнопку '''Создать'''.
::б) Заполните поля появившейся формы.
::в) Нажмите кнопку '''Создать'''.
::[[File:93 Окно добавления организации в реестр.png|thumb|none|upright=1.5|Окно добавления организации в реестр]]

:2. Редактирование организации:
::а) Нажмите кнопку [[File:Icon edit2.png|x25px]] в крайнем правом столбце.
::б) В появившейся форме отредактируйте данные организации.
::в) Нажмите кнопку '''Сохранить'''.

:3. Удаление организации:
::а) Нажмите кнопку [[File:Icon delete.png|x25px]] в крайнем правом столбце.
::б) В появившемся диалоге подтвердите удаление, нажав на кнопку '''Удалить'''.

:4. Удаление несколько организаций одновременно:
::а) Для выбора нескольких записей установите флажки в первом столбце списка организаций.
::б) Чтобы выбрать все организации, установите один флажок в заголовке столбцов в первом столбце списка.
::в) Нажмите кнопку '''Удалить''' и подтвердите удаление.

=== Настройка глобальных фильтров ===
В разделе '''Глобальные фильтры''' страницы '''Настройки''' можно настроить глобальные фильтры, применительно [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|к выбранным проекту или ветке проекта]]: 
{{Note|type=info|text=''По умолчанию выбран контекст (проект, ветка), заданный ранее в режиме '''Разметка''', или '''Код'''.''}}
[[File:82 Вкладка Фильтры на странице Настройки.png|thumb|none|upright=4|Раздел '''Глобальные фильтры''' на странице '''Настройки''']]

В разделе доступен поиск по названию фильтра.

Для настройки фильтров:
:1. Выберите проект и ветку в верхней строке раздела. По умолчанию указаны проект и ветка, выбранные в разделе '''Разметка'''.
:2. Чтобы добавить фильтр, нажмите кнопку '''Создать'''.
:Отобразится новая строка:
:[[File:83 Новая строка с фильтром.png|thumb|none|upright=4|Новая строка с фильтром]]

:3. Чтобы изменить настройки фильтров:
::а) Введите или поменяйте название фильтра
::б) Включите или выключите фильтр – нажмите на значение в столбце '''Статус''', чтобы отобразилась иконка [[File:Icon check2.png|x25px]] (по умолчанию) или [[File:Icon cross 01.png|x25px]].
::в) Выберите область применения фильтра – нажмите на значение в столбце '''Область''' один или два раза, чтобы отобразилось значение '''ветка''' или '''проект'''.
::г) Введите [[Help:UI manual#Использование регулярных выражений|регулярное выражение]] или загрузите его из файла в столбцах '''Включить пути по шаблону''', '''Исключить пути по шаблону''' и '''Детекторы'''.
::{{Note|type=info|text=''Шаблоны регулярных выражений не зависят от регистра и поддерживают следующий синтаксис:''
:* ''; – для разделения списков значений;''
:* ''* – любое количество символов;''
:* ''? – один произвольный символ;''
:* ''re: – включая значения, определяемые регулярным выражением;''
:* ''re!: – исключая значения, определяемые регулярным выражением (только для столбца '''Детекторы''').''}}
::д) Выберите уровни серьезности (критичности) и надежности:
::* [[File:Icon_critical_on.png|x30px]] – уровень выбран;
::* [[File:Icon_critical_off.png|x30px]] – уровень не выбран.
::Для изменения выбора нажмите на название уровня.
:4. Нажмите кнопку [[File:Icon delete.png|x25px]] в крайнем правом столбце, чтобы удалить один фильтр.
:5. Чтобы удалить несколько фильтров:
::а) Для выбора нескольких записей установите флажки в первом столбце списка фильтров.
::б) Чтобы выбрать все записи, установите один флажок в заголовке столбцов в первом столбце списка фильтров.
::в) Нажмите кнопку '''Удалить'''.
:6. Для сохранения и применения изменений нажмите кнопку '''Применить'''.
Если не применить изменения, то при переходе в другой раздел системы отобразится сообщение о том, что изменения не применены:
:[[File:115 Запрос на изменение глобальных фильтров.png|thumb|none|upright=1.5]]

:{{Note|type=warn|text=''После применения глобальных фильтров пользователям, у которых в режиме разметки открыт данный контекст, требуется перезагрузить страницу (нажать клавишу F5) для обновления списка маркеров.''}}

=== Управление блокировками разметки ===
Чтобы посмотреть список всех [[Help:UI manual#Блокировка разметки|блокировок]], перейдите на вкладку '''Блокировки''' страницы '''Настройки''':
[[File:61 Просмотр всех блокировок.png|800px|thumb|none|Раздел '''Блокировки''' страницы '''Настройки''']]
{{Note|type=info|text=''Пользователю отображается список блокировок в контейнерах, к которым у него есть доступ. Удаление не своих блокировок доступно пользователям с соответствующим доступом.''}}

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

Для удаления одной блокировки:
:1. Нажмите кнопку [[File:Icon delete.png|x25px]] в строке проекта в крайнем правом столбце.
:2. Подтвердите удаление.
Для удаления нескольких блокировок:
:1. Чтобы выбрать для удаления все блокировки, установите флажок в заголовке табличного списка.
:2. Чтобы выбрать несколько блокировок, установите флажки в крайнем правом столбце табличного списка.
:3. Нажмите кнопку '''Удалить''' в верхней части списка.

=== Ведение журнала операций ===
В разделе '''Журнал операций''' страницы '''Настройки''' доступны просмотр и откат выполнения групповых операций по разметке и комментированию маркеров, таких как импорт разметки, копирование разметки, импорт снимков и т. п.
[[File:206 Настройки. Журнал операций.png|800px|thumb|none|Раздел '''Журнал операций''' на странице '''Настройки''']]
В разделе доступны:
* поиск по названию контейнера, типу операции и её описанию;
* фильтрация списка:
** по статусу операции: '''Applied''', '''Reverted''', '''Invalid''';
** типу операции;
** генератору операции;
** автору операции;
** диапазону дат создания операции;
* сортировка по всем колонкам, кроме '''Описание'''.

Чтобы откатить выполнение операции, нажмите кнопку [[File:Icon return.png|x25px]] в строке и подтвердите действие в открывшемся окне.
{{Note|type=warn|text=''Откат своих операций доступен пользователям с [[#Проектные доступы|проектными доступами]] '''Разметка маркеров''' и '''Импорт разметки'''. Откат операций других пользователей доступен пользователям с [[#Проектные доступы|проектным доступом]] '''Разметка маркеров''' и [[#Серверные доступы|серверным доступом]] '''Администрирование сервера''' или серверным доступами '''Изменение любой разметки''' и '''Изменение любых комментариев'''.''}}

=== Управление шаблонами разметки ===
Управление шаблонами разметки доступно в разделе '''Шаблоны разметки''' страницы '''Настройки''':
[[File:84 Вкладка Шаблоны на странице Настройки.png|thumb|none|upright=3|Раздел '''Шаблоны разметки''' на странице '''Настройки''']]

Шаблоны разметки нужны для [[Help:UI manual#Импорт разметки|импорта]]/[[Help:UI manual#Экспорт разметки|экспорта разметки]]. С их помощью комментарии в исходном коде будут преобразовываться в разметку на сервере истории и обратно.

Шаблон с именем DEFAULT есть всегда, его нельзя отредактировать или удалить.

{{Note|type=info|text=''Для корректного создания или изменения шаблонов разметки следует обратиться к разработчикам Svacer.''}}

Для управления шаблонами:
:1. Нажмите кнопку '''Создать'''.
:Откроется окно создания шаблона.
:[[File:Добавление шаблона разметки.png|thumb|none|upright=1.5|Окно создания шаблона разметки]]
:2. Введите название шаблона.
:3. Нажмите кнопку '''Создать'''.
:Шаблон появится в списке шаблонов для разметки в правой панели формы
:4. Отредактируйте поля шаблона разметки:
:[[File:85 Поля шаблона, доступные для редактирования.png|thumb|none|upright=2.5|Редактирование шаблона разметки]]
:5. Нажмите '''Сохранить'''.
:6. Чтобы клонировать существующий шаблон разметки, нажмите кнопку [[File:Icon_clone.png|x20px]] в правой части строки шаблона в списке.
:7. Для удаления одного шаблона:
::а) Нажмите кнопку [[File:Icon delete.png|x25px]] в правой части строки шаблона в списке.
::б) Подтвердите удаление.
:8. Для удаления нескольких шаблонов:
::а) Выберите шаблоны для удаления – установите флажки в левой части названий шаблонов или нажмите кнопку '''Выбрать всё'''.
::б) Нажмите кнопку '''Удалить''' в верхней части списка шаблонов и подтвердите удаление.

=== Управление токенами доступа ===
Управление персональными токенами доступа выполняется в разделе '''Токены доступа''' на странице '''Настройки'''.
[[File:207 Настройки. Токены доступа.png|800px|thumb|none|Раздел '''Токены доступа''' на странице '''Настройки''']]
В разделе доступны:
* поиск по названию токена и его описанию, а также по логину пользователя;
* сортировка по всем колонкам, кроме '''Описание'''.
Для управления токенами доступа:
:1. Создайте токен:
::а) Нажмите кнопку '''Создать'''.
::б) В окне '''Создать токен доступа''' введите название и, опционально, описание токена; выберите срок действия.
::По умолчанию срок действия токена 90 дней (минимальный срок 1 день, максимальный – 365).
::в) Нажмите кнопку '''Создать'''.
::[[File:208 Окно Создание токена доступа.png|thumb|none|upright=1.5|Окно '''Создать токен доступа''']]
::Отобразится окно с токеном доступа.
::{{Note|type=warn|text=''Токен отображается только один раз – при создании''}}
::[[File:209 Токен доступа.png|thumb|none|upright=1.5|Пример токена]]
::г) Нажмите кнопку '''Скопировать в буфер обмена''' и сохраните токен в надежном месте.
:2. Для удаления одного токена:
::а) Нажмите кнопку [[File:Icon delete.png|x25px]] в крайнем правом столбце.
::б) Подтвердите удаление.
:3. Для удаления нескольких токенов:
::а) Чтобы выбрать для удаления все токены, установите флажок в заголовке табличного списка.
::б) Чтобы выбрать несколько токенов, установите флажки в крайнем правом столбце табличного списка.
::в) Нажмите кнопку '''Удалить''' в верхней части табличного списка токенов и подтвердите удаление.

=== Управление асинхронными задачами ===
К асинхронным задачам относятся:
* экспорт snap и SARIF файлов (в режиме [[Help:UI manual#Экспорт|'''Разметки''']] и в разделе [[Help:UI manual#Работа со снимками|'''Проекты''']]);
* копирование снимков (см. раздел 4.6.4).
Управление этими задачами выполняется разделе '''Асинхронные задачи''' на странице '''Настройки'''.

В разделе доступны:
* поиск по идентификатору задачи, её типу, описанию, статусу, а также по логину пользователя;
* фильтрация списка:
:* по статусу;
:* типу задачи;
:* пользователю;
:* диапазону дат старта и окончания выполнения задачи;
* сортировка по всем колонкам, кроме '''Описание'''.
[[File:342 Настройки. Асинхронные задачи.png|800px|thumb|none|Раздел '''Асинхронные задачи''' на странице '''Настройки''']]

Для управления асинхронными задачами:
:1. Чтобы посмотреть лог выполнения задачи, нажмите кнопку в крайнем правом столбце.
:Откроется окно с текстом лога (Рисунок 205).
:[[File:343 Окно с текстом лога асинхронной задачи.png|600px|thumb|none|Окно с текстом лога асинхронной задачи]]
:2. Чтобы скачать лог, нажмите кнопку в крайнем правом столбце или откройте окно с текстом лога и нажмите кнопку '''Скачать лог'''.
:3. Для удаления истории об одной задаче:
::а) Нажмите кнопку [[File:Icon delete.png|x25px]] в строке задачи в крайнем правом столбце.
::б) Подтвердите удаление.
:4. Для удаления истории о нескольких задачах:
::а) Чтобы выбрать для удаления все задачи, установите флажок в заголовке табличного списка.
::б) Чтобы выбрать несколько задач, установите флажки в крайнем правом столбце табличного списка.
::в) Нажмите кнопку '''Удалить''' в верхней части списка.

=== Просмотр информации о сервере ===
В разделе '''Информация о сервере''' на странице '''Настройки''' отображаются вкладки:
* '''Параметры''' – параметры, с которыми запущен сервер;
* '''Системный лог''' – журнал событий сервера;
* '''Системный журнал''' – журнал базы данных.
[[File:344 Настройки. Информация о сервере. Вкладка Параметры.png|thumb|none|upright=3|Раздел '''Информация о сервере''' на странице '''Настройки'''. Вкладка '''Параметры''']]
[[File:345 Настройки. Информация о сервере. Вкладка Системный лог.png|thumb|none|upright=3|Раздел '''Информация о сервере''' на странице '''Настройки'''. Вкладка '''Системный лог''']]
[[File:346 Настройки. Информация о сервере. Вкладка Системный журнал.png|thumb|none|upright=3|Раздел '''Информация о сервере''' на странице '''Настройки'''. Вкладка '''Системный журнал''']]

{{Note|type=warn|text=''На вкладке '''Системный лог''' вывод информации ограничен 1 МБ последних данных (значение настраивается в параметрах сервера). При скачивании файл содержит данные лога в полном объеме.''}}

Доступны функции:
* поиск параметров по их имени и значению – на вкладке '''Параметры''';
* копирование записей – на вкладках '''Системный лог''' и '''Системный журнал''';
* выгрузка лога в файлы в формате .log по нажатии кнопки '''Скачать''' – на вкладках '''Системный лог''' и '''Системный журнал'''.

== Выход из системы ==
Для выхода из системы выберите пункт '''Выйти''' в меню пользователя в правом верхнем углу экрана.
[[File:95 Выход из системы —без VSCode.png|thumb|none|upright=1.5|Выход из системы]]

== Использование регулярных выражений ==
Регулярные выражения можно использовать:
* для поиска и фильтрации данных [[Help:UI manual#Функции навигационной панели|в навигационной панели]] [[Help:UI manual#Вкладка «Файлы»|на вкладке '''Файлы''']];
* в окне настройки [[Help:UI manual#Настройка и использование пользовательских фильтров|пользовательских фильтров]] в блоке '''Файлы''';
* при [[Help:UI manual#Экспорт исходного кода с разметкой|экспорте кода с разметкой]];
* при [[Help:UI manual#Настройка глобальных фильтров|настройке глобальных фильтров]];
* в полях [[Help:UI manual#Глобальный поиск|глобального поиска]].

Особенности реализации:
:1. Поиск происходит только по регулярному выражению. Если требуется найти специальный символ в качестве обычного символа, его нужно экранировать (например, точку: <code>\.</code>)
:2. При поиске находятся вхождения подстроки в полном пути к файлу (аналогично grep). Если требуется найти по полной строке, используйте символы начала и конца строки: <code>^</code> и <code>$</code>
:3. Поиск не зависит от регистра символов (case insensitive) и поддерживает следующий синтаксис:
::* ; – для разделения списков значений;
::* * – любое количество символов;
::* ? – один произвольный символ.
:В окне настройки [[Help:UI manual#Настройка и использование пользовательских фильтров|пользовательских фильтров]] в блоке '''Файлы''' можно применить фильтр как для отображения только маркеров из файлов, которые подходят под паттерн, так и для скрытия таких маркеров. Для переключения между этими режимами используйте кнопки [[File:Icon plus 2.png|x20px]] и [[File:Icon minus 3.png|x20px]], которые расположены рядом с полем ввода. В остальных частях интерфейса следует использовать теги re: и re!:

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

== Описание ролевой модели ==
=== Серверные доступы ===
{| class="wikitable"
! Полномочие (доступ) !! Описание !! Влияние на графический интерфейс !! admin !! filter_master !! importer
|-
| Создание проектов
|| Создание и клонирование проектов. Пользователь, создавший проект, имеет полный доступ к управлению этим проектом
|| Наличие полномочия делает доступным:
* раздел [[Help:UI manual#Управление проектами и группами проектов|'''Проекты''']];
* кнопку '''Создать проект''';
* форму создания, клонирования и редактирования проекта.

Наличие доступа предоставляет автору проекта полные права на управление своими проектами, включая разметку (даже при отсутствии у него соответствующего проектного доступа), а также позволяет удалять приложения к снимкам в созданных проектах
|| + || – || –

|-
| Настройка групп проектов
|| Создание, редактирование и удаление групп проектов
|| Наличие полномочия делает доступным:
* раздел [[Help:UI manual#Управление проектами и группами проектов|'''Проекты''']] с кнопкой для перехода к настройке групп;
* панель [[Help:UI manual#Работа с группами проектов|'''Группы проектов''']] с полным списком проектов в группах.
Наличие доступа предоставляет права на просмотр маркеров во всех проектах
|| + || – || –

|-
| Управление пользователями
|| Создание, редактирование и удаление пользователей
|| Наличие полномочия делает доступной вкладку [[Help:UI manual#Управление пользователями|'''Пользователи''']] в разделе [[Help:UI manual#Управление пользователями, ролями и организациями|'''Настройки – Управление пользователями''']] со всеми функциями управления учетными записями пользователей
|| + || – || –

|-
| Управление ролями
|| Создание, редактирование и удаление ролей
|| Наличие полномочия делает доступной вкладку [[Help:UI manual#Управление ролями|'''Роли''']] в разделе [[Help:UI manual#Управление пользователями, ролями и организациями|'''Настройки – Управление пользователями''']] со всеми функциями управления ролями
|| + || – || –

|-
| Управление организациями
|| Создание, редактирование и удаление организаций
|| Наличие полномочия делает доступной вкладку [[Help:UI manual#Управление организациями|'''Организации''']] в разделе [[Help:UI manual#Управление пользователями, ролями и организациями|'''Настройки – Управление пользователями''']] со всеми функциями управления организациями
|| + || – || –

|-
| Управление шаблонами разметки
|| Создание, редактирование и удаление шаблонов разметки
|| Наличие полномочия делает доступным раздел [[Help:UI manual#Управление шаблонами разметки|'''Настройки – Шаблоны разметки''']] со всеми функциями управления учетными записями шаблонами
|| + || – || –

|-
| Удаление блокировок
|| Просмотр и удаление блокировок всех пользователей
|| Наличие полномочия позволяет просматривать и удалять блокировки всех пользователей в разделе [[Help:UI manual#Управление блокировками разметки|'''Настройки – Блокировки''']]
|| + || – || –

|-
| Администрирование сервера
|| Просмотр настроек сервера, системных лог-файлов и выполнение операций по администрированию сервера Svacer, включая активацию лицензии
|| Наличие полномочия делает доступным раздел [[Help:UI manual#Просмотр информации о сервере|'''Настройки – Информация о сервере''']]
Совместно с проектными доступами '''Управление ветками''' и снимками и '''Разметка маркеров''' становится доступна функция очистки разметки и комментариев в ветке
|| + || – || –

|-
| Управление публичными фильтрами
|| Публикация, редактирование и удаление публичных фильтров
|| Наличие полномочия позволяет публиковать сохраненные фильтры, а также редактировать и удалять публичные фильтры
|| + || – || –

|-
| Изменение любой разметки
|| Изменение любой разметки маркеров, включая выполненную пользователями с признаком [[Help:UI manual#Управление пользователями, ролями и организациями|'''Мастер разметки''']]
|| Доступ позволяет переразмечать маркеры (добавлять новую разметку), которые разметили любые пользователи, в том числе те, для которых активирована опция [[Help:UI manual#Управление пользователями, ролями и организациями|'''Мастер разметки''']].
При этом:
# Полномочие не предоставляет доступ ко всем проектам. Т. е. пользователь с таким полномочием может изменять разметку только в проектах, к которым у него имеется доступ.
# Для переразметки маркеров пользователю должен быть предоставлен проектный доступ '''Разметка маркеров'''.
# Чтобы переразметить заблокированный маркер, сначала нужно [[Help:UI manual#Блокировка разметки маркеров|снять его блокировку]]
|| + || – || –

|-
| Изменение любых комментариев
|| Редактирование и удаление любых пользовательских комментариев к маркерам
|| Доступ позволяет изменять/удалять комментарии, которые создали любые пользователи, в том числе те, для которых активирована опция [[Help:UI manual#Управление пользователями, ролями и организациями|'''Мастер разметки''']].
При этом:
# Полномочие не предоставляет доступ ко всем проектам. Т. е. пользователь с таким полномочием может изменять разметку только в проектах, к которым у него имеется доступ.
# Для добавления комментариев пользователю должно быть предоставлено проектное полномочие '''Разметка маркеров'''.
# Чтобы поменять комментарий к заблокированному маркеру, сначала нужно [[Help:UI manual#Блокировка разметки маркеров|снять его блокировку]]
|| + || – || –

|-
| Создание резервных копий
|| Создание, просмотр и восстановление резервных копий в интерфейсе командной строки
|| –
|| + || – || –

|-
| Запуск скриптов
|| Запуск скриптов (hooks) по кнопке, расположенной на вкладке '''Подробности''' в правой панели, содержащей информацию о маркере
|| Наличие полномочия добавляет строку '''Хуки''' на вкладке '''Подробности''' правой панели с возможностью запуска скриптов
|| + || – || –
|}

=== Проектные доступы===
{| class="wikitable"
! Полномочие (доступ) !! Описание !! Влияние на графический интерфейс !! admin !! filter_master !! importer
|-
| Управление проектом и его ветками
|| Редактирование и удаление проекта, включая операции по управлению ветками и снимками проекта, настройке глобальных фильтров, импорту/экспорту разметки и просмотру маркеров
|| Наличие полномочия делает доступным:
* раздел [[Help:UI manual#Управление проектами и группами проектов|'''Проекты''']];
* все функции управления проектом (проектами в группе) и его содержимым (за исключением разметки маркеров) – т. е. все операции с проектом, ветками и снимками.
Наличие полномочия позволяет удалять приложения к снимкам и экспортировать разметку с исходным кодом
|| + || – || –

|-
| Управление ветками и снимками
|| Редактирование и удаление ветки проекта, включая операции по управлению снимками, настройке глобальных фильтров, импорту/экспорту разметки и просмотру маркеров
|| Наличие полномочия делает доступным:
* раздел [[Help:UI manual#Управление проектами и группами проектов|'''Проекты''']];
* все функции управления веткой и снимками проекта (за исключением разметки маркеров) – т. е. доступны все операции с веткой и снимками, но не операции управления проектом.
Наличие полномочия позволяет удалять приложения к снимкам и экспортировать разметку с исходным кодом.
Запрещено клонировать ветку при наличии доступа только к этой ветке
|| + || – || –

|-
| Настройка глобальных фильтров
|| Создание, редактирование и удаление глобальных фильтров
|| Наличие полномочия делает доступным раздел [[Help:UI manual#Настройка глобальных фильтров|'''Настройки – Глобальные фильтры''']].
Список проектов и веток в разделе определяется полномочиями к этим проектам и веткам
|| + || + || –

|-
| Импорт снимков
|| Загрузка, редактирование названия и удаление снимков
|| Наличие полномочия делает доступным:
* раздел [[Help:UI manual#Управление проектами и группами проектов|'''Проекты''']];
* функции просмотра проекта и ветки, управления снимками в указанной ветке (включая импорт .svace-dir, SARIF и *.snap), просмотра маркеров в указанном контейнере
|| + || – || +

|-
| Импорт разметки
|| Импорт разметки из файла и комментариев в исходном коде
|| Наличие полномочия делает доступным импорт разметки из файла, импорт разметки из комментариев исходного кода снимка и просмотр маркеров в указанном контейнере
|| + || – || +

|-
| Экспорт снимков
|| Экспорт данных снимков с разметкой и их открытие в IDE
|| Наличие полномочия позволяет:

* экспортировать разметку с исходными кодами;
* экспортировать снимки в форматах *.snap и SARIF;
* просматривать код с маркерами в Web-IDE
|| + || – || +

|-
| Просмотр маркеров
|| Просмотр маркеров и кода снимков, просмотр блокировок маркеров
|| Наличие полномочия предоставляет доступ к следующим функциям [[Help:UI manual#Работа в режиме разметки|в режиме разметки]]:
* просмотр и выбор снимков в указанном контейнере;
* просмотр содержимого снимков и маркеров (без возможности разметки).
Также наличие полномочия предоставляет доступ к разделу [[Help:UI manual#Управление блокировками разметки|'''Настройки – Блокировки''']], но только в части просмотра блокировок в доступных контейнерах, без возможности их удаления
|| + || + || +

|-
| Разметка маркеров
|| Просмотр и разметка маркеров в снимках, включая добавление комментариев, управление списком блокировок
|| Наличие полномочия позволяет пользователю размечать маркеры в указанном контейнере, добавлять комментарии, управлять своими блокировками, т. е. для собственных блокировок доступны кнопки удаления, а блокировки других пользователей доступны только для просмотра.
При отсутствии полномочия в таблице маркеров недоступны поля для установки флажков, а кнопка групповой разметки – неактивна.
Для разметки маркеров с помощью AI совместно с данным доступом должен быть активен доступ '''Импорт разметки'''
|| + || – || –

|-
| Report API
|| Использование Report API для получения статистических показателей
|| –
|| + || – || –
|}

=== Известные ограничения ===

* Управление ''своими'' проектами для пользователей только c серверной ролью "Create Projects" без дополнительных прав может не работать для проектов, созданных до Release 7-0-0.
: Workaround: добавить пользователю явно проектные доступы на каждый необходимый проект.

Notifications

2025-12-03T10:33:23Z

Akuzmin: fix page link (installation > configuration)

== Механизм подписок на внутренние события Svacer ==

=== Общие принципы ===

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

* Электронная почта
* Индивидуальный чат пользователя мессенджера telegram с ботом

Существует три класса внутренних событий, на которые возможно получение оповещения:

* разметка маркера(ов), в том числе групповая (REVIEW)
* создание/редактирование и удаление комментария к маркеру (COMMENT)
* добавление/удаление снимков (SNAPSHOT)
* удаление контейнеров (веток, проектов)

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

* Цель
* Класс события
* Флаг
* Тип подписки

'''Цель''' – определяет объект, в отношении которого должно произойти событие, чтобы пользователь получил оповещение. Возможна подписка на проекты и ветки 
'''Класс события''' – определяет один из трех классов события, описанных выше (кроме удаления контейнеров) 
'''Флаг''' – дополнительное условие к активации подписки. Возможны следующие значения: 
:''Участие'' – подписка приведет к созданию сообщения пользователю только в том случае, если в указанной цели есть какая-либо активность пользователя (разметка или комментарий), кому подписка принадлежит 
'''Тип подписки''' – подписка может иметь "исключающее" свойство, когда она подавляет создание сообщений. Полезно при исключении некоторых целей из списка срабатывания (например, когда есть подписка на проект, но некоторые ветки не требуют внимания)

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

==== Некоторые детали работы механизма подписок ====

Механизм подписок может удерживать некоторые сообщения, накапливая их в очереди, для минимизации числа соединений с сервером (почтовым или telegram). Отправка сообщений происходит 1 раз в 30 секунд, в связи с чем могут быть задержки с получением сообщений.

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

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

Для предотвращения создания большого количества соединений с почтовым сервером (при активной работе пользователей или средств автоматизации) возможно использование специального флага в конфигурации – saveConection, который позволяет переиспользовать уже созданное ранее соединение с почтовым сервером. Соединение закрывается автоматически через 10 секунд простоя.

Для отправки сообщений через мессенджер telegram сервер Svacer требует идентификатор заранее созданного бота. При этом бот используется только для отправки сообщений и не находится в запущенном состоянии постоянно (нет постоянного соединения с серверами telegram).

=== Конфигурация ===

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

<pre class="">subscription:
enabled: true
trace: false
advanced:
transport_queue_len: 256
transport_worker_period: 30000000000
trace_dir: /tmp
telegram:
enabled: true
botID: "7865.........."
mail:
enabled: true
smtpAddress: "smtp.local"
smtpPort: 25
smtpUsername: ""
smtpPassword: ""
caCerts: ""
smtpAuth: "noauth"
from: "mailer@local"
tls: true
saveConnection: false
debug: false</pre>

{{Note|type=reminder|text=При конфигурировании службы необходимо явно указать значение advanced.transport_worker_period для избежания проблемы повышенной загрузки CPU. Значение указывается в наносекундах}}

==== Описание параметров конфигурации ====

{|
| subscription.enabled
| Состояние службы при старте сервера Svacer
|-
| subscription.trace
| Позволяет фиксировать работу службы в виде набора файлов, создаваемых во временной папке ОС (/tmp/ для ОС Linux)
|-
| telegram.enabled
| Состояние канала доставки сообщений посредством мессенджера telegram при запуске сервера
|-
| telegram.botID
| Идентификатор бота, который будет использован для отправки сообщений
|-
| mail.enabled
| Состояние канала доставки сообщений с помощью электронной почты при запуске сервера
|-
| mail.smtpAddress
| Адрес почтового сервера, который будет использован для отправки сообщений
|-
| mail.smtpPort
| Параметр, задающий порт на котором работает почтовый сервер. По умолчанию используется значение 25
|-
| mail.smtpAuth
| Параметр, задающий тип аутентификации, используемой клиентом. Возможны варианты: noauth, plain, login
|-
| mail.smtpUsername (mail.smtpPassword)
| Параметры, задающие учетную запись от имени которой будет происходить рассылка сообщений. В случае аутентификации noauth, должны быть указаны пустые значения
|-
| mail.caCerts
| Параметр, задающий сертификаты CA. Значения поля аналогичны значениям соответствующего поля из конфигурации сервера для работы по протоколу TLS (нативный режим). Если указано пустое значение, то поддержка TLS будет сконфигурирована в небезопасном режиме с доверием любому сертификату сервера
|-
| mail.from
| Поле, указывающее почтовый адрес, от имени которого будет осуществлять рассылка
|-
| mail.tls
| Использовать или нет tls для соединения с сервером
|-
| mail.debug
| Выводить отладочную информацию протокола взаимодействия с почтовым сервером
|-
| saveConnection
| Сохранять уже установленное соединение с почтовым сервером (в течении 10 секунд после последней активности)
|-
|advanced.transport_queue_len
|Значение по умолчанию — 256. Определяет максимальный размер буфера накапливаемых сообщений. Если буфер полный, новые сообщения будут игнорироваться (о чем будет сообщение в логах сервера)
|-
|advanced.transport_worker_period
|Значение по умолчанию — 30. Определяет период срабатывания очереди сообщения в наносекундах
|-
|advanced.trace_dir
|Значение по умолчанию определяется типом системы (Для Linux — /tmp). Позволяет указать папку, в которой будут размещаться отладочные файлы работы службы оповещений
|}

{{Note|type=reminder|text=Для работы службы необходимо запускать Svacer с опцией '''[[Help:Configuration#Указание_public-url|public-url]]'''. Без указания этой опции служба не будет активирована, так как создаваемые в процессе ее работы ссылки должны содержать правильные URL}}

==== Особенности работы почтового клиента, используемого Svacer ====

''Поддержка TLS''. Если флаг mail.tls установлен, то соединение с сервером изначально будет установлено по протоколу TLS. В противном случае, изначально будет установлено обычное TCP соединение, и уже после команды STARTTLS стороны перейдут на протокол TLS. В случае если TLS соединение не сможет быть установлено, клиент будет пытаться работать без TLS соединения.

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

svacer subscription transport mail test --config mail.yaml

=== Команды CLI для работы с механизмом подписок ===

Все команды собраны в группу ''svacer subscription''. Доступны следующие подкоманды:

* <code>transport</code> – функции по работе (конфигурации) используемых механизмов доставки сообщений (mail, tg)
* <code>profile</code> – управление профилем подписки пользователя
* <code>admin</code> – управление службой подписок
* <code>create</code> – cоздание новой подписки
* <code>list</code> – просмотр списка подписок
* <code>delete</code> – удаление подписок
* <code>update</code> – обновление существующей подписки

==== Команды управления подписками ====

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

* <code>create</code> – создание подписки
* <code>list</code> – перечесление подписок пользователя
* <code>delete</code> – удаление подписки
* <code>update</code> – редактирование подписки

{{Note|text=Во всех командах присутствуют стандартные для CLI Svacer флаги подключения к серверу (--host, --port, --grpc, --user, --password, --ssl и другие). Группа этих флагов в дальнейшем будет обозначаться как [svacer_conn]}}

===== Создание подписки (команда 'create') =====

Общий формат команды:

svacer subscription create [svacer_conn] [опции]

'''Опции:'''

* <code>project</code> – имя или ID проекта
* <code>branch</code> – имя или ID ветки
* <code>marker</code> – ID маркера
* <code>exclude</code> – подписка имеет исключающий характер (по умолчанию <code>false</code>)
* <code>my-activities</code> – оповещение только в случае событий на маркерах, где была собственная активность (разметка, комментарий) (по умолчанию <code>false</code>)
* <code>review</code> – подписаться на события REVIEW
* <code>snapshot</code> – подписаться на события SNAPSHOT
* <code>comment</code> – подписаться на события COMMENT
* <code>all-events</code> – подписаться на все классы событий

{{Note}} При создании подписки важно указывать имена или ID одновременно во всех требуемых флагах. Например, команда:

svacer subscription create --project darpa --branch 1111-2222-333333333

не будет корректно обработана. При использовании ID цели можно не указывать родительские сущности (например, проект для ветки)

'''Пример использования:'''

Подписаться на события REVIEW в проекте "MyProject" и ветке "MyBranch":

<pre class="">svacer subscription create --project MyProject --branch MyBranch --review</pre>
Подписаться на все события в проекте "MyProject":

<pre class="">svacer subscription create --project MyProject --all-events</pre>

===== Получение списка подписок (команда list) =====

Общий формат команды:

svacer subscription list [svacer_conn] [опции]

'''Опции:'''

* <code>all</code> – вывести все подписки всех пользователей (требуется роль admin)
* <code>humanize</code> – вывести в удобном для чтения виде

'''Пример использования:'''

Вывести все подписки пользователя 'user' в формате JSON (по умолчанию):

<pre class="">svacer subscription list --user user --password 1234</pre>
Вывести все подписки пользователя 'user' в удобном формате

<pre class="">svacer subscription list --user user --password 1234 --humanize</pre>
Вывести все подписки всех пользователей

<pre class="">svacer subscription list --user admin --password admin --all --humanize</pre>

===== Удаление подписки (команда delete) =====

Общий формат команды:

svacer subscription delete [svacer_conn] [опции]

'''Опции:'''

* <code>all</code> – удаление всех подписок пользователя
* <code>id</code> – удаление конкретной подписки

'''Пример использования:'''

Удалить подписку пользователя user1

svacer subscription delete --user user1 --password 1234 --id 1234

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

===== Обновление подписки (команда update) =====

Общий формат команды:

svacer subscription update [svacer_conn] [опции]

'''Опции:'''

* <code>id</code> – ID подписки для обновления
* <code>only-my-activities</code> – установка флага my-activities для подписки (по умолчанию <code>false</code>)

'''Пример использования:'''

Установить флаг my-activities для подписки, ID которой начинается с символов f1f2

<pre class="">svacer subscription update --id f1f2 --only-my-activities true</pre>

==== Команды настройки и управления каналами доставки сообщений ====

В Svacer поддерживаются два канала доставки сообщений — электронная почта и мессенджер Telegram. Для облегчения конфигурации данных каналов используются подкоманды команды <code>svacer subscription transport</code>

* <code>mail</code>

'''Подкоманда 'mail''''

Предназначена для облегчения конфигурации почтового клиента Svacer. Общий формат команды:

svacer subscription transport mail [опции]

'''Опции:'''

* <code>--to</code> — почтовый адрес для отправки тестового сообщения
* <code>--config</code> — секция mail конфигурационного файла в формате YAML

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

<pre class=""> enabled: true
smtpAddress: "smtp.mail.local"
smtpPort: 25
smtpUsername: ""
smtpPassword: ""
smtpAuth: "noauth"
from: "sender@mail.local"
debug: true</pre>

'''Пример использования:'''

Отправить тестовое письмо на адрес <code>admin@mail.org</code>, используя конфигурацию <code>test.yaml</code>

<pre class="">svacer subscription transport mail test --config test.yaml --to admin@mail.org</pre>

==== Группа команд администрирования службы (admin) ====

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

* <code>service</code> – управление службой подписок 
Общий формат команды:

svacer subscription admin service [svacer_conn] [опции]

'''Опции'''

* <code>enable</code> – включение/выключение службы
* <code>use-mail</code> – включение/выключение канала передачи сообщений через электронную почту
* <code>use-tg</code> – включение/выключение канала передачи сообщений через Telegram

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

{{Note|text=При использовании флагов use-mail, use-tg не происходит повторное считывание конфигурационного файла. Для того, чтобы флаги use-mail и use-tg корректно применились их необходимо запускать одновременно с флагом --enable true, предварительно отключив службу с помощью флага --enable false}}

==== Группа команд управления профилем пользователя (profile) ====

Команда предназначена для управление профилем пользователя и имеет следующий формат:

svacer subscription profile [svacer_conn] [update] [опции]

'''Опции (актуальны для подкоманды update):'''

* <code>use-mail</code> – использовать канал передачи сообщений через электронную почту
* <code>use-tg</code> – использовать канал передачи сообщений через Telegram
* <code>mail</code> – изменить почтовый адрес
* <code>tg-chat-id</code> – установить ID чата для сообщений Telegram
* <code>tg-user-id</code> – установить ID пользователя для сообщений Telegram
* <code>enable</code> – включение/отключение механизма оповещения для конкретного пользователя

Если опции и подкоманда <code>update</code> не указаны, то будет выведен текущий профиль пользователя.

=== Пример скрипта для создания подписок пользователей ===

<pre class="">#!/bin/bash -x
#Общие параметры подключения к Svacer
HOST="--host 10.0.0.10 --port 8888"
#Тестовые проекты
PROJECT1="NET6"
PROJECT2="darpa"
PROJECT3="large"
PROJECT3_BRANCH1="master"
#Параметры аутентификации пользователей
USER1="--user admin_1 --password password"
USER2="--user admin_2 --password password"
USER3="--user admin_3 --password password"
USER4="--user admin_4 --password password"
USER5="--user admin_5 --password password"
USER6="--user admin_6 --password password"
USER7="--user admin_7 --password password"
#ID пользователя в Telegram
TG_USER_ID=721941843
TG_CHAT_ID=$TG_USER_ID

#Команда создания подписки
CREATE_SN="./svacer subscription create"

#User1 - подписка на все, но с флагом myactivities
$CREATE_SN $HOST $USER1 --all-events --my-activities
#User2 - подписка на проект1, только снимки
$CREATE_SN $HOST $USER2 --project $PROJECT1 --snapshot
#User2 - подписка на проект2, только разметка
$CREATE_SN $HOST $USER2 --project $PROJECT2 --review
#User2 - подписка на проект3, только комментарии
$CREATE_SN $HOST $USER2 --project $PROJECT3 --comment
#User3 - подписка на проект3, исключая ветку1, все события
$CREATE_SN $HOST $USER3 --project $PROJECT3 --all-events
$CREATE_SN $HOST $USER3 --project $PROJECT3 --branch $PROJECT3_BRANCH1 --exclude
#User4 - подписка на проект2, все события
$CREATE_SN $HOST $USER4 --project $PROJECT2 --all-events
#User5 - подписка на проект3, все события
$CREATE_SN $HOST $USER5 --project $PROJECT3 --all-events
#User6 - подписка на все проекты, все события
$CREATE_SN $HOST $USER6 --all-events
#User7 - подписка на все проекты, все события
$CREATE_SN $HOST $USER7 --all-events

#Команда работы с профилем
ENABLE_NTFY_MAIL="./svacer subscription profile"
#User1, включить получение сообщений по почте, по Telegram, установить адрес электронной почты для сообщений, указать ID пользователя для получения сообщений в Telegram
$ENABLE_NTFY_MAIL $HOST $USER1 update --enable true --use-mail true --mail user1@mb1lo.ru --use-tg true --tg-user-id $TG_USER_ID --tg-chat-id $TG_CHAT_ID
#User2, отключить получение всех сообщений (подписки останутся)
$ENABLE_NTFY_MAIL $HOST $USER2 update --enable false
#User3, отключить получение собщений по Telegram
$ENABLE_NTFY_MAIL $HOST $USER3 update --use-tg false
#User4, изменить параметры канала Telegram
$ENABLE_NTFY_MAIL $HOST $USER4 update --tg-user-id $TG_USER_ID --tg-chat-id $TG_CHAT_ID</pre>

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

<pre class="">subscription:
enabled: true
telegram:
enabled: true
botID: "7861931704:AAEHfp035U10pJk0lIjo1lYJj1e837qv7j4"
mail:
enabled: true
smtpAddress: "mail-server.ispras.ru"
smtpPort: 25
smtpUsername: ""
smtpPassword: ""
smtpAuth: "noauth"
from: "relay@ispras.ru"</pre>

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

<pre class="">subscription:
enabled: true
telegram:
enabled: true
botID: "7861931704:AAEHfp035U10pJk0lIjo1lYJj1e837qv7j4"
mail:
enabled: true
smtpAddress: "mail.ispras.ru"
smtpPort: 25
smtpUsername: "user@ispras.ru"
smtpPassword: "abrakadabra"
smtpAuth: "plain"
from: "user@ispras.ru"</pre>

В следующем примере устанавливается соединение TLS с почтовым сервером

<pre class="">subscription:
enabled: true
telegram:
enabled: true
botID: "7861931704:AAEHfp035U10pJk0lIjo1lYJj1e837qv7j4"
mail:
enabled: true
smtpAddress: "mail.ispras.ru"
smtpPort: 465
smtpUsername: "user@ispras.ru"
smtpPassword: "abrakadabra"
smtpAuth: "plain"
from: "user@ispras.ru"
tls: true</pre>

В следующем примере устанавливается соединение TLS с помощью команды STARTTLS с почтовым сервером (в консоль будут также выведены отладочные сообщения почтового клиента)

<pre class="">subscription:
enabled: true
telegram:
enabled: true
botID: "7861931704:AAEHfp035U10pJk0lIjo1lYJj1e837qv7j4"
mail:
enabled: true
smtpAddress: "mail.ispras.ru"
smtpPort: 587
smtpUsername: "user@ispras.ru"
smtpPassword: "abrakadabra"
smtpAuth: "plain"
from: "user@ispras.ru"
tls: false
debug: true</pre>

При этом сервер mail.ispras.ru работает на всех портах: на 465 принимаются только TLS соединения, на 587 — обычные соединения с переходом на TLS впоследствии, на 25 — обычные соединения (без TLS)

=== Пример конфигурации службы с запуском ее вручную через команду cli ===

<pre class="">subscription:
enabled: false
telegram:
enabled: true
botID: "7861931704:AAEHfp035U10pJk0lIjo1lYJj1e837qv7j4"
mail:
enabled: true
smtpAddress: "mail.ispras.ru"
smtpPort: 587
smtpUsername: "user@ispras.ru"
smtpPassword: "abrakadabra"
smtpAuth: "plain"
from: "user@ispras.ru"
tls: false</pre>
После запуска сервера Svacer можно активировать службу с помощью команды

<pre class="">svacer subscription admin service --user admin --password admin --enable true</pre>

Pipelines

2025-12-03T10:19:36Z

Akuzmin: fix page link (installation > configuration)

=== Статический анализ и загрузка результатов ===
Самый базовый пример пайплайна Gitlab-CI. Сборка и анализ запускаются в докер-контейнере, где уже установлен Svace, Svacer и базовые пакеты для сборки (метапакет build-essential). Репозиторий в пайплайне не клонируется, поскольку файл пайплайна .gitlab-ci.yml уже находится в анализируемом репозитории.

<pre>
image: registry.ispras.ru/demo/docker-images/ubuntu-svace-svacer:focal-3.4.240902-9.0.2

analyze:
stage: build

script:
- ./configure
- /opt/svace/bin/svace build --init make
- /opt/svace/bin/svace analyze
- /usr/bin/svacer import --svace /opt/svace/bin/svace --project bash
- /usr/bin/svacer upload --host https://svacer.ispras.ru
</pre>

=== Использование quality gate ===

{{Note|text=В версии 9.х.х был баг в quality-gate: он всегда возвращал 0, даже если задан другой exit code. В версии 10.0.0 это исправили.}}

В этом примере пайплайна из Gitlab-CI после этапов сборки и анализа запускается импорт результатов с указанием имен проекта, ветки и снимка, взятых из CI-переменных, а при загрузке используется quality-gate, который меняет статус пайплайна в зависимости от результатов статического анализа.

<pre>
image: registry.ispras.ru/demo/docker-images/ubuntu-svace-svacer:focal-3.4.240902-9.0.2

analyze:
stage: build

tags:
- docker
- linux

script:
- apt update
- apt install -y git python3 pkg-config mesa-common-dev libgl-dev libglu1-mesa-dev freeglut3-dev libx11-dev libxi-dev libxrandr-dev
- git clone --recurse-submodules -j`nproc` https://github.com/ArtifexSoftware/mupdf.git
- cd mupdf
- /opt/svace/bin/svace build --init make -j`nproc`
- /opt/svace/bin/svace analyze
- /usr/bin/svacer import --svace /opt/svace/bin/svace --project "${CI_PROJECT_NAMESPACE}-${CI_PROJECT_NAME}" --branch $CI_COMMIT_REF_NAME --snapshot "$CI_COMMIT_SHORT_SHA - `date -R`"
- /usr/bin/svacer upload --host https://svacer.ispras.ru --quick-stats --quality-gate total:critical:0 --quality-gate-exit-code 1

allow_failure:
exit_codes:
- 1
</pre>

* В начале ставятся специфические зависимости, необходимые для сборки mupdf
* Клонируется репозиторий с его сабмодулями
* Запускается сборка с перехватом ее статическим анализатором (svace build)
* Запускается анализ (svace analyze)
* После фазы анализа запускается импорт данных анализа в Svacer (svacer import). На этом этапе указывается имя проекта, ветки и снимка, которые будут отображаться в интерфейсе Svacer-сервера после загрузки. Имена берутся из CI-переменных гитлаба, к имени снимка добавляется текущая дата
* На этапе загрузки (svacer upload) добавляются две опции: '''quality-gate''' и '''quality-gate-exit-code''' ([[Help:Import_from_Svace#Использование_quality_gate|документация по quality gate]])
:* <code>--quality-gate total:critical:0</code> — quality gate сработает, если статическим анализатором будут найдены предупреждения с severity:critical
:* <code>--quality-gate-exit-code 1</code> — в случае срабатывания quality gate команда вернет exit code 1
* Далее в пайплайне указываем, что exit code 1 считается как допустимый failure. Гитлаб в этом случае отобразит статус пайплайна '''Warning'''. Если quality gate не сработает (предупреждений с severity:critical не будет найдено), пайплайн завершитcя со статусом '''Passed'''

[[File:Pipeline-warning.png|frame|none]]

{{Note|text=Для корректной работы опций <code>--quality-gate</code> и <code>--quick-stats</code> при использовании reverse proxy, в частности Nginx, для gRPC порта Svacer, необходимо в настройках секции http или server добавить инструкцию:
underscores_in_headers on;
См. [[Help:Configuration#Nginx|пример конфига]]}}

Changelog

2025-12-03T10:18:07Z

Akuzmin: fix page link

=== Release 12-0-0 ===
28.11.2025

* API методы на fullmarkers позволяют [[Help:Public_API#Примеры_использования_фильтров_в_public_api|указать фильтр]] с полем фильтрации по checker reliability
* В функциональность полнотекстового поиска добавлен поиск маркеров по id и инварианту
* Промежуточное хранилище при импорте результатов командой <code>svacer import / svacer sarif2 import</code> теперь использует новый формат представления. Это должно снизить использование памяти при импорте
* Сериализация JSON переведена на jsonv2 библиотеку в Go
* Импорт SARIF теперь более устойчив к пропускам в файле (отсутствие таких полей как location)
* Добавлены переменные окружения <code>SVACER_TIMEOUT_IMPORT_RESULTS</code> для [[Help:Configuration#Переменные_окружения|контроля таймаута]] на ожидание начала импорта результатов и <code>SVACER_NUM_PARALLEL_IMPORTS</code> на [[Help:Configuration#Переменные_окружения|ограничение числа параллельных импортов]]. По умолчанию значения 15 минут и <code>(максимальное число коннектов к БД) / 2</code>. Ограничения необходимы для предотвращения бесконечных ожиданий и зависаний при импорте данных
* Убраны лишние сообщения об устаревших детекторах при старте сервера или импорте снимков
* В метрики Prometheus добавлен ряд показателей размеров object store
* Размер лога сервера, показываемого в Web-интерфейсе, ограничен. Размер [[Help:Configuration#Переменные_окружения|задается переменной окружения]] SVACER_TAIL_LOG_SIZE (по умолчанию 1Мб). Показывается последний кусок не более SVACER_TAIL_LOG_SIZE. Сам лог файл не ограничивается в размерах и кнопка выгрузки лога выгружает полный лог
* ['''Экспериментально'''] Можно [[Help:Configuration#Переменные_окружения|указать JSON-формат]] лог-файла посредством параметра <code>svacer-server --log-format=json ...</code>, также формат может быть указан через переменную окружения <code>SVACER_LOG_FORMAT=json</code>. Опции также работают для CLI-клиента svacer
* При запуске сервера можно указать флаг <code>--force-invariant-refresh</code> для принудительной регенерации инвариантов. Это может решить проблему с переносом разметки
* Добавлена переменная окружения SVACER_INV_GEN_JOBS для контроля числа параллельных заданий при регенерации инвариантов. При ограниченных ресурсах машины рекомендуем ставить значение 2. По умолчанию значение ставится в 70% от <code>runtime.GOMAXPROCS</code>
* Добавлена функциональность по чистке object store при удалении снимков
* Добавлена возможность создания [[Afilters|сложных пользовательских фильтров]] по условиям, выраженным предикатом
* Проведена работа по предотвращению зависаний при исчерпывании доступных соединений с PostgreSQL сервером
* Добавлен файл с чексуммой бинарника сервера <code>svacer-server</code> и проверка чексуммы при запуске
* Упростили [[Help:XSvacer:AIAssistant#Активация_и_запуск_ИИ-ассистента|деплой ИИ-ассистента]]: добавили его сервис в docker-compose и deb/rpm пакеты
* Расширили возможности конфигурации при запуске сервера через [https://svacer.ispras.ru/extra/docker-compose.yml docker-compose]: теперь можно включить debug, указать конфиг LDAP и параметр public-url
* Добавлена возможность указания минимального количества снимков, которое необходимо оставлять в ветке, тип очистки и период удаления в [[Help:CLI/cleanup|автоматическом удалении снимков]]
* ['''Экспериментально'''] Добавлена возможность [[Edit markers (command line)|автоматически обрабатывать маркеры]] при импорте данных. Также обработка маркеров доступна через [[Help:UI manual#Работа со снимками|UI]]
* Добавлен флаг <code>diff-url</code> для команды <code>quickdiff</code> в CLI, также как и для команд <code>import</code>, <code>upload</code>, <code>sarif2 import</code> с указанием опции <code>quick-stat</code>. Данный флаг позволяет получать ссылку на diff снимков
* Добавлены предупреждения если в командах <code>import</code>, <code>sarif2 import</code> используются флаги, которые используются флагом <code>upload</code>, но флаг <code>upload</code> не установлен
* Добавлена интеграция с внешними системами посредством механизма [[Help:Configuration#Механизм интеграции с внешними системами посредством Webhook-ов|Webhooks]]
* Добавлена [[Help:Configuration#Настройка защиты от перебора паролей пользователей|защита от перебора пароля пользователя]]
* Добавлена возможность задать [[Help:Configuration#Настройка парольной политики внутреннего механизма аутентификации Svacer|парольную политику безопасности]] для пользователей, использующих встроенный механизм аутентификации Svacer
* Добавлена возможность задать [[Help:Configuration#Задание вкладки по умолчанию на странице входа в GUI Svacer (а также отключение внутреннего механизма аутентификации Svacer)|вкладку по умолчанию]] для страницы входа в систему
* Исправлена ошибка, приводящая к разрастанию базы данных
* Исправлена ошибка, связанная с невозможностью в ряде случаев использовать механизм подписок
* Форма [[Help:UI_manual#Разметка_маркера_с_помощью_ассистента_AI|разметки]] с помощью [[Help:XSvacer:AIAssistant|ИИ-ассистента]] реализована в основном интерфейсе Svacer
* [[Help:XSvacer:Webide#Запуск функциональности при использовании docker compose|Упрощён запуск функциональности Webide]] при запуске сервера через [https://svacer.ispras.ru/extra/docker-compose.yml docker-compose]

=== Release 11-2-0 ===
22.07.2025

* Исправлены зависания сервера
* Добавлено автоматическое удаление архивов и прочих временных файлов при импорте .svace-dir и SARIF-файлов через REST API

=== Release 11-1-0 ===
08.07.2025

* Команды <code>--project-group, --if-no-group, --autoclean, --autoclean-svace</code> можно использовать в REST API для импорта svace-dir
* При использовании REST API для импорта svace-dir сервер будет автоматически удалять директории <code>.svace-dir</code> и <code>.svacer</code> если не указаны явные опции <code>--autoclean=false, --autoclean-svace=false</code>
* Добавлена опция запуска сервера <code>--classic-inv-mode</code> для включения режима совместимости по генерации инвариантов с версией <= 8.x.x
* Исправлены ошибки в работе <code>--quality-gate</code>, добавлена возможность учета статусов разметки. Добавлена возможность [[Help:Import from Svace#Флаг --baseline|указания baseline]] для сравнений при использовании опции <code>--quality-gate</code>
* Исправлены ошибки при подключении к PostgreSQL в SSL-режиме
* Исправлен ряд ошибок при работе с LDAP
* Команда <code>quickdiff</code> в CLI теперь выдает информацию также о Same и Matched предупреждениях

=== Release 11-0-0 ===
19.05.2025

* Убраны излишние сообщения в логе сервера о login/logout операциях. Они будут выводиться только при запуске сервера с опцией <code>--debug</code>
* Команды CLI <code>svacer sarif *</code> были убраны, для [[Help:Sarif|импорта и экспорта]] следует использовать <code>svacer sarif2 *</code>
* Экспорт SARIF теперь включает все комментарии как отдельные объекты в <code>Properties</code>
* При экспорте в SARIF теперь экспортируются поля <code>Labels, Orig function</code>
* Импорт SARIF теперь корректным образом учитывает relatedLocations и формирует трассу
* Импорт SARIF теперь автоматически импортирует исходники, если они включены в сам SARIF файл
* Добавлена возможность указания [[Help:Sarif#Мэппинг severity|мэппинга severity]] детекторов при импорте из SARIF
* Добавлен механизм указания правил резолвинга путей при импортировании исходного кода вместе с SARIF файлом
* Экспорт исходников из снимка будет доступен только при наличии исходников на сервере
* Добавлены флаги <code>--autoclean</code>, <code>--autoclean-svace</code> в команду <code>svacer import</code> для автоматического удаления <code>.svace-dir / .svacer-dir</code> после успешного импорта и загрузки данных на сервер
* Улучшена поддержка [[OIDC]]
* Улучшена поддержка [[LDAP configuration|LDAP]]
* Добавлена интеграция с хранилищем секретов [[Infisical]]
* Добавлена [[Notifications|служба нотификаций]] пользователей через почтовые сообщения и мессенджер telegram
* Добавлен механизм аутентификации и [[Help:UI manual#Управление токенами доступа|управления]] персональными токенами доступа
* Добавлен механизм упоминания пользователей через специальную конструкцию @login в комментариях к разметке
* В разделе Статистика добавлен дашборд с [[Release notes 11-0-0#Изменения в разделе Статистика|Общей статистикой]], содержащей метрики по последним импортированным снимкам в ветках проектов
* В статистике по активности пользователей добавлена возможность просмотра панели с актуальной информацией о маркере и опция показа только действий с актуальной разметкой
* Большинство CLI команд, работающих с сервером, теперь делают явный logout после завершения
* Svacer при импорте результатов Svace автоматически импортирует файлы <code>*.warn, *.err</code> с предупреждениями от самого анализатора Svace. Автоматический импорт не будет происходить при размере этих файлов более 30Мб (большой размер может свидетельствовать о проблемах в ходе анализа)
* Переменная окружения <code>SVACER_CACHE_DIR</code> теперь учитывается во всех местах (ранее в ряде случаев мог неявно использоваться <code>$HOME/.cache</code>)
* Добавлена возможность [[Help:CLI/cleanup|автоматического удаления снимков]]

=== Release 10-0-1 ===
17.02.2025

* Исправлена ошибка с временной таблицей при обработке планов автомиграции разметки при импорте результатов (ERROR: relation "loaded_review" already exists)

=== Release 10-0-0 ===
16.01.2025

* Множество изменений в UI, смотрите [[Release notes 10-0-0]]
* Сделали [[Help:Installation#deb/rpm|dnf/yum репозиторий]] для RPM-пакетов Svacer
* Реализована возможность [[Markup2|экспорта, импорта и копирования разметки посредством Public REST API и CLI]]
* Реализован дополнительный экспериментальный механизм [[Help:UI manual#Настройка интерфейса|генерации PDF на основе HTML]]. Генерация PDF переведена на асинхронный режим с показом нотификации пользователю
* Добавлена возможность очистки всей разметки и/или комментариев на ветке проекта
* Улучшения функциональности просмотра маркеров в встроенном IDE Theia
* Добавлена функциональность по [[Help:UI manual#Глобальный поиск|глобальному поиску]] маркеров, комментариев и снимков по различным атрибутам
* Добавлена возможность [[Help:UI manual#Просмотр статистики|получения статистики]] по маркерам и активностям пользователей при разметке
* В API fullmarkers добавлен параметр <code>labels: true/false</code> для выгрузки меток маркера
* Реализован Public API для получения/добавления/удаления меток маркеров
* Настройки LDAP и прочие настройки аутентификации добавлены в единый конфигурационный файл
* Добавлена возможность удаления кода из снимка при частичном импорте в Svacer
* Добавлена опция minVersion, maxVersion для TLS при запуске сервера Svacer
* Добавлена поддержка групп проектов при импорте снимков в CLI
* При импорте снимков реализована поддержка автоматического определения пути префикса для переноса разметки
* Исправлен ряд ошибок в импорте и генерации [[Help:Sarif|SARIF]]
* Исправлены ошибки в копировании разметки между ветками, клонировании проектов и веток
* Добавлена возможность отключения бэкграунд задач по очистке мусора
* Добавлено экспериментальное CLI API для просмотра асинхронных задач на генерацию PDF
* Добавлена возможность визуализации производительности сервера на основе [https://github.com/arl/statsviz statsviz]
* Добавлена поддержка относительных путей в svres файле
* Добавлена возможность ожидания завершения операций по очистки мусора при выполнении операций по импорту результатов анализа
* Добавлена поддержка CWE таксономий при экспорте [[Help:Sarif|SARIF]]
* Добавлена переменная окружения SVACER_TOKEN_LIFETIME для управления временем жизни токена аутентификации
* Добавлена переменная окружения SVACER_RESET_ADMIN_PASSWORD для явного указания желаемого пароля при операции по сбросу пароля администратора
* Добавлен [[Notifications|механизм нотификаций пользователей]] о внутренних событиях Svacer (экспериментальный функционал)

=== Release 9-0-2 ===
22.07.2024

* Еще некоторые исправления, связанные с миграцией данных
* Исправлена проблема с навигацией по Go to Definition

=== Release 9-0-1 ===
15.07.2024

* Исправлены ошибки в клонировании проектов, приводящие к размножению записей в некоторых внутренних таблицах
* Различные исправления, связанные с миграцией данных
* Исправлена работа ряда CLI команд с включенным TLS на сервере
* Исправлен ряд ошибок в генерации PDF

=== Release 9-0-0 ===
04.06.2024

* Множество изменений в UI, смотрите [[Release notes 9-0-0]]
* Svacer разделен на два исполняемых файла: <code>svacer-server</code> — сервер и <code>svacer</code> — клиент
* {{Note}}Object store заменен на другую реализацию. Конвертация данных запускается автоматически при апгрейде и требует примерно 2х-2.2х дискового пространства, после конвертации старый object store будет удален. Время конвертации зависит от объема данных и скорости диска
* {{Note}}Изменен [[Help:Match|алгоритм сопоставления предупреждений]]. При старте сервера будет произведена регенерация всех инвариантов во всех ветках. Это может занять продолжительное время (зависит от мощности сервера и объемов данных)
* Добавлена возможность [[Help:Match#Ручное сопоставление предупреждений (экспериментальная возможность)|ручного сопоставления предупреждений]] для переноса разметки
* Добавлена экспериментальная поддержка [[OIDC|OpenID]] протокола для аутентификации
* Добавлена экспериментальная возможность [[Help:CLI#Слияние снимков из CLI (экспериментальная опция)|слияния снимков через CLI]]
* Исправлены баги в [[Help:Sarif|импорте Sarif]], добавлена поддержка импорта с относительными путями к файлам (флаг <code>--base-dir</code>)
* Лог сервера работает в режиме append, прежние данные не затираются
* Добавлена возможность передачи токена аутентификации в клиент Svacer через переменную окружения <code>SVACER_AUTH_TOKEN=token</code>
* Добавлена возможность передачи логина и пароля в клиент Svacer через переменную окружения <code>SVACER_AUTH_CREDS=login:password</code>
* Добавлен public REST endpoint для импорта <code>.svace-dir</code> на стороне сервера
* Добавлена возможность импорта <code>.svace-dir</code> из веб-интерфейса
* Добавлены [[Metrics|метрики]] для Prometheus, доступны при запуске сервера с переменной окружения <code>SVACER_TRACE_OPTIONS=prom_metrics_on</code> на <code>/api/metrics</code>
* Добавлена очистка БД от мусора с возможностью настройки периодичности данной операции через переменную окружения <code>SVACER_GC_PERIOD=val</code> где val — duration в формате <code>hhmmss</code> или [https://en.wikipedia.org/wiki/Cron Cron]
* Добавлена возможность клонирования проектов
* Добавлен импорт <code>*warn, *.err</code> файлов из <code>.svace-dir</code>, которые содержат диагностические сообщения от Svace
* Добавлена возможность [[Help:CLI#Ограничение числа запросов|ограничения числа запросов]] на сервер с указанием параметров в переменной окружения <code>SVACER_SERVER_THROTTLE_PARAMS</code>
* Добавлен шаблон для импорта разметки из кода на Go: <code>DEFAULT_GO</code>
* Добавлена возможность [[Help:CLI#Аутентификация из файла|аутентификации из файла]]
* Исправлены проблемы безопасности
* Добавлена возможность просмотра исходного кода снимка с предупреждениями анализатора во внешней IDE собранной на базе [https://theia-ide.org/ Theia IDE]
* К команде automigrate add в CLI добавлен флаг <code>skip-exist</code>, чтобы при добавлении паттерна, который уже существует, не выдавало ошибки
* К команде upload (import с флагом upload) с указанием флага <code>quality-gate</code> теперь можно добавить флаг <code>quality-gate-verbose</code>. Если его указать, то также будет выведен результат успешных проверок quality-gate
* Улучшения в поддержке протокола LDAP

=== Release 8-0-1 ===
22.01.2024

* Исправлена работа в изолированной от сети среде. Загрузка Web UI больше не требует доступа к публичным CDN
* Добавлена поддержка функций при указании пользовательского фильтра
* Добавлено API для управления пользовательскими фильтрами. Детали и пример использования можно найти здесь: https://gitlab.ispras.ru/svacer-public/api-go-examples/-/tree/master/api-ui-settings
* Исправлено отображение Checker Severity при экспорте в SARIF. Теперь Critical -> error; Major, Normal -> warning; Minor -> note; any other -> warning

=== Release 8-0-0 ===
21.11.2023

* Множество изменений в UI. Смотрите обзор в [[Release notes 8-0-0]]
* Добавлен новый импорт и экспорт из SARIF в command line с поддержкой исходного кода в SARIF файлах и импортом описания детекторов из SARIF
* Добавлены группы проектов
* Переделана модель ролей и доступов. Добавлен CLI для управления ролями и доступами
* Добавлена возможность настройки автопереноса разметки между ветками, в том числе в разных проектах
* Импорт/экспорт снимков включает информацию о детекторах
* Исправлена работа интерфейса с Undefined детекторами (т. е. детекторами, информация о которых отсутствует в Svacer)
* Добавлено экспериментальное API по управлению детекторами и конфигурациями детекторов
* Добавлена очистка исходного кода от Svacer-specific комментариев перед экспортом разметки в код
* Добавлена возможность включения режима обязательного комментария при разметке кода. Комментарий будет сгруппирован с операцией разметки и будет иметь ссылку на нее
* Утилита миграции со старого svace-сервера больше не поддерживается. При необходимости миграции используйте утилиту из прошлых релизов Svacer
* Добавлена Swagger документация на API
* Добавлено хранение истории изменений комментариев
* Опция <code>--pathPrefix</code> поддерживает файлы в JSON формате вида: <code>[{ "prefix": "/some/path", "replace": "/test" }, ...]</code>
* При использовании операции по обновлению <code>pathPrefix</code> на сервере, данные о прежнем <code>pathPrefix</code> запоминаются в мета-информации о снимке
* Добавлена возможность переименования снимков в UI
* Sensitive информация (детали подключения к БД с данными аутентификации) убрана из UI и API
* ОС в docker-образе Svacer обновлена с Ubuntu 18 до Ubuntu 22
* Улучшена логика автоопределения портов и протоколов при соединении с сервером из Svacer CLI

=== Release 7-0-1 ===
23.05.2023

* Исправлена проблема с фильтрацией предупреждений для C# проектов

=== Release 7-0-0 ===
16.05.2023

* Убрана зависимость от PostgreSQL из .deb и .rpm пакетов, чтобы проще было ставить Svacer только как клиент
* Сделан пакет для Windows (.msi) и документация по установке и запуску на Windows
* Теперь, если при svacer import и svacer sarif не указан путь к проекту, им считается текущая директория
* Информация о разметке и блокировках теперь обновляется автоматически при изменении в другом браузере (табе) или другим пользователем
* UI для пользовательских фильтров улучшен и перенесен в правую верхнюю часть экрана
* UI для выбора проекта, ветки и снимка теперь находится на одном уровне
* Улучшен UI для режима сравнения снимков
* Добавлена возможность работать одновременно с несколькими открытыми файлами в режиме Code, это поведение можно изменить в настройках профиля пользователя
* В левой навигационной панели детекторы теперь по умолчанию группируются по серьезности, это поведение можно изменить в настройках профиля пользователя
* Профиль текущего пользователя теперь можно смотреть/редактировать только через меню в правом верхнем углу
* Добавлена возможность копирования в системном логе и журнале
* Для пользователя теперь запоминается последний контекст (проект/ветка/снимок), с которым он работал, он автоматически открывается при старте новой сессии
* Групповая разметка теперь делается единой транзакцией, в случае ошибок или отмены все изменения откатываются
* Добавлено предупреждение при использовании некорректных путей при использовании REST API с префиксом /api
* Поддержка указания паролей из файла или pipe-а при использование Svacer CLI
* Добавлена поддержка multi-tab code view для режима просмотра кода объекта сборки
* Добавлена поддержка сохранения информации об удаленных детекторах при загрузке информации о детекторах из новой версии Svace
* Исправлен импорт результатов анализа, если сборка проводилась с опцией --disable-dxr
* Исправлены проблемы при импорте и прикреплении нескольких файлов к снимку
* Исправлены ошибки с входом в систему пользователей LDAP (специальные символы в пароле, вход по атрибуту mail)
* Добавлена возможность использования резервных серверов LDAP
* Добавлена возможность автоматического назначения пользователям LDAP роли Svacer, в зависимости от принадлежности пользователя к LDAP группе
* Добавлены новые public запросы на получение маркеров/снимков/проектов с учетом заданных параметров фильтрации
* Добавлена поддержка TLS при работе сервера по протоколам HTTP и gRPC
* Добавлена возможность загрузки статистики по общему количеству предупреждений и по количеству размеченных предупреждений для проектов и веток через REST API
* Добавлена вкладка выбора проектов в расширении VSCode
* Убрана возможность использовать всплывающее окно в VScode для добавления/редактирования/удаления комментариев, установки ревью-статусов, локов и т.д.

=== Release 6-0-3 ===
25.01.2023

* RPM-пакет теперь при сборке упаковывается в gzip вместо zstd для обратной совместимости со старыми дистрибутивами
* Если short url некорректен, то Svacer теперь будет возвращать корректный http error NotFound
* Если путь к лог файлу явно не указан, то svacer.log будет создаваться во временной директории. Это решает проблемы при запуске Svacer из директорий с запретом на запись. Путь к лог файлу будет печататься в stdout
* Лог файлы не будут создаваться, когда используется опция --help
* Исправлены проблемы при миграции схемы данных, когда в PostgreSQL используется SSL подключение
* Добавлены описания детекторов из последнего релиза Svace, которые были пропущены в релизе 6-0-2
* Исправлена работа Svacer за proxy-сервером, где выставляется Header "X-Content-Type-Options nosniff"
* Добавлены кнопки для скачивания системного лога и журнала из web-интерфейса
* Поправлен ряд ошибок валидации схемы при экспорте в SARIF
* Исправлено поведение при наличии нескольких хуков в конфигурационном файле
* В информацию о маркере для хуков добавлены checker severity и reliability
* Исправлен случайный порядок URL для маркеров при использовании public API для получения URL-ов
* На главную страницу добавлена кнопка "Помощь", которая открывает документацию
* При использовании команд навигации в режиме "Browse code" текущий файл теперь корректно подсвечивается в дереве файлов
* В диалоге групповой разметки убран индикатор изменений в виде кружочка, наличие изменений можно определить по активности кнопок "Apply" и "Reset"
* Кнопка обновления в верхнем меню теперь корректно обновляет информацию на странице Settings/Project
* Различные небольшие исправления в пользовательском интерфейсе

=== Release 6-0-2 ===
16.12.2022

* Исправлена проблема в UI с сохраненными пользовательскими фильтрами

=== Release 6-0-1 ===
13.12.2022

* Добавлено описание ряда детекторов, которые есть в последнем релизе Svace 3.3.2 но были пропущены в Svacer
* Исправлено вылетание в Login Screen при удалении нотификации из панели нотификаций
* Исправлено появление белого экрана при клике на детектор, информация о котором отсутствует
* Ряд различных небольших исправлений в UI
* Промежуточное хранилище будет очищаться по умолчанию при использовании команды import

=== Release 6-0-0 ===
30.11.2022

* Добавлено копирование комментариев при копировании разметки
* Комментарии добавлены к отчету в формате csv
* Добавлена возможность вводить пароль с клавиатуры для консольных команд
* Добавлена возможность импортировать разметку из объекта сборки (из ранее загруженных данных)
* Добавлена возможность импортировать разметку сразу после загрузки на сервер (опция для команды svacer upload)
* Добавлена возможность загружать исходный код не из папки .svace-dir
* Добавлена возможность бэкапа и восстановление объектного хранилища в сервер PostgresSQL
* Добавлена возможность создания отчета по проекту в формате PDF через интерфейс командной строки и посредством REST API
* Добавлена возможность подавления предупреждений через inline комментарии в коде
* Добавлена возможность подавления предупреждений по идентификатору предупреждения через command line и REST API
* Добавлена возможность ассоциировать организацию с пользователем и реестр организаций
* Добавлена фильтрация списка комментариев по пользователю в правой панели веб-интерфейса
* Добавлен поиск пользователей по его атрибутам в панели управления пользователями
* Добавлена возможность заполнения данных профиля LDAP пользователя данными, полученными от LDAP сервера
* Добавлена возможность прикреплять файлы к снимкам при импорте результатов (данные файлы составляют часть экспортируемых данных при экспорте снимков)
* Добавлена возможность ассоциировать пользовательские атрибуты типа "строка" или массив строк со снимком при импорте данных (данные атрибуты составляют часть экспортируемых данных при экспорте снимков)
* Добавлены command line операции по получению прикрепленных файлов и пользовательских атрибутов со снимков
* Добавлена возможность группового добавления комментариев
* Добавлена возможность указания сетевого интерфейса для работы WEB и GRPC серверов
* Добавлен вывод краткой статистики по загруженному снимку при команде upload. Поддерживается текстовой и JSON форматы вывода
* Существенно расширены возможности по интеграции Visual Studio Code с сервером Svacer
* Добавлен флаг --git в команду import. При наличии такого флага, ищется ближайший git репозиторий содержащий .svace-dir и при наличии такого - используется путь к гит репозиторию для замены путей на префикс .build.
* Portable PostgreSQL больше не входит в поставку. Вместо него поставляется docker-compose.yml файл для запуска PostgreSQL в докер-контейнере
* Добавлено больше данных и информации об ошибках в вывод команды svacer import
* Изменение Public API: добавлена точка входа /api/public/login
* Операции по импорту и экспорту снимков доступны теперь обычным пользователям (не администраторам) при использовании command line интерфейса
* Операция по экспорту снимков доступна обычному пользователю из веб-интерфейса (импорт все еще требует роль администратора для веб-интерфейса)
* Операции по экспорту снимков переведены на асинхронный режим. Нотификация о готовности будет показана пользователю и доступна в панели нотификаций
* Обновлено описание детекторов в соответствии с релизом Svace 3.3.2
* Исправлена ошибка обработки корневых сертификатов при подключении к LDAP серверу по протоколу ldaps
* Исправлено ошибочное создание дубликатов локальных учетных записей LDAP пользователей (case sensitive login)
* Различные исправления в пользовательском интерфейсе с целью оптимизации производительности
* Добавлены пропущенные проверки ролей при работе с веб-интерфейсом
* Svacer больше не создает временные файлы в директории с исполняемым файлом
* Устаранены задержки при удалении веток и проектов

Afilters

2025-12-02T15:40:18Z

Akuzmin: minor fixes after partial review

= Advanced filters =
Поле "Расширенный фильтр" в пользовательских фильтрах предназначено для фильтрации маркеров (предупреждений) по сложным предикатам.
[[File:Image-afilters-prop.png|thumb]]
Предикат может использовать:

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

Формат фильтра определяется следующим шаблоном:

filter(markers, <predicate expr>)

Выражение <code><predicate expr></code> определяет предикат. Объект <code>markers</code> содержит массив маркеров из контекста, функция <code>filter</code> фильтрует данный список по предикату. Таким образом, применение фильтра заключается в фильтрации списка маркеров по указанному предикату.

== Список доступных полей ==

=== Поля маркера (предупреждения) ===

* <code>Comments</code> — список комментариев маркера. Объект типа Comment (смотрите ниже)
* <code>Details</code> — информация, специфичная для анализатора. Ближайший аналог — fingerprint в SARIF
* <code>File</code> — имя файла
* <code>Function</code> — имя функции, может быть mangled для С++
* <code>ID</code> — UUID маркера
* <code>Invariant</code> — инвариант маркера. Используется для автопереноса разметки между снимками
* <code>Lang</code> — язык детектора
* <code>Line</code> — номер строки в файле
* <code>LocID</code> — порядковый номер маркера относительно изначального отчета анализатора
* <code>MTid</code> — шаблон сообщения
* <code>Msg</code> — текст сообщения
* <code>OrigFunc</code> — 'человекочитаемое' имя функции. Может быть недоступно
* <code>Tags</code> — список тегов (меток) маркера
* <code>Tool</code> — модуль анализатора, ответственного за данный детектор
* <code>Traces</code> — список трасс маркера. Объект типа Trace (смотрите ниже)
* <code>WarnClass</code> — название детектора/класса детекторов

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

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

* <code>severity(item) string</code> — серьезность детектора (чекера)

Пример:

filter(markers, severity(#) == "Critical")

'''Внимание:''' использование в предикатах поля <code>Trace</code> может сказаться на скорости применения фильтра, т. к. загрузка большого числа трасс может занять время.

=== Данные о разметке ===
Поддерживаются следующие функции для получения информации о разметке:

* <code>status(item) string</code> — статус разметки текущего маркера. Пример: <code>filter(markers, status(#) == "Confirmed")</code>
* <code>action(item) string</code> — статус поля action текущего маркера. Пример: <code>filter(markers, action(#) == "Ignore")</code>
* <code>mseverity(item) string</code> — статус поля severity текущего маркера (не путать с severity детектора). Пример: <code>filter(markers, mseverity(#) == "Critical")</code>
* <code>triaged(item) bool</code> — возвращает true, если маркер имеет не дефолтную разметку. Пример: <code>filter(markers, triaged(#))</code>
* <code>get_triaged_by(item) UserInfo</code> — возвращает структуру с информацией о пользователе, кто произвел разметку

Поля структуры <code>UserInfo</code>:

* <code>login: string</code> — логин пользователя
* <code>create_ts: Time (UTC)</code> — время разметки в UTC формате (RFC3339)

=== Комментарии ===
Объекты типа <code>Comment</code> содержатся в поле <code>Comments</code> маркера. Объект имеет следующие поля:

* <code>ID</code> — UUID комментария
* <code>Text</code> — текст комментария
* <code>CreatedBy</code> — имя пользователя, кто создал комментарий
* <code>CreateTs</code> — время создания комментария (объект типа <code>time.Time</code>)
* <code>UpdateTs</code> — время обновления комментария (объект типа <code>time.Time</code>), может быть пустым
* <code>UpdatedBy</code> — имя пользователя, кто обновил комментарий

=== Трассы ===
Маркер может содержать трассу маркера в поле <code>Traces</code>. Трасса описывается следующими структурами:
type Trace struct {
Role string
Locations []TraceEntry
}
type TraceEntry struct {
File string
Line uint32
Col uint32
Info string
}

Доступ к полям объекта <code>Trace</code> может выполняться, используя правила языка <code>go-expr</code>, описанные ниже.

Имена полей могут использоваться в виде как описано выше, либо в формате lowercase: <code>role, locations, file, line, col, info</code>

Пример:
filter(markers, any(.Comments, .Text == "Test") &&
any(.Traces, any(.Locations, .Info == "Boolean expression has constant value"))
)

=== Поля снимка ===
Для доступа к полям снимка можно использовать переменную <code>snapshot</code>. Переменная имеет тип структуры со следующими полями

struct {
ID string
Name string
SerialID uint32
BuildObject string
ResultsObject string
ImportTime time.Time
CreatedBy string
CreatedByID string
Details map[string]any
CreateTime time.Time
SourcesAvailable bool
}
Имена полей могут использоваться в виде, где первая буква в lowercase.

Объекты в поле <code>Details</code> можно просмотреть, нажав на кнопку <code>View JSON</code> в WebUI в поле <code>Snapshot Information</code>.

Пример:
filter(markers,
snapshot.buildObject == "5b634b75422bd554a8569cc10bfadc3aea77b73e" &&
.warnClass matches "DEREF"
)

== Описание языка предикатов ==
Для написания предикатов используется язык '''Expr'''. Детальное описание всех возможностей можно найти здесь: https://github.com/expr-lang/expr

Далее описываются конструкции, наиболее подходящие для написания правил фильтрации.

=== Литералы ===
Comment /* */ or //
Boolean true, false
Integer 42, 0x2A, 0o52, 0b101010
Float 0.5, .5
String "foo", 'bar'
Array [1, 2, 3]
Map {a: 1, b: 2, c: 3}
Nil nil

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

Пример однострочного текста:
"Hello\nWorld"

Пример многострочного текста:
`Hello
World`

В многострочном тексте escape-последовательности не поддерживаются.

=== Операторы ===
Arithmetic: +, -, *, /, % (modulus), ^ or ** (exponent)
Comparison: ==, !=, <, >, <=, >=
Logical: not or !, and or &&, or or ||
Conditional: ?: (ternary), ?? (nil coalescing), if {} else {} (multiline)
Membership: [], ., ?., in
String: + (concatenation), contains, startsWith, endsWith
Regex: matches
Range ..
Slice [:]
Pipe |

=== Операторы доступа к полю объекта ===
Можно использовать оператор точка <code>.</code> и оператор <code>[]</code>:
<code>user.Name
user["Name"]</code>

=== Оператор in ===
Оператор <code>in</code> для проверки наличия объекта в массиве или мэпе:
<code>"John" in ["John", "Jane"]
"name" in {"name": "John", "age": 30}</code>

=== Optional chaining ===
Оператор <code>?.</code> может использоваться для доступа к полю структуры или элементу отображения (map) без необходимости проверки, является ли структура или отображение равными <code>nil</code>. Если структура или отображение имеют значение <code>nil</code>, результатом выражения будет <code>nil</code>.

Пример вида:
<code>author.User?.Name</code>
значит тоже самое, что:
<code>author.User != nil ? author.User.Name : nil</code>

=== Nil coalescing ===
Оператор <code>??</code> может использоваться для возврата левого операнда, если он не равен <code>nil</code>, в противном случае возвращается правый операнд.

Пример вида:
<code>author.User?.Name ?? "Anonymous"</code>
значит тоже самое, что:
<code>author.User != nil ? author.User.Name : "Anonymous"</code>

=== Оператор конвейера ===
Оператор конвейера <code>|</code> может использоваться для передачи результата выражения левого операнда в качестве первого аргумента выражения правого операнда.

Пример вида:
<code>user.Name | lower() | split(" ")</code>
значит тоже самое, что:
<code>split(lower(user.Name), " ")</code>

=== Предикаты ===
Предикат — это выражение. Предикаты можно использовать в функциях, таких как filter, all, any, one, none и других.
<code>filter(0..9, {# % 2 == 0})</code>

<code>filter(tweets, {len(.Content) > 240})</code>
Скобки можно опускать <code>{</code> <code>}</code>:
<code>filter(tweets, len(.Content) > 240)</code>

=== Операции над строками ===
<code>trim(str[, chars])
trimPrefix(str, prefix)
trimSuffix(str, suffix)
upper(str)
lower(str)
indexOf(str, substring)
lastIndexOf(str, substring)
hasPrefix(str, prefix)
hasSuffix(str, suffix)</code>
Так же есть оператор <code>matches</code> для поиска регулярного выражения в строке:
<code>str matches "regular expression"</code>
Для сопоставления целой строки с регулярным выражением следует использовать вариант:
<code>str matches "^regex$"</code>

=== Функции времени ===
Поддерживаются Go типы для времени и интервалов (<code>time.Time</code>, <code>time.Duration</code>) time package.

Можно использовать операции сложения и вычитания над объектами с типом <code>time.Time</code>.
<code>createdAt - now()</code>

<code>createdAt + duration("1h")</code>

<code>createdAt > now() - duration("1h")</code>

<code>date("2023-08-14")
date("15:04:05")
date("2023-08-14T00:00:00Z")
date("2023-08-14 00:00:00", "2006-01-02 15:04:05", "Europe/Zurich")</code>

=== Функции над массивами ===
* <code>all(array, predicate)</code> — все объекты должны удовлетворять предикату
* <code>any(array, predicate)</code> — должен быть по крайней мере один объект, который удовлетворяет предикату
* <code>one(array, predicate)</code> — должен быть только один объект, который удовлетворяет предикату
* <code>none(array, predicate)</code> — ни один объект не должен удовлетворять предикату
* <code>find(array, predicate)</code> — возвращает первый объект, который удовлетворяет предикату
* <code>findLast(array, predicate)</code> — возвращает последний объект, который удовлетворяет предикату
* <code>count(array[, predicate])</code> — возвращает число объектов, удовлетворяющих предикату
* <code>first(array)</code> — первый объект из массива
* <code>last(array)</code> — последний объект из массива

Примеры:
all(tweets, {.Size < 280})
any(tweets, {.Size > 280})
none(tweets, {.Size > 280})
find([1, 2, 3, 4], # > 2) == 3
findLast([1, 2, 3, 4], # > 2) == 4
count(users, .Age > 18)
first([1, 2, 3]) == 1
last([1, 2, 3]) == 3

Help:XSvacer:AIAssistant:Deploy

2025-12-01T14:26:46Z

Akuzmin: Redirected page to Help:XSvacer:AIAssistant

#REDIRECT [[Help:XSvacer:AIAssistant]]

Changelog

2025-12-01T14:23:37Z

Akuzmin: more AI-assistant links fixes

=== Release 12-0-0 ===
28.11.2025

* API методы на fullmarkers позволяют [[Help:Public_API#Примеры_использования_фильтров_в_public_api|указать фильтр]] с полем фильтрации по checker reliability
* В функциональность полнотекстового поиска добавлен поиск маркеров по id и инварианту
* Промежуточное хранилище при импорте результатов командой <code>svacer import / svacer sarif2 import</code> теперь использует новый формат представления. Это должно снизить использование памяти при импорте
* Сериализация JSON переведена на jsonv2 библиотеку в Go
* Импорт SARIF теперь более устойчив к пропускам в файле (отсутствие таких полей как location)
* Добавлены переменные окружения <code>SVACER_TIMEOUT_IMPORT_RESULTS</code> для [[Help:Configuration#Переменные_окружения|контроля таймаута]] на ожидание начала импорта результатов и <code>SVACER_NUM_PARALLEL_IMPORTS</code> на [[Help:Configuration#Переменные_окружения|ограничение числа параллельных импортов]]. По умолчанию значения 15 минут и <code>(максимальное число коннектов к БД) / 2</code>. Ограничения необходимы для предотвращения бесконечных ожиданий и зависаний при импорте данных
* Убраны лишние сообщения об устаревших детекторах при старте сервера или импорте снимков
* В метрики Prometheus добавлен ряд показателей размеров object store
* Размер лога сервера, показываемого в Web-интерфейсе, ограничен. Размер [[Help:Configuration#Переменные_окружения|задается переменной окружения]] SVACER_TAIL_LOG_SIZE (по умолчанию 1Мб). Показывается последний кусок не более SVACER_TAIL_LOG_SIZE. Сам лог файл не ограничивается в размерах и кнопка выгрузки лога выгружает полный лог
* ['''Экспериментально'''] Можно [[Help:Configuration#Переменные_окружения|указать JSON-формат]] лог-файла посредством параметра <code>svacer-server --log-format=json ...</code>, также формат может быть указан через переменную окружения <code>SVACER_LOG_FORMAT=json</code>. Опции также работают для CLI-клиента svacer
* При запуске сервера можно указать флаг <code>--force-invariant-refresh</code> для принудительной регенерации инвариантов. Это может решить проблему с переносом разметки
* Добавлена переменная окружения SVACER_INV_GEN_JOBS для контроля числа параллельных заданий при регенерации инвариантов. При ограниченных ресурсах машины рекомендуем ставить значение 2. По умолчанию значение ставится в 70% от <code>runtime.GOMAXPROCS</code>
* Добавлена функциональность по чистке object store при удалении снимков
* Добавлена возможность создания [[Afilters|сложных пользовательских фильтров]] по условиям, выраженным предикатом
* Проведена работа по предотвращению зависаний при исчерпывании доступных соединений с PostgreSQL сервером
* Добавлен файл с чексуммой бинарника сервера <code>svacer-server</code> и проверка чексуммы при запуске
* Упростили [[Help:XSvacer:AIAssistant#Активация_и_запуск_ИИ-ассистента|деплой ИИ-ассистента]]: добавили его сервис в docker-compose и deb/rpm пакеты
* Расширили возможности конфигурации при запуске сервера через [https://svacer.ispras.ru/extra/docker-compose.yml docker-compose]: теперь можно включить debug, указать конфиг LDAP и параметр public-url
* Добавлена возможность указания минимального количества снимков, которое необходимо оставлять в ветке, тип очистки и период удаления в [[Help:CLI/cleanup|автоматическом удалении снимков]]
* ['''Экспериментально'''] Добавлена возможность [[Edit markers (command line)|автоматически обрабатывать маркеры]] при импорте данных. Также обработка маркеров доступна через [[Help:UI manual#Работа со снимками|UI]]
* Добавлен флаг <code>diff-url</code> для команды <code>quickdiff</code> в CLI, также как и для команд <code>import</code>, <code>upload</code>, <code>sarif2 import</code> с указанием опции <code>quick-stat</code>. Данный флаг позволяет получать ссылку на diff снимков
* Добавлены предупреждения если в командах <code>import</code>, <code>sarif2 import</code> используются флаги, которые используются флагом <code>upload</code>, но флаг <code>upload</code> не установлен
* Добавлена интеграция с внешними системами посредством механизма [[Help:Configuration#Механизм интеграции с внешними системами посредством Webhook-ов|Webhooks]]
* Добавлена [[Help:Configuration#Настройка защиты от перебора паролей пользователей|защита от перебора пароля пользователя]]
* Добавлена возможность задать [[Help:Configuration#Настройка парольной политики внутреннего механизма аутентификации Svacer|парольную политику безопасности]] для пользователей, использующих встроенный механизм аутентификации Svacer
* Добавлена возможность задать [[Help:Configuration#Задание вкладки по умолчанию на странице входа в GUI Svacer (а также отключение внутреннего механизма аутентификации Svacer)|вкладку по умолчанию]] для страницы входа в систему
* Исправлена ошибка, приводящая к разрастанию базы данных
* Исправлена ошибка, связанная с невозможностью в ряде случаев использовать механизм подписок
* Форма [[Help:UI_manual#Разметка_маркера_с_помощью_ассистента_AI|разметки]] с помощью [[Help:XSvacer:AIAssistant|ИИ-ассистента]] реализована в основном интерфейсе Svacer
* [[Help:XSvacer:Webide#Запуск функциональности при использовании docker compose|Упрощён запуск функциональности Webide]] при запуске сервера через [https://svacer.ispras.ru/extra/docker-compose.yml docker-compose]

=== Release 11-2-0 ===
22.07.2025

* Исправлены зависания сервера
* Добавлено автоматическое удаление архивов и прочих временных файлов при импорте .svace-dir и SARIF-файлов через REST API

=== Release 11-1-0 ===
08.07.2025

* Команды <code>--project-group, --if-no-group, --autoclean, --autoclean-svace</code> можно использовать в REST API для импорта svace-dir
* При использовании REST API для импорта svace-dir сервер будет автоматически удалять директории <code>.svace-dir</code> и <code>.svacer</code> если не указаны явные опции <code>--autoclean=false, --autoclean-svace=false</code>
* Добавлена опция запуска сервера <code>--classic-inv-mode</code> для включения режима совместимости по генерации инвариантов с версией <= 8.x.x
* Исправлены ошибки в работе <code>--quality-gate</code>, добавлена возможность учета статусов разметки. Добавлена возможность [[Help:Import from Svace#Флаг --baseline|указания baseline]] для сравнений при использовании опции <code>--quality-gate</code>
* Исправлены ошибки при подключении к PostgreSQL в SSL-режиме
* Исправлен ряд ошибок при работе с LDAP
* Команда <code>quickdiff</code> в CLI теперь выдает информацию также о Same и Matched предупреждениях

=== Release 11-0-0 ===
19.05.2025

* Убраны излишние сообщения в логе сервера о login/logout операциях. Они будут выводиться только при запуске сервера с опцией <code>--debug</code>
* Команды CLI <code>svacer sarif *</code> были убраны, для [[Help:Sarif|импорта и экспорта]] следует использовать <code>svacer sarif2 *</code>
* Экспорт SARIF теперь включает все комментарии как отдельные объекты в <code>Properties</code>
* При экспорте в SARIF теперь экспортируются поля <code>Labels, Orig function</code>
* Импорт SARIF теперь корректным образом учитывает relatedLocations и формирует трассу
* Импорт SARIF теперь автоматически импортирует исходники, если они включены в сам SARIF файл
* Добавлена возможность указания [[Help:Sarif#Мэппинг severity|мэппинга severity]] детекторов при импорте из SARIF
* Добавлен механизм указания правил резолвинга путей при импортировании исходного кода вместе с SARIF файлом
* Экспорт исходников из снимка будет доступен только при наличии исходников на сервере
* Добавлены флаги <code>--autoclean</code>, <code>--autoclean-svace</code> в команду <code>svacer import</code> для автоматического удаления <code>.svace-dir / .svacer-dir</code> после успешного импорта и загрузки данных на сервер
* Улучшена поддержка [[OIDC]]
* Улучшена поддержка [[LDAP configuration|LDAP]]
* Добавлена интеграция с хранилищем секретов [[Infisical]]
* Добавлена [[Notifications|служба нотификаций]] пользователей через почтовые сообщения и мессенджер telegram
* Добавлен механизм аутентификации и [[Help:UI manual#Управление токенами доступа|управления]] персональными токенами доступа
* Добавлен механизм упоминания пользователей через специальную конструкцию @login в комментариях к разметке
* В разделе Статистика добавлен дашборд с [[Release notes 11-0-0#Изменения в разделе Статистика|Общей статистикой]], содержащей метрики по последним импортированным снимкам в ветках проектов
* В статистике по активности пользователей добавлена возможность просмотра панели с актуальной информацией о маркере и опция показа только действий с актуальной разметкой
* Большинство CLI команд, работающих с сервером, теперь делают явный logout после завершения
* Svacer при импорте результатов Svace автоматически импортирует файлы <code>*.warn, *.err</code> с предупреждениями от самого анализатора Svace. Автоматический импорт не будет происходить при размере этих файлов более 30Мб (большой размер может свидетельствовать о проблемах в ходе анализа)
* Переменная окружения <code>SVACER_CACHE_DIR</code> теперь учитывается во всех местах (ранее в ряде случаев мог неявно использоваться <code>$HOME/.cache</code>)
* Добавлена возможность [[Help:CLI/cleanup|автоматического удаления снимков]]

=== Release 10-0-1 ===
17.02.2025

* Исправлена ошибка с временной таблицей при обработке планов автомиграции разметки при импорте результатов (ERROR: relation "loaded_review" already exists)

=== Release 10-0-0 ===
16.01.2025

* Множество изменений в UI, смотрите [[Release notes 10-0-0]]
* Сделали [[Help:Installation#rpm|dnf/yum репозиторий]] для RPM-пакетов Svacer
* Реализована возможность [[Markup2|экспорта, импорта и копирования разметки посредством Public REST API и CLI]]
* Реализован дополнительный экспериментальный механизм [[Help:UI manual#Настройка интерфейса|генерации PDF на основе HTML]]. Генерация PDF переведена на асинхронный режим с показом нотификации пользователю
* Добавлена возможность очистки всей разметки и/или комментариев на ветке проекта
* Улучшения функциональности просмотра маркеров в встроенном IDE Theia
* Добавлена функциональность по [[Help:UI manual#Глобальный поиск|глобальному поиску]] маркеров, комментариев и снимков по различным атрибутам
* Добавлена возможность [[Help:UI manual#Просмотр статистики|получения статистики]] по маркерам и активностям пользователей при разметке
* В API fullmarkers добавлен параметр <code>labels: true/false</code> для выгрузки меток маркера
* Реализован Public API для получения/добавления/удаления меток маркеров
* Настройки LDAP и прочие настройки аутентификации добавлены в единый конфигурационный файл
* Добавлена возможность удаления кода из снимка при частичном импорте в Svacer
* Добавлена опция minVersion, maxVersion для TLS при запуске сервера Svacer
* Добавлена поддержка групп проектов при импорте снимков в CLI
* При импорте снимков реализована поддержка автоматического определения пути префикса для переноса разметки
* Исправлен ряд ошибок в импорте и генерации [[Help:Sarif|SARIF]]
* Исправлены ошибки в копировании разметки между ветками, клонировании проектов и веток
* Добавлена возможность отключения бэкграунд задач по очистке мусора
* Добавлено экспериментальное CLI API для просмотра асинхронных задач на генерацию PDF
* Добавлена возможность визуализации производительности сервера на основе [https://github.com/arl/statsviz statsviz]
* Добавлена поддержка относительных путей в svres файле
* Добавлена возможность ожидания завершения операций по очистки мусора при выполнении операций по импорту результатов анализа
* Добавлена поддержка CWE таксономий при экспорте [[Help:Sarif|SARIF]]
* Добавлена переменная окружения SVACER_TOKEN_LIFETIME для управления временем жизни токена аутентификации
* Добавлена переменная окружения SVACER_RESET_ADMIN_PASSWORD для явного указания желаемого пароля при операции по сбросу пароля администратора
* Добавлен [[Notifications|механизм нотификаций пользователей]] о внутренних событиях Svacer (экспериментальный функционал)

=== Release 9-0-2 ===
22.07.2024

* Еще некоторые исправления, связанные с миграцией данных
* Исправлена проблема с навигацией по Go to Definition

=== Release 9-0-1 ===
15.07.2024

* Исправлены ошибки в клонировании проектов, приводящие к размножению записей в некоторых внутренних таблицах
* Различные исправления, связанные с миграцией данных
* Исправлена работа ряда CLI команд с включенным TLS на сервере
* Исправлен ряд ошибок в генерации PDF

=== Release 9-0-0 ===
04.06.2024

* Множество изменений в UI, смотрите [[Release notes 9-0-0]]
* Svacer разделен на два исполняемых файла: <code>svacer-server</code> — сервер и <code>svacer</code> — клиент
* {{Note}}Object store заменен на другую реализацию. Конвертация данных запускается автоматически при апгрейде и требует примерно 2х-2.2х дискового пространства, после конвертации старый object store будет удален. Время конвертации зависит от объема данных и скорости диска
* {{Note}}Изменен [[Help:Match|алгоритм сопоставления предупреждений]]. При старте сервера будет произведена регенерация всех инвариантов во всех ветках. Это может занять продолжительное время (зависит от мощности сервера и объемов данных)
* Добавлена возможность [[Help:Match#Ручное сопоставление предупреждений (экспериментальная возможность)|ручного сопоставления предупреждений]] для переноса разметки
* Добавлена экспериментальная поддержка [[OIDC|OpenID]] протокола для аутентификации
* Добавлена экспериментальная возможность [[Help:CLI#Слияние снимков из CLI (экспериментальная опция)|слияния снимков через CLI]]
* Исправлены баги в [[Help:Sarif|импорте Sarif]], добавлена поддержка импорта с относительными путями к файлам (флаг <code>--base-dir</code>)
* Лог сервера работает в режиме append, прежние данные не затираются
* Добавлена возможность передачи токена аутентификации в клиент Svacer через переменную окружения <code>SVACER_AUTH_TOKEN=token</code>
* Добавлена возможность передачи логина и пароля в клиент Svacer через переменную окружения <code>SVACER_AUTH_CREDS=login:password</code>
* Добавлен public REST endpoint для импорта <code>.svace-dir</code> на стороне сервера
* Добавлена возможность импорта <code>.svace-dir</code> из веб-интерфейса
* Добавлены [[Metrics|метрики]] для Prometheus, доступны при запуске сервера с переменной окружения <code>SVACER_TRACE_OPTIONS=prom_metrics_on</code> на <code>/api/metrics</code>
* Добавлена очистка БД от мусора с возможностью настройки периодичности данной операции через переменную окружения <code>SVACER_GC_PERIOD=val</code> где val — duration в формате <code>hhmmss</code> или [https://en.wikipedia.org/wiki/Cron Cron]
* Добавлена возможность клонирования проектов
* Добавлен импорт <code>*warn, *.err</code> файлов из <code>.svace-dir</code>, которые содержат диагностические сообщения от Svace
* Добавлена возможность [[Help:CLI#Ограничение числа запросов|ограничения числа запросов]] на сервер с указанием параметров в переменной окружения <code>SVACER_SERVER_THROTTLE_PARAMS</code>
* Добавлен шаблон для импорта разметки из кода на Go: <code>DEFAULT_GO</code>
* Добавлена возможность [[Help:CLI#Аутентификация из файла|аутентификации из файла]]
* Исправлены проблемы безопасности
* Добавлена возможность просмотра исходного кода снимка с предупреждениями анализатора во внешней IDE собранной на базе [https://theia-ide.org/ Theia IDE]
* К команде automigrate add в CLI добавлен флаг <code>skip-exist</code>, чтобы при добавлении паттерна, который уже существует, не выдавало ошибки
* К команде upload (import с флагом upload) с указанием флага <code>quality-gate</code> теперь можно добавить флаг <code>quality-gate-verbose</code>. Если его указать, то также будет выведен результат успешных проверок quality-gate
* Улучшения в поддержке протокола LDAP

=== Release 8-0-1 ===
22.01.2024

* Исправлена работа в изолированной от сети среде. Загрузка Web UI больше не требует доступа к публичным CDN
* Добавлена поддержка функций при указании пользовательского фильтра
* Добавлено API для управления пользовательскими фильтрами. Детали и пример использования можно найти здесь: https://gitlab.ispras.ru/svacer-public/api-go-examples/-/tree/master/api-ui-settings
* Исправлено отображение Checker Severity при экспорте в SARIF. Теперь Critical -> error; Major, Normal -> warning; Minor -> note; any other -> warning

=== Release 8-0-0 ===
21.11.2023

* Множество изменений в UI. Смотрите обзор в [[Release notes 8-0-0]]
* Добавлен новый импорт и экспорт из SARIF в command line с поддержкой исходного кода в SARIF файлах и импортом описания детекторов из SARIF
* Добавлены группы проектов
* Переделана модель ролей и доступов. Добавлен CLI для управления ролями и доступами
* Добавлена возможность настройки автопереноса разметки между ветками, в том числе в разных проектах
* Импорт/экспорт снимков включает информацию о детекторах
* Исправлена работа интерфейса с Undefined детекторами (т. е. детекторами, информация о которых отсутствует в Svacer)
* Добавлено экспериментальное API по управлению детекторами и конфигурациями детекторов
* Добавлена очистка исходного кода от Svacer-specific комментариев перед экспортом разметки в код
* Добавлена возможность включения режима обязательного комментария при разметке кода. Комментарий будет сгруппирован с операцией разметки и будет иметь ссылку на нее
* Утилита миграции со старого svace-сервера больше не поддерживается. При необходимости миграции используйте утилиту из прошлых релизов Svacer
* Добавлена Swagger документация на API
* Добавлено хранение истории изменений комментариев
* Опция <code>--pathPrefix</code> поддерживает файлы в JSON формате вида: <code>[{ "prefix": "/some/path", "replace": "/test" }, ...]</code>
* При использовании операции по обновлению <code>pathPrefix</code> на сервере, данные о прежнем <code>pathPrefix</code> запоминаются в мета-информации о снимке
* Добавлена возможность переименования снимков в UI
* Sensitive информация (детали подключения к БД с данными аутентификации) убрана из UI и API
* ОС в docker-образе Svacer обновлена с Ubuntu 18 до Ubuntu 22
* Улучшена логика автоопределения портов и протоколов при соединении с сервером из Svacer CLI

=== Release 7-0-1 ===
23.05.2023

* Исправлена проблема с фильтрацией предупреждений для C# проектов

=== Release 7-0-0 ===
16.05.2023

* Убрана зависимость от PostgreSQL из .deb и .rpm пакетов, чтобы проще было ставить Svacer только как клиент
* Сделан пакет для Windows (.msi) и документация по установке и запуску на Windows
* Теперь, если при svacer import и svacer sarif не указан путь к проекту, им считается текущая директория
* Информация о разметке и блокировках теперь обновляется автоматически при изменении в другом браузере (табе) или другим пользователем
* UI для пользовательских фильтров улучшен и перенесен в правую верхнюю часть экрана
* UI для выбора проекта, ветки и снимка теперь находится на одном уровне
* Улучшен UI для режима сравнения снимков
* Добавлена возможность работать одновременно с несколькими открытыми файлами в режиме Code, это поведение можно изменить в настройках профиля пользователя
* В левой навигационной панели детекторы теперь по умолчанию группируются по серьезности, это поведение можно изменить в настройках профиля пользователя
* Профиль текущего пользователя теперь можно смотреть/редактировать только через меню в правом верхнем углу
* Добавлена возможность копирования в системном логе и журнале
* Для пользователя теперь запоминается последний контекст (проект/ветка/снимок), с которым он работал, он автоматически открывается при старте новой сессии
* Групповая разметка теперь делается единой транзакцией, в случае ошибок или отмены все изменения откатываются
* Добавлено предупреждение при использовании некорректных путей при использовании REST API с префиксом /api
* Поддержка указания паролей из файла или pipe-а при использование Svacer CLI
* Добавлена поддержка multi-tab code view для режима просмотра кода объекта сборки
* Добавлена поддержка сохранения информации об удаленных детекторах при загрузке информации о детекторах из новой версии Svace
* Исправлен импорт результатов анализа, если сборка проводилась с опцией --disable-dxr
* Исправлены проблемы при импорте и прикреплении нескольких файлов к снимку
* Исправлены ошибки с входом в систему пользователей LDAP (специальные символы в пароле, вход по атрибуту mail)
* Добавлена возможность использования резервных серверов LDAP
* Добавлена возможность автоматического назначения пользователям LDAP роли Svacer, в зависимости от принадлежности пользователя к LDAP группе
* Добавлены новые public запросы на получение маркеров/снимков/проектов с учетом заданных параметров фильтрации
* Добавлена поддержка TLS при работе сервера по протоколам HTTP и gRPC
* Добавлена возможность загрузки статистики по общему количеству предупреждений и по количеству размеченных предупреждений для проектов и веток через REST API
* Добавлена вкладка выбора проектов в расширении VSCode
* Убрана возможность использовать всплывающее окно в VScode для добавления/редактирования/удаления комментариев, установки ревью-статусов, локов и т.д.

=== Release 6-0-3 ===
25.01.2023

* RPM-пакет теперь при сборке упаковывается в gzip вместо zstd для обратной совместимости со старыми дистрибутивами
* Если short url некорректен, то Svacer теперь будет возвращать корректный http error NotFound
* Если путь к лог файлу явно не указан, то svacer.log будет создаваться во временной директории. Это решает проблемы при запуске Svacer из директорий с запретом на запись. Путь к лог файлу будет печататься в stdout
* Лог файлы не будут создаваться, когда используется опция --help
* Исправлены проблемы при миграции схемы данных, когда в PostgreSQL используется SSL подключение
* Добавлены описания детекторов из последнего релиза Svace, которые были пропущены в релизе 6-0-2
* Исправлена работа Svacer за proxy-сервером, где выставляется Header "X-Content-Type-Options nosniff"
* Добавлены кнопки для скачивания системного лога и журнала из web-интерфейса
* Поправлен ряд ошибок валидации схемы при экспорте в SARIF
* Исправлено поведение при наличии нескольких хуков в конфигурационном файле
* В информацию о маркере для хуков добавлены checker severity и reliability
* Исправлен случайный порядок URL для маркеров при использовании public API для получения URL-ов
* На главную страницу добавлена кнопка "Помощь", которая открывает документацию
* При использовании команд навигации в режиме "Browse code" текущий файл теперь корректно подсвечивается в дереве файлов
* В диалоге групповой разметки убран индикатор изменений в виде кружочка, наличие изменений можно определить по активности кнопок "Apply" и "Reset"
* Кнопка обновления в верхнем меню теперь корректно обновляет информацию на странице Settings/Project
* Различные небольшие исправления в пользовательском интерфейсе

=== Release 6-0-2 ===
16.12.2022

* Исправлена проблема в UI с сохраненными пользовательскими фильтрами

=== Release 6-0-1 ===
13.12.2022

* Добавлено описание ряда детекторов, которые есть в последнем релизе Svace 3.3.2 но были пропущены в Svacer
* Исправлено вылетание в Login Screen при удалении нотификации из панели нотификаций
* Исправлено появление белого экрана при клике на детектор, информация о котором отсутствует
* Ряд различных небольших исправлений в UI
* Промежуточное хранилище будет очищаться по умолчанию при использовании команды import

=== Release 6-0-0 ===
30.11.2022

* Добавлено копирование комментариев при копировании разметки
* Комментарии добавлены к отчету в формате csv
* Добавлена возможность вводить пароль с клавиатуры для консольных команд
* Добавлена возможность импортировать разметку из объекта сборки (из ранее загруженных данных)
* Добавлена возможность импортировать разметку сразу после загрузки на сервер (опция для команды svacer upload)
* Добавлена возможность загружать исходный код не из папки .svace-dir
* Добавлена возможность бэкапа и восстановление объектного хранилища в сервер PostgresSQL
* Добавлена возможность создания отчета по проекту в формате PDF через интерфейс командной строки и посредством REST API
* Добавлена возможность подавления предупреждений через inline комментарии в коде
* Добавлена возможность подавления предупреждений по идентификатору предупреждения через command line и REST API
* Добавлена возможность ассоциировать организацию с пользователем и реестр организаций
* Добавлена фильтрация списка комментариев по пользователю в правой панели веб-интерфейса
* Добавлен поиск пользователей по его атрибутам в панели управления пользователями
* Добавлена возможность заполнения данных профиля LDAP пользователя данными, полученными от LDAP сервера
* Добавлена возможность прикреплять файлы к снимкам при импорте результатов (данные файлы составляют часть экспортируемых данных при экспорте снимков)
* Добавлена возможность ассоциировать пользовательские атрибуты типа "строка" или массив строк со снимком при импорте данных (данные атрибуты составляют часть экспортируемых данных при экспорте снимков)
* Добавлены command line операции по получению прикрепленных файлов и пользовательских атрибутов со снимков
* Добавлена возможность группового добавления комментариев
* Добавлена возможность указания сетевого интерфейса для работы WEB и GRPC серверов
* Добавлен вывод краткой статистики по загруженному снимку при команде upload. Поддерживается текстовой и JSON форматы вывода
* Существенно расширены возможности по интеграции Visual Studio Code с сервером Svacer
* Добавлен флаг --git в команду import. При наличии такого флага, ищется ближайший git репозиторий содержащий .svace-dir и при наличии такого - используется путь к гит репозиторию для замены путей на префикс .build.
* Portable PostgreSQL больше не входит в поставку. Вместо него поставляется docker-compose.yml файл для запуска PostgreSQL в докер-контейнере
* Добавлено больше данных и информации об ошибках в вывод команды svacer import
* Изменение Public API: добавлена точка входа /api/public/login
* Операции по импорту и экспорту снимков доступны теперь обычным пользователям (не администраторам) при использовании command line интерфейса
* Операция по экспорту снимков доступна обычному пользователю из веб-интерфейса (импорт все еще требует роль администратора для веб-интерфейса)
* Операции по экспорту снимков переведены на асинхронный режим. Нотификация о готовности будет показана пользователю и доступна в панели нотификаций
* Обновлено описание детекторов в соответствии с релизом Svace 3.3.2
* Исправлена ошибка обработки корневых сертификатов при подключении к LDAP серверу по протоколу ldaps
* Исправлено ошибочное создание дубликатов локальных учетных записей LDAP пользователей (case sensitive login)
* Различные исправления в пользовательском интерфейсе с целью оптимизации производительности
* Добавлены пропущенные проверки ролей при работе с веб-интерфейсом
* Svacer больше не создает временные файлы в директории с исполняемым файлом
* Устаранены задержки при удалении веток и проектов

Changelog

2025-12-01T14:20:01Z

Akuzmin: fix AI assistant deploy link

=== Release 12-0-0 ===
28.11.2025

* API методы на fullmarkers позволяют [[Help:Public_API#Примеры_использования_фильтров_в_public_api|указать фильтр]] с полем фильтрации по checker reliability
* В функциональность полнотекстового поиска добавлен поиск маркеров по id и инварианту
* Промежуточное хранилище при импорте результатов командой <code>svacer import / svacer sarif2 import</code> теперь использует новый формат представления. Это должно снизить использование памяти при импорте
* Сериализация JSON переведена на jsonv2 библиотеку в Go
* Импорт SARIF теперь более устойчив к пропускам в файле (отсутствие таких полей как location)
* Добавлены переменные окружения <code>SVACER_TIMEOUT_IMPORT_RESULTS</code> для [[Help:Configuration#Переменные_окружения|контроля таймаута]] на ожидание начала импорта результатов и <code>SVACER_NUM_PARALLEL_IMPORTS</code> на [[Help:Configuration#Переменные_окружения|ограничение числа параллельных импортов]]. По умолчанию значения 15 минут и <code>(максимальное число коннектов к БД) / 2</code>. Ограничения необходимы для предотвращения бесконечных ожиданий и зависаний при импорте данных
* Убраны лишние сообщения об устаревших детекторах при старте сервера или импорте снимков
* В метрики Prometheus добавлен ряд показателей размеров object store
* Размер лога сервера, показываемого в Web-интерфейсе, ограничен. Размер [[Help:Configuration#Переменные_окружения|задается переменной окружения]] SVACER_TAIL_LOG_SIZE (по умолчанию 1Мб). Показывается последний кусок не более SVACER_TAIL_LOG_SIZE. Сам лог файл не ограничивается в размерах и кнопка выгрузки лога выгружает полный лог
* ['''Экспериментально'''] Можно [[Help:Configuration#Переменные_окружения|указать JSON-формат]] лог-файла посредством параметра <code>svacer-server --log-format=json ...</code>, также формат может быть указан через переменную окружения <code>SVACER_LOG_FORMAT=json</code>. Опции также работают для CLI-клиента svacer
* При запуске сервера можно указать флаг <code>--force-invariant-refresh</code> для принудительной регенерации инвариантов. Это может решить проблему с переносом разметки
* Добавлена переменная окружения SVACER_INV_GEN_JOBS для контроля числа параллельных заданий при регенерации инвариантов. При ограниченных ресурсах машины рекомендуем ставить значение 2. По умолчанию значение ставится в 70% от <code>runtime.GOMAXPROCS</code>
* Добавлена функциональность по чистке object store при удалении снимков
* Добавлена возможность создания [[Afilters|сложных пользовательских фильтров]] по условиям, выраженным предикатом
* Проведена работа по предотвращению зависаний при исчерпывании доступных соединений с PostgreSQL сервером
* Добавлен файл с чексуммой бинарника сервера <code>svacer-server</code> и проверка чексуммы при запуске
* Упростили [[Help:XSvacer:AIAssistant#Активация_и_запуск_ИИ-ассистента|деплой ИИ-ассистента]]: добавили его сервис в docker-compose и deb/rpm пакеты
* Расширили возможности конфигурации при запуске сервера через [https://svacer.ispras.ru/extra/docker-compose.yml docker-compose]: теперь можно включить debug, указать конфиг LDAP и параметр public-url
* Добавлена возможность указания минимального количества снимков, которое необходимо оставлять в ветке, тип очистки и период удаления в [[Help:CLI/cleanup|автоматическом удалении снимков]]
* ['''Экспериментально'''] Добавлена возможность [[Edit markers (command line)|автоматически обрабатывать маркеры]] при импорте данных. Также обработка маркеров доступна через [[Help:UI manual#Работа со снимками|UI]]
* Добавлен флаг <code>diff-url</code> для команды <code>quickdiff</code> в CLI, также как и для команд <code>import</code>, <code>upload</code>, <code>sarif2 import</code> с указанием опции <code>quick-stat</code>. Данный флаг позволяет получать ссылку на diff снимков
* Добавлены предупреждения если в командах <code>import</code>, <code>sarif2 import</code> используются флаги, которые используются флагом <code>upload</code>, но флаг <code>upload</code> не установлен
* Добавлена интеграция с внешними системами посредством механизма [[Help:Configuration#Механизм интеграции с внешними системами посредством Webhook-ов|Webhooks]]
* Добавлена [[Help:Configuration#Настройка защиты от перебора паролей пользователей|защита от перебора пароля пользователя]]
* Добавлена возможность задать [[Help:Configuration#Настройка парольной политики внутреннего механизма аутентификации Svacer|парольную политику безопасности]] для пользователей, использующих встроенный механизм аутентификации Svacer
* Добавлена возможность задать [[Help:Configuration#Задание вкладки по умолчанию на странице входа в GUI Svacer (а также отключение внутреннего механизма аутентификации Svacer)|вкладку по умолчанию]] для страницы входа в систему
* Исправлена ошибка, приводящая к разрастанию базы данных
* Исправлена ошибка, связанная с невозможностью в ряде случаев использовать механизм подписок
* Форма разметки с помощью [[Help:XSvacer:AIAssistant:Deploy|ИИ-ассистента]] реализована в основном интерфейсе Svacer
* [[Help:XSvacer:Webide#Запуск функциональности при использовании docker compose|Упрощён запуск функциональности Webide]] при запуске сервера через [https://svacer.ispras.ru/extra/docker-compose.yml docker-compose]

=== Release 11-2-0 ===
22.07.2025

* Исправлены зависания сервера
* Добавлено автоматическое удаление архивов и прочих временных файлов при импорте .svace-dir и SARIF-файлов через REST API

=== Release 11-1-0 ===
08.07.2025

* Команды <code>--project-group, --if-no-group, --autoclean, --autoclean-svace</code> можно использовать в REST API для импорта svace-dir
* При использовании REST API для импорта svace-dir сервер будет автоматически удалять директории <code>.svace-dir</code> и <code>.svacer</code> если не указаны явные опции <code>--autoclean=false, --autoclean-svace=false</code>
* Добавлена опция запуска сервера <code>--classic-inv-mode</code> для включения режима совместимости по генерации инвариантов с версией <= 8.x.x
* Исправлены ошибки в работе <code>--quality-gate</code>, добавлена возможность учета статусов разметки. Добавлена возможность [[Help:Import from Svace#Флаг --baseline|указания baseline]] для сравнений при использовании опции <code>--quality-gate</code>
* Исправлены ошибки при подключении к PostgreSQL в SSL-режиме
* Исправлен ряд ошибок при работе с LDAP
* Команда <code>quickdiff</code> в CLI теперь выдает информацию также о Same и Matched предупреждениях

=== Release 11-0-0 ===
19.05.2025

* Убраны излишние сообщения в логе сервера о login/logout операциях. Они будут выводиться только при запуске сервера с опцией <code>--debug</code>
* Команды CLI <code>svacer sarif *</code> были убраны, для [[Help:Sarif|импорта и экспорта]] следует использовать <code>svacer sarif2 *</code>
* Экспорт SARIF теперь включает все комментарии как отдельные объекты в <code>Properties</code>
* При экспорте в SARIF теперь экспортируются поля <code>Labels, Orig function</code>
* Импорт SARIF теперь корректным образом учитывает relatedLocations и формирует трассу
* Импорт SARIF теперь автоматически импортирует исходники, если они включены в сам SARIF файл
* Добавлена возможность указания [[Help:Sarif#Мэппинг severity|мэппинга severity]] детекторов при импорте из SARIF
* Добавлен механизм указания правил резолвинга путей при импортировании исходного кода вместе с SARIF файлом
* Экспорт исходников из снимка будет доступен только при наличии исходников на сервере
* Добавлены флаги <code>--autoclean</code>, <code>--autoclean-svace</code> в команду <code>svacer import</code> для автоматического удаления <code>.svace-dir / .svacer-dir</code> после успешного импорта и загрузки данных на сервер
* Улучшена поддержка [[OIDC]]
* Улучшена поддержка [[LDAP configuration|LDAP]]
* Добавлена интеграция с хранилищем секретов [[Infisical]]
* Добавлена [[Notifications|служба нотификаций]] пользователей через почтовые сообщения и мессенджер telegram
* Добавлен механизм аутентификации и [[Help:UI manual#Управление токенами доступа|управления]] персональными токенами доступа
* Добавлен механизм упоминания пользователей через специальную конструкцию @login в комментариях к разметке
* В разделе Статистика добавлен дашборд с [[Release notes 11-0-0#Изменения в разделе Статистика|Общей статистикой]], содержащей метрики по последним импортированным снимкам в ветках проектов
* В статистике по активности пользователей добавлена возможность просмотра панели с актуальной информацией о маркере и опция показа только действий с актуальной разметкой
* Большинство CLI команд, работающих с сервером, теперь делают явный logout после завершения
* Svacer при импорте результатов Svace автоматически импортирует файлы <code>*.warn, *.err</code> с предупреждениями от самого анализатора Svace. Автоматический импорт не будет происходить при размере этих файлов более 30Мб (большой размер может свидетельствовать о проблемах в ходе анализа)
* Переменная окружения <code>SVACER_CACHE_DIR</code> теперь учитывается во всех местах (ранее в ряде случаев мог неявно использоваться <code>$HOME/.cache</code>)
* Добавлена возможность [[Help:CLI/cleanup|автоматического удаления снимков]]

=== Release 10-0-1 ===
17.02.2025

* Исправлена ошибка с временной таблицей при обработке планов автомиграции разметки при импорте результатов (ERROR: relation "loaded_review" already exists)

=== Release 10-0-0 ===
16.01.2025

* Множество изменений в UI, смотрите [[Release notes 10-0-0]]
* Сделали [[Help:Installation#rpm|dnf/yum репозиторий]] для RPM-пакетов Svacer
* Реализована возможность [[Markup2|экспорта, импорта и копирования разметки посредством Public REST API и CLI]]
* Реализован дополнительный экспериментальный механизм [[Help:UI manual#Настройка интерфейса|генерации PDF на основе HTML]]. Генерация PDF переведена на асинхронный режим с показом нотификации пользователю
* Добавлена возможность очистки всей разметки и/или комментариев на ветке проекта
* Улучшения функциональности просмотра маркеров в встроенном IDE Theia
* Добавлена функциональность по [[Help:UI manual#Глобальный поиск|глобальному поиску]] маркеров, комментариев и снимков по различным атрибутам
* Добавлена возможность [[Help:UI manual#Просмотр статистики|получения статистики]] по маркерам и активностям пользователей при разметке
* В API fullmarkers добавлен параметр <code>labels: true/false</code> для выгрузки меток маркера
* Реализован Public API для получения/добавления/удаления меток маркеров
* Настройки LDAP и прочие настройки аутентификации добавлены в единый конфигурационный файл
* Добавлена возможность удаления кода из снимка при частичном импорте в Svacer
* Добавлена опция minVersion, maxVersion для TLS при запуске сервера Svacer
* Добавлена поддержка групп проектов при импорте снимков в CLI
* При импорте снимков реализована поддержка автоматического определения пути префикса для переноса разметки
* Исправлен ряд ошибок в импорте и генерации [[Help:Sarif|SARIF]]
* Исправлены ошибки в копировании разметки между ветками, клонировании проектов и веток
* Добавлена возможность отключения бэкграунд задач по очистке мусора
* Добавлено экспериментальное CLI API для просмотра асинхронных задач на генерацию PDF
* Добавлена возможность визуализации производительности сервера на основе [https://github.com/arl/statsviz statsviz]
* Добавлена поддержка относительных путей в svres файле
* Добавлена возможность ожидания завершения операций по очистки мусора при выполнении операций по импорту результатов анализа
* Добавлена поддержка CWE таксономий при экспорте [[Help:Sarif|SARIF]]
* Добавлена переменная окружения SVACER_TOKEN_LIFETIME для управления временем жизни токена аутентификации
* Добавлена переменная окружения SVACER_RESET_ADMIN_PASSWORD для явного указания желаемого пароля при операции по сбросу пароля администратора
* Добавлен [[Notifications|механизм нотификаций пользователей]] о внутренних событиях Svacer (экспериментальный функционал)

=== Release 9-0-2 ===
22.07.2024

* Еще некоторые исправления, связанные с миграцией данных
* Исправлена проблема с навигацией по Go to Definition

=== Release 9-0-1 ===
15.07.2024

* Исправлены ошибки в клонировании проектов, приводящие к размножению записей в некоторых внутренних таблицах
* Различные исправления, связанные с миграцией данных
* Исправлена работа ряда CLI команд с включенным TLS на сервере
* Исправлен ряд ошибок в генерации PDF

=== Release 9-0-0 ===
04.06.2024

* Множество изменений в UI, смотрите [[Release notes 9-0-0]]
* Svacer разделен на два исполняемых файла: <code>svacer-server</code> — сервер и <code>svacer</code> — клиент
* {{Note}}Object store заменен на другую реализацию. Конвертация данных запускается автоматически при апгрейде и требует примерно 2х-2.2х дискового пространства, после конвертации старый object store будет удален. Время конвертации зависит от объема данных и скорости диска
* {{Note}}Изменен [[Help:Match|алгоритм сопоставления предупреждений]]. При старте сервера будет произведена регенерация всех инвариантов во всех ветках. Это может занять продолжительное время (зависит от мощности сервера и объемов данных)
* Добавлена возможность [[Help:Match#Ручное сопоставление предупреждений (экспериментальная возможность)|ручного сопоставления предупреждений]] для переноса разметки
* Добавлена экспериментальная поддержка [[OIDC|OpenID]] протокола для аутентификации
* Добавлена экспериментальная возможность [[Help:CLI#Слияние снимков из CLI (экспериментальная опция)|слияния снимков через CLI]]
* Исправлены баги в [[Help:Sarif|импорте Sarif]], добавлена поддержка импорта с относительными путями к файлам (флаг <code>--base-dir</code>)
* Лог сервера работает в режиме append, прежние данные не затираются
* Добавлена возможность передачи токена аутентификации в клиент Svacer через переменную окружения <code>SVACER_AUTH_TOKEN=token</code>
* Добавлена возможность передачи логина и пароля в клиент Svacer через переменную окружения <code>SVACER_AUTH_CREDS=login:password</code>
* Добавлен public REST endpoint для импорта <code>.svace-dir</code> на стороне сервера
* Добавлена возможность импорта <code>.svace-dir</code> из веб-интерфейса
* Добавлены [[Metrics|метрики]] для Prometheus, доступны при запуске сервера с переменной окружения <code>SVACER_TRACE_OPTIONS=prom_metrics_on</code> на <code>/api/metrics</code>
* Добавлена очистка БД от мусора с возможностью настройки периодичности данной операции через переменную окружения <code>SVACER_GC_PERIOD=val</code> где val — duration в формате <code>hhmmss</code> или [https://en.wikipedia.org/wiki/Cron Cron]
* Добавлена возможность клонирования проектов
* Добавлен импорт <code>*warn, *.err</code> файлов из <code>.svace-dir</code>, которые содержат диагностические сообщения от Svace
* Добавлена возможность [[Help:CLI#Ограничение числа запросов|ограничения числа запросов]] на сервер с указанием параметров в переменной окружения <code>SVACER_SERVER_THROTTLE_PARAMS</code>
* Добавлен шаблон для импорта разметки из кода на Go: <code>DEFAULT_GO</code>
* Добавлена возможность [[Help:CLI#Аутентификация из файла|аутентификации из файла]]
* Исправлены проблемы безопасности
* Добавлена возможность просмотра исходного кода снимка с предупреждениями анализатора во внешней IDE собранной на базе [https://theia-ide.org/ Theia IDE]
* К команде automigrate add в CLI добавлен флаг <code>skip-exist</code>, чтобы при добавлении паттерна, который уже существует, не выдавало ошибки
* К команде upload (import с флагом upload) с указанием флага <code>quality-gate</code> теперь можно добавить флаг <code>quality-gate-verbose</code>. Если его указать, то также будет выведен результат успешных проверок quality-gate
* Улучшения в поддержке протокола LDAP

=== Release 8-0-1 ===
22.01.2024

* Исправлена работа в изолированной от сети среде. Загрузка Web UI больше не требует доступа к публичным CDN
* Добавлена поддержка функций при указании пользовательского фильтра
* Добавлено API для управления пользовательскими фильтрами. Детали и пример использования можно найти здесь: https://gitlab.ispras.ru/svacer-public/api-go-examples/-/tree/master/api-ui-settings
* Исправлено отображение Checker Severity при экспорте в SARIF. Теперь Critical -> error; Major, Normal -> warning; Minor -> note; any other -> warning

=== Release 8-0-0 ===
21.11.2023

* Множество изменений в UI. Смотрите обзор в [[Release notes 8-0-0]]
* Добавлен новый импорт и экспорт из SARIF в command line с поддержкой исходного кода в SARIF файлах и импортом описания детекторов из SARIF
* Добавлены группы проектов
* Переделана модель ролей и доступов. Добавлен CLI для управления ролями и доступами
* Добавлена возможность настройки автопереноса разметки между ветками, в том числе в разных проектах
* Импорт/экспорт снимков включает информацию о детекторах
* Исправлена работа интерфейса с Undefined детекторами (т. е. детекторами, информация о которых отсутствует в Svacer)
* Добавлено экспериментальное API по управлению детекторами и конфигурациями детекторов
* Добавлена очистка исходного кода от Svacer-specific комментариев перед экспортом разметки в код
* Добавлена возможность включения режима обязательного комментария при разметке кода. Комментарий будет сгруппирован с операцией разметки и будет иметь ссылку на нее
* Утилита миграции со старого svace-сервера больше не поддерживается. При необходимости миграции используйте утилиту из прошлых релизов Svacer
* Добавлена Swagger документация на API
* Добавлено хранение истории изменений комментариев
* Опция <code>--pathPrefix</code> поддерживает файлы в JSON формате вида: <code>[{ "prefix": "/some/path", "replace": "/test" }, ...]</code>
* При использовании операции по обновлению <code>pathPrefix</code> на сервере, данные о прежнем <code>pathPrefix</code> запоминаются в мета-информации о снимке
* Добавлена возможность переименования снимков в UI
* Sensitive информация (детали подключения к БД с данными аутентификации) убрана из UI и API
* ОС в docker-образе Svacer обновлена с Ubuntu 18 до Ubuntu 22
* Улучшена логика автоопределения портов и протоколов при соединении с сервером из Svacer CLI

=== Release 7-0-1 ===
23.05.2023

* Исправлена проблема с фильтрацией предупреждений для C# проектов

=== Release 7-0-0 ===
16.05.2023

* Убрана зависимость от PostgreSQL из .deb и .rpm пакетов, чтобы проще было ставить Svacer только как клиент
* Сделан пакет для Windows (.msi) и документация по установке и запуску на Windows
* Теперь, если при svacer import и svacer sarif не указан путь к проекту, им считается текущая директория
* Информация о разметке и блокировках теперь обновляется автоматически при изменении в другом браузере (табе) или другим пользователем
* UI для пользовательских фильтров улучшен и перенесен в правую верхнюю часть экрана
* UI для выбора проекта, ветки и снимка теперь находится на одном уровне
* Улучшен UI для режима сравнения снимков
* Добавлена возможность работать одновременно с несколькими открытыми файлами в режиме Code, это поведение можно изменить в настройках профиля пользователя
* В левой навигационной панели детекторы теперь по умолчанию группируются по серьезности, это поведение можно изменить в настройках профиля пользователя
* Профиль текущего пользователя теперь можно смотреть/редактировать только через меню в правом верхнем углу
* Добавлена возможность копирования в системном логе и журнале
* Для пользователя теперь запоминается последний контекст (проект/ветка/снимок), с которым он работал, он автоматически открывается при старте новой сессии
* Групповая разметка теперь делается единой транзакцией, в случае ошибок или отмены все изменения откатываются
* Добавлено предупреждение при использовании некорректных путей при использовании REST API с префиксом /api
* Поддержка указания паролей из файла или pipe-а при использование Svacer CLI
* Добавлена поддержка multi-tab code view для режима просмотра кода объекта сборки
* Добавлена поддержка сохранения информации об удаленных детекторах при загрузке информации о детекторах из новой версии Svace
* Исправлен импорт результатов анализа, если сборка проводилась с опцией --disable-dxr
* Исправлены проблемы при импорте и прикреплении нескольких файлов к снимку
* Исправлены ошибки с входом в систему пользователей LDAP (специальные символы в пароле, вход по атрибуту mail)
* Добавлена возможность использования резервных серверов LDAP
* Добавлена возможность автоматического назначения пользователям LDAP роли Svacer, в зависимости от принадлежности пользователя к LDAP группе
* Добавлены новые public запросы на получение маркеров/снимков/проектов с учетом заданных параметров фильтрации
* Добавлена поддержка TLS при работе сервера по протоколам HTTP и gRPC
* Добавлена возможность загрузки статистики по общему количеству предупреждений и по количеству размеченных предупреждений для проектов и веток через REST API
* Добавлена вкладка выбора проектов в расширении VSCode
* Убрана возможность использовать всплывающее окно в VScode для добавления/редактирования/удаления комментариев, установки ревью-статусов, локов и т.д.

=== Release 6-0-3 ===
25.01.2023

* RPM-пакет теперь при сборке упаковывается в gzip вместо zstd для обратной совместимости со старыми дистрибутивами
* Если short url некорректен, то Svacer теперь будет возвращать корректный http error NotFound
* Если путь к лог файлу явно не указан, то svacer.log будет создаваться во временной директории. Это решает проблемы при запуске Svacer из директорий с запретом на запись. Путь к лог файлу будет печататься в stdout
* Лог файлы не будут создаваться, когда используется опция --help
* Исправлены проблемы при миграции схемы данных, когда в PostgreSQL используется SSL подключение
* Добавлены описания детекторов из последнего релиза Svace, которые были пропущены в релизе 6-0-2
* Исправлена работа Svacer за proxy-сервером, где выставляется Header "X-Content-Type-Options nosniff"
* Добавлены кнопки для скачивания системного лога и журнала из web-интерфейса
* Поправлен ряд ошибок валидации схемы при экспорте в SARIF
* Исправлено поведение при наличии нескольких хуков в конфигурационном файле
* В информацию о маркере для хуков добавлены checker severity и reliability
* Исправлен случайный порядок URL для маркеров при использовании public API для получения URL-ов
* На главную страницу добавлена кнопка "Помощь", которая открывает документацию
* При использовании команд навигации в режиме "Browse code" текущий файл теперь корректно подсвечивается в дереве файлов
* В диалоге групповой разметки убран индикатор изменений в виде кружочка, наличие изменений можно определить по активности кнопок "Apply" и "Reset"
* Кнопка обновления в верхнем меню теперь корректно обновляет информацию на странице Settings/Project
* Различные небольшие исправления в пользовательском интерфейсе

=== Release 6-0-2 ===
16.12.2022

* Исправлена проблема в UI с сохраненными пользовательскими фильтрами

=== Release 6-0-1 ===
13.12.2022

* Добавлено описание ряда детекторов, которые есть в последнем релизе Svace 3.3.2 но были пропущены в Svacer
* Исправлено вылетание в Login Screen при удалении нотификации из панели нотификаций
* Исправлено появление белого экрана при клике на детектор, информация о котором отсутствует
* Ряд различных небольших исправлений в UI
* Промежуточное хранилище будет очищаться по умолчанию при использовании команды import

=== Release 6-0-0 ===
30.11.2022

* Добавлено копирование комментариев при копировании разметки
* Комментарии добавлены к отчету в формате csv
* Добавлена возможность вводить пароль с клавиатуры для консольных команд
* Добавлена возможность импортировать разметку из объекта сборки (из ранее загруженных данных)
* Добавлена возможность импортировать разметку сразу после загрузки на сервер (опция для команды svacer upload)
* Добавлена возможность загружать исходный код не из папки .svace-dir
* Добавлена возможность бэкапа и восстановление объектного хранилища в сервер PostgresSQL
* Добавлена возможность создания отчета по проекту в формате PDF через интерфейс командной строки и посредством REST API
* Добавлена возможность подавления предупреждений через inline комментарии в коде
* Добавлена возможность подавления предупреждений по идентификатору предупреждения через command line и REST API
* Добавлена возможность ассоциировать организацию с пользователем и реестр организаций
* Добавлена фильтрация списка комментариев по пользователю в правой панели веб-интерфейса
* Добавлен поиск пользователей по его атрибутам в панели управления пользователями
* Добавлена возможность заполнения данных профиля LDAP пользователя данными, полученными от LDAP сервера
* Добавлена возможность прикреплять файлы к снимкам при импорте результатов (данные файлы составляют часть экспортируемых данных при экспорте снимков)
* Добавлена возможность ассоциировать пользовательские атрибуты типа "строка" или массив строк со снимком при импорте данных (данные атрибуты составляют часть экспортируемых данных при экспорте снимков)
* Добавлены command line операции по получению прикрепленных файлов и пользовательских атрибутов со снимков
* Добавлена возможность группового добавления комментариев
* Добавлена возможность указания сетевого интерфейса для работы WEB и GRPC серверов
* Добавлен вывод краткой статистики по загруженному снимку при команде upload. Поддерживается текстовой и JSON форматы вывода
* Существенно расширены возможности по интеграции Visual Studio Code с сервером Svacer
* Добавлен флаг --git в команду import. При наличии такого флага, ищется ближайший git репозиторий содержащий .svace-dir и при наличии такого - используется путь к гит репозиторию для замены путей на префикс .build.
* Portable PostgreSQL больше не входит в поставку. Вместо него поставляется docker-compose.yml файл для запуска PostgreSQL в докер-контейнере
* Добавлено больше данных и информации об ошибках в вывод команды svacer import
* Изменение Public API: добавлена точка входа /api/public/login
* Операции по импорту и экспорту снимков доступны теперь обычным пользователям (не администраторам) при использовании command line интерфейса
* Операция по экспорту снимков доступна обычному пользователю из веб-интерфейса (импорт все еще требует роль администратора для веб-интерфейса)
* Операции по экспорту снимков переведены на асинхронный режим. Нотификация о готовности будет показана пользователю и доступна в панели нотификаций
* Обновлено описание детекторов в соответствии с релизом Svace 3.3.2
* Исправлена ошибка обработки корневых сертификатов при подключении к LDAP серверу по протоколу ldaps
* Исправлено ошибочное создание дубликатов локальных учетных записей LDAP пользователей (case sensitive login)
* Различные исправления в пользовательском интерфейсе с целью оптимизации производительности
* Добавлены пропущенные проверки ролей при работе с веб-интерфейсом
* Svacer больше не создает временные файлы в директории с исполняемым файлом
* Устаранены задержки при удалении веток и проектов

Metrics

2025-11-28T14:49:32Z

Akuzmin: add new metrics

=== Включение метрик ===
Для включения метрик запустите сервер Svacer с переменной окружения '''SVACER_TRACE_OPTIONS=prom_metrics_on'''

SVACER_TRACE_OPTIONS=prom_metrics_on svacer-server run

После этого метрики будут доступны по URL вашего сервера на '''/api/metrics'''
<pre>http://localhost:8080/api/metrics</pre>

=== Список метрик ===
{| class="wikitable"
|+
!Название
!Описание
|-
|svacer_active_imports
|Number of active imports of svace/sarif results
|-
|svacer_active_pdf_exports
|Number of active pdf export tasks
|-
|svacer_active_snapshot_exports
|Number of active snapshot exports
|-
|svacer_active_snapshot_imports
|Number of active snapshot imports
|-
|svacer_comment_changes_since_start
|The total number of comment additions/deletions/modifications since start
|-
|svacer_import_results_since_start
|The total number of imported results since last server start
|-
|svacer_import_snapshots_since_start
|The total number of imported snapshots since last server start
|-
|svacer_object_store_read_ampl
|The current read amplification of the database. It's computed as the number of sublevels in L0 + the number of non-empty levels below L0
|-
|svacer_object_store_size
|Approximate size of the object store
|-
|svacer_object_store_vsize
|VirtualSize is the sum of the sizes of the virtual sstables in the latest version. BackingTableSize - VirtualSize gives an estimate for the space amplification caused by not compacting virtual sstables
|-
|svacer_pgxpool_acquire_count
|Cumulative count of successful acquires from the pool
|-
|svacer_pgxpool_acquire_duration_ns
|Total duration of all successful acquires from the pool in nanoseconds
|-
|svacer_pgxpool_acquired_conns
|Number of currently acquired connections in the pool
|-
|svacer_pgxpool_canceled_acquire_count
|Cumulative count of acquires from the pool that were canceled by a context
|-
|svacer_pgxpool_constructing_conns
|Number of conns with construction in progress in the pool
|-
|svacer_pgxpool_empty_acquire
|Cumulative count of successful acquires from the pool that waited for a resource to be released or constructed because the pool was empty
|-
|svacer_pgxpool_idle_conns
|Number of currently idle conns in the pool
|-
|svacer_pgxpool_max_conns
|Maximum size of the pool
|-
|svacer_pgxpool_max_idle_destroy_count
|Cumulative count of connections destroyed because they exceeded MaxConnIdleTime
|-
|svacer_pgxpool_max_lifetime_destroy_count
|Cumulative count of connections destroyed because they exceeded MaxConnLifetime
|-
|svacer_pgxpool_new_conns_count
|Cumulative count of new connections opened
|-
|svacer_pgxpool_total_conns
|Total number of resources currently in the pool. The value is the sum of ConstructingConns, AcquiredConns, and IdleConns
|-
|svacer_rest_import_sarif
|The total number of import sarif requests via REST endpoint
|-
|svacer_rest_import_sarif_failed
|The total number of failed import sarif requests via REST endpoint
|-
|svacer_rest_import_sarif_success
|The total number of success import sarif requests via REST endpoint
|-
|svacer_rest_import_svace_dirs
|The total number of import svace dir requests via REST endpoint
|-
|svacer_rest_import_svace_dirs_failed
|The total number of failed import svace dir requests via REST endpoint
|-
|svacer_rest_import_svace_dirs_success
|The total number of success import svace dir requests via REST endpoint
|-
|svacer_rest_num_tokens_issued
|The total number of login tokens issued
|-
|svacer_rest_num_tokens_removed
|The total number of login tokens removed
|-
|svacer_review_changes_since_start
|The total number of review modifications since start
|-
|svacer_total_branches_count
|Total number of branches on server
|-
|svacer_total_ldap_users_count
|Total number of LDAP users on server
|-
|svacer_total_projects_count
|Total number of projects on server
|-
|svacer_total_snapshots_count
|Total number of projects on server
|-
|svacer_total_users_count
|Total number of non-LDAP users on server
|-
|svacer_wsocket_sessions_counter
|The total number of active web socket connections
|}

=== Добавление в Prometheus ===
Для сбора метрик Прометеусом добавьте в его конфиг-файл '''/etc/prometheus/prometheus.yml''' подобную запись, поменяв название, хост и порт на те что у вас

- job_name: svacer-metrics-example
metrics_path: /api/metrics
static_configs:
- targets: ['svacer.ispras.ru:8080']

=== Grafana dashboard ===
Для визуализации метрик в [https://grafana.com Grafana] импортируете dashboard из файла [[Media:Grafana-dashboard-svacer.json|grafana-dashboard-svacer.json]]. В диалоге импорта выберите собирающий метрики Prometheus в качестве data source.

Svacer

2025-11-28T12:01:18Z

Akuzmin: remove ai-demo: it's a part of the svacer demo now

Svacer — сервер для хранения и обработки результатов статического анализа. Поддерживает импорт результатов анализа из [https://svace.ispras.ru Svace] напрямую и из прочих анализаторов через формат [[Help:Sarif|SARIF]].

=== Документация ===
Version 12.x.x
# [[Help:Introduction|Введение]]
# [[Help:Installation|Установка и обновление]]
# [[Help:Configuration|Настройка сервера]]
# [[Help:Import from Svace|Импорт из Svace]]
# [[Help:Backup|Резервное копирование]]
# [[Help:UI manual|Использование веб-интерфейса]]
# [[Help:Public API|Public REST API]]
# [[Help:CLI|CLI]]
# [[LDAP configuration|LDAP]]
# [[OIDC|OpenID Connect]]
# [[Help:Sarif|SARIF]]
# [[Help:Statistics|Статистика]]
# [[Help:Match|Механизмы сопоставления предупреждений и переноса разметки]]
# [[Help:XSvacer|XSvacer — расширение функциональности Svacer]]
# [[Help:Utils|Дополнительные утилиты]]
# [[Metrics|Prometheus-метрики]]
# [[Pipelines|Примеры пайплайнов]]
# [[Notifications|Уведомления]]

=== Релизы ===
Также доступны в виде docker-образа на [https://hub.docker.com/r/ispras/svacer docker hub] и как пакеты в [[Help:Installation#Установка и запуск из deb/rpm пакета|репозиториях]]

{| class="wikitable"
! version !! distrib !! linux bin !! windows bin !! deb/rpm !! doc
!svace checkers version
|-
| 12.0.0
| [https://svacer.ispras.ru/releases/svacer-12-0-0/svacer-12-0-0-linux.tar.gz svacer-12-0-0-linux.tar.gz] [https://svacer.ispras.ru/releases/svacer-12-0-0/svacer-12-0-0-windows.zip svacer-12-0-0-windows.zip]
| [https://svacer.ispras.ru/releases/svacer-12-0-0/svacer svacer] [https://svacer.ispras.ru/releases/svacer-12-0-0/svacer-server svacer-server]
| [https://svacer.ispras.ru/releases/svacer-12-0-0/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-12-0-0/svacer-server.exe svacer-server.exe]
| [https://svacer.ispras.ru/releases/svacer-12-0-0/svacer_12.0-0_amd64.deb svacer_12.0-0_amd64.deb] [https://svacer.ispras.ru/releases/svacer-12-0-0/svacer-12.0-0.x86_64.rpm svacer-12.0-0.x86_64.rpm]
| [[Changelog#Release 12-0-0|Changelog]] [[Release notes 12-0-0|Release notes]] [[Help:Installation#Обновление|Upgrade notes]] [[Svacer#Документация|Documentation 12.x.x]]
|4.0.251120
|-
| 11.2.0
| [https://svacer.ispras.ru/releases/svacer-11-2-0/svacer-11-2-0-linux.tar.gz svacer-11-2-0-linux.tar.gz] [https://svacer.ispras.ru/releases/svacer-11-2-0/svacer-11-2-0-windows.zip svacer-11-2-0-windows.zip]
| [https://svacer.ispras.ru/releases/svacer-11-2-0/svacer svacer] [https://svacer.ispras.ru/releases/svacer-11-2-0/svacer-server svacer-server]
| [https://svacer.ispras.ru/releases/svacer-11-2-0/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-11-2-0/svacer-server.exe svacer-server.exe]
| [https://svacer.ispras.ru/releases/svacer-11-2-0/svacer_11.2-0_amd64.deb svacer_11.2-0_amd64.deb] [https://svacer.ispras.ru/releases/svacer-11-2-0/svacer-11.2-0.x86_64.rpm svacer-11.2-0.x86_64.rpm]
| [[Changelog#Release 11-2-0|Changelog]] [[Help:Installation#Обновление|Upgrade notes]] [[Documentation 11.x.x]]
|4.0.250415
|-
| 11.1.0
| [https://svacer.ispras.ru/releases/svacer-11-1-0/svacer-11-1-0-linux.tar.gz svacer-11-1-0-linux.tar.gz] [https://svacer.ispras.ru/releases/svacer-11-1-0/svacer-11-1-0-windows.zip svacer-11-1-0-windows.zip]
| [https://svacer.ispras.ru/releases/svacer-11-1-0/svacer svacer] [https://svacer.ispras.ru/releases/svacer-11-1-0/svacer-server svacer-server]
| [https://svacer.ispras.ru/releases/svacer-11-1-0/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-11-1-0/svacer-server.exe svacer-server.exe]
| [https://svacer.ispras.ru/releases/svacer-11-1-0/svacer_11.1-0_amd64.deb svacer_11.1-0_amd64.deb] [https://svacer.ispras.ru/releases/svacer-11-1-0/svacer-11.1-0.x86_64.rpm svacer-11.1-0.x86_64.rpm]
| [[Changelog#Release 11-1-0|Changelog]] [[Help:Installation#Обновление|Upgrade notes]] [[Documentation 11.x.x]]
|4.0.250415
|-
| 11.0.0
| [https://svacer.ispras.ru/releases/svacer-11-0-0/svacer-11-0-0-linux.tar.gz svacer-11-0-0-linux.tar.gz] [https://svacer.ispras.ru/releases/svacer-11-0-0/svacer-11-0-0-windows.zip svacer-11-0-0-windows.zip]
| [https://svacer.ispras.ru/releases/svacer-11-0-0/svacer svacer] [https://svacer.ispras.ru/releases/svacer-11-0-0/svacer-server svacer-server]
| [https://svacer.ispras.ru/releases/svacer-11-0-0/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-11-0-0/svacer-server.exe svacer-server.exe]
| [https://svacer.ispras.ru/releases/svacer-11-0-0/svacer_11.0-0_amd64.deb svacer_11.0-0_amd64.deb] [https://svacer.ispras.ru/releases/svacer-11-0-0/svacer-11.0-0.x86_64.rpm svacer-11.0-0.x86_64.rpm]
| [[Changelog#Release 11-0-0|Changelog]] [[Release notes 11-0-0|Release notes]] [[Help:Installation#Обновление|Upgrade notes]] [[Documentation 11.x.x]]
|4.0.250415
|-
| 10.0.1
| [https://svacer.ispras.ru/releases/svacer-10-0-1/svacer-10-0-1-linux.tar.gz svacer-10-0-1-linux.tar.gz] [https://svacer.ispras.ru/releases/svacer-10-0-1/svacer-10-0-1-windows.zip svacer-10-0-1-windows.zip]
| [https://svacer.ispras.ru/releases/svacer-10-0-1/svacer svacer] [https://svacer.ispras.ru/releases/svacer-10-0-1/svacer-server svacer-server]
| [https://svacer.ispras.ru/releases/svacer-10-0-1/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-10-0-1/svacer-server.exe svacer-server.exe]
| [https://svacer.ispras.ru/releases/svacer-10-0-1/svacer_10.0-1_amd64.deb svacer_10.0-1_amd64.deb] [https://svacer.ispras.ru/releases/svacer-10-0-1/svacer-10.0-1.x86_64.rpm svacer-10.0-1.x86_64.rpm]
| [[Changelog#Release 10-0-1|Changelog]] [[Help:Installation#Обновление|Upgrade notes]] [[Documentation 10.x.x]]
|4.0.241102
|-
| 10.0.0
| [https://svacer.ispras.ru/releases/svacer-10-0-0/svacer-10-0-0-linux.tar.gz svacer-10-0-0-linux.tar.gz] [https://svacer.ispras.ru/releases/svacer-10-0-0/svacer-10-0-0-windows.zip svacer-10-0-0-windows.zip]
| [https://svacer.ispras.ru/releases/svacer-10-0-0/svacer svacer] [https://svacer.ispras.ru/releases/svacer-10-0-0/svacer-server svacer-server]
| [https://svacer.ispras.ru/releases/svacer-10-0-0/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-10-0-0/svacer-server.exe svacer-server.exe]
| [https://svacer.ispras.ru/releases/svacer-10-0-0/svacer_10.0-0_amd64.deb svacer_10.0-0_amd64.deb] [https://svacer.ispras.ru/releases/svacer-10-0-0/svacer-10.0-0.x86_64.rpm svacer-10.0-0.x86_64.rpm]
| [[Changelog#Release 10-0-0|Changelog]] [[Release notes 10-0-0|Release notes]] [[Help:Installation#Обновление|Upgrade notes]] [[Documentation 10.x.x]]
|4.0.241102
|-
| 9.0.2
| [https://svacer.ispras.ru/releases/svacer-9-0-2/svacer-9-0-2.zip svacer-9-0-2.zip]
| [https://svacer.ispras.ru/releases/svacer-9-0-2/svacer svacer] [https://svacer.ispras.ru/releases/svacer-9-0-2/svacer-server svacer-server]
| [https://svacer.ispras.ru/releases/svacer-9-0-2/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-9-0-2/svacer-server.exe svacer-server.exe]
| [https://svacer.ispras.ru/releases/svacer-9-0-2/svacer_9.0-2_amd64.deb svacer_9.0-2_amd64.deb] [https://svacer.ispras.ru/releases/svacer-9-0-2/svacer-9.0-2.x86_64.rpm svacer-9.0-2.x86_64.rpm]
| [[Changelog#Release 9-0-2|Changelog]] [[Help:Installation#9-0-0|Upgrade notes]] [[Documentation 9.x.x]]
|3.4.240312
|-
| 9.0.1
| [https://svacer.ispras.ru/releases/svacer-9-0-1/svacer-9-0-1.zip svacer-9-0-1.zip]
| [https://svacer.ispras.ru/releases/svacer-9-0-1/svacer svacer] [https://svacer.ispras.ru/releases/svacer-9-0-1/svacer-server svacer-server]
| [https://svacer.ispras.ru/releases/svacer-9-0-1/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-9-0-1/svacer-server.exe svacer-server.exe]
| [https://svacer.ispras.ru/releases/svacer-9-0-1/svacer_9.0-1_amd64.deb svacer_9.0-1_amd64.deb] [https://svacer.ispras.ru/releases/svacer-9-0-1/svacer-9.0-1.x86_64.rpm svacer-9.0-1.x86_64.rpm]
| [[Changelog#Release 9-0-1|Changelog]] [[Help:Installation#9-0-0|Upgrade notes]] [[Documentation 9.x.x]]
|3.4.240312
|-
| 9.0.0
| [https://svacer.ispras.ru/releases/svacer-9-0-0/svacer-9-0-0.zip svacer-9-0-0.zip]
| [https://svacer.ispras.ru/releases/svacer-9-0-0/svacer svacer] [https://svacer.ispras.ru/releases/svacer-9-0-0/svacer-server svacer-server]
| [https://svacer.ispras.ru/releases/svacer-9-0-0/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-9-0-0/svacer-server.exe svacer-server.exe]
| [https://svacer.ispras.ru/releases/svacer-9-0-0/svacer_9.0-0_amd64.deb svacer_9.0-0_amd64.deb] [https://svacer.ispras.ru/releases/svacer-9-0-0/svacer-9.0-0.x86_64.rpm svacer-9.0-0.x86_64.rpm]
| [[Changelog#Release 9-0-0|Changelog]] [[Release notes 9-0-0|Release notes]] [[Help:Installation#9-0-0|Upgrade notes]] [[Documentation 9.x.x]]
|3.4.240312
|-
| 8.0.1
| [https://svacer.ispras.ru/releases/svacer-8-0-1/svacer-8-0-1.zip svacer-8-0-1.zip]
| [https://svacer.ispras.ru/releases/svacer-8-0-1/svacer svacer]
| [https://svacer.ispras.ru/releases/svacer-8-0-1/svacer.exe svacer.exe]
| [https://svacer.ispras.ru/releases/svacer-8-0-1/svacer_8.0-1_amd64.deb svacer_8.0-1_amd64.deb] [https://svacer.ispras.ru/releases/svacer-8-0-1/svacer-8.0-1.x86_64.rpm svacer-8.0-1.x86_64.rpm] [https://svacer.ispras.ru/releases/svacer-8-0-1/svacer-8.0.1.msi svacer-8.0.1.msi]
| [[Changelog#Release 8-0-1|Changelog]] [[Documentation 8.x.x]]
|3.4.0
|-
| 8.0.0
| [https://svacer.ispras.ru/releases/svacer-8-0-0/svacer-8-0-0.zip svacer-8-0-0.zip]
| [https://svacer.ispras.ru/releases/svacer-8-0-0/svacer svacer]
| [https://svacer.ispras.ru/releases/svacer-8-0-0/svacer.exe svacer.exe]
| [https://svacer.ispras.ru/releases/svacer-8-0-0/svacer_8.0-0_amd64.deb svacer_8.0-0_amd64.deb] [https://svacer.ispras.ru/releases/svacer-8-0-0/svacer-8.0-0.x86_64.rpm svacer-8.0-0.x86_64.rpm] [https://svacer.ispras.ru/releases/svacer-8-0-0/svacer-8.0.0.msi svacer-8.0.0.msi]
| [[Changelog#Release 8-0-0|Changelog]] [[Release notes 8-0-0|Release notes]] [[Documentation 8.x.x]]
|3.4.0
|}

[https://svacer.ispras.ru/releases Предыдущие релизы] | [https://nextcloud.ispras.ru/index.php/s/x4r4cMJAMr5RZtd?path=%2F Еще более старые релизы]

=== FAQ ===
* [https://gitlab.ispras.ru/svace/svace-support/-/wikis/home Документация на статический анализатор Svace]
* [[Help:Introduction#Системные требования|Системные требования]]
* [[Примеры использования хуков#Создание кейсов в системах отслеживания ошибок|Создание из Svacer кейсов в Gitlab, Jira, Redmine]]
* Public REST API
:* [[Help:Public API#Примеры использования public REST API|Примеры использования]]
:* [https://gitlab.ispras.ru/svacer-public Репозитории с примерами на Python и Go]
:* [https://svacer-demo.ispras.ru/api/public/swagger/ Спецификация OpenAPI]
* [https://t.me/+6pvgZ0oveNVhOTc6 Группа технической поддержки в Telegram]

=== Демо ===
https://svacer-demo.ispras.ru

* admin / admin — логин / пароль администратора
* user / user — логин / пароль пользователя

Svacer

2025-11-28T11:58:11Z

Akuzmin: add release notes

Svacer — сервер для хранения и обработки результатов статического анализа. Поддерживает импорт результатов анализа из [https://svace.ispras.ru Svace] напрямую и из прочих анализаторов через формат [[Help:Sarif|SARIF]].

=== Документация ===
Version 12.x.x
# [[Help:Introduction|Введение]]
# [[Help:Installation|Установка и обновление]]
# [[Help:Configuration|Настройка сервера]]
# [[Help:Import from Svace|Импорт из Svace]]
# [[Help:Backup|Резервное копирование]]
# [[Help:UI manual|Использование веб-интерфейса]]
# [[Help:Public API|Public REST API]]
# [[Help:CLI|CLI]]
# [[LDAP configuration|LDAP]]
# [[OIDC|OpenID Connect]]
# [[Help:Sarif|SARIF]]
# [[Help:Statistics|Статистика]]
# [[Help:Match|Механизмы сопоставления предупреждений и переноса разметки]]
# [[Help:XSvacer|XSvacer — расширение функциональности Svacer]]
# [[Help:Utils|Дополнительные утилиты]]
# [[Metrics|Prometheus-метрики]]
# [[Pipelines|Примеры пайплайнов]]
# [[Notifications|Уведомления]]

=== Релизы ===
Также доступны в виде docker-образа на [https://hub.docker.com/r/ispras/svacer docker hub] и как пакеты в [[Help:Installation#Установка и запуск из deb/rpm пакета|репозиториях]]

{| class="wikitable"
! version !! distrib !! linux bin !! windows bin !! deb/rpm !! doc
!svace checkers version
|-
| 12.0.0
| [https://svacer.ispras.ru/releases/svacer-12-0-0/svacer-12-0-0-linux.tar.gz svacer-12-0-0-linux.tar.gz] [https://svacer.ispras.ru/releases/svacer-12-0-0/svacer-12-0-0-windows.zip svacer-12-0-0-windows.zip]
| [https://svacer.ispras.ru/releases/svacer-12-0-0/svacer svacer] [https://svacer.ispras.ru/releases/svacer-12-0-0/svacer-server svacer-server]
| [https://svacer.ispras.ru/releases/svacer-12-0-0/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-12-0-0/svacer-server.exe svacer-server.exe]
| [https://svacer.ispras.ru/releases/svacer-12-0-0/svacer_12.0-0_amd64.deb svacer_12.0-0_amd64.deb] [https://svacer.ispras.ru/releases/svacer-12-0-0/svacer-12.0-0.x86_64.rpm svacer-12.0-0.x86_64.rpm]
| [[Changelog#Release 12-0-0|Changelog]] [[Release notes 12-0-0|Release notes]] [[Help:Installation#Обновление|Upgrade notes]] [[Svacer#Документация|Documentation 12.x.x]]
|4.0.251120
|-
| 11.2.0
| [https://svacer.ispras.ru/releases/svacer-11-2-0/svacer-11-2-0-linux.tar.gz svacer-11-2-0-linux.tar.gz] [https://svacer.ispras.ru/releases/svacer-11-2-0/svacer-11-2-0-windows.zip svacer-11-2-0-windows.zip]
| [https://svacer.ispras.ru/releases/svacer-11-2-0/svacer svacer] [https://svacer.ispras.ru/releases/svacer-11-2-0/svacer-server svacer-server]
| [https://svacer.ispras.ru/releases/svacer-11-2-0/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-11-2-0/svacer-server.exe svacer-server.exe]
| [https://svacer.ispras.ru/releases/svacer-11-2-0/svacer_11.2-0_amd64.deb svacer_11.2-0_amd64.deb] [https://svacer.ispras.ru/releases/svacer-11-2-0/svacer-11.2-0.x86_64.rpm svacer-11.2-0.x86_64.rpm]
| [[Changelog#Release 11-2-0|Changelog]] [[Help:Installation#Обновление|Upgrade notes]] [[Documentation 11.x.x]]
|4.0.250415
|-
| 11.1.0
| [https://svacer.ispras.ru/releases/svacer-11-1-0/svacer-11-1-0-linux.tar.gz svacer-11-1-0-linux.tar.gz] [https://svacer.ispras.ru/releases/svacer-11-1-0/svacer-11-1-0-windows.zip svacer-11-1-0-windows.zip]
| [https://svacer.ispras.ru/releases/svacer-11-1-0/svacer svacer] [https://svacer.ispras.ru/releases/svacer-11-1-0/svacer-server svacer-server]
| [https://svacer.ispras.ru/releases/svacer-11-1-0/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-11-1-0/svacer-server.exe svacer-server.exe]
| [https://svacer.ispras.ru/releases/svacer-11-1-0/svacer_11.1-0_amd64.deb svacer_11.1-0_amd64.deb] [https://svacer.ispras.ru/releases/svacer-11-1-0/svacer-11.1-0.x86_64.rpm svacer-11.1-0.x86_64.rpm]
| [[Changelog#Release 11-1-0|Changelog]] [[Help:Installation#Обновление|Upgrade notes]] [[Documentation 11.x.x]]
|4.0.250415
|-
| 11.0.0
| [https://svacer.ispras.ru/releases/svacer-11-0-0/svacer-11-0-0-linux.tar.gz svacer-11-0-0-linux.tar.gz] [https://svacer.ispras.ru/releases/svacer-11-0-0/svacer-11-0-0-windows.zip svacer-11-0-0-windows.zip]
| [https://svacer.ispras.ru/releases/svacer-11-0-0/svacer svacer] [https://svacer.ispras.ru/releases/svacer-11-0-0/svacer-server svacer-server]
| [https://svacer.ispras.ru/releases/svacer-11-0-0/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-11-0-0/svacer-server.exe svacer-server.exe]
| [https://svacer.ispras.ru/releases/svacer-11-0-0/svacer_11.0-0_amd64.deb svacer_11.0-0_amd64.deb] [https://svacer.ispras.ru/releases/svacer-11-0-0/svacer-11.0-0.x86_64.rpm svacer-11.0-0.x86_64.rpm]
| [[Changelog#Release 11-0-0|Changelog]] [[Release notes 11-0-0|Release notes]] [[Help:Installation#Обновление|Upgrade notes]] [[Documentation 11.x.x]]
|4.0.250415
|-
| 10.0.1
| [https://svacer.ispras.ru/releases/svacer-10-0-1/svacer-10-0-1-linux.tar.gz svacer-10-0-1-linux.tar.gz] [https://svacer.ispras.ru/releases/svacer-10-0-1/svacer-10-0-1-windows.zip svacer-10-0-1-windows.zip]
| [https://svacer.ispras.ru/releases/svacer-10-0-1/svacer svacer] [https://svacer.ispras.ru/releases/svacer-10-0-1/svacer-server svacer-server]
| [https://svacer.ispras.ru/releases/svacer-10-0-1/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-10-0-1/svacer-server.exe svacer-server.exe]
| [https://svacer.ispras.ru/releases/svacer-10-0-1/svacer_10.0-1_amd64.deb svacer_10.0-1_amd64.deb] [https://svacer.ispras.ru/releases/svacer-10-0-1/svacer-10.0-1.x86_64.rpm svacer-10.0-1.x86_64.rpm]
| [[Changelog#Release 10-0-1|Changelog]] [[Help:Installation#Обновление|Upgrade notes]] [[Documentation 10.x.x]]
|4.0.241102
|-
| 10.0.0
| [https://svacer.ispras.ru/releases/svacer-10-0-0/svacer-10-0-0-linux.tar.gz svacer-10-0-0-linux.tar.gz] [https://svacer.ispras.ru/releases/svacer-10-0-0/svacer-10-0-0-windows.zip svacer-10-0-0-windows.zip]
| [https://svacer.ispras.ru/releases/svacer-10-0-0/svacer svacer] [https://svacer.ispras.ru/releases/svacer-10-0-0/svacer-server svacer-server]
| [https://svacer.ispras.ru/releases/svacer-10-0-0/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-10-0-0/svacer-server.exe svacer-server.exe]
| [https://svacer.ispras.ru/releases/svacer-10-0-0/svacer_10.0-0_amd64.deb svacer_10.0-0_amd64.deb] [https://svacer.ispras.ru/releases/svacer-10-0-0/svacer-10.0-0.x86_64.rpm svacer-10.0-0.x86_64.rpm]
| [[Changelog#Release 10-0-0|Changelog]] [[Release notes 10-0-0|Release notes]] [[Help:Installation#Обновление|Upgrade notes]] [[Documentation 10.x.x]]
|4.0.241102
|-
| 9.0.2
| [https://svacer.ispras.ru/releases/svacer-9-0-2/svacer-9-0-2.zip svacer-9-0-2.zip]
| [https://svacer.ispras.ru/releases/svacer-9-0-2/svacer svacer] [https://svacer.ispras.ru/releases/svacer-9-0-2/svacer-server svacer-server]
| [https://svacer.ispras.ru/releases/svacer-9-0-2/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-9-0-2/svacer-server.exe svacer-server.exe]
| [https://svacer.ispras.ru/releases/svacer-9-0-2/svacer_9.0-2_amd64.deb svacer_9.0-2_amd64.deb] [https://svacer.ispras.ru/releases/svacer-9-0-2/svacer-9.0-2.x86_64.rpm svacer-9.0-2.x86_64.rpm]
| [[Changelog#Release 9-0-2|Changelog]] [[Help:Installation#9-0-0|Upgrade notes]] [[Documentation 9.x.x]]
|3.4.240312
|-
| 9.0.1
| [https://svacer.ispras.ru/releases/svacer-9-0-1/svacer-9-0-1.zip svacer-9-0-1.zip]
| [https://svacer.ispras.ru/releases/svacer-9-0-1/svacer svacer] [https://svacer.ispras.ru/releases/svacer-9-0-1/svacer-server svacer-server]
| [https://svacer.ispras.ru/releases/svacer-9-0-1/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-9-0-1/svacer-server.exe svacer-server.exe]
| [https://svacer.ispras.ru/releases/svacer-9-0-1/svacer_9.0-1_amd64.deb svacer_9.0-1_amd64.deb] [https://svacer.ispras.ru/releases/svacer-9-0-1/svacer-9.0-1.x86_64.rpm svacer-9.0-1.x86_64.rpm]
| [[Changelog#Release 9-0-1|Changelog]] [[Help:Installation#9-0-0|Upgrade notes]] [[Documentation 9.x.x]]
|3.4.240312
|-
| 9.0.0
| [https://svacer.ispras.ru/releases/svacer-9-0-0/svacer-9-0-0.zip svacer-9-0-0.zip]
| [https://svacer.ispras.ru/releases/svacer-9-0-0/svacer svacer] [https://svacer.ispras.ru/releases/svacer-9-0-0/svacer-server svacer-server]
| [https://svacer.ispras.ru/releases/svacer-9-0-0/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-9-0-0/svacer-server.exe svacer-server.exe]
| [https://svacer.ispras.ru/releases/svacer-9-0-0/svacer_9.0-0_amd64.deb svacer_9.0-0_amd64.deb] [https://svacer.ispras.ru/releases/svacer-9-0-0/svacer-9.0-0.x86_64.rpm svacer-9.0-0.x86_64.rpm]
| [[Changelog#Release 9-0-0|Changelog]] [[Release notes 9-0-0|Release notes]] [[Help:Installation#9-0-0|Upgrade notes]] [[Documentation 9.x.x]]
|3.4.240312
|-
| 8.0.1
| [https://svacer.ispras.ru/releases/svacer-8-0-1/svacer-8-0-1.zip svacer-8-0-1.zip]
| [https://svacer.ispras.ru/releases/svacer-8-0-1/svacer svacer]
| [https://svacer.ispras.ru/releases/svacer-8-0-1/svacer.exe svacer.exe]
| [https://svacer.ispras.ru/releases/svacer-8-0-1/svacer_8.0-1_amd64.deb svacer_8.0-1_amd64.deb] [https://svacer.ispras.ru/releases/svacer-8-0-1/svacer-8.0-1.x86_64.rpm svacer-8.0-1.x86_64.rpm] [https://svacer.ispras.ru/releases/svacer-8-0-1/svacer-8.0.1.msi svacer-8.0.1.msi]
| [[Changelog#Release 8-0-1|Changelog]] [[Documentation 8.x.x]]
|3.4.0
|-
| 8.0.0
| [https://svacer.ispras.ru/releases/svacer-8-0-0/svacer-8-0-0.zip svacer-8-0-0.zip]
| [https://svacer.ispras.ru/releases/svacer-8-0-0/svacer svacer]
| [https://svacer.ispras.ru/releases/svacer-8-0-0/svacer.exe svacer.exe]
| [https://svacer.ispras.ru/releases/svacer-8-0-0/svacer_8.0-0_amd64.deb svacer_8.0-0_amd64.deb] [https://svacer.ispras.ru/releases/svacer-8-0-0/svacer-8.0-0.x86_64.rpm svacer-8.0-0.x86_64.rpm] [https://svacer.ispras.ru/releases/svacer-8-0-0/svacer-8.0.0.msi svacer-8.0.0.msi]
| [[Changelog#Release 8-0-0|Changelog]] [[Release notes 8-0-0|Release notes]] [[Documentation 8.x.x]]
|3.4.0
|}

[https://svacer.ispras.ru/releases Предыдущие релизы] | [https://nextcloud.ispras.ru/index.php/s/x4r4cMJAMr5RZtd?path=%2F Еще более старые релизы]

=== FAQ ===
* [https://gitlab.ispras.ru/svace/svace-support/-/wikis/home Документация на статический анализатор Svace]
* [[Help:Introduction#Системные требования|Системные требования]]
* [[Примеры использования хуков#Создание кейсов в системах отслеживания ошибок|Создание из Svacer кейсов в Gitlab, Jira, Redmine]]
* Public REST API
:* [[Help:Public API#Примеры использования public REST API|Примеры использования]]
:* [https://gitlab.ispras.ru/svacer-public Репозитории с примерами на Python и Go]
:* [https://svacer-demo.ispras.ru/api/public/swagger/ Спецификация OpenAPI]
* [https://t.me/+6pvgZ0oveNVhOTc6 Группа технической поддержки в Telegram]

=== Демо ===
https://svacer-demo.ispras.ru

* admin / admin — логин / пароль администратора
* user / user — логин / пароль пользователя

https://svacer-ai-demo.ispras.ru/ — [[Help:XSvacer:AIAssistant|ИИ-ассистент]]
* admin / admin

Svacer

2025-11-28T11:52:21Z

Akuzmin: fix documentation link

Svacer — сервер для хранения и обработки результатов статического анализа. Поддерживает импорт результатов анализа из [https://svace.ispras.ru Svace] напрямую и из прочих анализаторов через формат [[Help:Sarif|SARIF]].

=== Документация ===
Version 12.x.x
# [[Help:Introduction|Введение]]
# [[Help:Installation|Установка и обновление]]
# [[Help:Configuration|Настройка сервера]]
# [[Help:Import from Svace|Импорт из Svace]]
# [[Help:Backup|Резервное копирование]]
# [[Help:UI manual|Использование веб-интерфейса]]
# [[Help:Public API|Public REST API]]
# [[Help:CLI|CLI]]
# [[LDAP configuration|LDAP]]
# [[OIDC|OpenID Connect]]
# [[Help:Sarif|SARIF]]
# [[Help:Statistics|Статистика]]
# [[Help:Match|Механизмы сопоставления предупреждений и переноса разметки]]
# [[Help:XSvacer|XSvacer — расширение функциональности Svacer]]
# [[Help:Utils|Дополнительные утилиты]]
# [[Metrics|Prometheus-метрики]]
# [[Pipelines|Примеры пайплайнов]]
# [[Notifications|Уведомления]]

=== Релизы ===
Также доступны в виде docker-образа на [https://hub.docker.com/r/ispras/svacer docker hub] и как пакеты в [[Help:Installation#Установка и запуск из deb/rpm пакета|репозиториях]]

{| class="wikitable"
! version !! distrib !! linux bin !! windows bin !! deb/rpm !! doc
!svace checkers version
|-
| 12.0.0
| [https://svacer.ispras.ru/releases/svacer-12-0-0/svacer-12-0-0-linux.tar.gz svacer-12-0-0-linux.tar.gz] [https://svacer.ispras.ru/releases/svacer-12-0-0/svacer-12-0-0-windows.zip svacer-12-0-0-windows.zip]
| [https://svacer.ispras.ru/releases/svacer-12-0-0/svacer svacer] [https://svacer.ispras.ru/releases/svacer-12-0-0/svacer-server svacer-server]
| [https://svacer.ispras.ru/releases/svacer-12-0-0/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-12-0-0/svacer-server.exe svacer-server.exe]
| [https://svacer.ispras.ru/releases/svacer-12-0-0/svacer_12.0-0_amd64.deb svacer_12.0-0_amd64.deb] [https://svacer.ispras.ru/releases/svacer-12-0-0/svacer-12.0-0.x86_64.rpm svacer-12.0-0.x86_64.rpm]
| [[Changelog#Release 12-0-0|Changelog]] [[Help:Installation#Обновление|Upgrade notes]] [[Svacer#Документация|Documentation 12.x.x]]
|4.0.251120
|-
| 11.2.0
| [https://svacer.ispras.ru/releases/svacer-11-2-0/svacer-11-2-0-linux.tar.gz svacer-11-2-0-linux.tar.gz] [https://svacer.ispras.ru/releases/svacer-11-2-0/svacer-11-2-0-windows.zip svacer-11-2-0-windows.zip]
| [https://svacer.ispras.ru/releases/svacer-11-2-0/svacer svacer] [https://svacer.ispras.ru/releases/svacer-11-2-0/svacer-server svacer-server]
| [https://svacer.ispras.ru/releases/svacer-11-2-0/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-11-2-0/svacer-server.exe svacer-server.exe]
| [https://svacer.ispras.ru/releases/svacer-11-2-0/svacer_11.2-0_amd64.deb svacer_11.2-0_amd64.deb] [https://svacer.ispras.ru/releases/svacer-11-2-0/svacer-11.2-0.x86_64.rpm svacer-11.2-0.x86_64.rpm]
| [[Changelog#Release 11-2-0|Changelog]] [[Help:Installation#Обновление|Upgrade notes]] [[Documentation 11.x.x]]
|4.0.250415
|-
| 11.1.0
| [https://svacer.ispras.ru/releases/svacer-11-1-0/svacer-11-1-0-linux.tar.gz svacer-11-1-0-linux.tar.gz] [https://svacer.ispras.ru/releases/svacer-11-1-0/svacer-11-1-0-windows.zip svacer-11-1-0-windows.zip]
| [https://svacer.ispras.ru/releases/svacer-11-1-0/svacer svacer] [https://svacer.ispras.ru/releases/svacer-11-1-0/svacer-server svacer-server]
| [https://svacer.ispras.ru/releases/svacer-11-1-0/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-11-1-0/svacer-server.exe svacer-server.exe]
| [https://svacer.ispras.ru/releases/svacer-11-1-0/svacer_11.1-0_amd64.deb svacer_11.1-0_amd64.deb] [https://svacer.ispras.ru/releases/svacer-11-1-0/svacer-11.1-0.x86_64.rpm svacer-11.1-0.x86_64.rpm]
| [[Changelog#Release 11-1-0|Changelog]] [[Help:Installation#Обновление|Upgrade notes]] [[Documentation 11.x.x]]
|4.0.250415
|-
| 11.0.0
| [https://svacer.ispras.ru/releases/svacer-11-0-0/svacer-11-0-0-linux.tar.gz svacer-11-0-0-linux.tar.gz] [https://svacer.ispras.ru/releases/svacer-11-0-0/svacer-11-0-0-windows.zip svacer-11-0-0-windows.zip]
| [https://svacer.ispras.ru/releases/svacer-11-0-0/svacer svacer] [https://svacer.ispras.ru/releases/svacer-11-0-0/svacer-server svacer-server]
| [https://svacer.ispras.ru/releases/svacer-11-0-0/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-11-0-0/svacer-server.exe svacer-server.exe]
| [https://svacer.ispras.ru/releases/svacer-11-0-0/svacer_11.0-0_amd64.deb svacer_11.0-0_amd64.deb] [https://svacer.ispras.ru/releases/svacer-11-0-0/svacer-11.0-0.x86_64.rpm svacer-11.0-0.x86_64.rpm]
| [[Changelog#Release 11-0-0|Changelog]] [[Release notes 11-0-0|Release notes]] [[Help:Installation#Обновление|Upgrade notes]] [[Documentation 11.x.x]]
|4.0.250415
|-
| 10.0.1
| [https://svacer.ispras.ru/releases/svacer-10-0-1/svacer-10-0-1-linux.tar.gz svacer-10-0-1-linux.tar.gz] [https://svacer.ispras.ru/releases/svacer-10-0-1/svacer-10-0-1-windows.zip svacer-10-0-1-windows.zip]
| [https://svacer.ispras.ru/releases/svacer-10-0-1/svacer svacer] [https://svacer.ispras.ru/releases/svacer-10-0-1/svacer-server svacer-server]
| [https://svacer.ispras.ru/releases/svacer-10-0-1/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-10-0-1/svacer-server.exe svacer-server.exe]
| [https://svacer.ispras.ru/releases/svacer-10-0-1/svacer_10.0-1_amd64.deb svacer_10.0-1_amd64.deb] [https://svacer.ispras.ru/releases/svacer-10-0-1/svacer-10.0-1.x86_64.rpm svacer-10.0-1.x86_64.rpm]
| [[Changelog#Release 10-0-1|Changelog]] [[Help:Installation#Обновление|Upgrade notes]] [[Documentation 10.x.x]]
|4.0.241102
|-
| 10.0.0
| [https://svacer.ispras.ru/releases/svacer-10-0-0/svacer-10-0-0-linux.tar.gz svacer-10-0-0-linux.tar.gz] [https://svacer.ispras.ru/releases/svacer-10-0-0/svacer-10-0-0-windows.zip svacer-10-0-0-windows.zip]
| [https://svacer.ispras.ru/releases/svacer-10-0-0/svacer svacer] [https://svacer.ispras.ru/releases/svacer-10-0-0/svacer-server svacer-server]
| [https://svacer.ispras.ru/releases/svacer-10-0-0/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-10-0-0/svacer-server.exe svacer-server.exe]
| [https://svacer.ispras.ru/releases/svacer-10-0-0/svacer_10.0-0_amd64.deb svacer_10.0-0_amd64.deb] [https://svacer.ispras.ru/releases/svacer-10-0-0/svacer-10.0-0.x86_64.rpm svacer-10.0-0.x86_64.rpm]
| [[Changelog#Release 10-0-0|Changelog]] [[Release notes 10-0-0|Release notes]] [[Help:Installation#Обновление|Upgrade notes]] [[Documentation 10.x.x]]
|4.0.241102
|-
| 9.0.2
| [https://svacer.ispras.ru/releases/svacer-9-0-2/svacer-9-0-2.zip svacer-9-0-2.zip]
| [https://svacer.ispras.ru/releases/svacer-9-0-2/svacer svacer] [https://svacer.ispras.ru/releases/svacer-9-0-2/svacer-server svacer-server]
| [https://svacer.ispras.ru/releases/svacer-9-0-2/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-9-0-2/svacer-server.exe svacer-server.exe]
| [https://svacer.ispras.ru/releases/svacer-9-0-2/svacer_9.0-2_amd64.deb svacer_9.0-2_amd64.deb] [https://svacer.ispras.ru/releases/svacer-9-0-2/svacer-9.0-2.x86_64.rpm svacer-9.0-2.x86_64.rpm]
| [[Changelog#Release 9-0-2|Changelog]] [[Help:Installation#9-0-0|Upgrade notes]] [[Documentation 9.x.x]]
|3.4.240312
|-
| 9.0.1
| [https://svacer.ispras.ru/releases/svacer-9-0-1/svacer-9-0-1.zip svacer-9-0-1.zip]
| [https://svacer.ispras.ru/releases/svacer-9-0-1/svacer svacer] [https://svacer.ispras.ru/releases/svacer-9-0-1/svacer-server svacer-server]
| [https://svacer.ispras.ru/releases/svacer-9-0-1/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-9-0-1/svacer-server.exe svacer-server.exe]
| [https://svacer.ispras.ru/releases/svacer-9-0-1/svacer_9.0-1_amd64.deb svacer_9.0-1_amd64.deb] [https://svacer.ispras.ru/releases/svacer-9-0-1/svacer-9.0-1.x86_64.rpm svacer-9.0-1.x86_64.rpm]
| [[Changelog#Release 9-0-1|Changelog]] [[Help:Installation#9-0-0|Upgrade notes]] [[Documentation 9.x.x]]
|3.4.240312
|-
| 9.0.0
| [https://svacer.ispras.ru/releases/svacer-9-0-0/svacer-9-0-0.zip svacer-9-0-0.zip]
| [https://svacer.ispras.ru/releases/svacer-9-0-0/svacer svacer] [https://svacer.ispras.ru/releases/svacer-9-0-0/svacer-server svacer-server]
| [https://svacer.ispras.ru/releases/svacer-9-0-0/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-9-0-0/svacer-server.exe svacer-server.exe]
| [https://svacer.ispras.ru/releases/svacer-9-0-0/svacer_9.0-0_amd64.deb svacer_9.0-0_amd64.deb] [https://svacer.ispras.ru/releases/svacer-9-0-0/svacer-9.0-0.x86_64.rpm svacer-9.0-0.x86_64.rpm]
| [[Changelog#Release 9-0-0|Changelog]] [[Release notes 9-0-0|Release notes]] [[Help:Installation#9-0-0|Upgrade notes]] [[Documentation 9.x.x]]
|3.4.240312
|-
| 8.0.1
| [https://svacer.ispras.ru/releases/svacer-8-0-1/svacer-8-0-1.zip svacer-8-0-1.zip]
| [https://svacer.ispras.ru/releases/svacer-8-0-1/svacer svacer]
| [https://svacer.ispras.ru/releases/svacer-8-0-1/svacer.exe svacer.exe]
| [https://svacer.ispras.ru/releases/svacer-8-0-1/svacer_8.0-1_amd64.deb svacer_8.0-1_amd64.deb] [https://svacer.ispras.ru/releases/svacer-8-0-1/svacer-8.0-1.x86_64.rpm svacer-8.0-1.x86_64.rpm] [https://svacer.ispras.ru/releases/svacer-8-0-1/svacer-8.0.1.msi svacer-8.0.1.msi]
| [[Changelog#Release 8-0-1|Changelog]] [[Documentation 8.x.x]]
|3.4.0
|-
| 8.0.0
| [https://svacer.ispras.ru/releases/svacer-8-0-0/svacer-8-0-0.zip svacer-8-0-0.zip]
| [https://svacer.ispras.ru/releases/svacer-8-0-0/svacer svacer]
| [https://svacer.ispras.ru/releases/svacer-8-0-0/svacer.exe svacer.exe]
| [https://svacer.ispras.ru/releases/svacer-8-0-0/svacer_8.0-0_amd64.deb svacer_8.0-0_amd64.deb] [https://svacer.ispras.ru/releases/svacer-8-0-0/svacer-8.0-0.x86_64.rpm svacer-8.0-0.x86_64.rpm] [https://svacer.ispras.ru/releases/svacer-8-0-0/svacer-8.0.0.msi svacer-8.0.0.msi]
| [[Changelog#Release 8-0-0|Changelog]] [[Release notes 8-0-0|Release notes]] [[Documentation 8.x.x]]
|3.4.0
|}

[https://svacer.ispras.ru/releases Предыдущие релизы] | [https://nextcloud.ispras.ru/index.php/s/x4r4cMJAMr5RZtd?path=%2F Еще более старые релизы]

=== FAQ ===
* [https://gitlab.ispras.ru/svace/svace-support/-/wikis/home Документация на статический анализатор Svace]
* [[Help:Introduction#Системные требования|Системные требования]]
* [[Примеры использования хуков#Создание кейсов в системах отслеживания ошибок|Создание из Svacer кейсов в Gitlab, Jira, Redmine]]
* Public REST API
:* [[Help:Public API#Примеры использования public REST API|Примеры использования]]
:* [https://gitlab.ispras.ru/svacer-public Репозитории с примерами на Python и Go]
:* [https://svacer-demo.ispras.ru/api/public/swagger/ Спецификация OpenAPI]
* [https://t.me/+6pvgZ0oveNVhOTc6 Группа технической поддержки в Telegram]

=== Демо ===
https://svacer-demo.ispras.ru

* admin / admin — логин / пароль администратора
* user / user — логин / пароль пользователя

https://svacer-ai-demo.ispras.ru/ — [[Help:XSvacer:AIAssistant|ИИ-ассистент]]
* admin / admin

Svacer

2025-11-28T11:51:38Z

Akuzmin: fix documentation link

Svacer — сервер для хранения и обработки результатов статического анализа. Поддерживает импорт результатов анализа из [https://svace.ispras.ru Svace] напрямую и из прочих анализаторов через формат [[Help:Sarif|SARIF]].

=== Документация ===
Version 12.x.x
# [[Help:Introduction|Введение]]
# [[Help:Installation|Установка и обновление]]
# [[Help:Configuration|Настройка сервера]]
# [[Help:Import from Svace|Импорт из Svace]]
# [[Help:Backup|Резервное копирование]]
# [[Help:UI manual|Использование веб-интерфейса]]
# [[Help:Public API|Public REST API]]
# [[Help:CLI|CLI]]
# [[LDAP configuration|LDAP]]
# [[OIDC|OpenID Connect]]
# [[Help:Sarif|SARIF]]
# [[Help:Statistics|Статистика]]
# [[Help:Match|Механизмы сопоставления предупреждений и переноса разметки]]
# [[Help:XSvacer|XSvacer — расширение функциональности Svacer]]
# [[Help:Utils|Дополнительные утилиты]]
# [[Metrics|Prometheus-метрики]]
# [[Pipelines|Примеры пайплайнов]]
# [[Notifications|Уведомления]]

=== Релизы ===
Также доступны в виде docker-образа на [https://hub.docker.com/r/ispras/svacer docker hub] и как пакеты в [[Help:Installation#Установка и запуск из deb/rpm пакета|репозиториях]]

{| class="wikitable"
! version !! distrib !! linux bin !! windows bin !! deb/rpm !! doc
!svace checkers version
|-
| 12.0.0
| [https://svacer.ispras.ru/releases/svacer-12-0-0/svacer-12-0-0-linux.tar.gz svacer-12-0-0-linux.tar.gz] [https://svacer.ispras.ru/releases/svacer-12-0-0/svacer-12-0-0-windows.zip svacer-12-0-0-windows.zip]
| [https://svacer.ispras.ru/releases/svacer-12-0-0/svacer svacer] [https://svacer.ispras.ru/releases/svacer-12-0-0/svacer-server svacer-server]
| [https://svacer.ispras.ru/releases/svacer-12-0-0/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-12-0-0/svacer-server.exe svacer-server.exe]
| [https://svacer.ispras.ru/releases/svacer-12-0-0/svacer_12.0-0_amd64.deb svacer_12.0-0_amd64.deb] [https://svacer.ispras.ru/releases/svacer-12-0-0/svacer-12.0-0.x86_64.rpm svacer-12.0-0.x86_64.rpm]
| [[Changelog#Release 12-0-0|Changelog]] [[Help:Installation#Обновление|Upgrade notes]] [[Documentation 12.x.x]]
|4.0.251120
|-
| 11.2.0
| [https://svacer.ispras.ru/releases/svacer-11-2-0/svacer-11-2-0-linux.tar.gz svacer-11-2-0-linux.tar.gz] [https://svacer.ispras.ru/releases/svacer-11-2-0/svacer-11-2-0-windows.zip svacer-11-2-0-windows.zip]
| [https://svacer.ispras.ru/releases/svacer-11-2-0/svacer svacer] [https://svacer.ispras.ru/releases/svacer-11-2-0/svacer-server svacer-server]
| [https://svacer.ispras.ru/releases/svacer-11-2-0/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-11-2-0/svacer-server.exe svacer-server.exe]
| [https://svacer.ispras.ru/releases/svacer-11-2-0/svacer_11.2-0_amd64.deb svacer_11.2-0_amd64.deb] [https://svacer.ispras.ru/releases/svacer-11-2-0/svacer-11.2-0.x86_64.rpm svacer-11.2-0.x86_64.rpm]
| [[Changelog#Release 11-2-0|Changelog]] [[Help:Installation#Обновление|Upgrade notes]] [[Svacer#Документация|Documentation 11.x.x]]
|4.0.250415
|-
| 11.1.0
| [https://svacer.ispras.ru/releases/svacer-11-1-0/svacer-11-1-0-linux.tar.gz svacer-11-1-0-linux.tar.gz] [https://svacer.ispras.ru/releases/svacer-11-1-0/svacer-11-1-0-windows.zip svacer-11-1-0-windows.zip]
| [https://svacer.ispras.ru/releases/svacer-11-1-0/svacer svacer] [https://svacer.ispras.ru/releases/svacer-11-1-0/svacer-server svacer-server]
| [https://svacer.ispras.ru/releases/svacer-11-1-0/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-11-1-0/svacer-server.exe svacer-server.exe]
| [https://svacer.ispras.ru/releases/svacer-11-1-0/svacer_11.1-0_amd64.deb svacer_11.1-0_amd64.deb] [https://svacer.ispras.ru/releases/svacer-11-1-0/svacer-11.1-0.x86_64.rpm svacer-11.1-0.x86_64.rpm]
| [[Changelog#Release 11-1-0|Changelog]] [[Help:Installation#Обновление|Upgrade notes]] [[Svacer#Документация|Documentation 11.x.x]]
|4.0.250415
|-
| 11.0.0
| [https://svacer.ispras.ru/releases/svacer-11-0-0/svacer-11-0-0-linux.tar.gz svacer-11-0-0-linux.tar.gz] [https://svacer.ispras.ru/releases/svacer-11-0-0/svacer-11-0-0-windows.zip svacer-11-0-0-windows.zip]
| [https://svacer.ispras.ru/releases/svacer-11-0-0/svacer svacer] [https://svacer.ispras.ru/releases/svacer-11-0-0/svacer-server svacer-server]
| [https://svacer.ispras.ru/releases/svacer-11-0-0/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-11-0-0/svacer-server.exe svacer-server.exe]
| [https://svacer.ispras.ru/releases/svacer-11-0-0/svacer_11.0-0_amd64.deb svacer_11.0-0_amd64.deb] [https://svacer.ispras.ru/releases/svacer-11-0-0/svacer-11.0-0.x86_64.rpm svacer-11.0-0.x86_64.rpm]
| [[Changelog#Release 11-0-0|Changelog]] [[Release notes 11-0-0|Release notes]] [[Help:Installation#Обновление|Upgrade notes]] [[Svacer#Документация|Documentation 11.x.x]]
|4.0.250415
|-
| 10.0.1
| [https://svacer.ispras.ru/releases/svacer-10-0-1/svacer-10-0-1-linux.tar.gz svacer-10-0-1-linux.tar.gz] [https://svacer.ispras.ru/releases/svacer-10-0-1/svacer-10-0-1-windows.zip svacer-10-0-1-windows.zip]
| [https://svacer.ispras.ru/releases/svacer-10-0-1/svacer svacer] [https://svacer.ispras.ru/releases/svacer-10-0-1/svacer-server svacer-server]
| [https://svacer.ispras.ru/releases/svacer-10-0-1/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-10-0-1/svacer-server.exe svacer-server.exe]
| [https://svacer.ispras.ru/releases/svacer-10-0-1/svacer_10.0-1_amd64.deb svacer_10.0-1_amd64.deb] [https://svacer.ispras.ru/releases/svacer-10-0-1/svacer-10.0-1.x86_64.rpm svacer-10.0-1.x86_64.rpm]
| [[Changelog#Release 10-0-1|Changelog]] [[Help:Installation#Обновление|Upgrade notes]] [[Documentation 10.x.x]]
|4.0.241102
|-
| 10.0.0
| [https://svacer.ispras.ru/releases/svacer-10-0-0/svacer-10-0-0-linux.tar.gz svacer-10-0-0-linux.tar.gz] [https://svacer.ispras.ru/releases/svacer-10-0-0/svacer-10-0-0-windows.zip svacer-10-0-0-windows.zip]
| [https://svacer.ispras.ru/releases/svacer-10-0-0/svacer svacer] [https://svacer.ispras.ru/releases/svacer-10-0-0/svacer-server svacer-server]
| [https://svacer.ispras.ru/releases/svacer-10-0-0/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-10-0-0/svacer-server.exe svacer-server.exe]
| [https://svacer.ispras.ru/releases/svacer-10-0-0/svacer_10.0-0_amd64.deb svacer_10.0-0_amd64.deb] [https://svacer.ispras.ru/releases/svacer-10-0-0/svacer-10.0-0.x86_64.rpm svacer-10.0-0.x86_64.rpm]
| [[Changelog#Release 10-0-0|Changelog]] [[Release notes 10-0-0|Release notes]] [[Help:Installation#Обновление|Upgrade notes]] [[Documentation 10.x.x]]
|4.0.241102
|-
| 9.0.2
| [https://svacer.ispras.ru/releases/svacer-9-0-2/svacer-9-0-2.zip svacer-9-0-2.zip]
| [https://svacer.ispras.ru/releases/svacer-9-0-2/svacer svacer] [https://svacer.ispras.ru/releases/svacer-9-0-2/svacer-server svacer-server]
| [https://svacer.ispras.ru/releases/svacer-9-0-2/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-9-0-2/svacer-server.exe svacer-server.exe]
| [https://svacer.ispras.ru/releases/svacer-9-0-2/svacer_9.0-2_amd64.deb svacer_9.0-2_amd64.deb] [https://svacer.ispras.ru/releases/svacer-9-0-2/svacer-9.0-2.x86_64.rpm svacer-9.0-2.x86_64.rpm]
| [[Changelog#Release 9-0-2|Changelog]] [[Help:Installation#9-0-0|Upgrade notes]] [[Documentation 9.x.x]]
|3.4.240312
|-
| 9.0.1
| [https://svacer.ispras.ru/releases/svacer-9-0-1/svacer-9-0-1.zip svacer-9-0-1.zip]
| [https://svacer.ispras.ru/releases/svacer-9-0-1/svacer svacer] [https://svacer.ispras.ru/releases/svacer-9-0-1/svacer-server svacer-server]
| [https://svacer.ispras.ru/releases/svacer-9-0-1/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-9-0-1/svacer-server.exe svacer-server.exe]
| [https://svacer.ispras.ru/releases/svacer-9-0-1/svacer_9.0-1_amd64.deb svacer_9.0-1_amd64.deb] [https://svacer.ispras.ru/releases/svacer-9-0-1/svacer-9.0-1.x86_64.rpm svacer-9.0-1.x86_64.rpm]
| [[Changelog#Release 9-0-1|Changelog]] [[Help:Installation#9-0-0|Upgrade notes]] [[Documentation 9.x.x]]
|3.4.240312
|-
| 9.0.0
| [https://svacer.ispras.ru/releases/svacer-9-0-0/svacer-9-0-0.zip svacer-9-0-0.zip]
| [https://svacer.ispras.ru/releases/svacer-9-0-0/svacer svacer] [https://svacer.ispras.ru/releases/svacer-9-0-0/svacer-server svacer-server]
| [https://svacer.ispras.ru/releases/svacer-9-0-0/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-9-0-0/svacer-server.exe svacer-server.exe]
| [https://svacer.ispras.ru/releases/svacer-9-0-0/svacer_9.0-0_amd64.deb svacer_9.0-0_amd64.deb] [https://svacer.ispras.ru/releases/svacer-9-0-0/svacer-9.0-0.x86_64.rpm svacer-9.0-0.x86_64.rpm]
| [[Changelog#Release 9-0-0|Changelog]] [[Release notes 9-0-0|Release notes]] [[Help:Installation#9-0-0|Upgrade notes]] [[Documentation 9.x.x]]
|3.4.240312
|-
| 8.0.1
| [https://svacer.ispras.ru/releases/svacer-8-0-1/svacer-8-0-1.zip svacer-8-0-1.zip]
| [https://svacer.ispras.ru/releases/svacer-8-0-1/svacer svacer]
| [https://svacer.ispras.ru/releases/svacer-8-0-1/svacer.exe svacer.exe]
| [https://svacer.ispras.ru/releases/svacer-8-0-1/svacer_8.0-1_amd64.deb svacer_8.0-1_amd64.deb] [https://svacer.ispras.ru/releases/svacer-8-0-1/svacer-8.0-1.x86_64.rpm svacer-8.0-1.x86_64.rpm] [https://svacer.ispras.ru/releases/svacer-8-0-1/svacer-8.0.1.msi svacer-8.0.1.msi]
| [[Changelog#Release 8-0-1|Changelog]] [[Documentation 8.x.x]]
|3.4.0
|-
| 8.0.0
| [https://svacer.ispras.ru/releases/svacer-8-0-0/svacer-8-0-0.zip svacer-8-0-0.zip]
| [https://svacer.ispras.ru/releases/svacer-8-0-0/svacer svacer]
| [https://svacer.ispras.ru/releases/svacer-8-0-0/svacer.exe svacer.exe]
| [https://svacer.ispras.ru/releases/svacer-8-0-0/svacer_8.0-0_amd64.deb svacer_8.0-0_amd64.deb] [https://svacer.ispras.ru/releases/svacer-8-0-0/svacer-8.0-0.x86_64.rpm svacer-8.0-0.x86_64.rpm] [https://svacer.ispras.ru/releases/svacer-8-0-0/svacer-8.0.0.msi svacer-8.0.0.msi]
| [[Changelog#Release 8-0-0|Changelog]] [[Release notes 8-0-0|Release notes]] [[Documentation 8.x.x]]
|3.4.0
|}

[https://svacer.ispras.ru/releases Предыдущие релизы] | [https://nextcloud.ispras.ru/index.php/s/x4r4cMJAMr5RZtd?path=%2F Еще более старые релизы]

=== FAQ ===
* [https://gitlab.ispras.ru/svace/svace-support/-/wikis/home Документация на статический анализатор Svace]
* [[Help:Introduction#Системные требования|Системные требования]]
* [[Примеры использования хуков#Создание кейсов в системах отслеживания ошибок|Создание из Svacer кейсов в Gitlab, Jira, Redmine]]
* Public REST API
:* [[Help:Public API#Примеры использования public REST API|Примеры использования]]
:* [https://gitlab.ispras.ru/svacer-public Репозитории с примерами на Python и Go]
:* [https://svacer-demo.ispras.ru/api/public/swagger/ Спецификация OpenAPI]
* [https://t.me/+6pvgZ0oveNVhOTc6 Группа технической поддержки в Telegram]

=== Демо ===
https://svacer-demo.ispras.ru

* admin / admin — логин / пароль администратора
* user / user — логин / пароль пользователя

https://svacer-ai-demo.ispras.ru/ — [[Help:XSvacer:AIAssistant|ИИ-ассистент]]
* admin / admin

Svacer

2025-11-28T11:16:53Z

Akuzmin: add release 12-0-0

Svacer — сервер для хранения и обработки результатов статического анализа. Поддерживает импорт результатов анализа из [https://svace.ispras.ru Svace] напрямую и из прочих анализаторов через формат [[Help:Sarif|SARIF]].

=== Документация ===
Version 12.x.x
# [[Help:Introduction|Введение]]
# [[Help:Installation|Установка и обновление]]
# [[Help:Configuration|Настройка сервера]]
# [[Help:Import from Svace|Импорт из Svace]]
# [[Help:Backup|Резервное копирование]]
# [[Help:UI manual|Использование веб-интерфейса]]
# [[Help:Public API|Public REST API]]
# [[Help:CLI|CLI]]
# [[LDAP configuration|LDAP]]
# [[OIDC|OpenID Connect]]
# [[Help:Sarif|SARIF]]
# [[Help:Statistics|Статистика]]
# [[Help:Match|Механизмы сопоставления предупреждений и переноса разметки]]
# [[Help:XSvacer|XSvacer — расширение функциональности Svacer]]
# [[Help:Utils|Дополнительные утилиты]]
# [[Metrics|Prometheus-метрики]]
# [[Pipelines|Примеры пайплайнов]]
# [[Notifications|Уведомления]]

=== Релизы ===
Также доступны в виде docker-образа на [https://hub.docker.com/r/ispras/svacer docker hub] и как пакеты в [[Help:Installation#Установка и запуск из deb/rpm пакета|репозиториях]]

{| class="wikitable"
! version !! distrib !! linux bin !! windows bin !! deb/rpm !! doc
!svace checkers version
|-
| 12.0.0
| [https://svacer.ispras.ru/releases/svacer-12-0-0/svacer-12-0-0-linux.tar.gz svacer-12-0-0-linux.tar.gz] [https://svacer.ispras.ru/releases/svacer-12-0-0/svacer-12-0-0-windows.zip svacer-12-0-0-windows.zip]
| [https://svacer.ispras.ru/releases/svacer-12-0-0/svacer svacer] [https://svacer.ispras.ru/releases/svacer-12-0-0/svacer-server svacer-server]
| [https://svacer.ispras.ru/releases/svacer-12-0-0/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-12-0-0/svacer-server.exe svacer-server.exe]
| [https://svacer.ispras.ru/releases/svacer-12-0-0/svacer_12.0-0_amd64.deb svacer_12.0-0_amd64.deb] [https://svacer.ispras.ru/releases/svacer-12-0-0/svacer-12.0-0.x86_64.rpm svacer-12.0-0.x86_64.rpm]
| [[Changelog#Release 12-0-0|Changelog]] [[Help:Installation#Обновление|Upgrade notes]] [[Documentation 11.x.x]]
|4.0.251120
|-
| 11.2.0
| [https://svacer.ispras.ru/releases/svacer-11-2-0/svacer-11-2-0-linux.tar.gz svacer-11-2-0-linux.tar.gz] [https://svacer.ispras.ru/releases/svacer-11-2-0/svacer-11-2-0-windows.zip svacer-11-2-0-windows.zip]
| [https://svacer.ispras.ru/releases/svacer-11-2-0/svacer svacer] [https://svacer.ispras.ru/releases/svacer-11-2-0/svacer-server svacer-server]
| [https://svacer.ispras.ru/releases/svacer-11-2-0/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-11-2-0/svacer-server.exe svacer-server.exe]
| [https://svacer.ispras.ru/releases/svacer-11-2-0/svacer_11.2-0_amd64.deb svacer_11.2-0_amd64.deb] [https://svacer.ispras.ru/releases/svacer-11-2-0/svacer-11.2-0.x86_64.rpm svacer-11.2-0.x86_64.rpm]
| [[Changelog#Release 11-2-0|Changelog]] [[Help:Installation#Обновление|Upgrade notes]] [[Svacer#Документация|Documentation 11.x.x]]
|4.0.250415
|-
| 11.1.0
| [https://svacer.ispras.ru/releases/svacer-11-1-0/svacer-11-1-0-linux.tar.gz svacer-11-1-0-linux.tar.gz] [https://svacer.ispras.ru/releases/svacer-11-1-0/svacer-11-1-0-windows.zip svacer-11-1-0-windows.zip]
| [https://svacer.ispras.ru/releases/svacer-11-1-0/svacer svacer] [https://svacer.ispras.ru/releases/svacer-11-1-0/svacer-server svacer-server]
| [https://svacer.ispras.ru/releases/svacer-11-1-0/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-11-1-0/svacer-server.exe svacer-server.exe]
| [https://svacer.ispras.ru/releases/svacer-11-1-0/svacer_11.1-0_amd64.deb svacer_11.1-0_amd64.deb] [https://svacer.ispras.ru/releases/svacer-11-1-0/svacer-11.1-0.x86_64.rpm svacer-11.1-0.x86_64.rpm]
| [[Changelog#Release 11-1-0|Changelog]] [[Help:Installation#Обновление|Upgrade notes]] [[Svacer#Документация|Documentation 11.x.x]]
|4.0.250415
|-
| 11.0.0
| [https://svacer.ispras.ru/releases/svacer-11-0-0/svacer-11-0-0-linux.tar.gz svacer-11-0-0-linux.tar.gz] [https://svacer.ispras.ru/releases/svacer-11-0-0/svacer-11-0-0-windows.zip svacer-11-0-0-windows.zip]
| [https://svacer.ispras.ru/releases/svacer-11-0-0/svacer svacer] [https://svacer.ispras.ru/releases/svacer-11-0-0/svacer-server svacer-server]
| [https://svacer.ispras.ru/releases/svacer-11-0-0/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-11-0-0/svacer-server.exe svacer-server.exe]
| [https://svacer.ispras.ru/releases/svacer-11-0-0/svacer_11.0-0_amd64.deb svacer_11.0-0_amd64.deb] [https://svacer.ispras.ru/releases/svacer-11-0-0/svacer-11.0-0.x86_64.rpm svacer-11.0-0.x86_64.rpm]
| [[Changelog#Release 11-0-0|Changelog]] [[Release notes 11-0-0|Release notes]] [[Help:Installation#Обновление|Upgrade notes]] [[Svacer#Документация|Documentation 11.x.x]]
|4.0.250415
|-
| 10.0.1
| [https://svacer.ispras.ru/releases/svacer-10-0-1/svacer-10-0-1-linux.tar.gz svacer-10-0-1-linux.tar.gz] [https://svacer.ispras.ru/releases/svacer-10-0-1/svacer-10-0-1-windows.zip svacer-10-0-1-windows.zip]
| [https://svacer.ispras.ru/releases/svacer-10-0-1/svacer svacer] [https://svacer.ispras.ru/releases/svacer-10-0-1/svacer-server svacer-server]
| [https://svacer.ispras.ru/releases/svacer-10-0-1/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-10-0-1/svacer-server.exe svacer-server.exe]
| [https://svacer.ispras.ru/releases/svacer-10-0-1/svacer_10.0-1_amd64.deb svacer_10.0-1_amd64.deb] [https://svacer.ispras.ru/releases/svacer-10-0-1/svacer-10.0-1.x86_64.rpm svacer-10.0-1.x86_64.rpm]
| [[Changelog#Release 10-0-1|Changelog]] [[Help:Installation#Обновление|Upgrade notes]] [[Documentation 10.x.x]]
|4.0.241102
|-
| 10.0.0
| [https://svacer.ispras.ru/releases/svacer-10-0-0/svacer-10-0-0-linux.tar.gz svacer-10-0-0-linux.tar.gz] [https://svacer.ispras.ru/releases/svacer-10-0-0/svacer-10-0-0-windows.zip svacer-10-0-0-windows.zip]
| [https://svacer.ispras.ru/releases/svacer-10-0-0/svacer svacer] [https://svacer.ispras.ru/releases/svacer-10-0-0/svacer-server svacer-server]
| [https://svacer.ispras.ru/releases/svacer-10-0-0/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-10-0-0/svacer-server.exe svacer-server.exe]
| [https://svacer.ispras.ru/releases/svacer-10-0-0/svacer_10.0-0_amd64.deb svacer_10.0-0_amd64.deb] [https://svacer.ispras.ru/releases/svacer-10-0-0/svacer-10.0-0.x86_64.rpm svacer-10.0-0.x86_64.rpm]
| [[Changelog#Release 10-0-0|Changelog]] [[Release notes 10-0-0|Release notes]] [[Help:Installation#Обновление|Upgrade notes]] [[Documentation 10.x.x]]
|4.0.241102
|-
| 9.0.2
| [https://svacer.ispras.ru/releases/svacer-9-0-2/svacer-9-0-2.zip svacer-9-0-2.zip]
| [https://svacer.ispras.ru/releases/svacer-9-0-2/svacer svacer] [https://svacer.ispras.ru/releases/svacer-9-0-2/svacer-server svacer-server]
| [https://svacer.ispras.ru/releases/svacer-9-0-2/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-9-0-2/svacer-server.exe svacer-server.exe]
| [https://svacer.ispras.ru/releases/svacer-9-0-2/svacer_9.0-2_amd64.deb svacer_9.0-2_amd64.deb] [https://svacer.ispras.ru/releases/svacer-9-0-2/svacer-9.0-2.x86_64.rpm svacer-9.0-2.x86_64.rpm]
| [[Changelog#Release 9-0-2|Changelog]] [[Help:Installation#9-0-0|Upgrade notes]] [[Documentation 9.x.x]]
|3.4.240312
|-
| 9.0.1
| [https://svacer.ispras.ru/releases/svacer-9-0-1/svacer-9-0-1.zip svacer-9-0-1.zip]
| [https://svacer.ispras.ru/releases/svacer-9-0-1/svacer svacer] [https://svacer.ispras.ru/releases/svacer-9-0-1/svacer-server svacer-server]
| [https://svacer.ispras.ru/releases/svacer-9-0-1/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-9-0-1/svacer-server.exe svacer-server.exe]
| [https://svacer.ispras.ru/releases/svacer-9-0-1/svacer_9.0-1_amd64.deb svacer_9.0-1_amd64.deb] [https://svacer.ispras.ru/releases/svacer-9-0-1/svacer-9.0-1.x86_64.rpm svacer-9.0-1.x86_64.rpm]
| [[Changelog#Release 9-0-1|Changelog]] [[Help:Installation#9-0-0|Upgrade notes]] [[Documentation 9.x.x]]
|3.4.240312
|-
| 9.0.0
| [https://svacer.ispras.ru/releases/svacer-9-0-0/svacer-9-0-0.zip svacer-9-0-0.zip]
| [https://svacer.ispras.ru/releases/svacer-9-0-0/svacer svacer] [https://svacer.ispras.ru/releases/svacer-9-0-0/svacer-server svacer-server]
| [https://svacer.ispras.ru/releases/svacer-9-0-0/svacer.exe svacer.exe] [https://svacer.ispras.ru/releases/svacer-9-0-0/svacer-server.exe svacer-server.exe]
| [https://svacer.ispras.ru/releases/svacer-9-0-0/svacer_9.0-0_amd64.deb svacer_9.0-0_amd64.deb] [https://svacer.ispras.ru/releases/svacer-9-0-0/svacer-9.0-0.x86_64.rpm svacer-9.0-0.x86_64.rpm]
| [[Changelog#Release 9-0-0|Changelog]] [[Release notes 9-0-0|Release notes]] [[Help:Installation#9-0-0|Upgrade notes]] [[Documentation 9.x.x]]
|3.4.240312
|-
| 8.0.1
| [https://svacer.ispras.ru/releases/svacer-8-0-1/svacer-8-0-1.zip svacer-8-0-1.zip]
| [https://svacer.ispras.ru/releases/svacer-8-0-1/svacer svacer]
| [https://svacer.ispras.ru/releases/svacer-8-0-1/svacer.exe svacer.exe]
| [https://svacer.ispras.ru/releases/svacer-8-0-1/svacer_8.0-1_amd64.deb svacer_8.0-1_amd64.deb] [https://svacer.ispras.ru/releases/svacer-8-0-1/svacer-8.0-1.x86_64.rpm svacer-8.0-1.x86_64.rpm] [https://svacer.ispras.ru/releases/svacer-8-0-1/svacer-8.0.1.msi svacer-8.0.1.msi]
| [[Changelog#Release 8-0-1|Changelog]] [[Documentation 8.x.x]]
|3.4.0
|-
| 8.0.0
| [https://svacer.ispras.ru/releases/svacer-8-0-0/svacer-8-0-0.zip svacer-8-0-0.zip]
| [https://svacer.ispras.ru/releases/svacer-8-0-0/svacer svacer]
| [https://svacer.ispras.ru/releases/svacer-8-0-0/svacer.exe svacer.exe]
| [https://svacer.ispras.ru/releases/svacer-8-0-0/svacer_8.0-0_amd64.deb svacer_8.0-0_amd64.deb] [https://svacer.ispras.ru/releases/svacer-8-0-0/svacer-8.0-0.x86_64.rpm svacer-8.0-0.x86_64.rpm] [https://svacer.ispras.ru/releases/svacer-8-0-0/svacer-8.0.0.msi svacer-8.0.0.msi]
| [[Changelog#Release 8-0-0|Changelog]] [[Release notes 8-0-0|Release notes]] [[Documentation 8.x.x]]
|3.4.0
|}

[https://svacer.ispras.ru/releases Предыдущие релизы] | [https://nextcloud.ispras.ru/index.php/s/x4r4cMJAMr5RZtd?path=%2F Еще более старые релизы]

=== FAQ ===
* [https://gitlab.ispras.ru/svace/svace-support/-/wikis/home Документация на статический анализатор Svace]
* [[Help:Introduction#Системные требования|Системные требования]]
* [[Примеры использования хуков#Создание кейсов в системах отслеживания ошибок|Создание из Svacer кейсов в Gitlab, Jira, Redmine]]
* Public REST API
:* [[Help:Public API#Примеры использования public REST API|Примеры использования]]
:* [https://gitlab.ispras.ru/svacer-public Репозитории с примерами на Python и Go]
:* [https://svacer-demo.ispras.ru/api/public/swagger/ Спецификация OpenAPI]
* [https://t.me/+6pvgZ0oveNVhOTc6 Группа технической поддержки в Telegram]

=== Демо ===
https://svacer-demo.ispras.ru

* admin / admin — логин / пароль администратора
* user / user — логин / пароль пользователя

https://svacer-ai-demo.ispras.ru/ — [[Help:XSvacer:AIAssistant|ИИ-ассистент]]
* admin / admin

Dockerfile

2025-11-28T11:01:33Z

Akuzmin: dockerfile for 12-0-0

Для сборки докер-образа Svacer мы используем следующий Dockerfile:

<pre>
FROM ubuntu:22.04

LABEL maintainer="akuzmin@ispras.ru"

ARG DEBIAN_FRONTEND=noninteractive

RUN apt update && apt install -y --no-install-recommends curl ca-certificates jq \
&& touch /etc/default/google-chrome \
&& curl -sL --output chrome.deb https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb \
&& apt install -y ./chrome.deb \
&& rm -rf /var/cache/apt/archives /var/lib/apt/lists/* chrome.deb \
&& mkdir -p /svacer/bin && mkdir -p /svacer/store

COPY svacer-server /svacer/bin/
COPY svacer-server.sig /svacer/bin/
COPY svacer /svacer/bin/
COPY libpdfium.so /svacer/bin/
COPY pdfmerge /svacer/bin/
COPY start.sh /svacer/bin/

WORKDIR /svacer/bin

ENV PATH=/svacer/bin:$PATH
ENV DEBUG=false
ENV PPROF_PORT=''
ENV STORE=/svacer/store
ENV SVACER_PG_URL=postgres://svace:svace@127.0.0.1:5432/svace?pool_max_conns=20
ENV LDAP_CONFIG=''
ENV PUBLIC_URL=''
ENV WEBIDE_ENABLE=false
ENV XSVACER_WEBIDE_THEIA_DEFAULT_DOCKER_CONTAINERHOSTCONFIGMOUNTS_PROJECTROOTBIND_DISABLED=true
ENV XSVACER_WEBIDE_THEIA_DEFAULT_DOCKER_CONTAINERHOSTCONFIGMOUNTS_PROJECTROOTVOLUME_DISABLED=false
ENV XSVACER_WEBIDE_THEIA_DEFAULT_DOCKER_CONTAINERNETWORKINGCONFIGENDPOINTS_SVACER_DISABLED=false
ENV AIASSISTANT_ENABLE=false
ENV XSVACER_AIASSISTANT_ASSISTANTHOSTURL=http://svacerai-server:7001/

EXPOSE 8080
EXPOSE 3002

CMD ["/svacer/bin/start.sh"]

HEALTHCHECK --timeout=10s --retries=4 CMD curl --fail http://localhost:8080/api/health || exit 1
</pre>

Documentation 11.x.x

2025-11-28T10:57:11Z

Akuzmin: create documentation 11-0-0 page

# [https://svacer.ispras.ru/mediawiki/index.php?title=Help:Introduction&oldid=2985 Введение]
# [https://svacer.ispras.ru/mediawiki/index.php?title=Help:Installation&oldid=3038 Установка и обновление]
# [https://svacer.ispras.ru/mediawiki/index.php?title=Help:Import_from_Svace&oldid=3036 Импорт из Svace]
# [https://svacer.ispras.ru/mediawiki/index.php?title=Help:Backup&oldid=2060 Резервное копирование]
# [https://svacer.ispras.ru/mediawiki/index.php?title=Help:UI_manual&oldid=2982 Использование веб-интерфейса]
# [https://svacer.ispras.ru/mediawiki/index.php?title=Help:Public_API&oldid=2450 Public REST API]
# [https://svacer.ispras.ru/mediawiki/index.php?title=Help:CLI&oldid=2956 CLI]
# [https://svacer.ispras.ru/mediawiki/index.php?title=LDAP_configuration&oldid=2955 LDAP]
# [https://svacer.ispras.ru/mediawiki/index.php?title=OIDC&oldid=2961 OpenID Connect]
# [https://svacer.ispras.ru/mediawiki/index.php?title=Help:Sarif&oldid=3022 SARIF]
# [https://svacer.ispras.ru/mediawiki/index.php?title=Help:Statistics&oldid=2028 Статистика]
# [https://svacer.ispras.ru/mediawiki/index.php?title=Help:Match&oldid=3006 Механизмы сопоставления предупреждений и переноса разметки]
# [https://svacer.ispras.ru/mediawiki/index.php?title=Help:XSvacer&oldid=3011 XSvacer — расширение функциональности Svacer]
# [https://svacer.ispras.ru/mediawiki/index.php?title=Help:Utils&oldid=2645 Дополнительные утилиты]
# [https://svacer.ispras.ru/mediawiki/index.php?title=Metrics&oldid=2080 Prometheus-метрики]
# [https://svacer.ispras.ru/mediawiki/index.php?title=Pipelines&oldid=3034 Примеры пайплайнов]
# [https://svacer.ispras.ru/mediawiki/index.php?title=Notifications&oldid=2970 Уведомления]

Help:Utils

2025-11-28T10:55:21Z

Akuzmin: minor fixes

== Утилиты ==
=== pfixer ===
pfixer — утилита для исправления путей при экспорте снимков в файл. Замена путей в существующем снимке опасна, поэтому предлагается делать экспорт снимка с заменой путей. После, при необходимости, исходный снимок можно удалить с сервера. Утилита также работает со снимками в <code>.snap</code> файлах.

Начиная с версии <code>>=devel.2025-08-19</code> включает флаг <code>--autofix</code> для исправления ряда проблем с дублями связей разметки и комментариев при импорте. Опцию можно использовать при обнаружении ошибок вида <code>ERROR: duplicate key value violates unique constraint "group_review_comments_idx_group_review_id"</code>.

Поддерживаются версии Svacer, начиная с 7-0-0, но в дистрибутив утилита входит с версии 10-0-0. Актуальную версию можно [https://svacer.ispras.ru/releases/utils/pfixer скачать отсюда].

Для работы с утилитой необходимо создать файл содержащий правила замены путей. Это должен быть юниксовый текстовый файл (разделитель строк <code>\n</code>). Его можно указать через опцию <code>--map-file</code> или через stdin. Каждая строчка должна содержать заменяемый префикс и значение, разделённые двоеточием. Если префикс должен быть удалён, для замены используется знак <code>-</code>.

<префикс1>:<замена1>
<префикс2>:<замена2>
<префикс3>:<замена3>
<префикс4>:-

Также есть возможность использовать [https://pkg.go.dev/regexp#Regexp.ReplaceAllString регулярные выражения] (в экспериментальной стадии) из языка Go. В этом случае надо использовать знак '@' в начале строки. Можно использовать $var для ссылок на группы в регулярном выражении.

@<регулярное_выражение1>:<замена>
@<регулярное_выражение2>:-

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

Авторизацию на сервере можно передать через опции <code>--credentials <login:password></code> или <code>--token <token></code> — сразу токен авторизации.

Исходный снимок с сервера можно передать в виде URL.

'''Примеры'''

<pre>
pfixer --source http://svacer/mode/review/project/{project}/branch/{branch}/snapshot/{snapshot} --output updated.snap --credentials login:password --map-file map.txt
pfixer --source input.snap --output updated.snap -map-file map.txt --log-file test.log
pfixer --source input.snap --output updated.snap --log-file test.log | cat map.txt
</pre>

=== reviewer ===
Утилита для репликации разметки по декларативно описанным правилам.

Подробнее в отдельной статье: [[Review_replication]]

Changelog

2025-11-28T10:17:04Z

Akuzmin: review and fixes

=== Release 12-0-0 ===
28.11.2025

* API методы на fullmarkers позволяют [[Help:Public_API#Примеры_использования_фильтров_в_public_api|указать фильтр]] с полем фильтрации по checker reliability
* В функциональность полнотекстового поиска добавлен поиск маркеров по id и инварианту
* Промежуточное хранилище при импорте результатов командой <code>svacer import / svacer sarif2 import</code> теперь использует новый формат представления. Это должно снизить использование памяти при импорте
* Сериализация JSON переведена на jsonv2 библиотеку в Go
* Импорт SARIF теперь более устойчив к пропускам в файле (отсутствие таких полей как location)
* Добавлены переменные окружения <code>SVACER_TIMEOUT_IMPORT_RESULTS</code> для [[Help:Configuration#Переменные_окружения|контроля таймаута]] на ожидание начала импорта результатов и <code>SVACER_NUM_PARALLEL_IMPORTS</code> на [[Help:Configuration#Переменные_окружения|ограничение числа параллельных импортов]]. По умолчанию значения 15 минут и <code>(максимальное число коннектов к БД) / 2</code>. Ограничения необходимы для предотвращения бесконечных ожиданий и зависаний при импорте данных
* Убраны лишние сообщения об устаревших детекторах при старте сервера или импорте снимков
* В метрики Prometheus добавлен ряд показателей размеров object store
* Размер лога сервера, показываемого в Web-интерфейсе, ограничен. Размер [[Help:Configuration#Переменные_окружения|задается переменной окружения]] SVACER_TAIL_LOG_SIZE (по умолчанию 1Мб). Показывается последний кусок не более SVACER_TAIL_LOG_SIZE. Сам лог файл не ограничивается в размерах и кнопка выгрузки лога выгружает полный лог
* ['''Экспериментально'''] Можно [[Help:Configuration#Переменные_окружения|указать JSON-формат]] лог-файла посредством параметра <code>svacer-server --log-format=json ...</code>, также формат может быть указан через переменную окружения <code>SVACER_LOG_FORMAT=json</code>. Опции также работают для CLI-клиента svacer
* При запуске сервера можно указать флаг <code>--force-invariant-refresh</code> для принудительной регенерации инвариантов. Это может решить проблему с переносом разметки
* Добавлена переменная окружения SVACER_INV_GEN_JOBS для контроля числа параллельных заданий при регенерации инвариантов. При ограниченных ресурсах машины рекомендуем ставить значение 2. По умолчанию значение ставится в 70% от <code>runtime.GOMAXPROCS</code>
* Добавлена функциональность по чистке object store при удалении снимков
* Добавлена возможность создания [[Afilters|сложных пользовательских фильтров]] по условиям, выраженным предикатом
* Проведена работа по предотвращению зависаний при исчерпывании доступных соединений с PostgreSQL сервером
* Добавлен файл с чексуммой бинарника сервера <code>svacer-server</code> и проверка чексуммы при запуске
* Упростили [[Help:XSvacer:AIAssistant:Deploy|деплой ИИ-ассистента]]: добавили его сервис в docker-compose и deb/rpm пакеты
* Расширили возможности конфигурации при запуске сервера через [https://svacer.ispras.ru/extra/docker-compose.yml docker-compose]: теперь можно включить debug, указать конфиг LDAP и параметр public-url
* Добавлена возможность указания минимального количества снимков, которое необходимо оставлять в ветке, тип очистки и период удаления в [[Help:CLI/cleanup|автоматическом удалении снимков]]
* ['''Экспериментально'''] Добавлена возможность [[Edit markers (command line)|автоматически обрабатывать маркеры]] при импорте данных. Также обработка маркеров доступна через [[Help:UI manual#Работа со снимками|UI]]
* Добавлен флаг <code>diff-url</code> для команды <code>quickdiff</code> в CLI, также как и для команд <code>import</code>, <code>upload</code>, <code>sarif2 import</code> с указанием опции <code>quick-stat</code>. Данный флаг позволяет получать ссылку на diff снимков
* Добавлены предупреждения если в командах <code>import</code>, <code>sarif2 import</code> используются флаги, которые используются флагом <code>upload</code>, но флаг <code>upload</code> не установлен
* Добавлена интеграция с внешними системами посредством механизма [[Help:Configuration#Механизм интеграции с внешними системами посредством Webhook-ов|Webhooks]]
* Добавлена [[Help:Configuration#Настройка защиты от перебора паролей пользователей|защита от перебора пароля пользователя]]
* Добавлена возможность задать [[Help:Configuration#Настройка парольной политики внутреннего механизма аутентификации Svacer|парольную политику безопасности]] для пользователей, использующих встроенный механизм аутентификации Svacer
* Добавлена возможность задать [[Help:Configuration#Задание вкладки по умолчанию на странице входа в GUI Svacer (а также отключение внутреннего механизма аутентификации Svacer)|вкладку по умолчанию]] для страницы входа в систему
* Исправлена ошибка, приводящая к разрастанию базы данных
* Исправлена ошибка, связанная с невозможностью в ряде случаев использовать механизм подписок
* Форма разметки с помощью [[Help:XSvacer:AIAssistant:Deploy|ИИ-ассистента]] реализована в основном интерфейсе Svacer
* [[Help:XSvacer:Webide#Запуск функциональности при использовании docker compose|Упрощён запуск функциональности Webide]] при запуске сервера через [https://svacer.ispras.ru/extra/docker-compose.yml docker-compose]

=== Release 11-2-0 ===
22.07.2025

* Исправлены зависания сервера
* Добавлено автоматическое удаление архивов и прочих временных файлов при импорте .svace-dir и SARIF-файлов через REST API

=== Release 11-1-0 ===
08.07.2025

* Команды <code>--project-group, --if-no-group, --autoclean, --autoclean-svace</code> можно использовать в REST API для импорта svace-dir
* При использовании REST API для импорта svace-dir сервер будет автоматически удалять директории <code>.svace-dir</code> и <code>.svacer</code> если не указаны явные опции <code>--autoclean=false, --autoclean-svace=false</code>
* Добавлена опция запуска сервера <code>--classic-inv-mode</code> для включения режима совместимости по генерации инвариантов с версией <= 8.x.x
* Исправлены ошибки в работе <code>--quality-gate</code>, добавлена возможность учета статусов разметки. Добавлена возможность [[Help:Import from Svace#Флаг --baseline|указания baseline]] для сравнений при использовании опции <code>--quality-gate</code>
* Исправлены ошибки при подключении к PostgreSQL в SSL-режиме
* Исправлен ряд ошибок при работе с LDAP
* Команда <code>quickdiff</code> в CLI теперь выдает информацию также о Same и Matched предупреждениях

=== Release 11-0-0 ===
19.05.2025

* Убраны излишние сообщения в логе сервера о login/logout операциях. Они будут выводиться только при запуске сервера с опцией <code>--debug</code>
* Команды CLI <code>svacer sarif *</code> были убраны, для [[Help:Sarif|импорта и экспорта]] следует использовать <code>svacer sarif2 *</code>
* Экспорт SARIF теперь включает все комментарии как отдельные объекты в <code>Properties</code>
* При экспорте в SARIF теперь экспортируются поля <code>Labels, Orig function</code>
* Импорт SARIF теперь корректным образом учитывает relatedLocations и формирует трассу
* Импорт SARIF теперь автоматически импортирует исходники, если они включены в сам SARIF файл
* Добавлена возможность указания [[Help:Sarif#Мэппинг severity|мэппинга severity]] детекторов при импорте из SARIF
* Добавлен механизм указания правил резолвинга путей при импортировании исходного кода вместе с SARIF файлом
* Экспорт исходников из снимка будет доступен только при наличии исходников на сервере
* Добавлены флаги <code>--autoclean</code>, <code>--autoclean-svace</code> в команду <code>svacer import</code> для автоматического удаления <code>.svace-dir / .svacer-dir</code> после успешного импорта и загрузки данных на сервер
* Улучшена поддержка [[OIDC]]
* Улучшена поддержка [[LDAP configuration|LDAP]]
* Добавлена интеграция с хранилищем секретов [[Infisical]]
* Добавлена [[Notifications|служба нотификаций]] пользователей через почтовые сообщения и мессенджер telegram
* Добавлен механизм аутентификации и [[Help:UI manual#Управление токенами доступа|управления]] персональными токенами доступа
* Добавлен механизм упоминания пользователей через специальную конструкцию @login в комментариях к разметке
* В разделе Статистика добавлен дашборд с [[Release notes 11-0-0#Изменения в разделе Статистика|Общей статистикой]], содержащей метрики по последним импортированным снимкам в ветках проектов
* В статистике по активности пользователей добавлена возможность просмотра панели с актуальной информацией о маркере и опция показа только действий с актуальной разметкой
* Большинство CLI команд, работающих с сервером, теперь делают явный logout после завершения
* Svacer при импорте результатов Svace автоматически импортирует файлы <code>*.warn, *.err</code> с предупреждениями от самого анализатора Svace. Автоматический импорт не будет происходить при размере этих файлов более 30Мб (большой размер может свидетельствовать о проблемах в ходе анализа)
* Переменная окружения <code>SVACER_CACHE_DIR</code> теперь учитывается во всех местах (ранее в ряде случаев мог неявно использоваться <code>$HOME/.cache</code>)
* Добавлена возможность [[Help:CLI/cleanup|автоматического удаления снимков]]

=== Release 10-0-1 ===
17.02.2025

* Исправлена ошибка с временной таблицей при обработке планов автомиграции разметки при импорте результатов (ERROR: relation "loaded_review" already exists)

=== Release 10-0-0 ===
16.01.2025

* Множество изменений в UI, смотрите [[Release notes 10-0-0]]
* Сделали [[Help:Installation#rpm|dnf/yum репозиторий]] для RPM-пакетов Svacer
* Реализована возможность [[Markup2|экспорта, импорта и копирования разметки посредством Public REST API и CLI]]
* Реализован дополнительный экспериментальный механизм [[Help:UI manual#Настройка интерфейса|генерации PDF на основе HTML]]. Генерация PDF переведена на асинхронный режим с показом нотификации пользователю
* Добавлена возможность очистки всей разметки и/или комментариев на ветке проекта
* Улучшения функциональности просмотра маркеров в встроенном IDE Theia
* Добавлена функциональность по [[Help:UI manual#Глобальный поиск|глобальному поиску]] маркеров, комментариев и снимков по различным атрибутам
* Добавлена возможность [[Help:UI manual#Просмотр статистики|получения статистики]] по маркерам и активностям пользователей при разметке
* В API fullmarkers добавлен параметр <code>labels: true/false</code> для выгрузки меток маркера
* Реализован Public API для получения/добавления/удаления меток маркеров
* Настройки LDAP и прочие настройки аутентификации добавлены в единый конфигурационный файл
* Добавлена возможность удаления кода из снимка при частичном импорте в Svacer
* Добавлена опция minVersion, maxVersion для TLS при запуске сервера Svacer
* Добавлена поддержка групп проектов при импорте снимков в CLI
* При импорте снимков реализована поддержка автоматического определения пути префикса для переноса разметки
* Исправлен ряд ошибок в импорте и генерации [[Help:Sarif|SARIF]]
* Исправлены ошибки в копировании разметки между ветками, клонировании проектов и веток
* Добавлена возможность отключения бэкграунд задач по очистке мусора
* Добавлено экспериментальное CLI API для просмотра асинхронных задач на генерацию PDF
* Добавлена возможность визуализации производительности сервера на основе [https://github.com/arl/statsviz statsviz]
* Добавлена поддержка относительных путей в svres файле
* Добавлена возможность ожидания завершения операций по очистки мусора при выполнении операций по импорту результатов анализа
* Добавлена поддержка CWE таксономий при экспорте [[Help:Sarif|SARIF]]
* Добавлена переменная окружения SVACER_TOKEN_LIFETIME для управления временем жизни токена аутентификации
* Добавлена переменная окружения SVACER_RESET_ADMIN_PASSWORD для явного указания желаемого пароля при операции по сбросу пароля администратора
* Добавлен [[Notifications|механизм нотификаций пользователей]] о внутренних событиях Svacer (экспериментальный функционал)

=== Release 9-0-2 ===
22.07.2024

* Еще некоторые исправления, связанные с миграцией данных
* Исправлена проблема с навигацией по Go to Definition

=== Release 9-0-1 ===
15.07.2024

* Исправлены ошибки в клонировании проектов, приводящие к размножению записей в некоторых внутренних таблицах
* Различные исправления, связанные с миграцией данных
* Исправлена работа ряда CLI команд с включенным TLS на сервере
* Исправлен ряд ошибок в генерации PDF

=== Release 9-0-0 ===
04.06.2024

* Множество изменений в UI, смотрите [[Release notes 9-0-0]]
* Svacer разделен на два исполняемых файла: <code>svacer-server</code> — сервер и <code>svacer</code> — клиент
* {{Note}}Object store заменен на другую реализацию. Конвертация данных запускается автоматически при апгрейде и требует примерно 2х-2.2х дискового пространства, после конвертации старый object store будет удален. Время конвертации зависит от объема данных и скорости диска
* {{Note}}Изменен [[Help:Match|алгоритм сопоставления предупреждений]]. При старте сервера будет произведена регенерация всех инвариантов во всех ветках. Это может занять продолжительное время (зависит от мощности сервера и объемов данных)
* Добавлена возможность [[Help:Match#Ручное сопоставление предупреждений (экспериментальная возможность)|ручного сопоставления предупреждений]] для переноса разметки
* Добавлена экспериментальная поддержка [[OIDC|OpenID]] протокола для аутентификации
* Добавлена экспериментальная возможность [[Help:CLI#Слияние снимков из CLI (экспериментальная опция)|слияния снимков через CLI]]
* Исправлены баги в [[Help:Sarif|импорте Sarif]], добавлена поддержка импорта с относительными путями к файлам (флаг <code>--base-dir</code>)
* Лог сервера работает в режиме append, прежние данные не затираются
* Добавлена возможность передачи токена аутентификации в клиент Svacer через переменную окружения <code>SVACER_AUTH_TOKEN=token</code>
* Добавлена возможность передачи логина и пароля в клиент Svacer через переменную окружения <code>SVACER_AUTH_CREDS=login:password</code>
* Добавлен public REST endpoint для импорта <code>.svace-dir</code> на стороне сервера
* Добавлена возможность импорта <code>.svace-dir</code> из веб-интерфейса
* Добавлены [[Metrics|метрики]] для Prometheus, доступны при запуске сервера с переменной окружения <code>SVACER_TRACE_OPTIONS=prom_metrics_on</code> на <code>/api/metrics</code>
* Добавлена очистка БД от мусора с возможностью настройки периодичности данной операции через переменную окружения <code>SVACER_GC_PERIOD=val</code> где val — duration в формате <code>hhmmss</code> или [https://en.wikipedia.org/wiki/Cron Cron]
* Добавлена возможность клонирования проектов
* Добавлен импорт <code>*warn, *.err</code> файлов из <code>.svace-dir</code>, которые содержат диагностические сообщения от Svace
* Добавлена возможность [[Help:CLI#Ограничение числа запросов|ограничения числа запросов]] на сервер с указанием параметров в переменной окружения <code>SVACER_SERVER_THROTTLE_PARAMS</code>
* Добавлен шаблон для импорта разметки из кода на Go: <code>DEFAULT_GO</code>
* Добавлена возможность [[Help:CLI#Аутентификация из файла|аутентификации из файла]]
* Исправлены проблемы безопасности
* Добавлена возможность просмотра исходного кода снимка с предупреждениями анализатора во внешней IDE собранной на базе [https://theia-ide.org/ Theia IDE]
* К команде automigrate add в CLI добавлен флаг <code>skip-exist</code>, чтобы при добавлении паттерна, который уже существует, не выдавало ошибки
* К команде upload (import с флагом upload) с указанием флага <code>quality-gate</code> теперь можно добавить флаг <code>quality-gate-verbose</code>. Если его указать, то также будет выведен результат успешных проверок quality-gate
* Улучшения в поддержке протокола LDAP

=== Release 8-0-1 ===
22.01.2024

* Исправлена работа в изолированной от сети среде. Загрузка Web UI больше не требует доступа к публичным CDN
* Добавлена поддержка функций при указании пользовательского фильтра
* Добавлено API для управления пользовательскими фильтрами. Детали и пример использования можно найти здесь: https://gitlab.ispras.ru/svacer-public/api-go-examples/-/tree/master/api-ui-settings
* Исправлено отображение Checker Severity при экспорте в SARIF. Теперь Critical -> error; Major, Normal -> warning; Minor -> note; any other -> warning

=== Release 8-0-0 ===
21.11.2023

* Множество изменений в UI. Смотрите обзор в [[Release notes 8-0-0]]
* Добавлен новый импорт и экспорт из SARIF в command line с поддержкой исходного кода в SARIF файлах и импортом описания детекторов из SARIF
* Добавлены группы проектов
* Переделана модель ролей и доступов. Добавлен CLI для управления ролями и доступами
* Добавлена возможность настройки автопереноса разметки между ветками, в том числе в разных проектах
* Импорт/экспорт снимков включает информацию о детекторах
* Исправлена работа интерфейса с Undefined детекторами (т. е. детекторами, информация о которых отсутствует в Svacer)
* Добавлено экспериментальное API по управлению детекторами и конфигурациями детекторов
* Добавлена очистка исходного кода от Svacer-specific комментариев перед экспортом разметки в код
* Добавлена возможность включения режима обязательного комментария при разметке кода. Комментарий будет сгруппирован с операцией разметки и будет иметь ссылку на нее
* Утилита миграции со старого svace-сервера больше не поддерживается. При необходимости миграции используйте утилиту из прошлых релизов Svacer
* Добавлена Swagger документация на API
* Добавлено хранение истории изменений комментариев
* Опция <code>--pathPrefix</code> поддерживает файлы в JSON формате вида: <code>[{ "prefix": "/some/path", "replace": "/test" }, ...]</code>
* При использовании операции по обновлению <code>pathPrefix</code> на сервере, данные о прежнем <code>pathPrefix</code> запоминаются в мета-информации о снимке
* Добавлена возможность переименования снимков в UI
* Sensitive информация (детали подключения к БД с данными аутентификации) убрана из UI и API
* ОС в docker-образе Svacer обновлена с Ubuntu 18 до Ubuntu 22
* Улучшена логика автоопределения портов и протоколов при соединении с сервером из Svacer CLI

=== Release 7-0-1 ===
23.05.2023

* Исправлена проблема с фильтрацией предупреждений для C# проектов

=== Release 7-0-0 ===
16.05.2023

* Убрана зависимость от PostgreSQL из .deb и .rpm пакетов, чтобы проще было ставить Svacer только как клиент
* Сделан пакет для Windows (.msi) и документация по установке и запуску на Windows
* Теперь, если при svacer import и svacer sarif не указан путь к проекту, им считается текущая директория
* Информация о разметке и блокировках теперь обновляется автоматически при изменении в другом браузере (табе) или другим пользователем
* UI для пользовательских фильтров улучшен и перенесен в правую верхнюю часть экрана
* UI для выбора проекта, ветки и снимка теперь находится на одном уровне
* Улучшен UI для режима сравнения снимков
* Добавлена возможность работать одновременно с несколькими открытыми файлами в режиме Code, это поведение можно изменить в настройках профиля пользователя
* В левой навигационной панели детекторы теперь по умолчанию группируются по серьезности, это поведение можно изменить в настройках профиля пользователя
* Профиль текущего пользователя теперь можно смотреть/редактировать только через меню в правом верхнем углу
* Добавлена возможность копирования в системном логе и журнале
* Для пользователя теперь запоминается последний контекст (проект/ветка/снимок), с которым он работал, он автоматически открывается при старте новой сессии
* Групповая разметка теперь делается единой транзакцией, в случае ошибок или отмены все изменения откатываются
* Добавлено предупреждение при использовании некорректных путей при использовании REST API с префиксом /api
* Поддержка указания паролей из файла или pipe-а при использование Svacer CLI
* Добавлена поддержка multi-tab code view для режима просмотра кода объекта сборки
* Добавлена поддержка сохранения информации об удаленных детекторах при загрузке информации о детекторах из новой версии Svace
* Исправлен импорт результатов анализа, если сборка проводилась с опцией --disable-dxr
* Исправлены проблемы при импорте и прикреплении нескольких файлов к снимку
* Исправлены ошибки с входом в систему пользователей LDAP (специальные символы в пароле, вход по атрибуту mail)
* Добавлена возможность использования резервных серверов LDAP
* Добавлена возможность автоматического назначения пользователям LDAP роли Svacer, в зависимости от принадлежности пользователя к LDAP группе
* Добавлены новые public запросы на получение маркеров/снимков/проектов с учетом заданных параметров фильтрации
* Добавлена поддержка TLS при работе сервера по протоколам HTTP и gRPC
* Добавлена возможность загрузки статистики по общему количеству предупреждений и по количеству размеченных предупреждений для проектов и веток через REST API
* Добавлена вкладка выбора проектов в расширении VSCode
* Убрана возможность использовать всплывающее окно в VScode для добавления/редактирования/удаления комментариев, установки ревью-статусов, локов и т.д.

=== Release 6-0-3 ===
25.01.2023

* RPM-пакет теперь при сборке упаковывается в gzip вместо zstd для обратной совместимости со старыми дистрибутивами
* Если short url некорректен, то Svacer теперь будет возвращать корректный http error NotFound
* Если путь к лог файлу явно не указан, то svacer.log будет создаваться во временной директории. Это решает проблемы при запуске Svacer из директорий с запретом на запись. Путь к лог файлу будет печататься в stdout
* Лог файлы не будут создаваться, когда используется опция --help
* Исправлены проблемы при миграции схемы данных, когда в PostgreSQL используется SSL подключение
* Добавлены описания детекторов из последнего релиза Svace, которые были пропущены в релизе 6-0-2
* Исправлена работа Svacer за proxy-сервером, где выставляется Header "X-Content-Type-Options nosniff"
* Добавлены кнопки для скачивания системного лога и журнала из web-интерфейса
* Поправлен ряд ошибок валидации схемы при экспорте в SARIF
* Исправлено поведение при наличии нескольких хуков в конфигурационном файле
* В информацию о маркере для хуков добавлены checker severity и reliability
* Исправлен случайный порядок URL для маркеров при использовании public API для получения URL-ов
* На главную страницу добавлена кнопка "Помощь", которая открывает документацию
* При использовании команд навигации в режиме "Browse code" текущий файл теперь корректно подсвечивается в дереве файлов
* В диалоге групповой разметки убран индикатор изменений в виде кружочка, наличие изменений можно определить по активности кнопок "Apply" и "Reset"
* Кнопка обновления в верхнем меню теперь корректно обновляет информацию на странице Settings/Project
* Различные небольшие исправления в пользовательском интерфейсе

=== Release 6-0-2 ===
16.12.2022

* Исправлена проблема в UI с сохраненными пользовательскими фильтрами

=== Release 6-0-1 ===
13.12.2022

* Добавлено описание ряда детекторов, которые есть в последнем релизе Svace 3.3.2 но были пропущены в Svacer
* Исправлено вылетание в Login Screen при удалении нотификации из панели нотификаций
* Исправлено появление белого экрана при клике на детектор, информация о котором отсутствует
* Ряд различных небольших исправлений в UI
* Промежуточное хранилище будет очищаться по умолчанию при использовании команды import

=== Release 6-0-0 ===
30.11.2022

* Добавлено копирование комментариев при копировании разметки
* Комментарии добавлены к отчету в формате csv
* Добавлена возможность вводить пароль с клавиатуры для консольных команд
* Добавлена возможность импортировать разметку из объекта сборки (из ранее загруженных данных)
* Добавлена возможность импортировать разметку сразу после загрузки на сервер (опция для команды svacer upload)
* Добавлена возможность загружать исходный код не из папки .svace-dir
* Добавлена возможность бэкапа и восстановление объектного хранилища в сервер PostgresSQL
* Добавлена возможность создания отчета по проекту в формате PDF через интерфейс командной строки и посредством REST API
* Добавлена возможность подавления предупреждений через inline комментарии в коде
* Добавлена возможность подавления предупреждений по идентификатору предупреждения через command line и REST API
* Добавлена возможность ассоциировать организацию с пользователем и реестр организаций
* Добавлена фильтрация списка комментариев по пользователю в правой панели веб-интерфейса
* Добавлен поиск пользователей по его атрибутам в панели управления пользователями
* Добавлена возможность заполнения данных профиля LDAP пользователя данными, полученными от LDAP сервера
* Добавлена возможность прикреплять файлы к снимкам при импорте результатов (данные файлы составляют часть экспортируемых данных при экспорте снимков)
* Добавлена возможность ассоциировать пользовательские атрибуты типа "строка" или массив строк со снимком при импорте данных (данные атрибуты составляют часть экспортируемых данных при экспорте снимков)
* Добавлены command line операции по получению прикрепленных файлов и пользовательских атрибутов со снимков
* Добавлена возможность группового добавления комментариев
* Добавлена возможность указания сетевого интерфейса для работы WEB и GRPC серверов
* Добавлен вывод краткой статистики по загруженному снимку при команде upload. Поддерживается текстовой и JSON форматы вывода
* Существенно расширены возможности по интеграции Visual Studio Code с сервером Svacer
* Добавлен флаг --git в команду import. При наличии такого флага, ищется ближайший git репозиторий содержащий .svace-dir и при наличии такого - используется путь к гит репозиторию для замены путей на префикс .build.
* Portable PostgreSQL больше не входит в поставку. Вместо него поставляется docker-compose.yml файл для запуска PostgreSQL в докер-контейнере
* Добавлено больше данных и информации об ошибках в вывод команды svacer import
* Изменение Public API: добавлена точка входа /api/public/login
* Операции по импорту и экспорту снимков доступны теперь обычным пользователям (не администраторам) при использовании command line интерфейса
* Операция по экспорту снимков доступна обычному пользователю из веб-интерфейса (импорт все еще требует роль администратора для веб-интерфейса)
* Операции по экспорту снимков переведены на асинхронный режим. Нотификация о готовности будет показана пользователю и доступна в панели нотификаций
* Обновлено описание детекторов в соответствии с релизом Svace 3.3.2
* Исправлена ошибка обработки корневых сертификатов при подключении к LDAP серверу по протоколу ldaps
* Исправлено ошибочное создание дубликатов локальных учетных записей LDAP пользователей (case sensitive login)
* Различные исправления в пользовательском интерфейсе с целью оптимизации производительности
* Добавлены пропущенные проверки ролей при работе с веб-интерфейсом
* Svacer больше не создает временные файлы в директории с исполняемым файлом
* Устаранены задержки при удалении веток и проектов

Help:Configuration

2025-11-28T09:27:14Z

Akuzmin: fix mistype

== Настройки аутентификации в Svacer ==
В Svacer возможны четыре способа аутентификации пользователей

# Встроенный
# С помощью LDAP сервера
# Через утилиту oauth_proxy (по протоколу OIDC)
# Посредством Personal Access Token (PAT)

Ниже рассматривается настройка аутентификации посредством внутреннего механизма аутентификации. Для настройки [[LDAP]], [[Help:CLI#Personal Access Token|PAT]] или [[OIDC]] аутентификации см. соответствующие разделы документации.

=== Настройка внутреннего механизма аутентификации Svacer ===

==== Настройка парольной политики внутреннего механизма аутентификации Svacer ====
Настройки параметров встроенного механизма аутентификации возможны посредством секции '''auth.svacer''' конфигурационного файла Svacer. Ниже приведен пример настроек:
<pre class="">auth:
svacer:
password:
min_length: 10
complexity:
- "[a-z]"
- "[A-Z]"
- "[0-9]"
- "[!#]"</pre>
Параметр '''min_length''' задает минимальную возможную длину пароля в системе. Данный критерий используется при смене пароля пользователя и не влияет на текущие пароли пользователей.

Параметр '''complexity''' содержит набор регулярных выражений, задающих требования к паролю с точки зрения наличия в нем определенных символов. При задании такого списка выражений Svacer будет проверять задаваемый пользователем новый пароль на предмет удовлетворения всем этим требованиям. Каждое выражение в списке — полноценное выражение, поддерживаемое языком golang.

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

==== Задание вкладки по умолчанию на странице входа в GUI Svacer (а также отключение внутреннего механизма аутентификации Svacer) ====
В случае интеграции Svacer с LDAP, можно указать Svacer какую вкладку — Svacer или LDAP — использовать по умолчанию. Для этого используется параметр '''auth.svacer.default'''. Если данный параметр установлен в значение '''true''', то вкладкой по умолчанию будет вкладка Svacer, иначе — вкладка LDAP.

Также возможно полностью отключить механизм внутренней аутентификации Svacer с помощью параметра '''auth.svacer.enabled'''.

Ниже приведен пример конфигурационного файла Svacer для задания вкладки LDAP по умолчанию (в случае наличие интеграции с LDAP сервером)<pre class="plaintext">auth:
svacer:
enabled: true
default: false</pre>

=== Настройка защиты от перебора паролей пользователей ===
Для случаев аутентификации с помощью LDAP сервера и с помощью встроенного механизма аутентификации реализован механизм блокировки учетных записей пользователей в том случае, если количество неудачных попыток входа превышает заданное в настройках число. По умолчанию защита отключена. Ниже приведен пример секции конфигурационного файла Svacer, задающего правила блокировки:

<pre class="plaintext">security:
login:
max_attempts: 5
lock_time: 2m</pre>

Время, на которое происходит блокировка учетной записи пользователя, указывается в формате golang/time: 1s,1m,60m и т. д.

В случае активации защиты данный механизм также защищает аутентификацию посредством вызовов соответствующих точек входа public API.

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

Для принудительной разблокировки пользователей можно использовать команды cli (требуются права управления сервером):

<pre class="">svacer user-provider unlock --user admin --password admin --login locked_user</pre>

== Настройка TLS ==
Svacer может быть сконфигурирован для поддержки TLS несколькими способами. Первый способ — использовать reverse proxy с поддержкой HTTPS и проксированием в Svacer по HTTP, второй — запуск Svacer с нативной поддержкой TLS.

=== Reverse proxy ===
Данный способ позволяет обеспечить безопасную передачу данных только по протоколу HTTPS, данные по протоколу gRPC передаются в незащищенном виде.

==== Nginx ====
Создайте конфигурационный файл с подобным содержанием в '''/etc/nginx/sites-enabled/'''
<pre>
server {
listen 443 ssl;
listen [::]:443 ssl;

server_name svacer.ispras.ru;

# for large data transfers and continuous connections
client_max_body_size 0;
proxy_connect_timeout 600;
proxy_send_timeout 600;
proxy_read_timeout 600;
send_timeout 600;

# path to ssl-certificate and key
ssl_certificate /etc/ssl/certs/svacer.ispras.ru.crt;
ssl_certificate_key /etc/ssl/private/svacer.ispras.ru.key;

location / {
include proxy_params;

# to make WebSockets work
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";

# svacer HTTP URL
proxy_pass http://127.0.0.1:8080;
}
}

# proxy gRPC port if required
server {
listen 13002 http2;
underscores_in_headers on;

location / {
grpc_pass grpc://127.0.0.1:3002;
}
}
</pre>

В этом конфигурационном файле укажите нужное имя сервера, пути к сертификату (можно использовать fullchain-сертификат) и ключу, а также адрес сервера Svacer, куда проксировать. После этого перезапустите Nginx.
systemctl restart nginx

Если ваш сервер виден из интернета и его внешний IP-адрес привязан к доменному имени, можете использовать Let's Encrypt и Certbot для получения валидного SSL-сертификата. См. [https://www.nginx.com/blog/using-free-ssltls-certificates-from-lets-encrypt-with-nginx/ эту инструкцию].

==== Apache ====
Включите нужные модули в Apache
sudo a2enmod ssl proxy proxy_http rewrite

Создайте конфигурационный файл с подобным содержанием в '''/etc/apache2/sites-enabled/'''
<pre>
<VirtualHost *:443>
SSLEngine On
ProxyPreserveHost On
ProxyTimeout 600

# path to ssl-certificate and key
SSLCertificateFile /etc/ssl/certs/svacer.ispras.ru.crt
SSLCertificateKeyFile /etc/ssl/private/svacer.ispras.ru.key

# svacer HTTP URL
ProxyPass / http://127.0.0.1:8080/
ProxyPassReverse / http://127.0.0.1:8080/

# to make WebSockets work
ProxyPass /api/ws/ ws://127.0.0.1:8080/api/ws/
ProxyPassReverse /api/ws/ ws://127.0.0.1:8080/api/ws/
RewriteEngine on
RewriteCond %{HTTP:UPGRADE} ^WebSocket$ [NC]
RewriteCond %{HTTP:CONNECTION} ^Upgrade$ [NC]
RewriteRule /api/ws/(.*) ws://127.0.0.1:8080%{REQUEST_URI} [P]

ServerName svacer.ispras.ru
ServerAdmin svacer@ispras.ru
</VirtualHost>
</pre>

В этом конфигурационном файле укажите нужное имя сервера, пути к сертификату (можно использовать fullchain-сертификат) и ключу, а также адрес сервера Svacer, куда проксировать. После этого перезапустите Apache.
systemctl restart apache2

=== Нативно ===
Этот способ позволяет обеспечить безопасную передачу данных как по протоколу HTTPS, так и по протоколу gRPC. Если сервер запускается с поддержкой TLS, то эта опция относится как к протоколу HTTPS, так и к протоколу gRPC.
По умолчанию сервер запускается без поддержки TLS, при этом в логах отображается информация об этом.
TLS for REST and gRPC DISABLED

Для запуска сервера с поддержкой TLS необходимо указать сертификат сервера и соответствующий закрытый ключ.
svacer-server run --ssl-cert svacer.crt --ssl-key svacer.key

При этом ключ должен быть в незашифрованном виде. Права доступа к файлу должны быть 0600. В файле сертификата можно указывать цепочку сертификатов. В этом случае сервер, при подключении клиента, будет возвращать всю цепочку. Первым сертификатом в цепочке всегда должен идти сертификат сервера Svacer. Формат файла — PEM. TLS соединение активируется и для протокола REST и для протокола gRPC.

Работа сервера по проктолу TLS сопровождается следующей записью в логе:
Using TLS for REST and gRPC protocols

Работа с таким сервером через CLI происходит как обычно. Для указания необходимости подключаться по TLS можно явно указать протокол в параметре '''--host''', либо добавить опцию '''--ssl'''.
<pre>
svacer upload --host https://example.com
svacer upload --ssl --host example.com
</pre>
Также в клиенте можно определить параметр '''--ssl-ca-certs'''. Он позволяет задать доверенные сертификаты корневых центров. Указывается шаблон файлов (с *) или конкретный файл. Путь к директории должен быть абсолютным. В случае отсутствия этого параметра используется TLS, но сертификат сервера не проверяется. Этому случаю соответствует запись в логе клиента:
Using weak TLS configuration, because no CA certificate found

Если сертификаты были загружены, в логе будет строчка:
added 1 ca certs from /home/user/svacer/svacer.crt

Для администрирования сервера в плане используемого сертификата (например, замена при истечении срока действия) добавлена область в CLI svacer admin: '''server:config'''. В данной области есть 3 команды: '''show''', '''reload''', '''update'''. ID в этом случае нужно всегда указывать в значение '''ssl.cert'''.

* '''show''' — отображает текущий используемый сертификат

:<pre>svacer admin --ssl --host example.com --user admin --password admin --scope server:config --id ssl.cert --action show</pre>

* '''reload''' — заставляет сервер перечитать использованные при старте сервера файлы с сертификатом и ключом

:<pre>svacer admin --ssl --host example.com --user admin --password admin --scope server:config --id ssl.cert --action reload</pre>

* '''update''' — позволяет переслать на сервер новый сертификат (и ключ, если надо) и записать их в указанные при старте сервера файлы. При использовании этой команды нужно сформировать файл с новым сертификатом и, при необходимости, ключом, в формате PEM (используете '''cat''' для объединения сертификата и ключа в один файл) и указать этот файл в параметре value. Если в файле не будет указан закрытый ключ, то сервером будет использован текущий (тот, что был указан при запуске). Данная команда также изменит файлы сертификата и ключа (если он указан), указанные при старте сервера, на новые значения.

:<pre>svacer admin --ssl --host example.com --user admin --password admin --scope server:config --id ssl.cert --action update --value svacer.pem</pre>

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

В конфигурационном файле Svacer можно указать минимальную и максимальные версии TLS, поддерживаемые сервером. Для этого необходимо в конфигурационном файле указать параметры <code>minVersion</code> и <code>maxVersion</code> в разделе security.tls.

<pre>
security:
tls:
minVersion: tls11
maxVersion: tls12
</pre>

== Интеграция с хранилищем секретов Infisical ==
В Svacer реализована поддержка получения секретов из хранилища секретов [https://infisical.com/ Infisical]. Подробную информацию об интеграции см. в статье [[Infisical|Интеграция с хранилищем секретов Infisical]].

== Механизм интеграции с внешними системами посредством Webhook-ов ==

=== Общий принцип работы ===

Механизм webhook-ов настраивается в конфигурационном файле в секции '''webhook'''. Механизм срабатывает при получении по внутренней шине одного из поддерживаемых событий Svacer. Каждое из внутренних событий преобразуется в событие вызова webhook-а (см. [[Help:Configuration#Модель поддерживаемых событий|Модель поддерживаемых событий]]) и отправляется на обработку в каждую из настроенных целей, которыми являются http-обработчики. Отправкой занимаются работники (их количество настраивается в конфигурационном файле в параметре '''workers_count'''). У каждой цели есть общая очередь, размер которой составляет 500 событий. Если очередь переполняется, будет выдаваться соответствующее сообщение в лог-файле Svacer.

Работники поддерживают протокол https (в том числе самоподписанные сертификаты). Для указания корневого сертификата можно использовать параметр '''ca_certs''' конфигурационного файла. Работникам можно указать таймаут соединения с webhook-сервером (в мс, по умолчанию 1000мс, параметр '''timeout''') и количество попыток отправки (по умолчанию — одна попытка, параметр '''retry_count''').

В настройках можно указать фильтр на отправляемые события (параметр '''filter'''). Фильтр указывается посредством задания выражения. В выражениях используется [https://github.com/expr-lang/expr синтаксис go-expr]. Фильтр возможно указать в количестве одной штуки на одну цель. Если фильтр после вычисления дает значение true, событие будет отправлено в цель.

Также реализован журнал событий отправки webhook-ов, размер которого может быть указан в конфигурационном файле (параметр '''journal_length'''). По умолчанию он равен 86400 записей — по 1 записи на каждую секунду суток. Журнал может быть использован для отладки механизма отправки событий в цель. Содержимое журнала хранится в памяти. При достижении журналом максимального размера, самые старые записи заменяются новыми.

Для настройки аутентификации работника можно использовать параметр '''headers''', который представляет собой список значений вида '''key:value'''. Данные пары будут добавлены в заголовки каждого http-запроса, выполняемого работником.

=== Конфигурация ===

Возможный пример конфигурационного файла, в котором указана отправка на сервер test-host.local событий, связанных с разметкой маркера.

webhook:
enabled: true
journal_length: 86400
targets:
- url: "<nowiki>https://test-host.local:8080/webhook</nowiki>"
workers_count: 1
enabled: true
filter: "Type == EventReviewMarker and Payload.Status != 'Undecided'"
ca_certs: "/etc/ssl/certs/ca.crt"
retry_count: 3
timeout: 1000
headers:
- "password:12345"
- "Authorization: Bearer eyJh .... "

=== CLI ===

Для взаимодействия с механизмом webhook реализованы две cli команды:

svacer server webhook journal
svacer server webhook stat

Первая команда позволяет посмотреть записи журнала отправки событий. Вторая команда позволяет вывести статистику по работе службы (особенно интересными могут быть поля '''sendError''' и '''skip''').

Пример вывода для первой команды (с флагом '''--humanize'''; если флага нет, то вывод будет в формате json):

==================== #1 ======================
Time: 2025-07-01 12:25:52.25343534 +0300 MSK
Created by: admin
Error:
Success: true
SvacerKind: UpdateMarkerReview
EventType: EventReviewMarker
TargetURL: <nowiki>https://swarm-mgr.home:8080/webhook</nowiki>
ProcessTime: 6 ms
==================== #2 ======================
Time: 2025-07-01 12:25:54.202850322 +0300 MSK
Created by: admin
Error:
Success: true
SvacerKind: UpdateMarkerReview
EventType: EventReviewMarker
TargetURL: <nowiki>https://swarm-mgr.home:8080/webhook</nowiki>
ProcessTime: 3 ms

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

{
"enabled": true,
"targets": [
{
"enabled": true,
"url": "<nowiki>https://swarm-mgr.home:8080/webhook</nowiki>",
"filtered": 0,
"sendSuccess": 3,
"sentError": 0,
"submitted": 3,
"skip": 0
}
]
}

==== Модель поддерживаемых событий ====
syntax = "proto3";
import "google/protobuf/any.proto";
option go_package="svacer/proto/webhook";
package webhook;

enum EventType {
EventNone = 0;
EventTest = 1;
EventReviewMarker = 2;
EventPurgeReview = 3;
EventGroupReview = 4;
EventImportSnapshot = 5;
EventCopySnapshot = 6;
EventNewComment = 7;
EventUpdateComment = 8;
EventNewContainer = 9;
EventDeleteContainer = 10;
EventUpdateContainer =11;
EventImportMarkup = 12;
EventDeleteSnapshot = 13;
UpdateSnapshot = 14;
}

message MarkerDetails {
string id = 1;
string file = 2;
string line = 3;
string lang = 4;
}

message Event {
uint64 timestamp = 1;
EventType type = 2;
string created_by = 3;
google.protobuf.Any payload = 4;
}

message PayloadMarkerReview {
string project_id = 1;
string project_name = 2;
string branch_id = 3;
string branch_name = 4;
string snapshot_id = 5;
string snapshot_name = 6;
repeated MarkerDetails markers = 7;
string comment = 8;
string severity = 9;
string action = 10;
string status = 11;
bool group_review = 12;
string created_by_id = 13;
string created_by_login = 14;
}

message PayloadPurgeReview {
string project_id = 1;
string project_name = 2;
string branch_id = 3;
string branch_name = 4;
string created_by_id = 5;
string created_by_login = 6;
}

message PayloadImportSnapshot {
string project_id = 1;
string project_name = 2;
string branch_id = 3;
string branch_name = 4;
string snapshot_id = 5;
string snapshot_name = 6;
}

message PayloadMarkerComment {
string project_id = 1;
string project_name = 2;
string branch_id = 3;
string branch_name = 4;
string snapshot_id = 5;
string snapshot_name = 6;
MarkerDetails marker = 7;
string comment = 8;
string created_by_id = 9;
string created_by_login = 10;
}

message PayloadCopySnapshot {
string project_id = 1;
string project_name = 2;
string branch_id = 3;
string branch_name = 4;
string snapshot_id = 5;
string snapshot_name = 6;
string created_by_id = 7;
string created_by_login = 8;
}

message Container {
string project_id = 1;
string project_name = 2;
string branch_id = 3;
string branch_name = 4;
Container source = 5;
}

message PayloadNewContainer {
repeated Container containers = 1;
}

message PayloadDeleteContainer {
repeated Container projects = 1;
repeated Container branches = 2;
}

message PayloadUpdateContainer {
Container container = 1;
}

message CopyResult {
uint64 total = 1;
uint64 applied_reviews = 2;
uint64 applied_comments = 3;
uint64 skipped_reviews = 4;
uint64 duplicate_reviews = 5;
uint64 duplicate_comments = 6;
}

message PayloadImportMarkup {
Container source=1;
Container target=2;
CopyResult copy_result =3;
}

message Snapshot {
string snapshot_id = 1;
string snapshot_name = 2;
Container container = 3;
}

message PayloadDeleteSnapshots {
repeated Snapshot snapshots = 1;
}

message PayloadUpdateSnapshot {
string snapshot_id = 1;
string snapshot_name = 2;
Container container = 3;
}

== Выбор сетевых интерфейсов и портов сервера ==
* По умолчанию web-сервер запускается на всех сетевых интерфейсах, на порту 8080 ('''0.0.0.0:8080'''). Для указания конкретного сетевого интерфейса можно использовать опцию '''--listen <network interface>''', для указания другого порта: '''--port <port_number>.
* Аналогично для grpc-сервера: по умолчанию — '''0.0.0.0:3002''', для выбора конкретного интерфейса: '''--listen-grpc <network_interface>''', для указания другого порта: '''--grpc <port_number>'''.

svacer-server run --listen 127.0.0.1 --port 9090 --listen-grpc 127.0.0.1 --grpc 3004

При попытке запуска на порту < 1024 от непривилегированного пользователя (например, от пользователя svacer при установке из deb/rpm пакета), сервер Svacer не запустится с ошибкой

ERROR: port 443 is privileged, please check current user permissions or set another rest api port

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

sudo setcap 'cap_net_bind_service=+ep' /usr/bin/svacer-server

== Увеличение лимита открытых файлов ==
Актуально только для Linux.

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

В POSIX таких лимита два:
* soft nofiles — текущее максимальное значение
* hard nofiles — общесистемное максимальное значение

В большинстве систем hard значение достаточно большое, а soft обычно маленькое, что и приводит к проблемам. Пример на Debian 11:

$ ulimit -Sn
1024
$ ulimit -Hn
1048576

Начиная с версии 6-0-0 Svacer пытается автоматически увеличить soft limit до значения hard limit при запуске, а начиная с версии 8-0-0 — проверяет, что увеличить удалось и выводит сообщение с текущим лимитом. Если видите в логах подобную запись — у soft и hard одно, достаточно большое значение — значит все в порядке.

Open files limit (soft and hard): 1048576

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

* Перед запуском Svacer выполнить из консоли команду, увеличив лимит для текущей сессии
ulimit -Sn 16384

* Либо один раз увеличить на уровне системы — в файл '''/etc/security/limits.conf''' добавить

* soft nofile 16384

* Если запускаете Svacer как сервис systemd, добавьте параметр '''LimitNOFILE''' в секцию '''[Service]''' файла описания сервиса.
:В файле из deb/rpm пакета релиза Svacer этот параметр уже добавлен

[Service]
LimitNOFILE=16384

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

sudo systemctl daemon-reload
sudo systemctl restart svacer.service

== Установка пути к директории для кэша ==
Если запускаете Svacer под пользователем без домашней директории, рекомендуется установить путь к директории для кэша через переменную окружения SVACER_CACHE_DIR в файле описания сервиса systemd

[Service]
Environment="SVACER_CACHE_DIR=/path/to/some/dir"

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

sudo systemctl daemon-reload
sudo systemctl restart svacer.service

== Дополнительные параметры при запуске в docker ==
При запуске в докер-контейнере можно указать дополнительные параметры, к примеру добавить конфиг [[Help:CLI#Хуки|хуков]].

Для этого переопределите команду запуска сервера Svacer в docker-compose файле и допишите туда нужные параметры:

command: /svacer/bin/svacer-server run --store /data/store --pg postgres://svace:svace@postgresql:5432/svace --hooks /svacer/hooks.json

Конфигурационный файл с описанием хуков примонтируйте как volume:

volumes:
- ./hooks.json:/svacer/hooks.json

Можете использовать переменные из секции environment docker-compose файла, тогда в строке запуска их надо экранировать с помощью <code>$$</code> и запускать сервер Svacer как shell-команду, чтобы в контейнере подставились значения переменных

environment:
- SVACER_PG_URL=postgres://svace:svace@postgresql:5432/svace
- STORE=/data/store
- HOOKS_FILE=/svacer/hooks.json
volumes:
- ./hooks.json:/svacer/hooks.json
command: sh -c "/svacer/bin/svacer-server run --store $$STORE --pg $$SVACER_PG_URL --hooks $$HOOKS_FILE"

Для более комплексных сценариев можете собрать свой образ с сервером Svacer, использовав наш [[Dockerfile]] как референс.

== Обновление детекторов ==
После установки новой версии Svace требуется обновить описания детекторов в Svacer. Для этого необходимо выполнить команду:

svacer checkers --upload </path/to/svace>

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

== Генерация PDF на основе HTML ==
В релиз 10.х.х включена генерация PDF на основе рендеринга HTML с последующим запуском headless chrome/chromium для генерации PDF. Этот подход позволяет упростить формирование шаблонов для генерации PDF, но требует существенно больше вычислительных ресурсов. Для тюнинга числа параллельных процессов при генерации используется переменная окружения

SVACER_PDF_GEN_LIMITS=<pdf tool limit>:<chrome limit>

Первое значение <code><pdf tool limit></code> определяет число одновременных процессов pdfmerge для сборки отдельных секций в единый PDF документ; второе значение <code><chrome limit></code> определяет одновременное число процессов chrome/chromium для генерации PDF из HTML. Не рекомендуется ставить значения, сильно превышающие число ядер в сервере.

== Полнотекстовый поиск ==
Для поддержки полнотекстового поиска Svacer строит индекс. По умолчанию директория для индекса создается в <code>$HOME/.cache/svacer</code>, для указания иной директории можно использовать переменную окружения <code>SVACER_SEARCH_INDEX_DIR</code>

В ряде случаев (падение и рестарт сервера, ошибки и т. п.) кэш может быть в некорректном состоянии. Для переиндексации данных администратор может использовать CLI команду

svacer search --host <nowiki>http://some_host:port</nowiki> --user <login> --password <pwd> --drop-cache

Используемая при этом учетная запись должна быть с правами на <code>Server administration</code>

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

== Указание public-url ==
В некоторых случаях необходимо явно указывать серверу Svacer его URL-адрес. Например, это нужно для корректной генерации коротких ссылок на предупреждения и ссылок в [[Notifications|уведомлениях]]. Используйте параметр <code>--public-url</code> при запуске сервера
<nowiki>svacer-server run --public-url http://svacer.intra.net:8080</nowiki>

== Расширенные параметры настройки сервера ==

=== Переменные окружения ===
Можно использовать следующие переменные окружения для изменения внутренних параметров сервера:
{| class="wikitable"
|+
!Переменная
!Значение по умолчанию
!Описание
|-
|SVACER_TIMEOUT_IMPORT_RESULTS
|15 минут
|Таймаут ожидания процесса начала импорта на сервере. При превышении запрос на импорт будет отклонен с ошибкой. Формат — Go Duration string: 1h2m3s. Переменная затрагивает только ожидание начала, но не ограничивает сам процесс импорта
|-
|SVACER_NUM_PARALLEL_IMPORTS
|(максимальное число коннектов к БД) / 2
|Число одновременных параллельных импортов. Остальные ждут в очереди. На ожидание влияет переменная SVACER_TIMEOUT_IMPORT_RESULTS
|-
|SVACER_TAIL_LOG_SIZE
|1Мб
|Число. Размер буфера для показа лога сервера в WebUI. Показывается последние SVACER_TAIL_LOG_SIZE байт из лога.
|-
|SVACER_LOG_FORMAT
|<пусто>
|При указании 'json' формат вывода лога заменяется на JSON. Предназначено для интеграции с агрегаторами логов. Также можно указать через флаг при старте: <code>svacer-server --log-format=json</code>
|-
|SVACER_INV_GEN_JOBS
|0.7 * runtime.GOMAXPROCS
|Максимальное число параллельных заданий для генерации инвариантов при миграции старой базы или импорте результатов. При ограниченных ресурсах сервера используйте значение 1 или 2. Нельзя установить значение больше, чем GOMAXPROCS
|}

=== Пересчет инвариантов ===
При миграции со старых версий иногда могут быть проблемы с переносом разметки. Для принудительного пересчета инвариантов запустите сервер с опцией <code>--force-invariant-refresh</code>.

=== Объектное хранилище ===
При больших размерах объектного хранилища (object store) можно запустить сервер с параметром <code>--compact-object-store</code> — это приведет к поиску недостижимых объектов в хранилище и сокращению размера базы. Операция может занять продолжительное время.

'''ЭКСПЕРИМЕНТАЛЬНО''': Для быстрого получения копии текущего объектного хранилища пользователь может использовать CLI команду

svacer server backup --host <nowiki>http://localhost:8080</nowiki> --user admin --password <admin pwd> --checkpoint <path>

Данная команда создаст по пути <path> на '''хосте, где работает сервер''', копию object store. При создании копии по возможности используются hard links, для ускорения процесса. Процесс работает в фоновом режиме, можно запускать его для работающего сервера.

Help:Installation

2025-11-28T09:22:19Z

Akuzmin: fix link

== Установка и запуск ==
Для использования только клиента Svacer достаточно [[Svacer#Релизы|скачать исполняемый файл]] '''svacer''', или установить [[Help:Installation#Svacer|deb/rpm пакет]].

Сервер Svacer можно запустить в [[Help:Installation#docker compose|докере]] или из [[Help:Installation#deb/rpm|deb/rpm пакета]].

=== docker compose ===
Рекомендуемый и самый простой способ деплоя — развернуть сервер Svacer в докер-контейнерах, воспользовавшиcь [https://svacer.ispras.ru/extra/docker-compose.yml docker-compose.yml] файлом:

<nowiki>curl -LO https://svacer.ispras.ru/extra/docker-compose.yml</nowiki>
docker compose up -d

После запуска контейнеров веб-интерфейс Svacer будет доступен по адресу http://localhost:8080, логин / пароль — admin / admin.

Для сборки своего докер-образа Svacer можете использовать [[Dockerfile]] в качестве референса.

Для указания других параметров сервера можете [[Help:Configuration#Дополнительные параметры при запуске в docker|переопределить команду запуска]] в docker-compose файле.

=== deb/rpm ===
==== PostgreSQL ====
{{Note|type=info|text=Disclaimer
* Рекомендуемая версия PostgreSQL — 15 и выше. С более старыми версиями корректная работа Svacer не гарантируется.
* Svacer требует эксклюзивного доступа к базе. Использование одной и той же базы для нескольких экземпляров Svacer может приводить к порче данных.}}

Для работы сервера Svacer установите PostgreSQL, следуя [https://www.postgresql.org/download/linux документации postgres]. Для RedHat-based OS нужно дополнительно установить пакет postgresql-contrib соответствующей версии.

Пример для Ubuntu 22:

sudo apt install -y postgresql-common
sudo /usr/share/postgresql-common/pgdg/apt.postgresql.org.sh
sudo apt install -y postgresql-17

Пример для Rocky Linux 9.4:

<nowiki>sudo dnf install -y https://download.postgresql.org/pub/repos/yum/reporpms/EL-9-x86_64/pgdg-redhat-repo-latest.noarch.rpm</nowiki>
sudo dnf -qy module disable postgresql
sudo dnf install -y postgresql17-server postgresql17-contrib
sudo /usr/pgsql-17/bin/postgresql-17-setup initdb
sudo systemctl enable postgresql-17
sudo systemctl start postgresql-17

==== Браузер для PDF-отчетов ====
Для создания PDF-отчетов с использованием нового HTML-генератора установите браузер Google Chrome на машину, где запускается сервер Svacer. Рекомендуется устанавливать из официального репозитория, следуя [https://www.google.com/chrome/?platform=linux инструкции с сайта google].

{{Note|type=info|text=Рекомендуемые системные требования при генерации PDF-отчетов для больших проектов с использованием HTML-генератора: Intel Core i9, 64 GB RAM, SSD, видеокарта Nvidia}}

При запуске Svacer проверит доступность браузера для генерации PDF. Если он не установлен или генерация не работает, будет использован нативный генератор: менее продвинутый, но для него не нужен браузер. Можно явно включить использование нативного генератора, передав опцию <code>--pdf-generator=native</code> при запуске сервера Svacer.

При невозможности установить Google Chrome, например если нет пакета для вашего дистрибутива Linux, можно установить Chromium. Его пакет в репозиториях, в зависимости от вышей ОС, может называться <code>chromium-browser</code> или <code>chromium</code>. В некоторых случаях генерация с Chromium может не работать. Например, если Svacer установлен из deb-пакета, а Сhromium из snap (на Ubuntu он устанавливается именно так даже при использовании apt) и сервер Svacer запускается от отдельного системного пользователя, от которого Chromium не может запуститься. В этом случае установите Google Chrome, с ним генерация работает.

==== Svacer ====
На Debian-based OS добавьте apt-репозиторий и установите Svacer из него.

<nowiki>echo 'deb [signed-by=/usr/share/keyrings/ispras.gpg] https://repo.ispras.ru/apt /' | sudo tee /etc/apt/sources.list.d/ispras.list</nowiki>
<nowiki>curl -fsSL https://repo.ispras.ru/apt/key.asc | sudo gpg --dearmor -o /usr/share/keyrings/ispras.gpg</nowiki>
sudo apt update
sudo apt install -y svacer

На RedHat-based OS добавьте dnf-репозиторий и установите Svacer из него

<nowiki>curl -fsSL https://repo.ispras.ru/rpm/ispras.repo | sudo tee /etc/yum.repos.d/ispras.repo</nowiki>
sudo dnf install -y svacer

Для создания БД PostgreSQL запустите '''psql''' от учетной записи пользователя '''postgres'''

sudo su -l postgres
psql

И выполните следующие запросы:
create database svace;
create user svace with encrypted password 'svace';
grant all privileges on database svace to svace;
alter user svace superuser;

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

При использовании других значений нужно поменять параметры подключения к БД в файле '''/etc/default/svacer'''

SVACER_ARGS="--pg postgres://<user>:<password>@127.0.0.1:5432/<database>"

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

На Astra Linux необходимо в файле '''/etc/parsec/mswitch.conf''' установить параметр <code>zero_if_notfound: yes</code>, иначе при запуске Svacer будет ошибка подключения к БД вида

error obtaining MAC configuration for user "svace" (SQLSTATE 57P03)

После создания БД и конфигурации сервера Svacer запустить его можно следующими командами

sudo systemctl enable svacer
sudo systemctl start svacer

После чего проверить успешность запуска командой

systemctl status svacer

После запуска сервер будет доступен по адресу http://localhost:8080, логин / пароль — admin / admin.

=== Установка и запуск на Windows ===
PostgreSQL нужен только для сервера Svacer, для клиента не требуется.
* Скачайте установщик PostgreSQL для Windows: https://www.postgresql.org/download/windows
* Установите PostgreSQL, выбрав, как минимум, компоненты "PostgreSQL Server" и "Command Line Tools"
* Задайте и запомните пароль на шаге выбора пароля для суперпользователя
* Остальные параметры при установке можно оставить по умолчанию
* После установки PostgreSQL откройте консоль, перейдите в директорию, куда установили PostgreSQL, запустите его клиент с указанием пользователя "postgres" и авторизуйтесь с паролем, заданным во время установки
cd c:\Program Files\PostgreSQL\15\bin
psql -U postgres
* Запустится консоль управления PostgreSQL. Выполните в ней следующие команды, чтобы создать БД и пользователя для Svacer
create database svace;
create user svace with encrypted password 'svace';
grant all privileges on database svace to svace;
alter user svace superuser;
* Выйдите из консоли PostgreSQL
* Запустите '''svacer-server.exe''' из консоли с указанием параметров подключения к БД. Если при создании пользователя и БД PostgreSQL вы использовали для них имя по умолчанию 'svace', как в примере выше, то указывать данные для подключения к БД при запуске сервера не обязательно
svacer-server.exe run
* Если создавали пользователя или БД с другими именами, то при запуске сервера надо указать их явно
svacer-server.exe run --pg postgres://svacer_user:svacer_password@127.0.0.1:5432/svacer_database
* После запуска сервера его веб-интерфейс будет доступен по адресу http://localhost:8080, логин / пароль — admin / admin

== Обновление ==
{{Note|type=reminder|text='''Перед обновлением настоятельно рекомендуется [[Help:Backup|делать резервные копии]]'''}}

Миграции схем БД PostgreSQL и object store происходят автоматически при обновлении на новую версию Svacer. Поэтому для обновления Svacer достаточно остановить сервер старой версии, запустить сервер новой версии, указав ему те же параметры БД и object store, и подождать, пока не пройдет обновление, после чего Svacer запустится как обычно. При больших объемах данных в БД это может занять существенное время, до нескольких часов. Прогресс можно отслеживать по логам сервера.

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

{{Note|type=warn|text=После запуска Svacer при обновлении обязательно дождитесь пока миграция БД завершится. Если прервать процесс во время миграции, принудительно остановив Svacer, база данных может оказаться в неконсистентном состоянии и придется восстанавливать данные из бэкапа.}}

=== Upgrade notes ===
==== 12-x-x ====
* Рекомендуем обновить PostgreSQL до версии 15 или выше. С более старыми версиями корректная работа Svacer не гарантируется
* Если вы использовали аутентификацию с помощью LDAP в версиях Svacer 5-1-X и у вас не работает механизм тегирования или уведомлений (подписки), см [[LDAP_configuration#Некоторые_замечания_для_пользователей,_которые_использовали_LDAP_в_версиях_Svacer_5-1-X|решение проблем с отсутствием статуса пользователя в БД]]

==== 11-x-x ====
Нет специфических рекомендаций по обновлению.

==== 10-x-x ====
Нет специфических рекомендаций по обновлению.

==== 9-0-0 ====
{{Note|type=reminder|text=При обновлении на эту версию рекомендуем не меньше 8GB RAM для корректности миграций}}

Базово, никаких обязательных ручных действий с базой данных или object store при обновлении на 9-0-0 не требуется. Описанные ниже шаги могут помочь увеличить производительность сервера Svacer или решить возможные проблемы.

'''1.'''

В версии 9-0-0 поменялся формат object store, поэтому при обновлении с предыдущих версий Svacer на 9-0-0 или выше будет запущена конвертация object store в новый формат. Конвертация сначала записывает новые данные, а потом, если все прошло успешно, удаляет старые. Из-за этого для конвертации нужно примерно в два раза больше свободного дискового пространства, чем занимает текущий object store. При больших размерах object store и медленном диске конвертация может занять много времени.

Конвертация запустится автоматически при обновлении на 9-0-0, но можно запустить вручную отдельно:

svacer-server kvconvert --from <path> --to <path>

Расположение object store в файловой системе описано в [[Help:Backup#Бэкап object store вручную|разделе про бэкапы]].

'''2.'''

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

delete from checkers where id not in (select max(id) from checkers group by (config_id, checker_id, languages, tools));

Если вы уже выполняли этот запрос при [[Help:Installation#8-0-0|обновлении на 8-0-0]], то второй раз запускать не обязательно.

'''3.'''

После обновления на версию 9-0-0 и завершения всех миграций БД (когда станет доступен веб-интерфейс) рекомендуем выполнить команду <code>VACUUM FULL</code> в PostgreSQL для очистки и оптимизации базы данных.

psql -h <postgres_host> -U <username> <svacer_database_name> -c 'VACUUM FULL;'

Например:

psql -h localhost -U svacer svacer_db -c 'VACUUM FULL;'

==== 8-0-0 ====
Если при обновлении на версию 8-0-0 и выше возникает подобная ошибка
Key (config_id, checker_id, languages, tools)=(4cd178ce-a2b2-4692-a45a-f84b145c807b, FB.ICAST_QUESTIONABLE_UNSIGNED_RIGHT_SHIFT, {JAVA}, {SpotBugs}) is duplicated
Это значит, что в БД есть дубликаты чекеров. Выполните следующий SQL-запрос в PostgreSQL-базе Svacer, чтобы удалить их:
delete from checkers where id not in (select max(id) from checkers group by (config_id, checker_id, languages, tools));

Help:Configuration

2025-11-28T09:21:33Z

Akuzmin: fix headers levels

== Настройки аутентификации в Svacer ==
В Svacer возможны четыре способа аутентификации пользователей

# Встроенный
# С помощью LDAP сервера
# Через утилиту oauth_proxy (по протоколу OIDC)
# Посредством Personal Access Token (PAT)

Ниже рассматривается настройка аутентификации посредством внутреннего механизма аутентификации. Для настройки [[LDAP]], [[Help:CLI#Personal Access Token|PAT]] или [[OIDC]] аутентификации см. соответствующие разделы документации.

=== Настройка внутреннего механизма аутентификации Svacer ===

==== Настройка парольной политики внутреннего механизма аутентификации Svacer ====
Настройки параметров встроенного механизма аутентификации возможны посредством секции '''auth.svacer''' конфигурационного файла Svacer. Ниже приведен пример настроек:
<pre class="">auth:
svacer:
password:
min_length: 10
complexity:
- "[a-z]"
- "[A-Z]"
- "[0-9]"
- "[!#]"</pre>
Параметр '''min_length''' задает минимальную возможную длину пароля в системе. Данный критерий используется при смене пароля пользователя и не влияет на текущие пароли пользователей.

Параметр '''complexity''' содержит набор регулярных выражений, задающих требования к паролю с точки зрения наличия в нем определенных символов. При задании такого списка выражений Svacer будет проверять задаваемый пользователем новый пароль на предмет удовлетворения всем этим требованиям. Каждое выражение в списке — полноценное выражение, поддерживаемое языком golang.

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

==== Задание вкладки по умолчанию на странице входа в GUI Svacer (а также отключение внутренного механизма аутентификации Svacer) ====
В случае интеграции Svacer с LDAP, можно указать Svacer какую вкладку — Svacer или LDAP — использовать по умолчанию. Для этого используется параметр '''auth.svacer.default'''. Если данный параметр установлен в значение '''true''', то вкладкой по умолчанию будет вкладка Svacer, иначе — вкладка LDAP.

Также возможно полностью отключить механизм внутренней аутентификации Svacer с помощью параметра '''auth.svacer.enabled'''.

Ниже приведен пример конфигурационного файла Svacer для задания вкладки LDAP по умолчанию (в случае наличие интеграции с LDAP сервером)<pre class="plaintext">auth:
svacer:
enabled: true
default: false</pre>

=== Настройка защиты от перебора паролей пользователей ===
Для случаев аутентификации с помощью LDAP сервера и с помощью встроенного механизма аутентификации реализован механизм блокировки учетных записей пользователей в том случае, если количество неудачных попыток входа превышает заданное в настройках число. По умолчанию защита отключена. Ниже приведен пример секции конфигурационного файла Svacer, задающего правила блокировки:

<pre class="plaintext">security:
login:
max_attempts: 5
lock_time: 2m</pre>

Время, на которое происходит блокировка учетной записи пользователя, указывается в формате golang/time: 1s,1m,60m и т. д.

В случае активации защиты данный механизм также защищает аутентификацию посредством вызовов соответствующих точек входа public API.

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

Для принудительной разблокировки пользователей можно использовать команды cli (требуются права управления сервером):

<pre class="">svacer user-provider unlock --user admin --password admin --login locked_user</pre>

== Настройка TLS ==
Svacer может быть сконфигурирован для поддержки TLS несколькими способами. Первый способ — использовать reverse proxy с поддержкой HTTPS и проксированием в Svacer по HTTP, второй — запуск Svacer с нативной поддержкой TLS.

=== Reverse proxy ===
Данный способ позволяет обеспечить безопасную передачу данных только по протоколу HTTPS, данные по протоколу gRPC передаются в незащищенном виде.

==== Nginx ====
Создайте конфигурационный файл с подобным содержанием в '''/etc/nginx/sites-enabled/'''
<pre>
server {
listen 443 ssl;
listen [::]:443 ssl;

server_name svacer.ispras.ru;

# for large data transfers and continuous connections
client_max_body_size 0;
proxy_connect_timeout 600;
proxy_send_timeout 600;
proxy_read_timeout 600;
send_timeout 600;

# path to ssl-certificate and key
ssl_certificate /etc/ssl/certs/svacer.ispras.ru.crt;
ssl_certificate_key /etc/ssl/private/svacer.ispras.ru.key;

location / {
include proxy_params;

# to make WebSockets work
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";

# svacer HTTP URL
proxy_pass http://127.0.0.1:8080;
}
}

# proxy gRPC port if required
server {
listen 13002 http2;
underscores_in_headers on;

location / {
grpc_pass grpc://127.0.0.1:3002;
}
}
</pre>

В этом конфигурационном файле укажите нужное имя сервера, пути к сертификату (можно использовать fullchain-сертификат) и ключу, а также адрес сервера Svacer, куда проксировать. После этого перезапустите Nginx.
systemctl restart nginx

Если ваш сервер виден из интернета и его внешний IP-адрес привязан к доменному имени, можете использовать Let's Encrypt и Certbot для получения валидного SSL-сертификата. См. [https://www.nginx.com/blog/using-free-ssltls-certificates-from-lets-encrypt-with-nginx/ эту инструкцию].

==== Apache ====
Включите нужные модули в Apache
sudo a2enmod ssl proxy proxy_http rewrite

Создайте конфигурационный файл с подобным содержанием в '''/etc/apache2/sites-enabled/'''
<pre>
<VirtualHost *:443>
SSLEngine On
ProxyPreserveHost On
ProxyTimeout 600

# path to ssl-certificate and key
SSLCertificateFile /etc/ssl/certs/svacer.ispras.ru.crt
SSLCertificateKeyFile /etc/ssl/private/svacer.ispras.ru.key

# svacer HTTP URL
ProxyPass / http://127.0.0.1:8080/
ProxyPassReverse / http://127.0.0.1:8080/

# to make WebSockets work
ProxyPass /api/ws/ ws://127.0.0.1:8080/api/ws/
ProxyPassReverse /api/ws/ ws://127.0.0.1:8080/api/ws/
RewriteEngine on
RewriteCond %{HTTP:UPGRADE} ^WebSocket$ [NC]
RewriteCond %{HTTP:CONNECTION} ^Upgrade$ [NC]
RewriteRule /api/ws/(.*) ws://127.0.0.1:8080%{REQUEST_URI} [P]

ServerName svacer.ispras.ru
ServerAdmin svacer@ispras.ru
</VirtualHost>
</pre>

В этом конфигурационном файле укажите нужное имя сервера, пути к сертификату (можно использовать fullchain-сертификат) и ключу, а также адрес сервера Svacer, куда проксировать. После этого перезапустите Apache.
systemctl restart apache2

=== Нативно ===
Этот способ позволяет обеспечить безопасную передачу данных как по протоколу HTTPS, так и по протоколу gRPC. Если сервер запускается с поддержкой TLS, то эта опция относится как к протоколу HTTPS, так и к протоколу gRPC.
По умолчанию сервер запускается без поддержки TLS, при этом в логах отображается информация об этом.
TLS for REST and gRPC DISABLED

Для запуска сервера с поддержкой TLS необходимо указать сертификат сервера и соответствующий закрытый ключ.
svacer-server run --ssl-cert svacer.crt --ssl-key svacer.key

При этом ключ должен быть в незашифрованном виде. Права доступа к файлу должны быть 0600. В файле сертификата можно указывать цепочку сертификатов. В этом случае сервер, при подключении клиента, будет возвращать всю цепочку. Первым сертификатом в цепочке всегда должен идти сертификат сервера Svacer. Формат файла — PEM. TLS соединение активируется и для протокола REST и для протокола gRPC.

Работа сервера по проктолу TLS сопровождается следующей записью в логе:
Using TLS for REST and gRPC protocols

Работа с таким сервером через CLI происходит как обычно. Для указания необходимости подключаться по TLS можно явно указать протокол в параметре '''--host''', либо добавить опцию '''--ssl'''.
<pre>
svacer upload --host https://example.com
svacer upload --ssl --host example.com
</pre>
Также в клиенте можно определить параметр '''--ssl-ca-certs'''. Он позволяет задать доверенные сертификаты корневых центров. Указывается шаблон файлов (с *) или конкретный файл. Путь к директории должен быть абсолютным. В случае отсутствия этого параметра используется TLS, но сертификат сервера не проверяется. Этому случаю соответствует запись в логе клиента:
Using weak TLS configuration, because no CA certificate found

Если сертификаты были загружены, в логе будет строчка:
added 1 ca certs from /home/user/svacer/svacer.crt

Для администрирования сервера в плане используемого сертификата (например, замена при истечении срока действия) добавлена область в CLI svacer admin: '''server:config'''. В данной области есть 3 команды: '''show''', '''reload''', '''update'''. ID в этом случае нужно всегда указывать в значение '''ssl.cert'''.

* '''show''' — отображает текущий используемый сертификат

:<pre>svacer admin --ssl --host example.com --user admin --password admin --scope server:config --id ssl.cert --action show</pre>

* '''reload''' — заставляет сервер перечитать использованные при старте сервера файлы с сертификатом и ключом

:<pre>svacer admin --ssl --host example.com --user admin --password admin --scope server:config --id ssl.cert --action reload</pre>

* '''update''' — позволяет переслать на сервер новый сертификат (и ключ, если надо) и записать их в указанные при старте сервера файлы. При использовании этой команды нужно сформировать файл с новым сертификатом и, при необходимости, ключом, в формате PEM (используете '''cat''' для объединения сертификата и ключа в один файл) и указать этот файл в параметре value. Если в файле не будет указан закрытый ключ, то сервером будет использован текущий (тот, что был указан при запуске). Данная команда также изменит файлы сертификата и ключа (если он указан), указанные при старте сервера, на новые значения.

:<pre>svacer admin --ssl --host example.com --user admin --password admin --scope server:config --id ssl.cert --action update --value svacer.pem</pre>

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

В конфигурационном файле Svacer можно указать минимальную и максимальные версии TLS, поддерживаемые сервером. Для этого необходимо в конфигурационном файле указать параметры <code>minVersion</code> и <code>maxVersion</code> в разделе security.tls.

<pre>
security:
tls:
minVersion: tls11
maxVersion: tls12
</pre>

== Интеграция с хранилищем секретов Infisical ==
В Svacer реализована поддержка получения секретов из хранилища секретов [https://infisical.com/ Infisical]. Подробную информацию об интеграции см. в статье [[Infisical|Интеграция с хранилищем секретов Infisical]].

== Механизм интеграции с внешними системами посредством Webhook-ов ==

=== Общий принцип работы ===

Механизм webhook-ов настраивается в конфигурационном файле в секции '''webhook'''. Механизм срабатывает при получении по внутренней шине одного из поддерживаемых событий Svacer. Каждое из внутренних событий преобразуется в событие вызова webhook-а (см. [[Help:Configuration#Модель поддерживаемых событий|Модель поддерживаемых событий]]) и отправляется на обработку в каждую из настроенных целей, которыми являются http-обработчики. Отправкой занимаются работники (их количество настраивается в конфигурационном файле в параметре '''workers_count'''). У каждой цели есть общая очередь, размер которой составляет 500 событий. Если очередь переполняется, будет выдаваться соответствующее сообщение в лог-файле Svacer.

Работники поддерживают протокол https (в том числе самоподписанные сертификаты). Для указания корневого сертификата можно использовать параметр '''ca_certs''' конфигурационного файла. Работникам можно указать таймаут соединения с webhook-сервером (в мс, по умолчанию 1000мс, параметр '''timeout''') и количество попыток отправки (по умолчанию — одна попытка, параметр '''retry_count''').

В настройках можно указать фильтр на отправляемые события (параметр '''filter'''). Фильтр указывается посредством задания выражения. В выражениях используется [https://github.com/expr-lang/expr синтаксис go-expr]. Фильтр возможно указать в количестве одной штуки на одну цель. Если фильтр после вычисления дает значение true, событие будет отправлено в цель.

Также реализован журнал событий отправки webhook-ов, размер которого может быть указан в конфигурационном файле (параметр '''journal_length'''). По умолчанию он равен 86400 записей — по 1 записи на каждую секунду суток. Журнал может быть использован для отладки механизма отправки событий в цель. Содержимое журнала хранится в памяти. При достижении журналом максимального размера, самые старые записи заменяются новыми.

Для настройки аутентификации работника можно использовать параметр '''headers''', который представляет собой список значений вида '''key:value'''. Данные пары будут добавлены в заголовки каждого http-запроса, выполняемого работником.

=== Конфигурация ===

Возможный пример конфигурационного файла, в котором указана отправка на сервер test-host.local событий, связанных с разметкой маркера.

webhook:
enabled: true
journal_length: 86400
targets:
- url: "<nowiki>https://test-host.local:8080/webhook</nowiki>"
workers_count: 1
enabled: true
filter: "Type == EventReviewMarker and Payload.Status != 'Undecided'"
ca_certs: "/etc/ssl/certs/ca.crt"
retry_count: 3
timeout: 1000
headers:
- "password:12345"
- "Authorization: Bearer eyJh .... "

=== CLI ===

Для взаимодействия с механизмом webhook реализованы две cli команды:

svacer server webhook journal
svacer server webhook stat

Первая команда позволяет посмотреть записи журнала отправки событий. Вторая команда позволяет вывести статистику по работе службы (особенно интересными могут быть поля '''sendError''' и '''skip''').

Пример вывода для первой команды (с флагом '''--humanize'''; если флага нет, то вывод будет в формате json):

==================== #1 ======================
Time: 2025-07-01 12:25:52.25343534 +0300 MSK
Created by: admin
Error:
Success: true
SvacerKind: UpdateMarkerReview
EventType: EventReviewMarker
TargetURL: <nowiki>https://swarm-mgr.home:8080/webhook</nowiki>
ProcessTime: 6 ms
==================== #2 ======================
Time: 2025-07-01 12:25:54.202850322 +0300 MSK
Created by: admin
Error:
Success: true
SvacerKind: UpdateMarkerReview
EventType: EventReviewMarker
TargetURL: <nowiki>https://swarm-mgr.home:8080/webhook</nowiki>
ProcessTime: 3 ms

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

{
"enabled": true,
"targets": [
{
"enabled": true,
"url": "<nowiki>https://swarm-mgr.home:8080/webhook</nowiki>",
"filtered": 0,
"sendSuccess": 3,
"sentError": 0,
"submitted": 3,
"skip": 0
}
]
}

==== Модель поддерживаемых событий ====
syntax = "proto3";
import "google/protobuf/any.proto";
option go_package="svacer/proto/webhook";
package webhook;

enum EventType {
EventNone = 0;
EventTest = 1;
EventReviewMarker = 2;
EventPurgeReview = 3;
EventGroupReview = 4;
EventImportSnapshot = 5;
EventCopySnapshot = 6;
EventNewComment = 7;
EventUpdateComment = 8;
EventNewContainer = 9;
EventDeleteContainer = 10;
EventUpdateContainer =11;
EventImportMarkup = 12;
EventDeleteSnapshot = 13;
UpdateSnapshot = 14;
}

message MarkerDetails {
string id = 1;
string file = 2;
string line = 3;
string lang = 4;
}

message Event {
uint64 timestamp = 1;
EventType type = 2;
string created_by = 3;
google.protobuf.Any payload = 4;
}

message PayloadMarkerReview {
string project_id = 1;
string project_name = 2;
string branch_id = 3;
string branch_name = 4;
string snapshot_id = 5;
string snapshot_name = 6;
repeated MarkerDetails markers = 7;
string comment = 8;
string severity = 9;
string action = 10;
string status = 11;
bool group_review = 12;
string created_by_id = 13;
string created_by_login = 14;
}

message PayloadPurgeReview {
string project_id = 1;
string project_name = 2;
string branch_id = 3;
string branch_name = 4;
string created_by_id = 5;
string created_by_login = 6;
}

message PayloadImportSnapshot {
string project_id = 1;
string project_name = 2;
string branch_id = 3;
string branch_name = 4;
string snapshot_id = 5;
string snapshot_name = 6;
}

message PayloadMarkerComment {
string project_id = 1;
string project_name = 2;
string branch_id = 3;
string branch_name = 4;
string snapshot_id = 5;
string snapshot_name = 6;
MarkerDetails marker = 7;
string comment = 8;
string created_by_id = 9;
string created_by_login = 10;
}

message PayloadCopySnapshot {
string project_id = 1;
string project_name = 2;
string branch_id = 3;
string branch_name = 4;
string snapshot_id = 5;
string snapshot_name = 6;
string created_by_id = 7;
string created_by_login = 8;
}

message Container {
string project_id = 1;
string project_name = 2;
string branch_id = 3;
string branch_name = 4;
Container source = 5;
}

message PayloadNewContainer {
repeated Container containers = 1;
}

message PayloadDeleteContainer {
repeated Container projects = 1;
repeated Container branches = 2;
}

message PayloadUpdateContainer {
Container container = 1;
}

message CopyResult {
uint64 total = 1;
uint64 applied_reviews = 2;
uint64 applied_comments = 3;
uint64 skipped_reviews = 4;
uint64 duplicate_reviews = 5;
uint64 duplicate_comments = 6;
}

message PayloadImportMarkup {
Container source=1;
Container target=2;
CopyResult copy_result =3;
}

message Snapshot {
string snapshot_id = 1;
string snapshot_name = 2;
Container container = 3;
}

message PayloadDeleteSnapshots {
repeated Snapshot snapshots = 1;
}

message PayloadUpdateSnapshot {
string snapshot_id = 1;
string snapshot_name = 2;
Container container = 3;
}

== Выбор сетевых интерфейсов и портов сервера ==
* По умолчанию web-сервер запускается на всех сетевых интерфейсах, на порту 8080 ('''0.0.0.0:8080'''). Для указания конкретного сетевого интерфейса можно использовать опцию '''--listen <network interface>''', для указания другого порта: '''--port <port_number>.
* Аналогично для grpc-сервера: по умолчанию — '''0.0.0.0:3002''', для выбора конкретного интерфейса: '''--listen-grpc <network_interface>''', для указания другого порта: '''--grpc <port_number>'''.

svacer-server run --listen 127.0.0.1 --port 9090 --listen-grpc 127.0.0.1 --grpc 3004

При попытке запуска на порту < 1024 от непривилегированного пользователя (например, от пользователя svacer при установке из deb/rpm пакета), сервер Svacer не запустится с ошибкой

ERROR: port 443 is privileged, please check current user permissions or set another rest api port

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

sudo setcap 'cap_net_bind_service=+ep' /usr/bin/svacer-server

== Увеличение лимита открытых файлов ==
Актуально только для Linux.

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

В POSIX таких лимита два:
* soft nofiles — текущее максимальное значение
* hard nofiles — общесистемное максимальное значение

В большинстве систем hard значение достаточно большое, а soft обычно маленькое, что и приводит к проблемам. Пример на Debian 11:

$ ulimit -Sn
1024
$ ulimit -Hn
1048576

Начиная с версии 6-0-0 Svacer пытается автоматически увеличить soft limit до значения hard limit при запуске, а начиная с версии 8-0-0 — проверяет, что увеличить удалось и выводит сообщение с текущим лимитом. Если видите в логах подобную запись — у soft и hard одно, достаточно большое значение — значит все в порядке.

Open files limit (soft and hard): 1048576

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

* Перед запуском Svacer выполнить из консоли команду, увеличив лимит для текущей сессии
ulimit -Sn 16384

* Либо один раз увеличить на уровне системы — в файл '''/etc/security/limits.conf''' добавить

* soft nofile 16384

* Если запускаете Svacer как сервис systemd, добавьте параметр '''LimitNOFILE''' в секцию '''[Service]''' файла описания сервиса.
:В файле из deb/rpm пакета релиза Svacer этот параметр уже добавлен

[Service]
LimitNOFILE=16384

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

sudo systemctl daemon-reload
sudo systemctl restart svacer.service

== Установка пути к директории для кэша ==
Если запускаете Svacer под пользователем без домашней директории, рекомендуется установить путь к директории для кэша через переменную окружения SVACER_CACHE_DIR в файле описания сервиса systemd

[Service]
Environment="SVACER_CACHE_DIR=/path/to/some/dir"

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

sudo systemctl daemon-reload
sudo systemctl restart svacer.service

== Дополнительные параметры при запуске в docker ==
При запуске в докер-контейнере можно указать дополнительные параметры, к примеру добавить конфиг [[Help:CLI#Хуки|хуков]].

Для этого переопределите команду запуска сервера Svacer в docker-compose файле и допишите туда нужные параметры:

command: /svacer/bin/svacer-server run --store /data/store --pg postgres://svace:svace@postgresql:5432/svace --hooks /svacer/hooks.json

Конфигурационный файл с описанием хуков примонтируйте как volume:

volumes:
- ./hooks.json:/svacer/hooks.json

Можете использовать переменные из секции environment docker-compose файла, тогда в строке запуска их надо экранировать с помощью <code>$$</code> и запускать сервер Svacer как shell-команду, чтобы в контейнере подставились значения переменных

environment:
- SVACER_PG_URL=postgres://svace:svace@postgresql:5432/svace
- STORE=/data/store
- HOOKS_FILE=/svacer/hooks.json
volumes:
- ./hooks.json:/svacer/hooks.json
command: sh -c "/svacer/bin/svacer-server run --store $$STORE --pg $$SVACER_PG_URL --hooks $$HOOKS_FILE"

Для более комплексных сценариев можете собрать свой образ с сервером Svacer, использовав наш [[Dockerfile]] как референс.

== Обновление детекторов ==
После установки новой версии Svace требуется обновить описания детекторов в Svacer. Для этого необходимо выполнить команду:

svacer checkers --upload </path/to/svace>

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

== Генерация PDF на основе HTML ==
В релиз 10.х.х включена генерация PDF на основе рендеринга HTML с последующим запуском headless chrome/chromium для генерации PDF. Этот подход позволяет упростить формирование шаблонов для генерации PDF, но требует существенно больше вычислительных ресурсов. Для тюнинга числа параллельных процессов при генерации используется переменная окружения

SVACER_PDF_GEN_LIMITS=<pdf tool limit>:<chrome limit>

Первое значение <code><pdf tool limit></code> определяет число одновременных процессов pdfmerge для сборки отдельных секций в единый PDF документ; второе значение <code><chrome limit></code> определяет одновременное число процессов chrome/chromium для генерации PDF из HTML. Не рекомендуется ставить значения, сильно превышающие число ядер в сервере.

== Полнотекстовый поиск ==
Для поддержки полнотекстового поиска Svacer строит индекс. По умолчанию директория для индекса создается в <code>$HOME/.cache/svacer</code>, для указания иной директории можно использовать переменную окружения <code>SVACER_SEARCH_INDEX_DIR</code>

В ряде случаев (падение и рестарт сервера, ошибки и т. п.) кэш может быть в некорректном состоянии. Для переиндексации данных администратор может использовать CLI команду

svacer search --host <nowiki>http://some_host:port</nowiki> --user <login> --password <pwd> --drop-cache

Используемая при этом учетная запись должна быть с правами на <code>Server administration</code>

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

== Указание public-url ==
В некоторых случаях необходимо явно указывать серверу Svacer его URL-адрес. Например, это нужно для корректной генерации коротких ссылок на предупреждения и ссылок в [[Notifications|уведомлениях]]. Используйте параметр <code>--public-url</code> при запуске сервера
<nowiki>svacer-server run --public-url http://svacer.intra.net:8080</nowiki>

== Расширенные параметры настройки сервера ==

=== Переменные окружения ===
Можно использовать следующие переменные окружения для изменения внутренних параметров сервера:
{| class="wikitable"
|+
!Переменная
!Значение по умолчанию
!Описание
|-
|SVACER_TIMEOUT_IMPORT_RESULTS
|15 минут
|Таймаут ожидания процесса начала импорта на сервере. При превышении запрос на импорт будет отклонен с ошибкой. Формат — Go Duration string: 1h2m3s. Переменная затрагивает только ожидание начала, но не ограничивает сам процесс импорта
|-
|SVACER_NUM_PARALLEL_IMPORTS
|(максимальное число коннектов к БД) / 2
|Число одновременных параллельных импортов. Остальные ждут в очереди. На ожидание влияет переменная SVACER_TIMEOUT_IMPORT_RESULTS
|-
|SVACER_TAIL_LOG_SIZE
|1Мб
|Число. Размер буфера для показа лога сервера в WebUI. Показывается последние SVACER_TAIL_LOG_SIZE байт из лога.
|-
|SVACER_LOG_FORMAT
|<пусто>
|При указании 'json' формат вывода лога заменяется на JSON. Предназначено для интеграции с агрегаторами логов. Также можно указать через флаг при старте: <code>svacer-server --log-format=json</code>
|-
|SVACER_INV_GEN_JOBS
|0.7 * runtime.GOMAXPROCS
|Максимальное число параллельных заданий для генерации инвариантов при миграции старой базы или импорте результатов. При ограниченных ресурсах сервера используйте значение 1 или 2. Нельзя установить значение больше, чем GOMAXPROCS
|}

=== Пересчет инвариантов ===
При миграции со старых версий иногда могут быть проблемы с переносом разметки. Для принудительного пересчета инвариантов запустите сервер с опцией <code>--force-invariant-refresh</code>.

=== Объектное хранилище ===
При больших размерах объектного хранилища (object store) можно запустить сервер с параметром <code>--compact-object-store</code> — это приведет к поиску недостижимых объектов в хранилище и сокращению размера базы. Операция может занять продолжительное время.

'''ЭКСПЕРИМЕНТАЛЬНО''': Для быстрого получения копии текущего объектного хранилища пользователь может использовать CLI команду

svacer server backup --host <nowiki>http://localhost:8080</nowiki> --user admin --password <admin pwd> --checkpoint <path>

Данная команда создаст по пути <path> на '''хосте, где работает сервер''', копию object store. При создании копии по возможности используются hard links, для ускорения процесса. Процесс работает в фоновом режиме, можно запускать его для работающего сервера.

Help:Configuration

2025-11-28T09:17:31Z

Akuzmin: add header

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

=== Настройки аутентификации в Svacer ===
В Svacer возможны четыре способа аутентификации пользователей

# Встроенный
# С помощью LDAP сервера
# Через утилиту oauth_proxy (по протоколу OIDC)
# Посредством Personal Access Token (PAT)

Ниже рассматривается настройка аутентификации посредством внутреннего механизма аутентификации. Для настройки [[LDAP]], [[Help:CLI#Personal Access Token|PAT]] или [[OIDC]] аутентификации см. соответствующие разделы документации.

==== Настройка внутреннего механизма аутентификации Svacer ====

===== Настройка парольной политики внутреннего механизма аутентификации Svacer =====
Настройки параметров встроенного механизма аутентификации возможны посредством секции '''auth.svacer''' конфигурационного файла Svacer. Ниже приведен пример настроек:
<pre class="">auth:
svacer:
password:
min_length: 10
complexity:
- "[a-z]"
- "[A-Z]"
- "[0-9]"
- "[!#]"</pre>
Параметр '''min_length''' задает минимальную возможную длину пароля в системе. Данный критерий используется при смене пароля пользователя и не влияет на текущие пароли пользователей.

Параметр '''complexity''' содержит набор регулярных выражений, задающих требования к паролю с точки зрения наличия в нем определенных символов. При задании такого списка выражений Svacer будет проверять задаваемый пользователем новый пароль на предмет удовлетворения всем этим требованиям. Каждое выражение в списке — полноценное выражение, поддерживаемое языком golang.

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

===== Задание вкладки по умолчанию на странице входа в GUI Svacer (а также отключение внутренного механизма аутентификации Svacer) =====
В случае интеграции Svacer с LDAP, можно указать Svacer какую вкладку — Svacer или LDAP — использовать по умолчанию. Для этого используется параметр '''auth.svacer.default'''. Если данный параметр установлен в значение '''true''', то вкладкой по умолчанию будет вкладка Svacer, иначе — вкладка LDAP.

Также возможно полностью отключить механизм внутренней аутентификации Svacer с помощью параметра '''auth.svacer.enabled'''.

Ниже приведен пример конфигурационного файла Svacer для задания вкладки LDAP по умолчанию (в случае наличие интеграции с LDAP сервером)<pre class="plaintext">auth:
svacer:
enabled: true
default: false</pre>

==== Настройка защиты от перебора паролей пользователей ====
Для случаев аутентификации с помощью LDAP сервера и с помощью встроенного механизма аутентификации реализован механизм блокировки учетных записей пользователей в том случае, если количество неудачных попыток входа превышает заданное в настройках число. По умолчанию защита отключена. Ниже приведен пример секции конфигурационного файла Svacer, задающего правила блокировки:

<pre class="plaintext">security:
login:
max_attempts: 5
lock_time: 2m</pre>

Время, на которое происходит блокировка учетной записи пользователя, указывается в формате golang/time: 1s,1m,60m и т. д.

В случае активации защиты данный механизм также защищает аутентификацию посредством вызовов соответствующих точек входа public API.

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

Для принудительной разблокировки пользователей можно использовать команды cli (требуются права управления сервером):

<pre class="">svacer user-provider unlock --user admin --password admin --login locked_user</pre>

=== Настройка TLS ===
Svacer может быть сконфигурирован для поддержки TLS несколькими способами. Первый способ — использовать reverse proxy с поддержкой HTTPS и проксированием в Svacer по HTTP, второй — запуск Svacer с нативной поддержкой TLS.

==== Reverse proxy ====
Данный способ позволяет обеспечить безопасную передачу данных только по протоколу HTTPS, данные по протоколу gRPC передаются в незащищенном виде.

===== Nginx =====
Создайте конфигурационный файл с подобным содержанием в '''/etc/nginx/sites-enabled/'''
<pre>
server {
listen 443 ssl;
listen [::]:443 ssl;

server_name svacer.ispras.ru;

# for large data transfers and continuous connections
client_max_body_size 0;
proxy_connect_timeout 600;
proxy_send_timeout 600;
proxy_read_timeout 600;
send_timeout 600;

# path to ssl-certificate and key
ssl_certificate /etc/ssl/certs/svacer.ispras.ru.crt;
ssl_certificate_key /etc/ssl/private/svacer.ispras.ru.key;

location / {
include proxy_params;

# to make WebSockets work
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";

# svacer HTTP URL
proxy_pass http://127.0.0.1:8080;
}
}

# proxy gRPC port if required
server {
listen 13002 http2;
underscores_in_headers on;

location / {
grpc_pass grpc://127.0.0.1:3002;
}
}
</pre>

В этом конфигурационном файле укажите нужное имя сервера, пути к сертификату (можно использовать fullchain-сертификат) и ключу, а также адрес сервера Svacer, куда проксировать. После этого перезапустите Nginx.
systemctl restart nginx

Если ваш сервер виден из интернета и его внешний IP-адрес привязан к доменному имени, можете использовать Let's Encrypt и Certbot для получения валидного SSL-сертификата. См. [https://www.nginx.com/blog/using-free-ssltls-certificates-from-lets-encrypt-with-nginx/ эту инструкцию].

===== Apache =====
Включите нужные модули в Apache
sudo a2enmod ssl proxy proxy_http rewrite

Создайте конфигурационный файл с подобным содержанием в '''/etc/apache2/sites-enabled/'''
<pre>
<VirtualHost *:443>
SSLEngine On
ProxyPreserveHost On
ProxyTimeout 600

# path to ssl-certificate and key
SSLCertificateFile /etc/ssl/certs/svacer.ispras.ru.crt
SSLCertificateKeyFile /etc/ssl/private/svacer.ispras.ru.key

# svacer HTTP URL
ProxyPass / http://127.0.0.1:8080/
ProxyPassReverse / http://127.0.0.1:8080/

# to make WebSockets work
ProxyPass /api/ws/ ws://127.0.0.1:8080/api/ws/
ProxyPassReverse /api/ws/ ws://127.0.0.1:8080/api/ws/
RewriteEngine on
RewriteCond %{HTTP:UPGRADE} ^WebSocket$ [NC]
RewriteCond %{HTTP:CONNECTION} ^Upgrade$ [NC]
RewriteRule /api/ws/(.*) ws://127.0.0.1:8080%{REQUEST_URI} [P]

ServerName svacer.ispras.ru
ServerAdmin svacer@ispras.ru
</VirtualHost>
</pre>

В этом конфигурационном файле укажите нужное имя сервера, пути к сертификату (можно использовать fullchain-сертификат) и ключу, а также адрес сервера Svacer, куда проксировать. После этого перезапустите Apache.
systemctl restart apache2

==== Нативно ====
Этот способ позволяет обеспечить безопасную передачу данных как по протоколу HTTPS, так и по протоколу gRPC. Если сервер запускается с поддержкой TLS, то эта опция относится как к протоколу HTTPS, так и к протоколу gRPC.
По умолчанию сервер запускается без поддержки TLS, при этом в логах отображается информация об этом.
TLS for REST and gRPC DISABLED

Для запуска сервера с поддержкой TLS необходимо указать сертификат сервера и соответствующий закрытый ключ.
svacer-server run --ssl-cert svacer.crt --ssl-key svacer.key

При этом ключ должен быть в незашифрованном виде. Права доступа к файлу должны быть 0600. В файле сертификата можно указывать цепочку сертификатов. В этом случае сервер, при подключении клиента, будет возвращать всю цепочку. Первым сертификатом в цепочке всегда должен идти сертификат сервера Svacer. Формат файла — PEM. TLS соединение активируется и для протокола REST и для протокола gRPC.

Работа сервера по проктолу TLS сопровождается следующей записью в логе:
Using TLS for REST and gRPC protocols

Работа с таким сервером через CLI происходит как обычно. Для указания необходимости подключаться по TLS можно явно указать протокол в параметре '''--host''', либо добавить опцию '''--ssl'''.
<pre>
svacer upload --host https://example.com
svacer upload --ssl --host example.com
</pre>
Также в клиенте можно определить параметр '''--ssl-ca-certs'''. Он позволяет задать доверенные сертификаты корневых центров. Указывается шаблон файлов (с *) или конкретный файл. Путь к директории должен быть абсолютным. В случае отсутствия этого параметра используется TLS, но сертификат сервера не проверяется. Этому случаю соответствует запись в логе клиента:
Using weak TLS configuration, because no CA certificate found

Если сертификаты были загружены, в логе будет строчка:
added 1 ca certs from /home/user/svacer/svacer.crt

Для администрирования сервера в плане используемого сертификата (например, замена при истечении срока действия) добавлена область в CLI svacer admin: '''server:config'''. В данной области есть 3 команды: '''show''', '''reload''', '''update'''. ID в этом случае нужно всегда указывать в значение '''ssl.cert'''.

* '''show''' — отображает текущий используемый сертификат

:<pre>svacer admin --ssl --host example.com --user admin --password admin --scope server:config --id ssl.cert --action show</pre>

* '''reload''' — заставляет сервер перечитать использованные при старте сервера файлы с сертификатом и ключом

:<pre>svacer admin --ssl --host example.com --user admin --password admin --scope server:config --id ssl.cert --action reload</pre>

* '''update''' — позволяет переслать на сервер новый сертификат (и ключ, если надо) и записать их в указанные при старте сервера файлы. При использовании этой команды нужно сформировать файл с новым сертификатом и, при необходимости, ключом, в формате PEM (используете '''cat''' для объединения сертификата и ключа в один файл) и указать этот файл в параметре value. Если в файле не будет указан закрытый ключ, то сервером будет использован текущий (тот, что был указан при запуске). Данная команда также изменит файлы сертификата и ключа (если он указан), указанные при старте сервера, на новые значения.

:<pre>svacer admin --ssl --host example.com --user admin --password admin --scope server:config --id ssl.cert --action update --value svacer.pem</pre>

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

В конфигурационном файле Svacer можно указать минимальную и максимальные версии TLS, поддерживаемые сервером. Для этого необходимо в конфигурационном файле указать параметры <code>minVersion</code> и <code>maxVersion</code> в разделе security.tls.

<pre>
security:
tls:
minVersion: tls11
maxVersion: tls12
</pre>

=== Интеграция с хранилищем секретов Infisical ===
В Svacer реализована поддержка получения секретов из хранилища секретов [https://infisical.com/ Infisical]. Подробную информацию об интеграции см. в статье [[Infisical|Интеграция с хранилищем секретов Infisical]].

=== Механизм интеграции с внешними системами посредством Webhook-ов ===

==== Общий принцип работы ====

Механизм webhook-ов настраивается в конфигурационном файле в секции '''webhook'''. Механизм срабатывает при получении по внутренней шине одного из поддерживаемых событий Svacer. Каждое из внутренних событий преобразуется в событие вызова webhook-а (см. [[Help:Configuration#Модель поддерживаемых событий|Модель поддерживаемых событий]]) и отправляется на обработку в каждую из настроенных целей, которыми являются http-обработчики. Отправкой занимаются работники (их количество настраивается в конфигурационном файле в параметре '''workers_count'''). У каждой цели есть общая очередь, размер которой составляет 500 событий. Если очередь переполняется, будет выдаваться соответствующее сообщение в лог-файле Svacer.

Работники поддерживают протокол https (в том числе самоподписанные сертификаты). Для указания корневого сертификата можно использовать параметр '''ca_certs''' конфигурационного файла. Работникам можно указать таймаут соединения с webhook-сервером (в мс, по умолчанию 1000мс, параметр '''timeout''') и количество попыток отправки (по умолчанию — одна попытка, параметр '''retry_count''').

В настройках можно указать фильтр на отправляемые события (параметр '''filter'''). Фильтр указывается посредством задания выражения. В выражениях используется [https://github.com/expr-lang/expr синтаксис go-expr]. Фильтр возможно указать в количестве одной штуки на одну цель. Если фильтр после вычисления дает значение true, событие будет отправлено в цель.

Также реализован журнал событий отправки webhook-ов, размер которого может быть указан в конфигурационном файле (параметр '''journal_length'''). По умолчанию он равен 86400 записей — по 1 записи на каждую секунду суток. Журнал может быть использован для отладки механизма отправки событий в цель. Содержимое журнала хранится в памяти. При достижении журналом максимального размера, самые старые записи заменяются новыми.

Для настройки аутентификации работника можно использовать параметр '''headers''', который представляет собой список значений вида '''key:value'''. Данные пары будут добавлены в заголовки каждого http-запроса, выполняемого работником.

==== Конфигурация ====

Возможный пример конфигурационного файла, в котором указана отправка на сервер test-host.local событий, связанных с разметкой маркера.

webhook:
enabled: true
journal_length: 86400
targets:
- url: "<nowiki>https://test-host.local:8080/webhook</nowiki>"
workers_count: 1
enabled: true
filter: "Type == EventReviewMarker and Payload.Status != 'Undecided'"
ca_certs: "/etc/ssl/certs/ca.crt"
retry_count: 3
timeout: 1000
headers:
- "password:12345"
- "Authorization: Bearer eyJh .... "

==== CLI ====

Для взаимодействия с механизмом webhook реализованы две cli команды:

svacer server webhook journal
svacer server webhook stat

Первая команда позволяет посмотреть записи журнала отправки событий. Вторая команда позволяет вывести статистику по работе службы (особенно интересными могут быть поля '''sendError''' и '''skip''').

Пример вывода для первой команды (с флагом '''--humanize'''; если флага нет, то вывод будет в формате json):

==================== #1 ======================
Time: 2025-07-01 12:25:52.25343534 +0300 MSK
Created by: admin
Error:
Success: true
SvacerKind: UpdateMarkerReview
EventType: EventReviewMarker
TargetURL: <nowiki>https://swarm-mgr.home:8080/webhook</nowiki>
ProcessTime: 6 ms
==================== #2 ======================
Time: 2025-07-01 12:25:54.202850322 +0300 MSK
Created by: admin
Error:
Success: true
SvacerKind: UpdateMarkerReview
EventType: EventReviewMarker
TargetURL: <nowiki>https://swarm-mgr.home:8080/webhook</nowiki>
ProcessTime: 3 ms

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

{
"enabled": true,
"targets": [
{
"enabled": true,
"url": "<nowiki>https://swarm-mgr.home:8080/webhook</nowiki>",
"filtered": 0,
"sendSuccess": 3,
"sentError": 0,
"submitted": 3,
"skip": 0
}
]
}

==== Модель поддерживаемых событий ====
syntax = "proto3";
import "google/protobuf/any.proto";
option go_package="svacer/proto/webhook";
package webhook;

enum EventType {
EventNone = 0;
EventTest = 1;
EventReviewMarker = 2;
EventPurgeReview = 3;
EventGroupReview = 4;
EventImportSnapshot = 5;
EventCopySnapshot = 6;
EventNewComment = 7;
EventUpdateComment = 8;
EventNewContainer = 9;
EventDeleteContainer = 10;
EventUpdateContainer =11;
EventImportMarkup = 12;
EventDeleteSnapshot = 13;
UpdateSnapshot = 14;
}

message MarkerDetails {
string id = 1;
string file = 2;
string line = 3;
string lang = 4;
}

message Event {
uint64 timestamp = 1;
EventType type = 2;
string created_by = 3;
google.protobuf.Any payload = 4;
}

message PayloadMarkerReview {
string project_id = 1;
string project_name = 2;
string branch_id = 3;
string branch_name = 4;
string snapshot_id = 5;
string snapshot_name = 6;
repeated MarkerDetails markers = 7;
string comment = 8;
string severity = 9;
string action = 10;
string status = 11;
bool group_review = 12;
string created_by_id = 13;
string created_by_login = 14;
}

message PayloadPurgeReview {
string project_id = 1;
string project_name = 2;
string branch_id = 3;
string branch_name = 4;
string created_by_id = 5;
string created_by_login = 6;
}

message PayloadImportSnapshot {
string project_id = 1;
string project_name = 2;
string branch_id = 3;
string branch_name = 4;
string snapshot_id = 5;
string snapshot_name = 6;
}

message PayloadMarkerComment {
string project_id = 1;
string project_name = 2;
string branch_id = 3;
string branch_name = 4;
string snapshot_id = 5;
string snapshot_name = 6;
MarkerDetails marker = 7;
string comment = 8;
string created_by_id = 9;
string created_by_login = 10;
}

message PayloadCopySnapshot {
string project_id = 1;
string project_name = 2;
string branch_id = 3;
string branch_name = 4;
string snapshot_id = 5;
string snapshot_name = 6;
string created_by_id = 7;
string created_by_login = 8;
}

message Container {
string project_id = 1;
string project_name = 2;
string branch_id = 3;
string branch_name = 4;
Container source = 5;
}

message PayloadNewContainer {
repeated Container containers = 1;
}

message PayloadDeleteContainer {
repeated Container projects = 1;
repeated Container branches = 2;
}

message PayloadUpdateContainer {
Container container = 1;
}

message CopyResult {
uint64 total = 1;
uint64 applied_reviews = 2;
uint64 applied_comments = 3;
uint64 skipped_reviews = 4;
uint64 duplicate_reviews = 5;
uint64 duplicate_comments = 6;
}

message PayloadImportMarkup {
Container source=1;
Container target=2;
CopyResult copy_result =3;
}

message Snapshot {
string snapshot_id = 1;
string snapshot_name = 2;
Container container = 3;
}

message PayloadDeleteSnapshots {
repeated Snapshot snapshots = 1;
}

message PayloadUpdateSnapshot {
string snapshot_id = 1;
string snapshot_name = 2;
Container container = 3;
}

=== Выбор сетевых интерфейсов и портов сервера ===
* По умолчанию web-сервер запускается на всех сетевых интерфейсах, на порту 8080 ('''0.0.0.0:8080'''). Для указания конкретного сетевого интерфейса можно использовать опцию '''--listen <network interface>''', для указания другого порта: '''--port <port_number>.
* Аналогично для grpc-сервера: по умолчанию — '''0.0.0.0:3002''', для выбора конкретного интерфейса: '''--listen-grpc <network_interface>''', для указания другого порта: '''--grpc <port_number>'''.

svacer-server run --listen 127.0.0.1 --port 9090 --listen-grpc 127.0.0.1 --grpc 3004

При попытке запуска на порту < 1024 от непривилегированного пользователя (например, от пользователя svacer при установке из deb/rpm пакета), сервер Svacer не запустится с ошибкой

ERROR: port 443 is privileged, please check current user permissions or set another rest api port

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

sudo setcap 'cap_net_bind_service=+ep' /usr/bin/svacer-server

=== Увеличение лимита открытых файлов ===
Актуально только для Linux.

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

В POSIX таких лимита два:
* soft nofiles — текущее максимальное значение
* hard nofiles — общесистемное максимальное значение

В большинстве систем hard значение достаточно большое, а soft обычно маленькое, что и приводит к проблемам. Пример на Debian 11:

$ ulimit -Sn
1024
$ ulimit -Hn
1048576

Начиная с версии 6-0-0 Svacer пытается автоматически увеличить soft limit до значения hard limit при запуске, а начиная с версии 8-0-0 — проверяет, что увеличить удалось и выводит сообщение с текущим лимитом. Если видите в логах подобную запись — у soft и hard одно, достаточно большое значение — значит все в порядке.

Open files limit (soft and hard): 1048576

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

* Перед запуском Svacer выполнить из консоли команду, увеличив лимит для текущей сессии
ulimit -Sn 16384

* Либо один раз увеличить на уровне системы — в файл '''/etc/security/limits.conf''' добавить

* soft nofile 16384

* Если запускаете Svacer как сервис systemd, добавьте параметр '''LimitNOFILE''' в секцию '''[Service]''' файла описания сервиса.
:В файле из deb/rpm пакета релиза Svacer этот параметр уже добавлен

[Service]
LimitNOFILE=16384

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

sudo systemctl daemon-reload
sudo systemctl restart svacer.service

=== Установка пути к директории для кэша ===
Если запускаете Svacer под пользователем без домашней директории, рекомендуется установить путь к директории для кэша через переменную окружения SVACER_CACHE_DIR в файле описания сервиса systemd

[Service]
Environment="SVACER_CACHE_DIR=/path/to/some/dir"

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

sudo systemctl daemon-reload
sudo systemctl restart svacer.service

=== Дополнительные параметры при запуске в docker-контейнере ===
При запуске в докер-контейнере можно указать дополнительные параметры, к примеру добавить конфиг [[Help:CLI#Хуки|хуков]].

Для этого переопределите команду запуска сервера Svacer в docker-compose файле и допишите туда нужные параметры:

command: /svacer/bin/svacer-server run --store /data/store --pg postgres://svace:svace@postgresql:5432/svace --hooks /svacer/hooks.json

Конфигурационный файл с описанием хуков примонтируйте как volume:

volumes:
- ./hooks.json:/svacer/hooks.json

Можете использовать переменные из секции environment docker-compose файла, тогда в строке запуска их надо экранировать с помощью <code>$$</code> и запускать сервер Svacer как shell-команду, чтобы в контейнере подставились значения переменных

environment:
- SVACER_PG_URL=postgres://svace:svace@postgresql:5432/svace
- STORE=/data/store
- HOOKS_FILE=/svacer/hooks.json
volumes:
- ./hooks.json:/svacer/hooks.json
command: sh -c "/svacer/bin/svacer-server run --store $$STORE --pg $$SVACER_PG_URL --hooks $$HOOKS_FILE"

Для более комплексных сценариев можете собрать свой образ с сервером Svacer, использовав наш [[Dockerfile]] как референс.

== Обновление детекторов ==
После установки новой версии Svace требуется обновить описания детекторов в Svacer. Для этого необходимо выполнить команду:

svacer checkers --upload </path/to/svace>

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

== Генерация PDF на основе HTML ==
В релиз 10.х.х включена генерация PDF на основе рендеринга HTML с последующим запуском headless chrome/chromium для генерации PDF. Этот подход позволяет упростить формирование шаблонов для генерации PDF, но требует существенно больше вычислительных ресурсов. Для тюнинга числа параллельных процессов при генерации используется переменная окружения

SVACER_PDF_GEN_LIMITS=<pdf tool limit>:<chrome limit>

Первое значение <code><pdf tool limit></code> определяет число одновременных процессов pdfmerge для сборки отдельных секций в единый PDF документ; второе значение <code><chrome limit></code> определяет одновременное число процессов chrome/chromium для генерации PDF из HTML. Не рекомендуется ставить значения, сильно превышающие число ядер в сервере.

== Полнотекстовый поиск ==
Для поддержки полнотекстового поиска Svacer строит индекс. По умолчанию директория для индекса создается в <code>$HOME/.cache/svacer</code>, для указания иной директории можно использовать переменную окружения <code>SVACER_SEARCH_INDEX_DIR</code>

В ряде случаев (падение и рестарт сервера, ошибки и т. п.) кэш может быть в некорректном состоянии. Для переиндексации данных администратор может использовать CLI команду

svacer search --host <nowiki>http://some_host:port</nowiki> --user <login> --password <pwd> --drop-cache

Используемая при этом учетная запись должна быть с правами на <code>Server administration</code>

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

== Указание public-url ==
В некоторых случаях необходимо явно указывать серверу Svacer его URL-адрес. Например, это нужно для корректной генерации коротких ссылок на предупреждения и ссылок в [[Notifications|уведомлениях]]. Используйте параметр <code>--public-url</code> при запуске сервера
<nowiki>svacer-server run --public-url http://svacer.intra.net:8080</nowiki>

== Расширенные параметры настройки сервера ==

=== Переменные окружения ===
Можно использовать следующие переменные окружения для изменения внутренних параметров сервера:
{| class="wikitable"
|+
!Переменная
!Значение по умолчанию
!Описание
|-
|SVACER_TIMEOUT_IMPORT_RESULTS
|15 минут
|Таймаут ожидания процесса начала импорта на сервере. При превышении запрос на импорт будет отклонен с ошибкой. Формат — Go Duration string: 1h2m3s. Переменная затрагивает только ожидание начала, но не ограничивает сам процесс импорта
|-
|SVACER_NUM_PARALLEL_IMPORTS
|(максимальное число коннектов к БД) / 2
|Число одновременных параллельных импортов. Остальные ждут в очереди. На ожидание влияет переменная SVACER_TIMEOUT_IMPORT_RESULTS
|-
|SVACER_TAIL_LOG_SIZE
|1Мб
|Число. Размер буфера для показа лога сервера в WebUI. Показывается последние SVACER_TAIL_LOG_SIZE байт из лога.
|-
|SVACER_LOG_FORMAT
|<пусто>
|При указании 'json' формат вывода лога заменяется на JSON. Предназначено для интеграции с агрегаторами логов. Также можно указать через флаг при старте: <code>svacer-server --log-format=json</code>
|-
|SVACER_INV_GEN_JOBS
|0.7 * runtime.GOMAXPROCS
|Максимальное число параллельных заданий для генерации инвариантов при миграции старой базы или импорте результатов. При ограниченных ресурсах сервера используйте значение 1 или 2. Нельзя установить значение больше, чем GOMAXPROCS
|}

=== Пересчет инвариантов ===
При миграции со старых версий иногда могут быть проблемы с переносом разметки. Для принудительного пересчета инвариантов запустите сервер с опцией <code>--force-invariant-refresh</code>.

=== Объектное хранилище ===
При больших размерах объектного хранилища (object store) можно запустить сервер с параметром <code>--compact-object-store</code> — это приведет к поиску недостижимых объектов в хранилище и сокращению размера базы. Операция может занять продолжительное время.

'''ЭКСПЕРИМЕНТАЛЬНО''': Для быстрого получения копии текущего объектного хранилища пользователь может использовать CLI команду

svacer server backup --host <nowiki>http://localhost:8080</nowiki> --user admin --password <admin pwd> --checkpoint <path>

Данная команда создаст по пути <path> на '''хосте, где работает сервер''', копию object store. При создании копии по возможности используются hard links, для ускорения процесса. Процесс работает в фоновом режиме, можно запускать его для работающего сервера.