Architecture Report Utility

The architecture report provides listings of all the components in a given application. The report generator examines the requested architecture and all of its references, and then constructs a formatted report. The report lists software components in each type referenced by the architecture. One advantage of the report is that it helps you to eliminate unnecessary code. The title page of the report identifies the date and time SCLM generated the report, names the architecture member you requested, and is based on the report cutoff you select. It also identifies any alternate project definition used.

The report is divided into two sections:

Architecture
Lists all architecture and source members subordinate to a given architecture to the report cutoff you specify. The architecture information is particularly useful during the development stages of a project to identify the current status of the application architecture. It is also useful at any time to determine a list of the software components of an application.

The report uses an indentation format to present a visual concept of the structure of the application. It also lists the number architecture types processed.
Cross-reference
Lists all the members, by type, that are referenced by members in the first part of the report. Use this information to determine the origin of a member.

Figure 1 shows an example of an architecture report.

SCLM displays the panel in Figure 1 when you select Option 5, Architecture Report, on the Utilities panel.

Note: Compilation unit dependencies are not used to generate the architecture report.

The architecture report is divided into three parts: a header, architecture information, and cross-reference information. The architecture report header lists the accounting and architecture selection criteria plus the customization parameters you specify. The architecture information lists all of the software components, by type, in a specified application. This part of the report can help you eliminate unnecessary code. The cross-reference information indicates where a given software component is embedded in the architecture of the application.

Figure 1. SCLM Architecture Report (FLMRA#P)

  Menu  SCLM  Utilities  Jobcard  Help
................................................................................
                          SCLM Architecture Report Utility - Entry Panel

Report input:
  Project  . . : PROJ1         Alternate - INT
  Group  . . . . DEV1    
  Type . . . . .                        Report
  Member . . . .                        Cutoff  .  . 6  1. HL
                                                       2. LEC
                                                       3. CC
                                                       4. Generic
                                                       5. Top Source
                                                       6. None

Output control:
               Ex Sub                   Process . . 1  1. Execute
  Messages . . 3  3   1. Terminal                      2. Submit
  Report . . . 3  3   2. Printer
                      3. Data set       Printer . .  
                      4. None           Volume  . . ______

Command ===> _________________________________________________________________
 F1=Help      F2=Split    F3=Exit      F7=Backward F8=Forward   F9=Swap
F10=Actions  F12=Cancel

The fields on the SCLM Architecture Report Utility - Entry panel are:

Project

The project that you specified on the SCLM Main Menu. An Alternate field also appears if you specified an alternate project definition.

Group

The group used to identify the lowest group in the hierarchy where the architecture begins.

Type

The type containing the architecture definition that controls the selected member.

Member

The member containing the architecture definition.

Report Cutoff

You must specify one of the following report cutoff values (which determine the depth of the report):

HL (High-level): To list only the HL architecture members in the application represented by the architecture member you specified in the Member field.
LEC (Linkedit control): To list all of the HL and LEC architecture members in the application represented by the architecture member you specified in the Member field.
CC (Compilation control): To list all of the HL, LEC, CC, Generic, and INCLD'ed members in the application represented by the architecture member you specified in the Member field.
GEN (Generic): To list all of the HL and generic architecture members in the application represented by the architecture member you specified in the Member field.
Top Source: To list all of the HL, LEC, CC, Generic, and INCL'ed members and the top source members in the application represented by the member you specified in the Member field.
None: To list all HL, LEC, CC, and generic architecture members in each of the types and all source member names down to the lowest include group in the application represented by the architecture member you specified in the Member field.

The default value for Report Cutoff is None.

Output control

Specify the destination for messages and report when they are executed (Ex) or submitted (Sub), by entering the corresponding destination number: 1 for Terminal, 2 for Printer, 3 for Dataset, or 4 for None.

Process

You can call the processing part of the architecture report utility from the interactive or batch environment by selecting Execute or Submit, respectively. If you request batch processing by selecting Submit, you must specify the job statement information that is used in the JCL generated for batch processing.

For information about using a unique jobname on the jobcard in batch processing, see Batch Processing.

Printer

Specify the printer output class.

Volume

Specify the volume on which SCLM should save data sets.