Requality: глоссарий

M

Markup Editor

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

Module Editor

– окно в перспективе Requality, визуальный редактор для представления требований и текстовых узлов в виде, близком к печатному документу. Предназначен для разработки документации путем создания требований. В отличие от редакторов 'UniEditor' и 'Review', в данном редакторе узлы отображаются без отступов, что позволяет более компактно отображать каталог требований, но не позволяет напрямую определить иерархию требований. Для анализа иерархии требований в данном представлении рекомендуется использовать дерево требований в окне 'Requality Explorer'.

N

nameorid

– параметр, использующийся для обозначения идентификатора или имени некоторого узла дерева требований. Если у узла есть имя, то 'nameorid' — это имя узла, в противном случае 'nameorid' - это его идентификатор. Может использоваться, например, как параметр в описаниях требований. В этом случае его нужно записывать с символом подчеркивания в начале: '_nameorid'.

O

Outline

– окно в перспективе Requality, отображающее список фрагментов документа.

P

Properties

– окно в перспективе Requality, отображает свойства выбранного объекта (требования, документа, тестовой ситуации, отчета, комментария).

R

REFERENCE-тип атрибута

– cпециальный тип атрибутов узла дерева требований, позволяющий связывать узел, для которого он указан, с другим узлом из того же каталога проекта Requality. Этот атрибут находится в окне 'Properties' на вкладке 'Main' в таблице 'Attributes'. Это обычный атрибут, у которого указан тип 'REFERENCE', а в качестве значения указан целевой узел, на который идет ссылка.

Имя этого атрибута является именем ссылки.

Связанность узлов можно посмотреть в представлении 'Requality Links Explorer'. Ссылки в этом представлении доступны в обе стороны, как у узла, в котором была создана такая ссылка:

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

Requality Explorer

– окно в перспективе Requality, отображающее все содержимое проекта Requality (документы, требования, отчеты, комментарии).

Requality Links Explorer

– окно в перспективе Requality, в котором отображаются узлы каталога проекта Requality, связанные с выбранным узлом связью-ссылкой, указанной в атрибуте типа 'REFERENCE'. В этом окне можно просматривать вместе и по отдельности как исходящие, так и входящие ссылки, сортировать их отображение по именам и включать подсветку связанных ссылкой узлов в окне 'Requality Explorer'.

Review

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

U

UniEditor

– окно в перспективе Requality, визуальный редактор для требований, тестовых ситуаций, текстовых узлов и комментариев. Позволяет добавлять, редактировать и изменять требования, тестовые ситуации и комментарии, а также изменять статусы требований и тестовых ситуаций. В отличие от редактора 'Review' не дает возможности устанавливать статусы требований и тестовых ситуаций в значение 'verified'.

Update Processor Tasks

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

• 'Verify' – если все фрагменты требования были перенесены, требуется проверить корректность переноса.
• 'Add Locations' – если была перенесена часть фрагментов требований, предлагается найти в новом документе аналоги не найденных фрагментов требований, которые не были перенесены, или убедиться, что в новой версии их нет.
• 'Find Locations' – не было перенесено ни одного фрагмента требования. Предлагается найти их аналоги в новой версии или убедиться, что данного требования больше нет в новой версии спецификации.

UUId

- уникальный и неизменный внутрисистемный (в рамках Requality) идентификатор любого узла проекта Requality. Представляет собой 128-битный номер. При изменении идентификатора 'Id' узла его 'UUId' не меняется, хотя нужно иметь в виду, что Requality понимает такую операцию как удаление старого узла (со старым идентификатором 'Id') и появление нового (с новым идентификатором 'Id').

UserVisibleId, UVId

- cпециальное обозначение узла для его идентификации.

• Если у рассматриваемого узла нет имени, то 'UVId' определяется как 'UVId узла-родителя'/'идентификатор узла'.
• Если имя есть и есть атрибут 'ignoreName' (см. Таблица атрибутов) со значением 'true', то 'UVId' определяется как 'UVId узла-родителя'/'имя узла'.
• Если имя есть и атрибут 'ignoreName' отсутствует или имеет значением 'false', то 'UVId' определяется как 'имя узла'.

А

Автогенерируемый идентификатор узла (SeqID)

– это уникальный в рамках проекта идентификатор узла дерева требований. Является атрибутом узла дерева требований (требования, текстового узла, комментария и т.д.) и представляет собой число. В некоторых случаях это число может иметь определяемый пользователем префикс, но по умолчанию его нет. Имя атрибута, содержащего 'SeqID', может быть задано пользователем, по умолчанию это 'ForeignID'. Уникальность идентификатора заключается в том, что в проекте на протяжении всего его жизненного цикла только один узел дерева требований может иметь такой идентификатор, и, даже если данный узел будет удален, пока механизм включен никакой другой узел не получит такой же идентификатор. Чтобы механизм поддержки автогенерируемых идентификаторов в проекте Requality работал и их уникальность отслеживалась, он должен быть включен в настройках проекта (по умолчанию при создании нового проекта механизм не включен). В противном случае такие атрибуты считаются обычными рядовыми атрибутами узла, и уникальность их значений не соблюдается. При включении механизма автогенерируемых идентификаторов все узлы дерева требований, которые уже были в проекте, получают атрибут с указанным именем и уникальным значением. Если у каких-то узлов атрибут с таким именем уже был, он учитывается как 'SeqID', и его значение будет зарезервировано за данным узлом. Все новые узлы будут получать данный атрибут с автоматически задаваемым значением. После отключения механизма автогенерируемых идентификаторов, все эти атрибуты будут удалены.

Активный шаблон узла (активный шаблон)

- 'шаблон узла', который выбран в качестве активного для данного типа узлов. Если шаблон выбран в качестве активного, то при создании новых узлов данного типа все узлы будут создаваться по этому шаблону по умолчанию. Изначально для всех узлов проекта выбран пустой шаблон, где все параметры заданы по умолчанию. (Cм. Редактор шаблонов.) Для одного типа узлов активный шаблон может быть только один. Активный шаблон выделяется жирным шрифтом в списке шаблонов в окне редактора шаблонов.

В

Виртуальный узел (Virtual Node)

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

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

• 'Reuse' — копии целевого узла будут добавлены к виртуальному узлу как потомки со всем своим поддеревом.
• 'Base element'- копии прямых потомков целевого элемента будут добавлены к виртуальному узлу как потомки со всем своим поддеревом.

Для метода итерации 'Reuse' также доступны настройки 'It.vars', связанные с определением количества копий. Эта настройка позволяет использовать списочные переменные для создания нескольких клонов одного узла с разными значениями переменной.

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

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

Г

Генератор значений атрибута

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

У всех типов узлов проекта Requality (кроме папок и документов) в окне 'Properties' во вкладке 'Main' находится таблица атрибутов (см. Таблица атрибутов). В этой таблице крайний справа столбец называется 'Generator'. При клике в ячейку этого столбца открывается окно генератора значений атрибута - 'Attribute value generator'.

Окно Attribute value generator содержит следующие параметры:

• Origin – элемент дерева требований, в котором задан генератор. Не может быть отредактировано вручную. Как правило, здесь указан тот узел, для атрибута которого был открыт генератор. Но в случае, если атрибут был унаследован, в этом поле будет указан узел, от которого произошло наследование.
• Attr.gen.type – способ генерации атрибута. Доступны три способа генерации атрибута: 'RANDOM', 'BY_FORMULA', 'CYCLE'.
  • RANDOM - генерация случайным образом. При выборе этого способа появляются поля 'Min' (минимальное значение выборки), 'Max' (максимальное значение выборки) и 'Count' (количество генерируемых значений).
    • По умолчанию во всех этих полях установлено значение 0.
    • Значение полей может быть отредактировано пользователем.
    • Значение 'Max' всегда должно быть не меньше значения 'Min', если пользователь указывает обратное, значения полей меняются местами между собой.
    • Изменение значений этих полей сразу влияет на содержимое поля 'Preview'.
    • Также, если выбрано значение 'RANDOM', доступна кнопка 'Generate new set', при нажатии которой генерируется новый набор значений в поле 'Preview'.
    • Изменение значений этих полей сразу влияет на содержимое поля 'Preview'.
    
    

    
    

  • BY_FORMULA - генерация значений в соответствии с заданной формулой. Если выбран этот способ, становится доступно поле 'Formula'.
    • По умолчанию оно пусто. Может быть отредактировано пользователем вручную.
    • Формулы описываются в виде выражений на языке JavaScript. В качестве переменных могут использоваться атрибуты узла.
    • Пример: если указать в поле Formula значение: 'element'+_i, где i - это имя одной из переменных узла, имеющей значение 'IValue', то генератор сгенерирует значение element_IVALUE.
    • Изменение значений этих полей сразу влияет на содержимое поля 'Preview'.
    
    

    
    

  • CYCLE - генерация значений с помощью перебора циклом типа From-To (с указанием начального и конечного значения, а так же шага). При выборе этого способа генерации становятся доступны следующие поля: 'From', 'To' и 'Step'.
    • По умолчанию во всех этих полях установлено значение 0. Пользователь может редактировать значение этих полей вручную.
    • Значение 'To' всегда должно быть не меньше значения 'From', если пользователь указывает обратное, значения полей меняются местами между собой.
    • Изменение значений этих полей сразу влияет на содержимое поля 'Preview'.
    
    

    
    

• Preview - поле, где отображается сгенерированный указанным способом набор значений атрибута. Содержимое этого поля является результатом установки значений параметров генератора. По умолчанию поле пусто. Редактирование возможно косвенным образом при изменении параметров генератора (см. редактирование поля 'Attr.gen.type').

Д

Документ (Document)

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

К

Клон, узел-клон

- узел-потомок виртуального узла, созданный на основе другого узла дерева требований (так называемого переиспользованного узла) в соответствии с настройками виртуального узла (см. Параметры виртуального узла). Клон по умолчанию получает тип и свойства от переиспользованного узла. Однако, они могут быть изменены пользователем. В окне 'Requality Explorer' пиктограмма узла-клона помечается дополнительным значком с буквой 'V'.

Комментарий (Comment)

- некоторая сущность, содержащая текстовый комментарий, относящийся к требованию, текстовому узлу или тестовой ситуации. У одного требования/одного тестового узла/одной тестовой ситуации может быть несколько комментариев.

Н

Настройки отчета (Report settings)

– некоторая сущность, позволяющая сгенерировать отчетный документ, содержащий сводную информацию по проекту (количество проверенных и непроверенных требований, покрытие требований тестовыми ситуациями, покрытие документа требованиями и т.п.). Обладает набором параметров, которые влияют на содержимое и вид отчета, а так же определяют источник информации для формирования отчета. Основной параметр для генерации отчета — 'Шаблон отчета'. На основе одного узла 'Настроек отчета' можно сгенерировать несколько отчетов. Изменение 'Настроек отчета' не влияет на уже сгенерированные отчеты.

О

Обязательные атрибуты

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

Отчет (Report)

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

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

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

Отчет по шаблону 'Анализ покрытия требований'

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

1. Файл с информацией о покрытии, записанной в определенном формате
2. Автоматический поиск файлов, содержащих идентификаторы покрытых ими требований или тестовых ситуаций.
   При использовании этого источника происходит поиск по выбранным пользователем проектам в workspace на предмет обнаружения файлов с заданным расширением. Расширение задается пользователем. Для указанных файлов производится построчная проверка содержимого файла на соответствие регулярному выражению, описанному пользователем. В результате такого поиска инструмент получает набор покрытых элементов и информацию о покрывающих файлах.

Отчет по шаблону 'Анализ покрытия выделенных требований'

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

1. Файл с информацией о покрытии, записанной в определенном формате
2. Автоматический поиск файлов, содержащих идентификаторы покрытых ими требований или тестовых ситуаций
   При использовании этого источника происходит поиск по выбранным пользователем проектам в workspace на предмет обнаружения файлов с заданным расширением. Расширение задается пользователем. Для указанных файлов производится построчная проверка содержимого файла на соответствие регулярному выражению, описанному пользователем. В результате такого поиска инструмент получает набор покрытых элементов и информацию о покрывающих файлах.

Отчет по шаблону 'Настраиваемая визуализация связей между требованиями' (экспериментальная функциональность)

– отчет со ссылками между связанными узлами каталога проекта Requality.

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

Отчет по шаблону 'Проверка правил оформления'

- отчет в виде таблицы, содержащей перечень узлов, в которых нарушены правила 'Checker rules', и информацию о том, какие именно правила нарушены в каждом таком узле.

Отчет по шаблону 'Прогресс по проекту'

– отчет со статистикой по разным ревизиям, загруженным в репозиторий.

Отчет состоит из двух страниц:

1. На первой странице находятся следующие графики:
   • График, отображающий общее количество элементов: требований (внутренних и листовых узлов), тестовых ситуаций.
   • График с информацией о покрытии.
   • И график с соотношением количества требований и количества тестовых ситуаций.
2. На второй странице отчета отображается общая таблица с числовыми характеристиками по ревизиям: количество требований, тестовых ситуаций, количество и процентное соотношение покрытых и не покрытых требований.

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

П

Параметры виртуального узла

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

Для виртуальных узлов окно 'Properties' содержит 4 вкладки:

1. Вкладка Main содержит следующие параметры виртуального узла:
   • Id – идентификатор виртуального узла. Идентификатор уникален среди дочерних узлов одного родителя. Может быть изменен вручную.
   • Name – имя виртуального узла. Может не быть уникальным. По умолчанию пусто. Может быть изменено вручную.
   • Attributes – атрибуты виртуального узла, представлены в таблице. Подробнее о таблице атрибутов здесь.
   
   
   
2. Вкладка Iteration содержит следующие параметры виртуального узла:
   • Target – целевой элемент, которым будет оперировать виртуальный узел. Требование или тестовая ситуация. По умолчанию не указан. Может быть выбран среди узлов каталога проекта. Если у требования-родителя виртуального узла есть дочерняя тестовая ситуация, то в качестве 'Target' может быть выбрана только тестовая ситуация (не требование).
   • Iteration method – способ использования виртуального узла. Может иметь два значения, выбираемые из выпадающего списка:
     • Reuse - использование обобщенного описания, копии которого будут добавлены к виртуальному узлу.

       
       

       
       
     • Base element- определение базового элемента, при котором копии прямых потомков целевого элемента будут добавлены к виртуальному узлу.
       
       
   • It.vars – итерируемые переменные. Этот параметр появляется только в том случае, если выбран способ 'Reuse'. По умолчанию ни одна итерируемая переменная не указана. Итерируемых переменных может быть несколько. Они могут быть добавлены и удалены с помощью соответствующих кнопок. Выбираются с помощью выпадающего списка, который содержит список доступных атрибутов. В качестве итерируемой переменной может быть использован один из атрибутов данного виртуального узла (т.е. находящийся в списке атрибутов на вкладке 'Main'), имеющий тип List (то есть имеющий список значений).
     
     
3. Вкладка History содержит информацию об истории всех ревизий, касающихся виртуального узла. Содержимое вкладки аналогично содержимому вкладки 'History' у требования (см. Параметры требования).
4. Вкладка Source содержит только json-код:
   • json – низкоуровневое представление виртуального узла как сущности. Не редактируется.
   
   
   
   

Параметры Комментария

– свойства узла Комментарий, которые указываются в окне 'Properties'. (Также могут быть в сокращенном виде просмотрены и отредактированы в 'окне редактирования параметров'.)

Для Комментария окно 'Properties' содержит 3 вкладки:

1. Вкладка Main содержит следующие параметры комментария:
   • Id – идентификатор комментария. Идентификатор уникален среди дочерних узлов одного родителя. Не редактируется.
   • Name – имя комментария. Может не быть уникальным. По умолчанию пусто. Может быть изменено вручную.
   • Author – автор комментария. По умолчанию это поле заполнено в соответствии с настройками операционной системы.
   • Поле для текста комментария – по умолчанию пусто. Может быть заполнено вручную.
   
   
   
   
2. Вкладка History содержит информацию об истории всех ревизий, касающихся этого комментария. Содержимое вкладки аналогично содержимому вкладки 'History' у требования (см. Параметры требования).
3. Вкладка Source содержит только json-код:
   • json – низкоуровневое представление комментария как сущности. Не редактируется.
   
   
   
   

Параметры Настроек отчета

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

Для Настроек отчета окно 'Properties' содержит 3 вкладки:

1. Вкладка Report Settings:
   • Id – идентификатор Настроек отчета. Идентификатор уникален среди узлов одной папки в разделе Отчетов. Может быть изменен вручную.
   • Root requirement – требование, для которого будет генерироваться отчет. В отчете, сгенерированном на основе этих Настроек отчета, будет рассматриваться не все дерево узлов проекта, а только поддерево указанного узла-требования и все его дочерние узлы (требования и комментарии). В случае подключения дополнительных плагинов к Requality в отчет могут войти и узлы других типов. Эта настройка изменяется вручную.
   • Template – шаблон отчета, в соответствии с которым модифицируется вид и содержимое отчета. Шаблон отчета изменяется вручную: выбирается из списка доступных шаблонов отчета. Является системным атрибутом. По умолчанию доступны следущие шаблоны отчета:

     
     

     • Отчёты для решения типовых задач
       • 'Чтение требований' - для выгрузки всех требований и текстовых узлов в виде таблицы.
       • 'Проверка правил оформления' - отчет, содержащий информацию о нарушений правил оформления требований, в том числе тех, что описаны в настройках 'Checker rules'.
       • 'Анализ покрытия требований' - содержит информацию о покрытии требований и тестовых ситуаций другими элементами (например, тестами). Для генерации требуется задать источник информации о покрытии. Подробнее об отчете 'Анализ покрытия требований' можно прочитать здесь.

       
       

     • Экспорт
       • 'Экспорт проекта в XML' - экспорт проекта Requality в виде xml-документа, предназначен для использования отчета другими инструментами.

       
       

     ЭКСПЕРИМЕНТАЛЬНЫЕ

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

       
       

     • Анализ связей между требованиями
       • 'Настраиваемая визуализация связей между требованиями' (экспериментальная функциональность) - отчет со ссылками между связанными узлами каталога проекта Requality. Предназначен для просмотра связей в соответствии с заданными настройками.
       • 'Двунаправленная визуализация связей' (экспериментальная функциональность) - этот отчет предназвачен для просмотра связей в двух направлениях (исходящих и входящих) одновременно.

       
       

     • Отладка правил оформления
       • 'Отладка правил оформления' (экспериментальная функциональность) - этот отчет предназначен для отладки правил оформления требований, он позволяет изучить узлы, на которых правила, записанные для проекта, выдают результат, отличный от 'true' или 'false', то есть могут быть записаны некорректно.

       
       

     • Остальное
       • 'Экспорт в LORequality' (экспериментальная функциональность) - этот отчет предназначен для обмена требованиями с LibreOffice.
       • 'Прогресс по проекту' (экспериментальная функциональность) - этот отчет предназначен для анализа изменения количества требований и тестовых ситуаций на основе истории коммитов, позволяет просматривать статистику по количеству требований и тестовых ситуаций в разных ревизиях, загруженных в репозиторий по данному проекту.

       
       

   • Attributes – атрибуты настроек отчета, представлены в таблице. Подробнее о таблице атрибутов здесь. Если для генерации отчета требуется указать источник информации об отчете, то информация о нем записывается в таблицу атрибутов как значение атрибута с именем coverageFilePath. Для задания или изменения значения этого атрибута используется кнопка 'Update Coverage Source', которая возникает на вкладке в том случае, если выбранный шаблон отчета требует указания источника информации о покрытии.
   
   
   
2. Вкладка History содержит информацию об истории всех ревизий, касающихся этого узла Настроек отчета. Содержимое вкладки аналогично содержимому вкладки 'History' у требования (см. Параметры требования).
3. Вкладка Source содержит только json-код:
   • json – низкоуровневое представление отчета как сущности. Не редактируется.

Параметры отчета

– параметры узла Настройки отчета, на основе которых отчет был сгенерирован. Указываются в окне 'Properties'.

Полностью идентичны параметрам узла Свойства отчета (за исключением атрибута 'date'), однако не могут быть отредактированы (за исключением параметра 'Id').

• Параметр Id в данном случае - это идентификатор отчета, располагающийся на вкладке 'Report Settings' окна 'Properties'. По умолчанию он включает идентификатор 'Настроек отчета', на основе которых был сгенерирован данный отчет, и дату и время генерации. Однако может быть вручную отредактирован пользователем.
• Таблица атрибутов содержит атрибут date, который автоматически создается при генерации отчета и содержит информацию о дате и времени генерации отчета.

Параметры проекта Requality (свойства проекта)

– свойства проекта Requality, задаются как параметры корневого узла проекта. Устанавливаются в окне 'Properties'.

Для проекта окно 'Properties' содержит 3 вкладки:

1. Вкладка 'Main'
   • Кнопка 'Extract enum definitions from attributes' открывает диалоговое окно для извлечения перечисляемого типа из уже существующих атрибутов проекта. См. подробнее Перечисляемый тип атрибута (Enum).
   • 'Attributes' - атрибуты проекта, представлены в таблице. Таблица атрибутов (см. Таблица атрибутов) проекта аналогична таблицам атрибутов других узлов проекта, за исключением того, что отсутствует столбец 'Scope'. Все атрибуты проекта считаются по умолчанию глобальными, то есть наследуются всем деревом проекта. В таблице атрибутов проекта могут быть заданы атрибуты типа 'ENUM_DEFINITION', которые служат для задания перечисляемого типа для использования в других атрибутах проекта. Подробнее о перечисляемом типе см. Перечисляемый тип атрибута (Enum).

   
   

   
   
   
2. Вкладка History содержит информацию об истории всех ревизий в проекте. На этой вкладке расположена таблица истории изменений — это таблица, содержащая информацию о всех ревизиях элементов дерева требований проекта, которые были сохранены в репозиторий с использованием меню 'Repository'. Каждому сохранению изменений в репозиторий соответствует одна строка:
   • в первой ячейке указан текст комментария к этому изменению,
   • во второй ячейке - системный номер версии (для обычного пользователя эта информация несущественна),
   • в третьей ячейке - имя загрузившего версию в репозиторий пользователя,
   • в четвертой - дата загрузки версии в репозиторий.
   При двойном клике по строке определенного изменения открывается перспектива для сравнения состояния проекта на тот момент с его текущим локальным состоянием.
   
   
   
3. Вкладка 'Templates' - содержимое этой вкладки полностью совпадает с содержимым окна 'Редактора шаблонов' и имеет ту же функциональность. См. Редактор шаблонов.

   
   

   

   
   

Параметры текстового узла

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

Для текстовых узлов окно 'Properties' содержит 5 вкладок:

1. Вкладка Main содержит следующие параметры текстового узла:
   • Id – идентификатор текстового узла. Идентификатор уникален среди дочерних узлов одного родителя. Может быть изменен вручную.
   • Name – имя текстового узла. Может не быть уникальным. По умолчанию пусто. Может быть изменено вручную.
   • Type – тип узла. Для текстового узла тип всегда указан или 'Text' (для простого текста), или 'Header' (для заголовка). Это поле представляет собой выпадающий список и предназначено для смены типа узла на другой вид текстового узла ('Text' на 'Header' или обратно) или требование ('Requirement').
   • Attributes – атрибуты текстового узла, представлены в таблице. Подробнее о таблице атрибутов здесь.
   
   
   
   
2. Вкладка Description содержит следующие параметры текстового узла:
   • Description – текст текстового узла. Заполняется вручную.

   
   
   
   

3. Вкладка History содержит информацию об истории всех ревизий, касающихся этого текстового узла. Содержимое вкладки аналогично содержимому вкладки 'History' у требования (см. Параметры требования).
4. Вкладка Advanced содержит следующие параметры текстового узла:
   • Predicate – предикат, условие отбора текстовых узлов для отчетов. По умолчанию наследуется от родительских узлов. Заполняется вручную.
   
   
   
   
5. Вкладка Source содержит только json-код:
   • json – низкоуровневое представление текстового узла как сущности. Не редактируется.
   
   
   
   

Параметры тестовой ситуации

– свойства тестовой ситуации, которые указываются в окне 'Properties'. (Также могут быть в сокращенном виде просмотрены и отредактированы в 'окне редактирования параметров'.)

Для тестовых ситуаций окно 'Properties' содержит 5 вкладок:

1. Вкладка Main:
   • Id – идентификатор тестовой ситуации. Идентификатор уникален среди тестовых ситуаций одного требования. Может быть изменен вручную.
   • Name – имя тестовой ситуации. Может не быть уникальным. По умолчанию пусто. Может быть изменено вручную.
   • Status - статус требования, может иметь одно из трех значений: 'in process', 'complete' или 'verified'. Изменяется вручную.
   • Author - автор требования, изменяется вручную.
   • Attributes – атрибуты тестовой ситуации, представлены в таблице. Подробнее о таблице атрибутов здесь.

   
   

   

   
   

2. Вкладка Description:
   • Test purpose description - описание теста, изменяется вручную.
   • Expected results - ожидаемый после выполнения теста результат.

   
   

   

   
   

3. Вкладка History содержит информацию об истории всех ревизий, касающихся этой тестовой ситуации. Содержимое вкладки аналогично содержимому вкладки 'History' у требования (см. Параметры требования).
4. Вкладка Advanced содержит:
   • Predicate – предикат, условие отбора тестовых ситуаций для отчетов. По умолчанию наследуется от родительских требований. Заполняется вручную.

   
   

   

   
   

5. Вкладка Source:
   • json – низкоуровневое представление тестовой ситуации как сущности. Не редактируется.

   
   

   

   
   

Параметры требования

– свойства требования, которые устанавливаются в окне 'Properties'. (Также могут быть в сокращенном виде просмотрены и отредактированы в 'окне редактирования параметров'.)

Для требований окно 'Properties' содержит 5 вкладок:

1. Вкладка Main содержит следующие параметры требования:
   • Id – идентификатор требования. Идентификатор уникален среди дочерних узлов одного родителя. Может быть изменен вручную.
   • Name – имя требования. Может не быть уникальным. По умолчанию пусто. Может быть изменено вручную.
   • Type – тип узла. Для требования - всегда 'Requirement'. Это поле представляет собой выпадающий список и предназначено для смены типа узла на текстовый ('Text' или 'Header').
   • Attributes – атрибуты требования, представлены в таблице. Подробнее о таблице атрибутов здесь.
   
   
   
   
2. Вкладка Description содержит следующие параметры требования:
   • Alternative Description – альтернативный текст требования, уточняет и дополняет текст выделенных фрагментов. Заполняется вручную.
   • Locations - список выделенных фрагментов данного требования, сгруппированный по документам. Вручную можно только удалять фрагменты.

   
   
   
   

3. Вкладка History содержит информацию об истории всех ревизий, касающихся этого требования. Пользователь не может редактировать что-либо на этой вкладке напрямую, только при сохранении в репозиторий очередной версии. Вкладка содержит следующую информацию:
   • Таблица истории версий — это таблица, содержащая информацию о всех версиях данного требования. Каждой версии соответствует одна строка, в ней указан текст комментария к этой версии, системный номер версии, имя загрузившего версию в репозиторий пользователя и дата ее загрузки в репозиторий. Самая верхняя строка соответствует последней синхронизированной с репозиторием версии. Далее сверху вниз идут версии в порядке по убыванию, от более свежих к более старым. При двойном клике по строке определенной версии можно открыть окно сравнения, в котором будет отображена информация о различиях между этой версией рассматриваемого требования и его текущей локальной версией. Локальная версия, находящаяся на текущий момент в workspace, помечена зеленым цветом. Это особенно актуально видеть в том случае, если проект был переключен на старую версию.

     
     
     
     

4. Вкладка Advanced содержит:
   • Predicate – предикат, условие отбора требований для отчетов. По умолчанию наследуется от родительских требований. Заполняется вручную.
   
   
   
   
5. Вкладка Source содержит только json-код:
   • json – низкоуровневое представление требования как сущности. Не редактируется.
   
   
   
   

Параметры узла

– это свойства узла, набор атрибутов, которые характеризуют узел. Полный перечень параметров узла можно посмотреть и отредактировать в окне-представлении 'Properties' перспективы Requality. Сокращенный перечень параметров находится в специальном 'окне редактирования параметров', которое открывается при создании и редактировании узлов в редакторах 'Module Editor', 'UniEditor' и 'Review'. Некоторые атрибуты могут быть 'обязательными', они настраиваются в настройках проекта Requality. Атрибуты, которые указаны в таблице атрибутов, являются пользовательскими, т.к. их наличие определяется пользователем, в отличие от всех остальных — системных — атрибутов.

Параметры шаблона узла

– свойства шаблона узла (см. Шаблон узла). Параметры шаблона узла определенного типа полностью аналогичны параметрам узла этого типа. Устанавливаются в окне 'Properties'. (Также могут быть в сокращенном виде просмотрены и отредактированы в 'окне редактирования параметров'.)

Переиспользуемый (переиспользованный) узел

- любой узел дерева требований, указанный в качестве целевого узла для итерации в параметрах виртуального узла (см. 'Target' в разделе Параметры виртуального узла). На основе этого узла создаются узлы-клоны (см. Клон) данного виртуального узла. На сам переиспользованный узел это никак не влияет. Изменения в переиспользуемом узле и его поддереве узлов влияют на узлы-клоны.

Перечисляемый тип атрибута (Enum)

– это тип атрибута, определяющий список допустимых значений атрибута. Перечисляемый тип - 'Enum' - в Requality определяется пользователем в окне параметров проекта (см. Параметры проекта Requality) как обычный атрибут узла проекта:

• Имя этого атрибута будет считаться названием 'Enum'-типа.
• В качестве типа этого атрибута должен быть выбран тип 'ENUM_DEFINITION'.
• В качестве значения атрибута указывается список значений. Его можно задать вручную с помощью специального редактора или воспользоваться дополнительной возможностью извлечения из уже существующих атрибутов всех узлов проекта:
  1. Редактор открывается при клике в столбце 'Value'. В окне редактора перечислены все допустимые значения типа и комментарии к ним (если есть). Окно редактора значений для задания перечисляемого типа выглядит так:
     
     
     
     
  2. Процедура извлечения 'Enum'-типа из узлов проекта запускается с помощью кнопки 'Extract enum definition from attributes' в окне 'Properties' проекта. Где пользователь может выбрать один из атрибутов, использующихся в дереве узлов проекта. Там же пользователю предлагается ввести имя для нового типа (по умолчанию оно будет совпадать с названием выбранного атрибута). После завершения процедуры все значения атрибута с таким именем станут списком значений перечисляемого типа. А атрибуты, по которым был задан 'Enum'-тип, получат в качестве типа название этого нового созданного перечисляемого типа, сохранив свои значения.
• Сам по себе атрибут 'ENUM_DEFINITION' не виден (не наследуется) в качестве атрибута в других узлах проекта. Но заданный им 'Enum'-тип отображается в списке доступных типов для всех атрибутов в узлах дерева проекта (во избежание путаницы он отображается с префиксом Ⓔ).

Подтребование, дочернее требование (sub-requirement, child-node)

– это требование, являющееся дочерним узлом другого 'требования' в иерархии проекта. Если родительское требование R содержит N подтребований RC_1, ..., RC_N, то считается, что требования RC_1, ..., RC_N представляют собой декомпозицию требования R. Другими словами, целевая система удовлетворяет требованию R тогда и только тогда, когда она удовлетворяет всем требованиям RC_1, ..., RC_N.

Полный путь к узлу (FullName)

– путь к узлу, идентифицирующий этот узел. Содержит перечисление всех родительских узлов по порядку, начиная от корневого узла 'Requirements' и заканчивая самим рассматриваемым узлом. В этом перечислении узлы указываются по их именам, в случае отсутствия имени — по идентификаторам. В качестве разделителя используется '/'.

Пользовательские атрибуты

– это параметры узла, которые настраиваются пользователем (в отличие от системных атрибутов): пользователь может создавать их, удалять, указывать для них тип данных. Пользовательские атрибуты задаются в таблице атрибутов (см. Таблица атрибутов). Следует различать 'пользовательские атрибуты' и 'системные атрибуты' (см. Системные атрибуты), а так же иметь в виду, что 'пользовательские атрибуты' могут стать 'обязательными атрибутами' (см. Обязательные атрибуты).

Проект Requality (Requality project)

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

Р

Ревизия, версия проекта

- состояние проекта и всех его узлов, сохраненное в репозиторий.

Редактор значений списка

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

• поле с выпадающим списком для выбора типа значений ('INT', 'FLOAT', 'BOOL', 'STRING', 'LIST', 'REFERENCE').
• таблица с перечислением всех значений. Редактируется вручную. Порядок перечисления значений можно изменить с помощью стрелок.
  
  
  

Редактор шаблонов

– редактор шаблонов узлов (см. Шаблон узла). Позволяет создавать, удалять, редактировать шаблоны узлов и задавать активные шаблоны. Открывается из редакторов: 'Module Editor', 'UniEditor', 'Review'.

Содержит поля:

• Select Node Type - выпадающий список для выбора типа узла. Определяет тип узлов, с которыми будет осуществляться работа в окне редактора шаблонов. То есть если, например, выбран тип 'Requirement', то ниже в списке шаблонов будут отображаться только шаблоны требований и при создании нового шаблона будет создан шаблон требования.
• Create template - кнопка для создания нового шаблона.
• Extract template - кнопка для создания нового шаблона на основе существующего узла.
• List of templates - список доступных шаблонов для выбранного в выпадающем списке 'Select Node Type' типа узлов.
• Edit - кнопка, открывающая редактор для шаблона, выбранного в списке 'List of templates'.
• Remove - кнопка для удаления шаблона, выбранного в списке 'List of templates'.
• Set as active - кнопка, делающая выбранный в списке 'List of templates' шаблон активным (см. 'Активный шаблон узла'). По умолчанию активным является пустой шаблон - 'Empty'. Активный шаблон выделяется жирным шрифтом в списке 'List of templates'.

C

Системные атрибуты

- это параметры узла проекта Requality, которые существуют для узлов по умолчанию, пользователь не может создать их, удалить или изменить их тип данных, но, как правильно, может отредактировать значение. Иногда значение отредактировать тоже невозможно, например, некоторые системные атрибуты отчета не редактируются, т.к. они содержат информацию о том, на основе каких настроек этот отчет был сгенерирован. Системные атрибуты можно редактировать в 'Параметрах узла' (см. в качестве примера Параметры требования). Следует различать 'системные атрибуты' и 'пользовательские атрибуты', а так же иметь в виду, что бывают 'обязательные атрибуты'.

Ссылка, ссылка между узлами дерева требований

- это однонаправленная именованная связь между двумя узлами дерева требований проекта Requality. Ссылка исходит из ссылающегося узла и входит в целевой узел. Она устанавливается в таблице атрибутов целевого узла как атрибут типа 'REFERENCE' и отображается для обоих узлов (ссылающегося и целевого) в окне 'Requality Links Explorer' (для ссылающегося узла как исходящая ссылка, для целевого узла — как входящая). Имя этого атрибута является именем исходящей ссылки у ссылающегося узла и, если специально не установлено в свойствах проекта иное, является именем входящей ссылки у целевого узла. При создании новой ссылки имя входящей ссылки у целевого узла совпадает с именем соответствующей исходящей ссылки у ссылающегося узла. Однако, в проекте Requality существует несколько предустановленных имен ссылок, у которых различаются имя входящей и исходящей ссылки.

Т

Таблица атрибутов (атрибуты)

– это набор параметров - атрибутов - узла проекта Requality, которые характеризуют различные свойства этого узла.

• Атрибуты перечислены в окне 'Properties'.
• Каждый атрибут имеет имя, тип, значение, область действия.
• Также для атрибута опционально может быть указан генератор значений.
• Атрибуты могут быть заданы вручную или сгенерированы автоматически с помощью генератора, параметры которого задаются пользователем.
• Атрибуты могут быть унаследованы от родительского узла, в таком случае они помечаются символом-стрелкой.
• Атрибуты применяются в предикатах, в описаниях узлов, а также при переиспользовании и итерации узлов.
• Некоторые атрибуты задаются автоматически, например, дата генерации отчета.
• Некоторые атрибуты должны иметь строго определенные имена, такие атрибуты обычно создаются с помощью вспомогательных диалоговых окон (например, атрибут 'coverageFilePath' у узла настроек отчета, который задает путь к файлу с информацией о покрытии).
• Для разных типов узла атрибуты могут различаться.

Атрибуты представлены в виде таблицы с полями 'Name' (имя атрибута), 'Type' (тип), 'Value' (значение), 'Scope' (область видимости) и 'Generator' ('генератор значений атрибута').

• Имя атрибута должно быть уникально у рамках одного узла. Оно не может быть пустым и не может начинаться или заканчиваться пробелами.
• Тип атрибута указывается в столбце 'Type'. По умолчанию доступны типы: 'INT', 'FLOAT', 'BOOL', 'STRING', 'LIST' и 'REFERENCE'. Однако в том случае, если для всего проекта задан глобальный атрибут типа 'ENUM_DEFINITION', имя этого атрибута тоже будет отображаться в выпадающем списке в столбце 'Type' с префиксом Ⓔ как доступный перечисляемый тип атрибута (см. Перечисляемый тип атрибута (Enum)).
• Значение атрибута указывается в столбце 'Value'.
• Область видимости атрибута указывается в столбце 'SCOPE'. Доступен один из вариантов: 'LOCAL', 'DIRECT_CHILDREN' или 'SUBTREE'.
  • 'LOCAL' - атрибут виден только в данном требовании.
  • 'DIRECT_CHILDREN' - атрибут виден в данном требовании и наследуется его детьми первого уровня (и не наследуется дочерними узлами детей).
  • 'SUBTREE' - атрибут виден в данном требовании и наследуется всем его поддеревом узлов.
  Кроме того, атрибут с тем же именем может быть переопределен в узле-потомке, тогда будет актуальным не унаследованное значение, а заново определенное.

  ВНИМАНИЕ! Столбец 'SCOPE' отсутствует в таблице атрибутов проекта, т.к. по умолчанию область видимости таких атрибутов - все дерево проекта.

• Генератор значений атрибута может быть задан в столбце 'Generator'. Механизм генерации подробно описан (здесь).

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

– это понятие в Requality, обозначающее наличие особой направленной связи 'Terms - Term referrers' типа 'один-ко-многим' между несколькими узлами, причем один из этих узлов считается местом определения термина, а все остальные - это места, где он используется. Эта связь задается не с помощью атрибута типа 'Reference', а с помощью специальных атрибутов с именами 'def-term' (в узле, где термин определен) и 'usedef' (в узлах, где термин используется). Имя термина уникально в рамках проекта.

Тестовая ситуация (Test purpose)

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

Текстовый узел (Text Node)

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

• Текстовый узел аналогичен требованию ('Requirement'), но им не является и в отчетах о покрытии требований или о покрытии требованиями не учитывается.
• Текстовый узел обладает набором параметров, которые задают его содержимое и свойства (см. Параметры текстового узла).
• Текстовый узел может иметь два формата: обычный текст ('text') и текст-заголовок ('header'). Формат текстового узла влияет на его отображение в редакторах 'UniEditor' и 'Module Editor'.
• Текстовый узел может быть преобразован в требование ('Requirement') с сохранением всех параметров.

Требование (Requirement)

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

• Требование может иметь 'подтребования (дочерние требования)'.
• Требование может не иметь описания и не ссылаться на документ, такие требования обычно используются для организации иерархической структуры требований, выступая в роли узлов-родителей.
• Только требования, не имеющие в иерархии дочерних требований, могут иметь тестовые ситуации.
• Требования обладают набором параметров, которые задают его содержимое и свойства (см. Параметры требования).
• Требование может быть преобразовано в текстовый узел ('Text Node') с сохранением всех параметров.

У

Уточняемое требование

– требование, на которое ссылается другое (уточняющее) требование.

Уточняющее требование

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

Ф

Файл с информацией о покрытии

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

Записывается следующим образом:

<?xml version="1.0" encoding="UTF-8"?>
<coverageInfo> 
  <reqcoverage qid="уникальный_идентификатор_требования_или_тестовой_ситуации">
    <covered_by uri="путь_к_покрывающему_элементу" [hits="1"]/>
  </reqcoverage>
  <reqcoverage qid="уникальный_идентификатор_требования_или_тестовой_ситуации">
    <covered_by uri="путь_к_покрывающему_элементу"/>
  </reqcoverage>
  <error [name="имя_ошибки"] testuri="uri_элемента_covered_by" [uri="ссылка_на_описание_ошибки"]>
      [<violates qid="уникальный_идентификатор_требования_или_тестовой_ситуации"/>]*
      [<description [format="вид_описания_ошибки"]>описание_ошибки</description>]
  </error>
</coverageInfo>

Здесь:

Квадратными скобками обозначены опциональные параметры.

1. coverageInfo - может быть только один экземпляр в файле. Он содержит вложенные XML-элементы reqcoverage (один или несколько) и error (может не быть, может быть один или несколько).
2. reqcoverage - элемент-ребенок для coverageInfo. Должен быть задан отдельно для каждого покрытого Requality-элемента. (Непокрытые узлы не описываются никак.) Содержит вложенные XML-элементы covered_by (один или несколько). Каждому вложенному covered_by соответствует один тест. Имеет атрибут qid.
3. qid - это user-visible-name(element) или qualifying-id(element) покрываемого элемента:
   • user-visible-name(element) - это имя элемента, если оно есть (то есть если поле name в окне 'Properties' у этого элемента не пустое), иначе это user-visible-name(element.parent)/id, то есть сначала user-visible-name родительского элемента, потом id - идентификатор элемента (в качестве разделителя использовать '/'). Например: "TR-FMF-01-01-002/TR-FMF-01-01-002_T01"
   • qualifying-id(element) - это полный путь к элементу, начиная с корневого элемента ('Requirements'), в качестве разделителя используется '/'. Например: "Requirements/01/MyRequirement01"
4. covered_by - элемент-ребенок для reqcoverage. Внутри reqcoverage их может быть несколько в зависимости от того, сколько тестов покрывают соответствующий ему Requality-элемент. Каждый covered_by соответствует одному покрывающему Requality-элементу. covered_by имеет атрибуты uri и hits.
5. uri - атрибут XML-элемента covered_by, указывает путь к тесту, описанному в этом covered_by элементе. Например: "file:///home/user/work/test1.c#12"
6. hits - атрибут XML-элемента covered_by, является опциональным. Указывает количество упоминаний этого требования reqcoverage в тесте covered_by.
7. error - элемент для описания ошибки, полученной в результате выполнения теста. Может содержать один элемент description с описанием ошибки. Может включать один или несколько элементов violates в ситуации, когда можно определить какие именно требования нарушает ошибка. Имеет атрибут testuri и опциональные атрибуты name и uri.
8. testuri - путь к одному из тестов, описанному в covered_by элементе.
9. name - опциональный параметр, представляет собой отображаемое имя ошибки. В случае если не определен, используется имя "error"+порядковый_номер_ошибки.
10. uri - опциональный параметр, путь к файлу с подробной информацией об ошибке.
11. violates - опциональный элемент, соответствует требованию, которое нарушает ошибка. Каждый элемент violates соответствует одному нарушенному требованию. Имеет атрибут qid. Если элемент violates не указан, ошибка в отчете отображена не будет.
12. qid – это user-visible-name(element) или qualifying-id(element) покрываемого элемента (подробнее см. выше, в описании элемента reqcoverage).
13. description - опциональный элемент, текстовое описание ошибки. Имеет опциональный атрибут format.
14. format - формат описания ошибки. Может быть "html" или "plain". В случае "plain" все html теги будут отображаться в виде текста.
15. описание_ошибки представляет собой описание ошибки, при этом для формата "html" допускается использование html тегов для форматирования текста.

Фрагмент требования (выделенный фрагмент документа, фрагмент, Location)

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

Ч

Числовой идентификатор узла (ForeignID)

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

Ш

Шаблон отчета

– это основная настройка, определяющая содержимое и внешний вид отчета. Указывается в узле 'Настроек отчета'. Например, данные можно представить в виде списка или таблицы. Можно включить в отчет все узлы дерева 'Requirements' или только узлы некоторого конкретного типа. В Requality существует набор встроенных шаблонов отчета, которые доступны по умолчанию. В случае использования плагинов к Requality список доступных шаблонов может пополняться. Также можно добавлять и удалять свои шаблоны отчета. Сам по себе шаблон отчета описан в отдельном файле в файловой системе.

Шаблон узла

– это некоторая сущность, соответствующая одному из типов узлов ('Comment', 'Report Settings', 'Requirement', 'Test Purpose', 'Text Node', 'Virtual Node') проекта Requality, которая служит шаблоном для создания новых узлов того же типа.

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