Defining Report Forms

CICS PA Report Forms help you access the wealth of information contained in CICS® Transaction Server CMF Performance records. Report Forms allow you to design your own reports by specifying the fields to include, the order, the format of values, which summary statistics (average, total, minimum, maximum, percentile, range, or standard deviation), and what alert severity levels to include. For example, if you suspect that there is a performance problem with Transient Data, you can create a Report Form that focuses on that aspect of CICS performance.

A library containing more than 180 sample Report Forms is supplied with CICS PA. The samples are designed for specific purposes. For example, sample Report Forms TDLST and TDSUM are suggested formats to help you analyze Transient Data activity.

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. If the Report Forms data set does not exist, you will be prompted to create it. This data set is where your Report Forms are stored. Press Enter to create it.

    Press Enter to create the Report Forms data set with default attributes. (Otherwise, cancel and go to option 0.3 from the Primary Option Menu to specify the data set name of your choice.)

  2. The initial Report Forms list is empty. Enter the NEW command to create a new Report Form.
       File  Confirm  Samples  Options  Help
     ------------------------------------------------------------------------------
                                     Report Forms
     Command ===> NEW_____________________________________________ Scroll ===> PAGE
     
     Report Forms Data Set  . . .  xxxx.CICSPA.FORM
     
     /   Name     Type              Description              Changed        ID
     ********************************* End of list *********************************
     
    The Report Forms data set is empty. Use the NEW command to create a new
    Report Form.                                                           
  3. 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 Report Form options.                                              
                                                                                  
    Name . . . HOURMON_  Version (VRM) . . . 680  +             
                                                                                  
    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
    • VRM 680 to populate the default Report Form with fields relevant to CICS Transaction Server V5.1
    • Form type 3 to create a SUMMARY Report Form relevant to Performance Summary reports
    Then press Enter to display the Report Form.
  4. If the Report Form does not meet your reporting requirements, you can change it. Since 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 (hh:mm:ss).
       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): 680        
                                                                                   
    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.
  5. 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): 680        
                                                                                   
    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.

  6. 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 *********************************
     
  7. Exit Report Forms and return to the Primary Option Menu.

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


Information Information

Feedback


Timestamp icon Last updated: Thursday, 7 November 2013


http://pic.dhe.ibm.com/infocenter/cicsts/v5r1/topic//getting-started/cpags488.htm