RPTARCH—Generate an SCLM Architecture Report

The RPTARCH service provides a list of all the components in a given application. The report generator examines the requested architecture and all of its references, and then constructs an indented report of the architecture. The report lists software components in each type referenced by the architecture to help you eliminate unnecessary code.

Command invocation format


>>-FLMCMD--RPTARCH,project,-+---------+--,group--,type---------->
                            '-prj_def-'                  

              .-NONE--------.                             
>--,member--,-+-------------+--,dd_rptmsgs--,dd_rptrept--------><
              +-HL----------+                             
              +-LEC---------+                             
              +-CC----------+                             
              +-GEN---------+                             
              '-TOP--SOURCE-'

Call invocation format

You cannot use call procedures to start this service.

ISPF interface panel

Figure 1. RPTARCH Service panel

   Menu  SCLM  Utilities  Help
 ──────────────────────────────────────────────────────────────────────────────
                   SCLM FLMCMD RPTARCH Service - Entry Panel

 SCLM Library:
    Project . . . SCLMTEST
    Alternate . .         
    Group . . . . DEV1    
    Type  . . . . SOURCE  
    Member  . . .         

 Report Cutoff       1. HL
                     2. LEC
                     3. CC
                     4. Generic
                     5. Top Source
                     6. None

 DD Names for output data sets:
    Error message data set           (Blank to write messages to the terminal)
    Report data set  . . .           (Blank to write report to the terminal)
 Command ===>                                                                  
  F1=HELP      F2=          F3=END       F4=DATASETS  F5=FIND      F6=CHANGE
  F9=SWAP     F10=LEFT     F11=RIGHT    F12=SUBMIT

Parameters

project

The project name. The maximum parameter length is 8 characters.

prj_def

The project definition name to be used for generating the architecture report. It defaults to project. The maximum parameter length is 8 characters.

group

The group the report is to be generated from. The maximum parameter length is 8 characters. If information is not found at the specified group, RPTARCH searches up the hierarchy to the next layer.

type

The type containing the member to be reported on. The maximum parameter length is 8 characters.

member

The member to be reported on. The maximum parameter length is 8 characters.

HL|LEC|CC|GEN|TOP SOURCE|NONE

Indicates the cutoff (determines depth) for the architecture report.

The architecture report contains the following if you specify:

HL: The HL architecture members in the application represented by the architecture member you specified with the member parameter.
LEC: The HL and LEC architecture members in the application represented by the architecture member you specified with the member parameter.
CC: The HL, LEC, and CC architecture members in the application represented by the architecture member you specified with the member parameter.
GEN: The HL and generic architecture members in the application represented by the architecture member you specified with the member parameter.
TOP SOURCE: The HL, LEC, CC, and generic architecture members and top source members in the application represented by the architecture member you specified with the member parameter.
NONE: The HL, LEC, CC, and generic architecture members in each of the types and all source members down to the lowest include group in the application represented by the architecture member you specified with the member parameter.

The maximum parameter length is 24 characters. The default value is NONE.

dd_rptmsgs

The ddname indicating the destination of the RPTARCH service messages. If you specify a blank ddname, SCLM routes the RPTARCH service messages to the default output device, such as your terminal. Otherwise, before you call the RPTARCH service, you must allocate the ddname. The following attributes should be used: RECFM=F, LRECL=80, BLKSIZE=80. The maximum parameter length is 8 characters.

dd_rptrept

The ddname indicating the destination of the architecture report. If you specify a blank ddname, SCLM routes the architecture report to the default output device, such as your terminal. Otherwise, before you call the RPTARCH service, you must allocate the ddname; the following attributes should be used: RECFM=FBA, LRECL=80, BLKSIZE=3120. The maximum parameter length is 8 characters.

Return codes

Additional special services messages are written to the FLMMSGS ddname. See SCLM service messages for more information.

Other return codes might be produced by the FLMCMD processor. See SCLM service return codes for more information about these.

Possible return codes are:

0: Normal completion. See the SCLM messages for more information.
4: Warning condition. See the SCLM messages for more information.
8: Error condition. See the SCLM messages for more information.

Example of command invocation

FLMCMD RPTARCH,PROJ1,,USER1,SOURCE,FLM01MD1,NONE

This service command generates an architecture report for the FLM01MD1 member of the SOURCE type in the USER1 group. The project name is PROJ1. The report cutoff is NONE, and SCLM sends messages and the architecture report to your terminal.