REQCHECKER™ Change Log

REQCHECKER 1.9.0

Build Sept. 2018

New help

Webhelp is available online and offline.

Linked requirement

Two requirements can be linked with the new tag LINKED. The linked required are presented in the coverage matrix.

Coverage Matrix improvements

Option Text in coverage matrix is replaced by Extended Coverage Matrix. It controls the display/hide of text, management rate, coverage rate, links and custom tags in the Matrix sheet. The requirement ID in the Matrix sheet are hyperlinks to the requirement details in the Status sheet.

Verification Table (EXCEL) improvement

When the Verification Table (EXCEL) is updated, added rows are inserted in the same order than in the source document.

Text Full Report (TXT) improvement

Text Full Report (TXT) format uses markdown.

Fixed

Does not display the title column in Verification Table (EXCEL) and Coverage Matrix (EXCEL) when Title for requirements option is enabled.

Fixed

Remove the boring macro warning when opening a xlsm report.

REQCHECKER 1.8.1

Build Aug. 2018

Fixed

Possibility of crash on old MS WORD (.doc) documents when document is empty

Fixed

Compatibility with some Microsoft Hyper-V configuration

Fixed

Possibility of crash on requirements longer than 32k with a reviewing error that ends after 32k.

REQCHECKER 1.8.0

Build Apr. 2018

Note

Several improvements increase software ability to extract requirements from PDF and WORD documents. The new check feature runs several checks on requirement titles and text to increase consistency and ease of reading. French, German, and English are the languages supported. The new Syntax+Full extraction mode considers any part of the document as a requirement.


NEW EXTRACTION FEATURES

New custom tag types

(REQCHECKER™ PRO only) Requirement custom tags (or attributes) can use the following new types:

  • Multiline Text extracts a requirement tag on several lines. The text is read until the next known thing: next keyword, next chapter or next requirement.
  • Cell Text extracts the tag keyword from a table cell and the tag value from the next cell. Reader plugins must support table recognition (for example: .pdf, .docx).

Reader improvements

The MS Word .docx and .doc reader plugin recognizes the bullet style (one level only). The MS Word .docx reader plugin recognizes table cells (one level only). The PDF reader plugin detects and ignores watermarks. Paragraph recognition is improved. (REQCHECKER™ PRO only)

Parser improvements

Accepts the dash character - as part of a requirement version.

Forces the first character of a requirement version to be a digit or an exception. This improves version parsing when there is no termination tag END VERSION. The exceptions are v, V and DELETED for compatibility with some existing projects.

Allows file ID to be 8 characters long when it is modified manually.

Requirement filtering by title

(REQCHECKER™ PRO only) This set of filters ignores (removes) requirements whose title matches one of the filters in the list. The filter value is case-sensitive. The filter value can use * (one or more characters) or ? (any character) wildcards to filter a position containing text. Default values for a new project ignore requirements containing dotted lines in a table of contents; this avoids the several statements error when the table of content refers to some requirement statements.

Text filtering by style name

(REQCHECKER™ PRO only) This set of filters ignores (removes) the text of the document whose style name matches one of the filters in the list. The filter value is case-sensitive. The filter value can use * (one or more characters) or ? (any character) wildcards to filter a position. Default values for a new project ignore the table of content styles; this avoids the several statements error when the table of content refers to some requirement statements.

Compatibility with REQTIFY improvement

  • The new title for requirement parsing option. When disabled, no title is read from requirement.
  • The statement version tag and the coverage version tag can use the same keyword.
  • The BEGIN COVER statement prefix (see Coverage GUI tab) can be written in the line or cell immediately preceding the REQUIREMENT ID.
  • Comparison of requirement versions is not case-sensitive.

New Syntax+Full extraction mode in Data Source tab

This new extraction mode considers any part of the document as a requirement. It extracts requirements using syntax and all other paragraphs extracted too. This mode provides a way to extract text for checking and traceability.

New Limit text to first section option

If enabled and if END TEXT tag is defined, the extracted requirement text stops at the next section (next chapter or next sheet) or the next tag.


NEW CHECKING FEATURES

Check engine

The check engine runs several checks on requirement titles and text to increase consistency and ease of reading. French, German, and English are the languages supported. The language used by checks is selected dynamically to match the main language of the analyzed document. Combined with the Syntax+Full parsing option, a full document, including requirements (if any) and other paragraphs, can be reviewed. If a static or dynamic folder is used in the Data Sources tab, the check engine checks a batch of documents. All errors are listed in the Verification Table (EXCEL) and the Coverage Full Report (PDF). The requirements that are not compliant with rules have the VALIDATION_ERROR status. Each check component can be fully enabled / disabled.

Blacklist check component

Blacklist check component finds all ambiguous (most, often, at ... level) or forbidden (ASAP, TBC, TBD, etc.) terms and expressions. Detection may or may not be case-sensitive. Wildcards can be used to specify the forbidden expression, or advanced regular expression. Rules are executed in the declaration order. When part of the text does not comply with a rule, it will not be used for the next rules. Several predefined lists of expressions are available for French, German, and English.

Customize controls

Rules can be customized or extended to another language. (REQCHECKER™ PRO only)

Metrics check component

Metrics check component checks several metrics that make text hard to read or ambiguous: Maximum Negation Count: checks the maximum number of negations included in a sentence. Sentences with too many negations are hard to read. Maximum Sentence Length: checks the maximum number of words included in a sentence. Sentences which are too long are hard to understand. * Maximum Number of Conjunctions and Adverbs: too many coordination conjunctions (and, or, for, same for French and German, etc.), subordinate conjunctions (after, though, unless, same for French and German, etc.), link adverbs (furthermore, unlike, besides, same for French and German, etc.) and logical relation adverbs (because, since, in order that, same for French and German, etc.).

Deletion management for Verification Table (EXCEL)

(REQCHECKER™ PRO only) The Verification Table (EXCEL) separates the DELETED status, and requirement deletion from documents. Requirements with DELETED status appear in the Verification Table (EXCEL) with the !DELETED! prefix displayed in the title and in the text. Requirements removed from documents appear with a strike-through the text and the (deleted) value in the Result column.


NEW REPORTING FEATURES

The new INCOMPLETE_MANAGEMENT_ERROR status is used instead of AMBIGUOUS_COVERAGE_ERROR whenever the management rate is below 100%.

Warning

Switch from version 1.7 to 1.8 will change the automatic requirement footprint in some are cases.


OTHER

Feature

GUI Improvement: The New menu creates a new empty project.

Fixed

default value of new project field (ascendant compatibility) are not saved if they are not modified.

Fixed

PDF chapter titles recognition when font sizes changes for the same level at several position in the document

Fixed

value are not correctly saved in .cover file and keep their default value after loading

Fixed

issues when reading a document with heading mode and with statement custom attributes.

Fixed

order of requirement in Verification Table (EXCEL) and Coverage Matrix (EXCEL).

Fixed

unable to find ID column on some EXCEL file by using database mode

Fixed

link from Verification Table (EXCEL) and Coverage Matrix (EXCEL) to Microsoft Word *.docx document containing hidden text (add support of w:vanish ooxml element)

REQCHECKER 1.7.3

Build Oct. 2017

Verification Table (EXCEL) and Coverage Matrix (EXCEL) improvement

New option Text in coverage matrix adds a column with the requirement text in the two tabs of coverage matrix. (REQCHECKER™ PRO only)

Fixed

Adds safe launcher shortcut as workaround when standard launcher fails on some computers with memory issues

REQCHECKER 1.7.2

Build Oct. 2017

Fixed

chapter titles recognition in MS WORD .docx document when the title style is applied to en empty line.

Fixed

some case of coverage version parsing

REQCHECKER 1.7.1

Build Sept. 2017

Fixed

coverage rate value for requirement with PARTIAL tag with an percentage is provided

Fixed

some uninstallation cases on Windows XP

Fixed

unable to open software on some 64 bits platform without Java already installed

Fixed

wrong virtual machine detection on some host computers with VMWare Player (REQCHECKER™ PRO only)

REQCHECKER 1.7.0

Build Aug. 2017

Automatic Impact Analysis

The software automatically creates a version for each requirement where no version is defined by the statement. The automatic version is a 6 characters length hash number. The hash is computed from the text and picture read from PDF and MS Word docx documents. The automatic version is not dependant from the following changes: case sensitive change, bullet modification, spaces.

Dynamic folders

The Add Folder button in Data sources tab now inserts either the files in batch mode, or lists the files at runtime. This works for folder and sub-folders. The advanced patterns allows filters like *.{cpp,h}.

Path update

The path of a file or a folder can be updated without changing other characteristics.

Regular expression conversion

When user switches from standard to advanced regular expression, the existing values are converted. Switch back to standard expression is not possible, then values are reset to default.

New export under Java enum format

This allows to reference requirements directly from Java language, for example as link in JavaDoc source code. (REQCHECKER™ PRO only)

Read comments for new languages

Python (.py, .pyw), Windows and Linux script files (.bat, .sh), C include files (.inc). (REQCHECKER™ PRO only)

Fixed

Increased maximum length of requirement text. This allows to catch longer text, in particular for heading mode where paragraphs can be long.

Fixed

PDF reader: some cases of landscape page are now correctly read. (REQCHECKER™ PRO only)

Fixed

False differences presented in Verification Table (EXCEL) in update mode when the text contains some unprintable characters. (REQCHECKER™ PRO only)

Fixed

Verification Table (EXCEL) no more includes deleted requirements. (REQCHECKER™ PRO only)

REQCHECKER 1.6.2

Build July 2017

Fixed

Crash when reading some PowerPoint files

Fixed

Rare case where new line is not detected in PDF

REQCHECKER 1.6.1

Build June 2017

PDF Improvement

Improved PDF chapter titles recognition: new numbering patterns

REQCHECKER 1.6.0

Build May 2017

Leaf requirements

The new LEAF tag defines that the requirement is leaf. A leaf requirement is covered by default; it must not be explicitly covered. The default tag value is #Leaf and can be customized. Leaf requirement have a correct status in the reports. The status can be error if it is covered, has several statements etc. Example:

[REQ_02]The red light must be on if the sub-system raises an alert. <<DSC_0012>> #Partial <<DSC_0013>> #Leaf

Statement from heading numbers

Statement from heading numbers is available for MS Word 97 documents

Management rate

The management rate is the rate of requirement explicitly managed, excluding requirement with error. The coverage rate is the coverage rate excluding not applicable and not managed requirements. For example let 3 requirements covered, 1 explicitly not covered, 2 not applicable and 4 not yet managed, with a total of 10 requirements. The management rate is 60% (6/10) and the coverage rate is 75% (¾).

Coverage rate

Coverage rate can be detailed in percentage. The coverage rate is more accurate, especially if requirements are not unitary. For example:

<<REQ_0040>> #Partial 13% ... <<REQ_0040>> #Partial 30% ... <<REQ_0040>> #Partial 40% ... <<REQ_0040>> #NA 17%

Coverage Full Report (PDF) Improvement

Updated Coverage Full Report (PDF) with new look and rates

Performance improvement

Performance improvement about 20%

German language

Graphical user interface and tooltips are available in German

§beginning

Display §beginning for position found before the first encountered chapter in PDF or WORD documents.

§beginning

(REQCHECKER™ PRO only)

The text of a custom tag without end tag stops at the end of line (previous behaviour) or when another tag if read. This allows to write all tags on the same line.

Eclipse content assistance

(REQCHECKER™ PRO only)

C++ and Java developers can import the requirement definition and use the Eclipse IDE content assistant (CTRL+SPACE) to select the requirement and insert coverage.