Quality Control Rules

Rational® Programming Patterns provides rules in Software Analyzer to perform the most common controls on the design files and the generated COBOL files.

Implementation

Before starting an analysis, open the Software Analyzer Configurations dialog to define a configuration rule set and specify the following information:
  • The scope (analyze the entire workspace, a working set, or one or more selected projects).
  • The rule set. You can change the severity for each rule (recommendation, warning, or severe).

To start the analysis, right-click a selected file or project. Select Software Analyzer and the rule set that was previously defined. The Software Analyzer Results view displays the list of the broken rules in a tree-like structure. The first level represents the category, the second level is the rule, and the last level lists the instances in error. To see the details of a violation, right-click the file and select View Result. The generated file opens in the editor where the violation was detected and the line in violation is highlighted.

After correcting the violations and saving, you can start the analysis again to check that all the rules are respected.

For a complete documentation on the Software Analyzer, see the Rational Developer for System z® online help, in the COBOL Code Review item of the Developing section.

Design Entities Analysis

The Rational Programming Patterns rules that analyze the design entities are gathered under Design Entities Analysis for RPP MAF.
  • The All Entities category contains the following rules:

    • A non-blank label is mandatory on design entities
    • At least one keyword is mandatory on design entities

  • The Generated Entities category contains the following rule:
    • A generated entity must have its name and external name equivalent

  • The Segment Entities category includes the following rules:

    • A Segment must use only defined Data Elements
    • Avoid calling the same Data Element multiple times in a Segment

Specific COBOL Code Review

Some rules apply only to the specific code that is inserted by the user in a generated COBOL file.
The Rational Programming Patterns rules are gathered under COBOL Code Review RPP. They are all prefixed by RPP /.

The Naming Conventions, Performance, and Program Structures rules are equivalent to the rules of Rational Developer for System z, but they restrict the control to specific code portions. On the other hand, the Pattern Driven Programming and Syntax Error rules are specific and have no equivalent in Rational Developer for System z.


Feedback