The RainCode Roadmap for PL/1 is a RainCode product, which produces documentation out of possibly large amounts of PL/1 source code automatically, in order to ease maintenance, and, more generally, deliver usable knowledge about existing systems.

Modules

Each source code module is rendered in HTML form, lines are numbered, colour codes are used to emphasize various parts (SQL statements, CICS statements, comments, etc.) and hypertext tags are used to navigate comfortably in the source file, going from a variable use to the matching definition, etc.

Groups

The user can also define groups, and indicate which of the modules belong to each group. A module can belong to more than a single group, it is not an exclusive classification.

Typically, groups are defined by a technical criterion (batch, interactive, using a relational database or not) or by an application-level criterion (payroll, accounting, etc.)

The documentation generated by the RainCode Roadmap can be viewed by group: the user can explicitly ask to view the information of one group only, ignoring the modules of other groups. This filter-like facility comes handy when dealing with metrics applied to excessively large portfolios: for instance, if one deals with 2000 batch programs and 100 interactive programs, the ability to define ad-hoc groups allows to view metrics (including statistical distribution) measured for the 100 interactive programs, without the clobbering of the 2000 batch programs.

Cross-references

Global resources are listed together with the places where they are used, across the entire portfolio. Such global resources include:

• SQL tables,
• CICS maps,
• CICS files,
• CICS queues,
• Copybooks.

Metrics

The PL/1 Roadmap provides a set of predefined metrics. Besides these metrics, additional user-defined ones may easily be added to the RainCode Roadmap.

Metrics about the code complexity:

• Cyclomatic Complexity
• Maximum nesting level
• Number of statements

Metrics about CICS:

• Number of CICS statements
• Number of different CICS maps
• Number of different CICS queues
• Number of different CICS files

Metrics about SQL:

• Number of SQL statements
• Number of different SQL tables

Metrics about lines:

• Number of lines
• Number of blank lines
• Number of code lines
• Number of comment lines
• Number of mixed code and comment lines

Copybooks

As mentionned above, includes and their uses are listed. Moreover, the uses of variables defined in these includes are collected and listed in a central way. This allow to easily:

• find unused variables,
• measure the impact of changes to these variables.

Example

Please register here and log in. On the download page, you will have access to a PL/1 Roadmap example. This example shows most of the PL/1 Roadmap standard features.