Defining report forms

Start of changeWhen none of the existing report forms show the fields you want, you can create a new report form.End of change

Form-based reporting is a two step process:
  1. Design the report format by defining a new report form or editing a sample one.
  2. Assign the report form to the report and submit for batch execution.

We will now design a report to show transaction performance on an hourly basis. In every hour, we want the report to show a summary of every transaction that ran in that hour.

To define the report form:
  1. Select option 3 from the Primary Option Menu.
  2. The Report Forms list contains only the report form you previously imported. Enter the NEW command to create a new report form.
       File  Confirm  Samples  Options  Help 
     ──────────────────────────────────────────────────────────────────────────────
                                      Report Forms                  Row 1 to 1 of 1 
     Command ===> NEW                                              Scroll ===> PAGE
    
     Report Forms Data Set . . : xxxx.CICSPA.FORM                        
    
     /   Name    Type              Description                Changed        ID    
        ABNDLST  LIST    Transaction Abend List           2015/12/15 00:00 CICSPA
     ******************************* Bottom of data ********************************
     
  3. Start of changeYou are prompted to select the report form type.
    • Performance to specify a Performance List (LIST), Performance List Extended (LISTX), or Performance Summary (SUMMARY) report form.
    • Statistics to specify a Start of changeStatistics List (STATLST) orEnd of change Statistics Summary (STATSUM) report form.
    For this tutorial, select Performance.End of change
  4. A New Report Form window is displayed so you can specify defining characteristics, such as the name, type, and CICS® Version (VRM). Alternatively, you can choose to model the new report form on an existing one.
      File  Systems  Options  Help                                                
    ------------------------------------------------------------------------------
                                   New Report Form                                
    Command ===> _________________________________________________________________
                                                                                  
    Specify new Start of changePerformance End of changeReport Form options.                                              
                                                                                  
    Name . . . HOURMON_  Version (VRM) . . . Start of change700End of change  +             
                                                                                  
    System Selection:             Field Categories:                               
     APPLID  . . . . ________  +  _  Select to specify Field Categories           
     MVS Image . . . ________                                                     
                                                                                  
    Form Type or Model:                                                           
    3  1. List                    4. Model (Report Form)              
       2. List Extended (Sorted)  5. Model (HDB Template)                         
       3. Summary                                                                 
                                                                                  
    Model . . . . . . . . . . ________  +                                         
    Report Forms Data Set . . ______________________________________________  +   
    Repository  . . . . . . . ______________________________________________  +   
                                                                                  
    Specify the following details:
    • Form name HOURMON to indicate hourly monitoring
    • Start of changeVRM 700 to populate the default report form with fields relevant to CICS Transaction Server V5.3End of change
    • Form type 3 to create a SUMMARY report form relevant to Performance Summary reports
    Then press Enter to display the report form.
  5. If the report form does not meet your reporting requirements, you can change it. Because we want to report by hourly intervals, we will add the START field at the top of the Form. There are various ways to do this, but we will describe one:
    1. Change the page width from the default value 132 to 140 to allow for the addition of the 8 byte START field (otherwise the last field SC31UHWM will not fit on the report line).
    2. Enter line action R to repeat the first row.
    3. Change the first row to specify field name START, sort order A (ascending), and format type TIMES.
       File  Edit  Confirm  Upgrade  Profiling  Options  Help
    –------------------------------------------------------------------------------
                        EDIT SUMMARY Report Form - HOURMON    Row 1 of 337 More: > 
    Command ===> ________________________________________________ Scroll ===> PAGE 
                                                                                   
    Description  . . . Summary Report Form_____________  Version (VRM): Start of change700End of change        
                                                                                   
    Selection Criteria:                                                            
     _  Performance                                      Page width . . 140_       
                                                                                   
        Field    Sort                                                              
    /   Name +   K  O Type    Fn   Description                                     
    R_  TRAN____ K  A _______ ___  Transaction identifier                          
    __  TASKCNT_    _ _______ ___  Total Task count                                
    __  RESPONSE    _ _______ AVE  Transaction response time                       
    __  RESPONSE    _ _______ MAX  Transaction response time                       
    __  DISPATCH    _ TIME___ AVE  Dispatch time                                   
    __  CPU_____    _ TIME___ AVE  CPU time                                        
    __  SUSPEND_    _ TIME___ AVE  Suspend time                                    
    __  SUSPEND_    _ TIME___ MAX  Suspend time                                    
    __  DISPWAIT    _ TIME___ AVE  Redispatch wait time                            
    __  FCWAIT__    _ TIME___ AVE  File I/O wait time                              
    __  FCAMCT__    _ _______ AVE  File access-method requests                     
    __  IRWAIT__    _ TIME___ AVE  MRO link wait time                              
    __  SC24UHWM    _ _______ AVE  UDSA HWM below 16MB                             
    __  SC31UHWM    _ _______ AVE  EUDSA HWM above 16MB                            
    __  EOR_____    _ _______ ___  ---------------- End of Report ---------------- 
    __  EOX_____    _ _______ ___  ---------------- End of Extract --------------- 
    __  ABCODEC_ K  * _______ ___  Current ABEND code                              
    __  ABCODEO_ K  * _______ ___  Original ABEND Code                             
    __  ACAPPLNM K  * _______ ___  Application context application name            
    __  ACMAJVER K  * _______ ___  Application context application major version   
    __  ACMINVER K  * _______ ___  Application context application minor version   
    __  ACMICVER K  * _______ ___  Application context application micro version   
    __  ACOPERNM K  * _______ ___  Application context operation name              
    __  ACPLATNM K  * _______ ___  Application context platform name               
    __  ALERT___    _ _______ SEV  Total Alert count or percentage                 
    __  APPLID__ K  * _______ ___  CICS Generic APPLID                             
    Notes:
    • The order of the fields in the report form (top-to-bottom) defines the order of the columns in the report (left-to-right).
    • EOR indicates where the report line ends. CICS PA automatically adjusts this for you to ensure that the fields you specify fit within the specified page width (default 132). You can move EOR and adjust the page width to fit more or fewer fields in your report. Fields below EOR are not reported. Move fields above EOR to include them in the report.
    • EOX signals the end of the extract record. There are no restrictions on record length. Fields above EOX are included in the extract, those below are ignored. If EOX is not specified, EOR is used. To include all fields in the extract, position EOX at the bottom of the list after the last field.
    • You have the option to specify Performance Selection Criteria to filter the data that is included in the report or extract.
  6. To complete the report form specification:
    • Provide a description that will help you identify this form in a list of forms.
    • Scroll right (F11) to view more columns and enter a meaningful report title.
    • Optionally, delete the unwanted fields below EOR that will not be reported.
       File  Edit  Confirm  Upgrade  Profiling  Options  Help
    –------------------------------------------------------------------------------
                        EDIT SUMMARY Report Form - HOURMON     Row 1 of 17 More: > 
    Command ===> ________________________________________________ Scroll ===> PAGE 
                                                                                   
    Description  . . . Transaction monitoring by hour__  Version (VRM): Start of change700End of change        
                                                                                   
    Selection Criteria:                                                            
     _  Performance                                      Page width . . 140_       
                                                                                   
        Field    Sort                                                              
    /   Name +   K  O Type    Fn   Description                                     
    __  START___ K  A TIMES__ ___  Task start time                                 
    __  TRAN____ K  A _______ ___  Transaction identifier                          
    __  TASKCNT_    _ _______ ___  Total Task count                                
    __  RESPONSE    _ _______ AVE  Transaction response time                       
    __  RESPONSE    _ _______ MAX  Transaction response time                       
    __  DISPATCH    _ TIME___ AVE  Dispatch time                                   
    __  CPU_____    _ TIME___ AVE  CPU time                                        
    H_  SUSPEND_    _ TIME___ AVE  Suspend time                                    
    __  SUSPEND_    _ TIME___ MAX  Suspend time                                    
    __  DISPWAIT    _ TIME___ AVE  Redispatch wait time                            
    __  FCWAIT__    _ TIME___ AVE  File I/O wait time                              
    __  FCAMCT__    _ _______ AVE  File access-method requests                     
    __  IRWAIT__    _ TIME___ AVE  MRO link wait time                              
    __  SC24UHWM    _ _______ AVE  UDSA HWM below 16MB                             
    __  SC31UHWM    _ _______ AVE  EUDSA HWM above 16MB                            
    __  EOR_____    _ _______ ___  ---------------- End of Report ---------------- 
    __  EOX_____    _ _______ ___  ---------------- End of Extract --------------- 

    To help you understand the formatted report, familiarize yourself with the structure of the report form. To see all the columns of information, scroll right (F11) or left (F10) to cycle through four views: the field descriptions, data dictionary information, distribution (range) specifications, and performance alert specifications. The default values are appropriate for this exercise. For help on any column, position the cursor within the column and press Help (F1). For an expanded description of any field, enter line action H against the field name.

  7. Exit from the report form to save it. The list of Report Forms is displayed.
       File  Confirm  Samples  Options  Help
     ------------------------------------------------------------------------------
                                      Report Forms             Member HOURMON saved
     Command ===> ________________________________________________ Scroll ===> CSR_
     
     Report Forms Data Set  . . . xxxx.CICSPA.FORM
     
     /   Name    Type              Description              Changed        ID
     _  HOURMON  SUMMARY Transaction monitoring by hour   2010/10/10 23:18 SEC
     ******************************* End of list *********************************
     
  8. Exit the Report Forms dialog and return to the Primary Option Menu.

With the report form defined, you can now use it to format your report.