Tailoring the HDB report format

To change the format of the report or to report additional information from the HDB then you need to use a Report Form. Report Forms are defined outside the HDB menu using option 3 Report Forms from the CICS PA Primary Option Menu.

In the following example we have created a Summary Report Form called HDBFORM1.
Figure 1. Edit Summary Report Form
  File  Edit  Confirm  Upgrade  Profiling  Options  Help
------------------------------------------------------------------------------ 
                    EDIT SUMMARY Report Form - HDBFORM1                More: >
Command ===> ________________________________________________ Scroll ===> CSR_
                                                                              
Description  . . . Summary Report Form_____________  Version (VRM): 700       
                                                                              
Selection Criteria:                                                           
 _  Performance                                      Page width . . 132_ 
                                                                              
   Field    Sort                                                                  
/  Name +   K  O Type    Fn   Description                                       
__ TRAN____ K  A _______ ___  Transaction identifier                            
__ TASKCNT_      _______ ___  Total Task count                                  
__ RESPONSE      _______ AVE  Transaction response time                         
__ RESPONSE      _______ DEV  Transaction response time                         
__ DISPATCH      TIME___ AVE  Dispatch time                                     
__ DISPATCH      COUNT__ AVE  Dispatch time                                     
__ CPU_____      TIME___ AVE  CPU time                                          
__ SUSPEND_      TIME___ AVE  Suspend time                                      
__ SUSPEND_      COUNT__ AVE  Suspend time                                      
__ DISPWAIT      TIME___ AVE  Redispatch wait time                              
__ FCWAIT__      TIME___ AVE  File I/O wait time                                
__ FCWAIT__      COUNT__ AVE  File I/O wait time                                
__ IRWAIT__      TIME___ AVE  MRO link wait time                                
__ IRWAIT__      COUNT__ AVE  MRO link wait time                                
__ EOR_____                   ---------------- End of Report ----------------   
This Form will change the default HDB report in a number of ways:
  1. The Form does not specify a time stamp key. This will cause the report to be summarized by Transaction ID only. The interval records of the HDB is accumulated for each Transaction ID.
  2. The count components of the Clock fields have been included. By default the HDB Summary report only displays the average of the time components.
  3. Response time is also to be reported as a Standard Deviation. This will provide an indication of how response time varies. The higher the standard deviation the more that response time varies.
When you next report against the HDB, you can use this Report Form. On the Run Report panel, press Prompt (F4) to select from a list of Report Forms.
Figure 2. Run Summary HDB report specifying a Report Form
  File  Options  Help                                               
------------------------------------------------------------------------
                     Run SUMMARY HDB Report - CICSP1H               
Command ===> ___________________________________________________________
                                                                    
Specify Report request options then press Enter to continue submit. 
                                                                    
Reporting Options:                      ----- Report Interval ------
 Report Form  . . HDBFORM1  +                YYYY/MM/DD  HH:MM:SS.TH
                                        From 2004/12/07  09:00:00.00
                                        To   2004/12/07  16:00:00.00
                                                                    
Time Interval  . . 01:00:00  (hh:mm:ss)                             
                                                                    
Enter "/" to select option                                          
/  Edit JCL before submit                                           
                                                                    
HDB contains data from 2004/12/07 09:00 to 2004/12/07 16:00.        
                                                                      
 F1=Help     F3=Exit     F4=Prompt   F6=Resize  F10=Actions F12=Cancel
When a Report Form is specified, the command input changes to include the FIELDS operand to indicate that customized reporting is required.
Figure 3. Edit JCL for Summary HDB report specifying a Report Form (FIELDS operand)
EDIT       JCH.SPFTEMP2.CNTL                               Columns 00001 00072 
Command ===> ________________________________________________ Scroll ===> CSR_ 
****** ***************************** Top of Data ******************************
000001 //CICSPA  JOB ,NOTIFY=&SYSUID                                           
000002 //*  CICS PA V5R3 HDB REPORT JCL                                        
000003 //CICSPA   EXEC PGM=CPAMAIN                                             
000004 //STEPLIB  DD DISP=SHR,DSN=CPA.V5R3M0.SCPALINK                          
000005 //CPAHDBRG DD DISP=SHR,DSN=CICSPROD.CICSPA.HDB.REPOSTRY                 
000006 //SYSPRINT DD SYSOUT=*                                                  
000007 //* Command Input                                                       
000008 //SYSIN DD *                                                            
000009 * HDB=CICSP1H                                                           
000010 * Description=Summary HDB for CICSP1                                    
000011          CICSPA SMFSTART(2004/12/07,09:00:00.00),                       
000012                  SMFSTOP(2004/12/07,16:00:00.00)                        
000013          CICSPA NOAPPLID,                                               
000014                 LINECNT(60),PRECISION(4),                               
000015                 FORMAT(':','/'),                                        
000016             HDB(OUTPUT(HDBR0001),REPORT(CICSP1H),                       
000017                 INTERVAL(01:00:00),NOTOTALS)                            
000018                 FIELDS(TRAN,                    
000019                        TASKCNT,                 
000020                        RESPONSE(AVE),           
000021                        RESPONSE(DEV),           
000022                        DISPATCH(TIME(AVE)),     
000023                        DISPATCH(COUNT(AVE)),    
000024                        CPU(TIME(AVE)),          
000025                        SUSPEND(TIME(AVE)),      
000026                        SUSPEND(COUNT(AVE)),     
000027                        DISPWAIT(TIME(AVE)),     
000028                        FCWAIT(TIME(AVE)),       
000029                        FCWAIT(COUNT(AVE)),      
000030                        IRWAIT(TIME(AVE)),       
000031                        IRWAIT(COUNT(AVE))))     
000032 /*                                                                      
000033 //HDB00001 DD DISP=SHR,DSN=JCH.CICSP1H.D03219.T092846.HDB               
****** **************************** Bottom of Data ****************************
Enter SUBmit in the command line to submit the job to run the report.
Successful completion of the Report request will generate an HDB Summary report.
Figure 4. HDB Summary report formatted using a Report Form
 V5R3M0                                                  CICS Performance Analyzer
                                                        Historical Database Summary
 
HDBR0001 Printed at 12:34:56 02/15/2015     Data from 09:00:00 12/07/2004 to 16:00:00 12/07/2004                Page     1
                                                                                                                                   
                    Avg    S Dev      Avg      Avg      Avg      Avg      Avg      Avg      Avg      Avg      Avg      Avg         
 Tran    Tasks Response Response Dispatch Dispatch User CPU  Suspend  Suspend DispWait  FC Wait  FC Wait  IR Wait  IR Wait         
                   Time     Time     Time    Count     Time     Time    Count     Time     Time    Count     Time    Count         
 ABRA     7854    .2729    .0147    .0009        3    .0006    .2720        3    .0000    .0000        0    .2719        2         
 ASIX     9327    .2184    .2949    .0009        2    .0006    .2175        2    .0000    .0000        0    .2175        1         
 ATRA    21024   1.6067    .4389    .0008        2    .0005   1.6058        2    .0000    .0000        0   1.6057        1         
 BLIX     7328    .0845    .0043    .0008        2    .0005    .0836        2    .0000    .0000        0    .0835        1         
 CRVI     9203    .0004    .0001    .0004        1    .0000    .0000        1    .0000    .0000        0    .0000        0         
 CSMI     2372    .0107    .0092    .0006        3    .0004    .0101        3    .0000    .0000        0    .0101        2         
 DEBT    13293    .0038    .0011    .0006        2    .0004    .0032        2    .0000    .0000        0    .0031        1         
 OPIC     1275    .0236    .0076    .0008        2    .0006    .0227        2    .0000    .0000        0    .0227        1         
 RESU     5674    .0341    .0132    .0009        2    .0006    .0332        2    .0000    .0000        0    .0332        1         
 RGYM     7485    .0056    .0009    .0010        2    .0007    .0046        2    .0000    .0000        0    .0045        1         
 T050    18290    .0296    .0121    .0009        3    .0006    .0288        3    .0000    .0000        0    .0286        2         
 T096      123    .0398    .0098    .0012        2    .0005    .0386        2    .0001    .0000        0    .0385        1         
 XYLO    13921    .0010    .0002    .0009        1    .0001    .0001        1    .0000    .0000        0    .0000        0         
The Report Form (and resultant FIELDS operand) changes the report to show a summary by Transaction ID over the entire reporting interval. Compare this report output to Figure 4.