Reports

This chapter includes the following topics:

CTOFANCI Reports

A number of reports are generated by each run of utility CTOFANCI. Each report contains information describing certain aspects of your current console management configuration and how it was handled by utility CTOFANCI. This information can help you plan and subsequently manage your conversion effort.

Each CTOFANCI report is produced in a file referenced by a separate DD statement. The following reports are generated:

Table 16 CTOFANCI Reports

Report

Description

RPTALL

General Message Report

RPTWARN

Warning Message Report

RPTFILES

Input/Output File Report

RPTRULES

Rule Report

RPTSRC

Rule Source Report

Each of these reports is described in detail below.

Reports RPTRULES and RTPSRC have a fixed format. You can view these reports as generated, or redirect them to a disk and perform your own sorting and reporting from the disk files. If a unit of information produced by the utility cannot fit in a fixed-size report field, an overflow occurs and the data is replaced with the symbol "+".

A special layout member describes the format of each report (for an explanation, see the following section).

RPTALL – General Message Report

Report RPTALL contains a copy of the control statements specified for utility CTOFANCI (that is, TYPERUN and INCLUDE statements) and all messages that were generated by the utility.

Messages generated by utility CTOFANCI are described in detail in C Messages.

RPTWARN – Warning Message Report

Report RPTWARN contains all warning, error, and severe error messages issued by utility CTOFANCI. The messages in this report are a subset of the messages listed in report RPTALL.

Messages generated by utility CTOFANCI are described in detail in C Messages.

This report can be used to review problems encountered by utility CTOFANCI and to determine what manual adjustments are necessary.

RPTFILES – Input/Output File Report

This report describes all input and output datasets processed or created by utility CTOFANCI. The report also indicates the dataset ID that was assigned to each input dataset name.

The following fields are included in report RPTFILES:

Table 17 Fields in RPTFILES Report

Field

 Description

DSN ID

Dataset ID of the dataset. Each dataset processed or created by utility CTOFANCI is assigned an ID number. This dataset ID is used in place of the complete dataset name in other reports produced by the utility.

  • Dataset IDs of input datasets are numbered D001, D002, and so on.
  • Dataset IDs of output datasets are numbered D101, D102, and so on.

If more than 100 datasets are selected as input for the utility, output dataset IDs are assigned numbers starting with the lowest multiple of 100 not already assigned to an input dataset.

IN/OUT

Whether the file described in this line is an input file or an output file. Possible values are:

  • IN—Input file.

  • OUT—Output file.

DATASET STATUS

Indication of how the dataset was handled by utility CTOFANCI. Valid values:

  • UNCHANGED – This value is assigned to input datasets. These datasets are not modified by utility CTOFANCI.

  • NEW – The dataset was created by this run of utility CTOFANCI.

  • UPDATED – The dataset existed prior to, but was modified during, this run of the utility.

DATASET NAME

Complete dataset name.

MEMBERS

Member names or masks specified in INCLUDE statements of the utility, which were used to select the dataset. This field is not relevant for output datasets.

The following report segment shows a sample of RPTFILES output.

Figure 3 Sample RPTFILES Output

Copy 
---------------------------------------------------------          
CTOFANCI:  DATASET INDEX REPORT (RPTFILES)  RUN ID = D1027.T1016         
---------------------------------------------------------                 
                                                                            
 DSN  IN/ DATASET                                                           
 ID   OUT STATUS    DATASET NAME                                 MEMBERS    
 ---- --- --------- -------------------------------------------- --------   
 D001 IN  UNCHANGED CTO.RULES.TEST.SPECIAL                       SPCLA2LN   
 D101 OUT NEW       CTO.OUTPUT                                   -

RPTRULES – Input Rule Report

Report RPTRULES describes input rules or members that were processed by the utility. Each line of the report describes one input rule regardless of whether it was the only rule in the input member.

  • Many input members contain only one rule. Each of these members is described in a single line of report RPTRULES.
  • Sometimes multiple rules are defined in a single input member. Each of these rules is described in a separate line of report RPTRULES.

The following fields are included in report RPTRULES:

Table 18 Fields in the RPTRULES Report

Field

Description

IN DSN ID

Dataset ID of the PDS in which the member containing the input rule was found. For more information about dataset IDs, see RPTFILES – Input/Output File Report

MEMBER NAME

Input member name.

WARN

Warning indicator field. This field contains an asterisk (*) if a warning message was issued while processing the rule described in this line of the report. If no warning was issued, this field is blank.

INPUT RULE SEQ NUM

Unique sequence number of the input rule within the input member (R0001, R0002, and so on.).

TOTAL MEM

Number of lines in the input member (including all rules in the member). The same value appears for all the rules in the same input member.

SCRIPT

Number of lines (in the input member) that contain text that is not a comment (for example, /* comment */), sequence number (columns 73 - 80 in numbered FB files or columns 1 - 8 in numbered VB files), or spaces.

The same value appears for all the rules in the same input member.

RULE

Number of lines of code in the rule (excluding comment lines and blank lines).

PRODUCT NAME

The product (or the language) associated with the rule. Utility CTOFANCI currently recognizes the following types of member content:

  • CA-OPS

  • CA-AUTOMATE

  • MVS Message Processing facility (MPF)

  • Native TSO REXX

  • MVS JCL

  • Documentation

  • Native TSO CLIST

  • NetView AOC

  • High level language (for example, C or PL/I)

  • Program in Assembler 370 or 390

  • Control-O Rule

  • PDSMAN($$$SPACE members)

EVENT TYPE CODE

The event type code of the input member or rule. The utility automatically assigns one of the supported event type codes to each input rule or member. Input members that do not contain rules are assigned an event type code according to the product or language of the member. The following event type codes are used:

  • AOC—NetView AOC CLIST member
  • ASM—Assembler member

  • CLS—CLIST member

  • CMD—Command rule

  • DOC—Documentation member

  • DOM—Message deletion event rule

  • EOJ—End of job rule

  • HLL—High level language member

  • JCL—JCL member

  • MSG—Message rule

  • OMG—OMEGAMON exception rule

  • OPX—OPS/REXX member

  • REQ—Explicit request member

  • REX—REXX member

  • SCR—Screen event rule

  • SEC—Security exception rule

  • TOD—Time of day rule

  • UNK—Unknown event type

  • VAR—Change of a Global variable rule

OUT DSN ID

Dataset ID of the output dataset to which the corresponding output rule or member is written.

OUTPUT TABLE/MEMBER

Member or Rule Table name to which the corresponding output rule or member is written.

INTENDED OUTPUT MEMBER

Name of the member or Rule table to which the corresponding output rule must have been written (for rules or members that were assigned a duplicate name (@DUPnnnn).

If the rule was actually written to the intended member, the Output Table or Member and Intended Output Table or Member fields contain the same value.

FULL DETAILS

Information about the event that triggers the rule (such as, message ID, time specification, name of a Global variable.).

DETAILS SUMMARY

A subset of the rule details supplied in the Detail field (for example, message ID, jobname).

The following screen segment contains part of a RPTRULES report. Note that this report contains additional columns not shown in this sample.

Figure 4 Sample RPTRULE Report

Copy 
 ------------------------------------------------------------------------------    
  CTOFANCI:  INPUT RULE SUMMARY REPORT (RPTRULES) RUN ID = D1027.T1256      
 ------------------------------------------------------------------------------
                                                                              
               W INPUT  NUM-OF-LINES                                          
 IN            A RULE  --------------          EVENT             OUT  OUTPUT  
 DSN  MEMBER   R SEQ   TOTL SCR-      PRODUCT  TYPE     DETAILS  DSN  TABLE/  
 ID   NAME     N NUM   MEM  IPT  RULE NAME     DESC     SUMMARY  ID   MEMBER  
 ---- -------- - ----- ---- ---- ---- -------- -------- -------- ---- --------
 D001 $$$SPACE   R0001    0    0    0 PDSMAN   -                              
 D001 C10ERR1    R0001   66   12   12 CLIST    CLIST             D101 MAIN    
 D001 DBASUN     R0001    4    1    1 UNKNOWN  UNKNOWN           D101 @DPL0001
 D001 IEF085I    R0001   10    1    1 CLIST    CLIST             D101 @DPL0002
 D001 INCBKUP    R0001   80   67   67 CLIST    CLIST             D101 @DPL0003

RPTSRC – Input Rule Source Report

Report RPTSRC contains the source lines of the input rules.

Each line of report RPTSRC contains 80 bytes of source code followed by a "sort-stub" (described below) that can be used to sort the report.

The lines of report RPTSRC are divided into title lines and text lines.

Title Lines

Title lines are provided in sets of three at the beginning of each rule in report RPTSRC.

The first and third header lines contain only dashes. The second line of the header contains 80 bytes of rule information extracted from the rule report (RPTRULES).

The following screen segment contains sample title lines (without the sort-stub):

Figure 5 RPTSRC Input Rule Source Report Title Lines

Copy 
 --------------------------------------------------------------------------------  
 D001 C10ERR1    R0001   66   12   12 CLIST    CLIST             D101 MAIN   ...
 --------------------------------------------------------------------------------

Each set of title lines is assigned line numbers A0001, A0002, and A0003 (in the sort-stub).

Text Lines

Text lines in report RPTSRC contain the text of rules selected as input for utility CTOFANCI. Text lines contain the original script lines without comments and without extra blanks.

The following screen segment contains sample text lines (without the sort-stub):

Figure 6 RPTSRC Input Rule Source Report Text Lines

Copy 
 PROC 1 SITE         GOTO MESSAGE   
 LINE1: +         
   SET &CIANUM = 1
   GOTO MESSAGE   
 LINE2: +         
   SET &CIANUM = 2
   GOTO MESSAGE   

Text lines are assigned line numbers beginning in the letter B in the sort-stub (for example, B0001, B0002, B0003).

Sort-Stubs in Report RPTSRC

A sort-stub is a string containing information that can be used to sort lines in report RPTSRC. Each record in the report RPTSRC contains a sort-stub (beginning in column 81). Information in the sort stub includes:

  • Dataset ID

  • Member name

  • Rule-sequence-number

  • Line number

  • Number of lines in member

  • Number of lines in the member not counting comments and blank lines

  • Number of lines in rule

  • Product code

  • Event type code

  • Output dataset ID

  • Output member name

Rules can be sorted into groups to suit your conversion work plan, while keeping all the lines of a given rule together.

The following screen segment contains sort-stubs:

Figure 7 RPTSRC Input Rule Source Report Sort-Stubs

Copy 
 D001 C10ERR1  R0001 A0001   66   12   12 CLS CLS          D101 MAIN 
 D001 C10ERR1  R0001 A0002   66   12   12 CLS CLS          D101 MAIN
 D001 C10ERR1  R0001 A0003   66   12   12 CLS CLS          D101 MAIN
 D001 C10ERR1  R0001 B0001   66   12   12 CLS CLS          D101 MAIN
 D001 C10ERR1  R0001 B0002   66   12   12 CLS CLS          D101 MAIN
 D001 C10ERR1  R0001 B0003   66   12   12 CLS CLS          D101 MAIN

When sorting report RPTSRC, the last four sort fields must be Dataset ID, Member name, Rule-sequence-number, and Line number (in that order). Including these sort fields in this way, ensures that each rule is sorted as a unit (meaning, title and text lines of each rule are kept together and in order).