Statement Tab

This tab defines how a requirement is created by syntax: the statement.

Overview

This tab defines how a requirement is created by syntax: the statement. The parameters described below can be modified. A requirement is identified at each time the tool reads the BEGIN STAT tag, the ID that matches the syntax (see Syntax examples), and reads the END STAT tag. For example: <REQ_10> in the text will identify the statement of the requirement with ID REQ_10.

Note

Blue fields use wildcards.

Orange fields use regular expression. Regular expression can be activated with the Syntax Advanced Reg. Exp. option.

The parameters described below can be modified. These parameters define how to detect a requirement statement.

Statement syntax

Syntax

[ BEGIN STAT ] REQUIREMENT ID [ END STAT ] [ title ]

[ attributes, coverages ]

text [ coverages ]

[ END TEXT ]

[ attributes, coverages ]

Where:

  • '[ ]' means the element is optional
  • attributes are the definition of the requirement attributes. Attributes are defined with the following tags: VERSION, DELETED, LEAF, LINKED, Custom tags. The order of the attributes is unimportant.
  • coverages is the list of covered requirements.

Tag BEGIN STAT

This is the requirement statement beginner tag. If empty, REQUIREMENT ID is used to search for the beginning of the statement.

REQUIREMENT ID part

This the unique ID for the requirement (usually a number).

The file-system like wildcars are allowed : * (zero or several characters) or ? (zero or one character).

Advanced regular expression can be used, see Syntax examples.

Tag END STAT

This is end of statement tag. If empty, the next character that does not match the REQUIREMENT ID syntax stops the ID.

Title part

This is the title of the requirement. It is read immediately after the END STAT tag. It stops at the first carriage return or at the next tag.

Text part

This is the main description of the requirement.

Tag VERSION

The version is defined in the requirement statement. The author updates it at each modification.

The version is referenced in the requirement coverage(s) too. The comparison between the statement and the coverage(s) versions can detect a change in the requirement that has not been propagated. This detection is called Impact Analysis.

The version must begin with a digit 0-9 followed by digits 0-9, letters a-zA-Z, dashes -, dots . and spaces . For backward compatibility, the version can begin with some exception: v, V, DELETED.

Example of version:

  • 1
  • 1.1
  • 1.2 beta
  • v3
  • V4 beta
  • DELETED

If no version is set, the default value is 0.

If the option Non-standard version is checked, the version can be a free text with digits 0-9, letters a-zA-Z, dashes -, dots . and spaces .

This tag defines the version associated with the statement. This tag is optional, if blank the version is supposed to be '0' (zero).

Tag DELETED

This tag specifies that the requirement is deleted. The requirement will never be covered. This tag is optional.

Tag LEAF

A LEAF requirement is at the last level of the coverage tree. It is 'covered' by default.

LEAF requirement must not be covered. The status can be error if it is covered, has several statements etc.

If a requirement is created from a document chapter and if this chapter is empty, then the associated requirement is set as LEAF. If the title is longer than 10 characters or if it contains any sentence, the requirement is not set as LEAF. This avoids to cover useless chapters.

Tag LINKED

This tag is followed by the requirement ID of a related requirement, for example same subject, same feature.

LINKED meaning is different from a coverage. The relationship helps on impact analysis.

Note

Several links can be declared. The tag must precede each of them.

Regular expressions are supported. For example: is derived from|see requirement|see specification|\(see|\: See|\(See requirement\:|\(see requirement

Custom tags

Custom tags defines the requirements custom attributes.

Custom tags can be added to each statement.

See Custom Tag for more details.