Skip to content

Формат шаблона отчетов

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

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

Вы можете включить в отчет:

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

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

Кроме того, вы можете использовать Markdown поля уязвимостей в своих шаблонах отчетов.

Фильтры отчета

С помощью фильтров вы можете создать собственный вывод данных в отчете.

Общие правила фильтрации:

  • Фильтр без параметров: {myExpression | filter}
  • Фильтр с одним параметром: {myExpression | filter:"argument1"}
  • Фильтр с несколькими параметрами: {myExpression | filter:variable:variable2}

Список доступных фильтров

lower

Конвертирует строку в нижний регистр.

{issue.name|lower}

upper

Конвертирует строку в верхний регистр.

{issue.name | upper}

length

Определяет длину коллекции (списка или строки).

{issues | length}
{issues | where:'totalScore >= 2' | length}

prop

Возвращает произвольное свойство объекта.

{issues | prop:'length'}

where

Фильтрует список элементов.

  • Общий показатель риска больше или равен двум (например, 2 - средний или 3 - высокий уровень риска):
{#issues | where:'totalScore >= 2'} {name} {/}
  • Общий показатель риска равен одному (где, 1 - низкий уровень риска):
{#issues | where:'totalScore === 1'} {name} {/}
  • Вероятность меньше трех (например, 1 - низкий или 2 - средний уровень вероятности):
{#issues | where:'probabilityScore < 3'} {name} {/}
  • Общий показатель риска равен трем, и критичность больше или равна двум (возможные значения: && И || ИЛИ):
{#issues | where:'totalScore === 3 && criticalityScore >= 2'} {name} {/}
  • Фильтр по любому настраиваемому полю с числовым значением:
{#issues | where:'myCustomFieldEstimatedLosses > 9000'} {name} {/}

find

Поиск по элементам.

{(issues | find:'id === 42').name}

sortBy, sortByAsc

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

{#issues | sortBy:'totalScore'} {name} {/}
{#issues | sortBy:'totalScore':'name'} {name} {/}

sortByDesc

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

{#issues | sortByDesc:'totalScore'} {name} {/}
{#issues | sortByDesc:'totalScore':'name'} {name} {/}

sumBy

Сумма значения поля объектов из списка.

{issues | sumBy:'myCustomFieldBusinessExpenses'}

toFixed

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

{myNumber | toFixed:2}

json

Выводит значение переменной в json, полезно для отладки при написании шаблона. Рекомендуется использовать с переменной this: отобразит текущую область видимости и все доступные переменные.

{myVariable | json}
{this | json}

displayValue

Отображение значения полей с перечислениями (например score, select, radio). Вызывается с системным значением поля (например 1 для score). Принимает описание поля из справочника presetFieldsMap.

Пример для поля Score:

{#issues}
{totalScore | displayValue:presetFieldsMap.totalScore}
{/issues}

Пример для кастомных полей:

  • одиночный select или радио кнопки:
{#issues}
{myCustomField | displayValue:presetFieldsMap.myCustomField} 
{/issues}
  • множественный select:
{#issues}
{#myCustomListField}
{this | displayValue:presetFieldsMap.myCustomListField}
{/myCustomListField}
{/issues}

Стили полей Markdown

Важно! Не меняйте идентификаторы (ID) и названия стилей в шаблонах template.docx и universal-template.docx. В настоящее время генератор отчетов поддерживает только предустановленные названия стилей.

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

Данные стили применяются только для Markdown полей (General description, Risk description, Technical description и Recommendations).

ID стиля Имя стиля Применение Комментарий
H1 H1 Параграф Заголовок уровень 1
H2 H2 Параграф Заголовок уровень 2
H3 H3 Параграф Заголовок уровень 3
H4 H4 Параграф Заголовок уровень 4
H5 H5 Параграф Заголовок уровень 5
BodyExpRep Body (Exp_Rep) Параграф все стандартные параметры body
BodyExpRepChar Body (Exp_Rep) Char Символ символы внутри стандартного параметра body
Code Code Параграф блочные строки кода
CodeChar Code Char Символ строка кода
InternetLink Internet Link Символ ссылки на внешние ресурсы
Emphasis Emphasis Символ курсив (Italic)
StrongChar Strong Char Символ жирное выделение (Bold)
PictureCaption Picture Caption Параграф название рисунков и таблиц
Table style 1 Table style 1 Таблица стиль таблиц

Стили для значений риска

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

ID стиля Имя стиля Применение Комментарий
vulnrate vulnrate Параграф абзац для уровня риска уязвимости
styleRatingLow styleRatingLow Символ символ для низкого уровня риска уязвимости (зеленый)
styleRatingMedium styleRatingMedium Символ символ для среднего уровня риска уязвимости (желтый)
styleRatingHigh styleRatingHigh Символ символ для высокого уровня риска уязвимости (красный)