Consequent

ReqIF is spreading, and partners start handing .reqif and .reqifz files back and forth.  But chances are that the first import of such a file will fail.  How do you debug the problem? Consequent, the free ReqIF-Validator, may provide the answer.

There are two versions of Consequent available, GUI and Console.

GUI-Version: Consequent is already built into ReqIF Studio. Validation is done automatically upon saving. Information on usage is found below and in the handbook.

Command Line Version: We provide a command line version of Consequent. This is useful for batch processing and has additional features. It is available as a separate download.

Differences at a Glance

Topic GUI Command Line
Cross-File-Validation Only one ReqIF file is validated, cross-file SpecRelations are ignored. SpecRelations across files are validated, if all relevant .reqif files are provided as arguments.
Selective disabling of rules Individual rules can be disabled via Window | Preferences | Model Validation | Constraints. All rules are always applied.
Error Markers Error markers are created, which allow to see errors in a text editor Line numbers are provided in the output
Saving results Upon validating, the user can save as XML. The output of the tool is plain text or XML (with -x option). It can be redirected into a file.

Usage GUI Version

The latest version of ReqiF Studio comes with an integrated version of Consequent. Use it as follows:

  • Right-Click the file to be validated in the Project Explorer (no need to open the file)
  • Select Validate | Consequent ReqIF Validation
  • A dialog indicates the completion of the validation, which is shown in the Problem View.
  • If the Problem View is not visible, open it by hand via Window | Show View | Other… | General | Problems
  • To see the error in the file, you must open it in a text editor as follows:
    • Right-Click the file in the Project Explorer
    • Select Open With | Text Editor
    • Errors are shown with an icon in the left margin (hovering over the error reveals the problem) – see screenshot below
    • For errors with line numbers, it is possible to double click on an error in the Problem View to jump to the corresponding position in the Text Editor
  • Error markers do not reset automatically. Re-run the validation to update them. You can manually clear error markes (e.g. for files that do not exist any more) by right-clicking on an element in the Problem View and selecting Delete.

In the Text Editor, errors are shown like this (with the mouse hovering over the icon):

error-marker

Leave a Reply