SUMMARY Report Form

The SUMMARY Report Form defines the format and content of the following reports and extracts:

The Report Form defines the fields to be included, the order of the columns, sort sequence, statistical functions, and a title for the report.

The Report Form panel has three views as there are too many columns of information to display in a single screen view. Scroll Right (F11) to toggle between the views.

When you select to Edit or View a Report Form, the first view shown in Figure 1 is displayed by default. This first view displays field descriptions. The second view displays data dictionary information for each field. The third view is relevant only when you use the RNG (Range) function.

Figure 1. SUMMARY Report Form (with Default Form)
   File  Edit  Confirm  Upgrade  Profiling  Options  Help
 ------------------------------------------------------------------------------
                   EDIT SUMMARY Report Form - SAMPSUMM                  More: >
 Command ===> ________________________________________________ Scroll ===> PAGE
 
 Description  . . . . Summary Report Form_____________  Version (VRM): 680
 
 Selection Criteria:
   _  Performance                                        Page width . . 132_ 
 
     Field
 /   Name +   Sort  Type    Fn   Description
 __  TRAN____ K  A  _______ ___  Transaction identifier
 __  TASKCNT_    _  _______ ___  Total Task count
 __  ALERT___    _  _______ SEV  Total Alert count or percentage
 __  RESPONSE    _  _______ AVE  Transaction response time
 __  RESPONSE    _  _______ MAX  Transaction response time
 __  RESPONSE    _  _______ SEV  Transaction response time
 __  DISPATCH    _  TIME___ AVE  Dispatch time
 __  CPU_____    _  TIME___ AVE  CPU time
 __  CPU_____    _  TIME___ SEV  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
  F1=Help      F3=Exit      F4=Prompt    F5=Rfind     F7=Backward  F8=Forward
 F10=Actions  F11=Right    F12=Cancel                                        
   File  Edit  Confirm  Upgrade  Profiling  Options  Help
 ------------------------------------------------------------------------------
                   EDIT SUMMARY Report Form - SAMPSUMM                  More: >
 Command ===> ________________________________________________ Scroll ===> PAGE
 
 Description  . . . . Summary Report Form_____________
 
 Title  . . First half title__________________________________________________
            Second half title_________________________________________________
 
     Field                                                       - User Field -
 /   Name +   Sort  Type    Fn    Length  Dictionary Definition  Offset  Length
 __  TRAN____ K  A  _______ ___        8  TRAN     DFHTASK C001   ___     ___
 __  TASKCNT_    _  _______ ___        8  TASKCNT  CICSPA  X902   ___     ___
 __  ALERT___    _  _______ SEV        8  ALERT    CICSPA  A915   ___     ___
 __  RESPONSE    _  _______ AVE        8  RESP     CICSPA  D901   ___     ___
 __  RESPONSE    _  _______ MAX        8  RESP     CICSPA  D901   ___     ___
 __  RESPONSE    _  _______ SEV        8  RESP     CICSPA  D901   ___     ___
 __  DISPATCH    _  TIME___ AVE        8  USRDISPT DFHTASK S007   ___     ___
 __  CPU_____    _  TIME___ AVE        8  USRCPUT  DFHTASK S008   ___     ___
 __  CPU_____    _  TIME___ SEV        8  USRCPUT  DFHTASK S008   ___     ___
 __  SUSPEND_    _  TIME___ AVE        8  SUSPTIME DFHTASK S014   ___     ___
 __  SUSPEND_    _  TIME___ MAX        8  SUSPTIME DFHTASK S014   ___     ___
 __  DISPWAIT    _  TIME___ AVE        8  DISPWTT  DFHTASK S102   ___     ___
 __  FCWAIT__    _  TIME___ AVE        8  FCIOWTT  DFHFILE S063   ___     ___
 __  FCAMCT__    _  _______ AVE        8  FCAMCT   DFHFILE A070   ___     ___
  F1=Help      F3=Exit      F4=Prompt    F5=Rfind     F7=Backward  F8=Forward
 F10=Actions  F11=Right    F12=Cancel                                        
   File  Edit  Confirm  Upgrade  Profiling  Options  Help
 ------------------------------------------------------------------------------
                   EDIT SUMMARY Report Form - SAMPSUMM                  More: >
 Command ===> ________________________________________________ Scroll ===> PAGE
 
 Description  . . . . Summary Report Form_____________  Version (VRM): 680
 
 Selection Criteria:
   _  Performance                                        Page width . . 132_ 
 
     Field    Sort               --------- Range -------------
 /   Name +   K  O  Type    Fn   From        To        Report
 __  TRAN____ K  A  _______ ___  ___________ _________ _______
 __  TASKCNT_    _  _______ ___  ___________ _________ _______
 __  ALERT___    _  _______ SEV  ___________ _________ _______
 __  RESPONSE    _  _______ AVE  ___________ _________ _______
 __  RESPONSE    _  _______ MAX  ___________ _________ _______
 __  RESPONSE    _  _______ SEV  ___________ _________ _______
 __  DISPATCH    _  TIME___ AVE  ___________ _________ _______
 __  CPU_____    _  TIME___ AVE  ___________ _________ _______
 __  CPU_____    _  TIME___ SEV  ___________ _________ _______
 __  SUSPEND_    _  TIME___ AVE  ___________ _________ _______
 __  SUSPEND_    _  TIME___ MAX  ___________ _________ _______
 __  DISPWAIT    _  TIME___ AVE  ___________ _________ _______
 __  FCWAIT__    _  TIME___ AVE  ___________ _________ _______
 __  FCAMCT__    _  _______ AVE  ___________ _________ _______
  F1=Help      F3=Exit      F4=Prompt    F5=Rfind     F7=Backward  F8=Forward
 F10=Actions  F11=Right    F12=Cancel                                        
   File  Edit  Confirm  Upgrade  Profiling  Options  Help
 ------------------------------------------------------------------------------
                   EDIT SUMMARY Report Form - SAMPSUMM                  More: >
 Command ===> ________________________________________________ Scroll ===> PAGE
 
 Description  . . . . Summary Report Form_____________  Version (VRM): 680
 
 Selection Criteria:
   _  Performance                                        Page width . . 132_ 
 
     Field    Sort               ---- Alert ----
 /   Name +   K  O  Type    Fn   Severity Report
 __  TRAN____ K  A  _______ ___  ________ _______
 __  TASKCNT_    _  _______ ___  ________ _______
 __  ALERT___    _  _______ SEV  WARNING_ PERCENT
 __  RESPONSE    _  _______ AVE  ________ _______
 __  RESPONSE    _  _______ MAX  ________ _______
 __  RESPONSE    _  _______ SEV  CRITICAL COUNT__
 __  DISPATCH    _  TIME___ AVE  ________ _______
 __  CPU_____    _  TIME___ AVE  ________ _______
 __  CPU_____    _  TIME___ SEV  WARNING_ COUNT__
 __  SUSPEND_    _  TIME___ AVE  ________ _______
 __  SUSPEND_    _  TIME___ MAX  ________ _______
 __  DISPWAIT    _  TIME___ AVE  ________ _______
 __  FCWAIT__    _  TIME___ AVE  ________ _______
 __  FCAMCT__    _  _______ AVE  ________ _______
  F1=Help      F3=Exit      F4=Prompt    F5=Rfind     F7=Backward  F8=Forward
 F10=Actions  F11=Right    F12=Cancel                                        
The SUMMARY Report Form consists of the following:
Form Description
Up to 32 characters of text to describe the purpose of the Report Form. This description is shown on the Report Forms panel to help you identify the Forms in the list. It is initially set to Summary Report Form.
Version (VRM)
This identifies the CICS® release that this Report Form was created for. It determines which CMF fields are available for selection in this Report Form.
Selection Criteria
Optionally, you can specify Selection Criteria to filter the data on time periods and field values to restrict the reporting to only the data that is of interest to you.

When a report specifies a Report Form and both have Selection Criteria specified, records must match both criteria to be included in the report.

Line Actions: The available line actions are:
/
Display the selection list of line actions.
S
Select (edit) the Selection Criteria. See Specifying Selection Criteria for information on specifying Selection Criteria.
A
Activate the Selection Criteria so they are included for reporting. Selection Criteria can only be activated if you have specified at least one Select Statement and it is not excluded. An asterisk * indicates they are active.
D
Deactivate the Selection Criteria. Any you might have specified here will not be used in reporting.
Field rows
One row for each field. The order of the fields in the rows dictates the order of the columns in the report or extract. The fields have the following attributes: Name, Sort Sequence (only certain fields), Type (clock and time stamp fields only), Statistical Function (clock and count fields only), Description, Length, Dictionary Definition, Offset and Length (character user fields only).
Field Name
One of the following:
  • The CICS PA field name. For CICS CMF fields, this is usually the Informal name or similar. The names for user fields are derived from the MCT. Use line action S or Prompt (F4) to select from a list of fields applicable to this Form type and CICS version.
  • The Application Group name. For details, see Application Grouping.

    Before entering an Application Group name, enter APG in the Type column. Otherwise, the panel attempts to interpret the Application Group name as a CMF data field.

    Note: When you add an Application Group to a Report Form, CICS PA adjusts the EOR marker to allow for the maximum width of an Application name (32 characters). However, when producing a report, CICS PA adjusts the Application Group column width to fit the longest Application name in the report.
  • The special entry EOR.

    EOR is managed by CICS PA. It signals the end of the report line. The fields listed above EOR fit on the report line and are included in the report in the same order as they appear in the list. Those below EOR will not be reported and are ignored.

    CICS PA automatically sets EOR when the Report Form is created and resets it if necessary when the Form is changed to ensure that the maximum page width of 132 is not exceeded. In positioning EOR, CICS PA allows for one blank separator between each field.

    To produce a report line shorter than 132, either move EOR towards the top of the Form, delete unwanted fields, or move them below EOR.

  • The special entry EOX.

    EOX signals the end of the extract record. There are no restrictions on record length so EOX can be positioned anywhere in the list. EOX is initially positioned just below EOR. Fields above EOX are included in the extract, those below EOX are ignored. If EOX is not specified, EOR is used.

Sort Sequence
SUMMARY Sort fields are identified by K in the Sort K column. The report can be ordered in ascending or descending sequence, as specified in the Sort O column, A and D respectively.

Sort fields identify the grouping required for summarization, and can be START and STOP time, or any character field, including character user fields.

A Sort Order of * (asterisk) identifies a candidate sort field, and is ignored for reporting purposes.

To activate a candidate sort field, move it to the top of the Form and set Sort Sequence to A or D.

Key fields above EOR must appear first in the list of fields. The only fields that can appear ahead of a key field are TASKCNT or TASKTCNT. Key fields below EOR are ignored. Up to 8 key fields can be specified, and at least one must be specified. The order of the key fields in the list defines the sort and summarization precedence, with the first key field being the major sort field.

If you create a Report Form that consists entirely of key fields, with or without the special fields TASKCNT or TASKTCNT, then reports or extracts that you create using this Report Form will contain additional default fields. To suppress these default fields, specify at least one other field that is not a key field: for example, the numeric field RESPONSE. For more information, see Customizing or suppressing default fields.

Alternate Sequencing
In addition to the Sort Key fields, one numeric field can be selected as Ascending or Descending to activate Alternate Sequencing. This will change the order of report lines from Sort Key to numeric field sequence. For example, specify Alternate Sequencing of D for RESPONSE time to see the transactions with the highest response time at the top of the report. Note that grouping by Sort Key for summarization remains unaffected.
Format Type
Either:
  • The value APG, indicating that the Field Name refers to the name of an Application Group

    or

  • The presentation format of fields.
    For numeric (A) fields, optionally specify one of the following:
    K
    Divide value by 1000, typically for count fields.
    M
    Divide value by 1000000, typically for count fields.
    KB
    Kilobytes (divide by 1024), typically for storage fields.
    MB
    Megabytes (divide by 1024x1024), typically for storage fields.
    For clock (S) fields, you must specify either:
    TIME
    Accumulation of elapsed time in seconds with requested precision of 0.0001 to 0.000001. Default: TIME with PRECISION(4).
    COUNT
    Number of occurrences of the condition.
    For time (T) fields START and STOP, you must specify one of:
    TIMET
    Time in the format hh:mm:ss.thm
    TIMEM
    Time in the format hh:mm
    TIMES
    Time in the format hh:mm:ss (default)
    DATE
    Date in the format mm/dd/yyyy
    DATEISO
    Date in the format yyyy-mm-dd
    DATEM
    Date in the format mm/dd
    DATEYR
    Date in the format mm/dd/yy
    DATETIM
    Date and Time in the format yyyy-mm-dd hh:mm:ss
Fn (Function)
The required statistical representation of clock and count fields. The valid functions are:
AVE
Average value (this is the default).
DEV
Standard deviation.
MAX
Maximum value.
MIN
Minimum value.
TOT
Total.
nnn
Peak percentile (50-100).
SEV
Alert severity. Identifies the alert reporting fields, including the ALERT field.

You must also specify the parameters for this function: the alert severity level CRITICAL, WARNING, or INFO, and whether to report COUNT or PERCENT. Press the Right (F11) key until the Alert columns scroll into view:

──── Alert ─────
Severity Report
________ _______
Tip: If you type SEV in the Fn column and then press Enter, the panel scrolls the Alert columns into view for you.

You can only enter values in the Alert columns if you have entered the SEV function in the Fn column.

Specifying the SEV function with Alert Severity and Report parameters generates the fieldname(SEV(CRITICAL|WARNING|INFO,COUNT|PERCENT)) operand.

Note: The SEV function is only supported by the Performance Summary report and extract. If a Summary Form containing SEV fields is used in any other report, such as Profiling, the SEV function is ignored and the Field will adopt its default function.

RNG
Range. This function calculates the number of tasks where the value of a field falls within a specified range or matches a single value. You can display the result in the report either as a count or as a percentage of tasks. You can use this function to produce distribution reports that answer questions such as: How many transactions had a response time between 0.4 and 0.6 seconds? What percentage of transactions had a response time of 1 second or longer?

To specify the parameters for this function, press the Right (F11) key until the Range columns scroll into view:

─────────── Range ───────────
From        To       Report
___________ ________ _______
Tip: If you type RNG in the Fn column and then press Enter, the panel scrolls the Range columns into view for you.

You can only enter values in the Range columns if you have entered the RNG function in the Fn column.

Specifying the RNG function with a Report value of COUNT (the default value) generates the RNGCOUNT() operand; a Report value of PERCENT generates the RNGPERCENT() operand.

From and To (RNG function only)
Specify a range of values or a single value:
  • To specify a single value, in the From column enter an equal sign (=) followed immediately by the value you want to match (for example, =0). Leave the To column blank.
  • To specify a range with only an upper limit or a lower limit, in the From column enter one of the following comparison operators:

    > >= < <=

    followed immediately by the limit value (for example, >1.0). Leave the To column blank.

  • To specify a range with upper and lower limits, enter the lower limit value in the From column and the upper limit value in the To column, with no comparison operators. To fall within the range, a field value must be greater than or equal to the lower limit, and less than the upper limit:

    lower limit <= field value < upper limit

For time fields, values with a decimal point (such as 1.0) are interpreted as seconds; integers (such as 1000) are interpreted as milliseconds.

Report (RNG or SEV function)
Specifies whether to display the result in the report as a count or as a percentage. Valid values are COUNT and PERCENT. If you leave this column blank, the default value is COUNT for distributions (RNG function) and PERCENT for alerts (SEV function).
Tips:
  1. If you type C or P and then press Enter, the panel automatically completes the value for you.
  2. COUNT and PERCENT generate identical column headings. To distinguish between columns for percentages and counts, check the column values under the headings: percentages appear with a decimal point, whereas counts are integers with no decimal point.
Alert Severity (SEV function only)
The threshold level for Performance Alert reporting, either CRITICAL, WARNING, or INFO.
Field Description
This is a short description of the field. Enter line action H (Help) for a more detailed description as shown in the example in Figure 1.
Length
The length of the field in the report or extract. This is used to calculate the width of the print line.
Dictionary Definition
The description of the CMF data field in terms of the CMF informal name, CICS owner, data type, and field identifier. See LIST Report Form for further information.
User Field Offset and Length
For character user fields when only part of the field is to be reported. Offset is the position of the first character and Length is the number of characters (1-8) to be reported. For example, if the user field contains the value ABCDEFG, then specifying offset 4 and length 3 gives the output DEF. Both values are required for character user fields and default to offset 1 and maximum field length, limited to eight characters for the Performance Summary report.

CICS PA JCL generation translates these values to FIELDS(CHARACTER(SUBSTR(offset,length),...

Figure 2. SUMMARY Report Form (with User Fields)
   File  Edit  Confirm  Upgrade  Profiling  Options  Help
 ------------------------------------------------------------------------------
                   EDIT SUMMARY Report Form - SUMMUFLD
 Command ===> ________________________________________________ Scroll ===> PAGE
 
 Description  . . . . Summary Report Form_____________  Version (VRM): 680
 
 Selection Criteria:
  _  Performance                                        Page width . . 132_ 
 
     Field
 /   Name +   Sort  Type    Fn   Description
 __  WBTOTAL_    _  _______ AVE  Web Total requests
 __  CLOCK1__    _  TIME___ AVE  User field: CMF ID=USERNM1  S001
     .  .  .
 __  FIELD1__ K  *  _______ ___  User field: CMF ID=USERNM2  C001
 ********************************* End of list *********************************
   File  Edit  Confirm  Upgrade  Profiling  Options  Help
 ------------------------------------------------------------------------------
                   EDIT SUMMARY Report Form - SUMMUFLD
 Command ===> ________________________________________________ Scroll ===> PAGE
 
 Description  . . . . Summary Report Form_____________
 
 Title  . . First half title__________________________________________________
            Second half title_________________________________________________
 
     Field                                                       - User Field -
 /   Name +   Sort  Type    Fn    Length  Dictionary Definition  Offset  Length
 __  WBTOTAL_    _  _______ AVE        8  WBTOTWCT DFHWEBB A235   ___     ___
 __  CLOCK1__    _  TIME___ AVE        8  CLOCK1   USERNM1 S001   ___     ___
     .  .  .
 __  FIELD1__ K  *  _______ ___       12  FIELD1   USERNM2 C001   1__     8__
 ********************************* End of list *********************************

Line Actions: For the list of valid line actions for the SUMMARY Report Form panel, see LIST Report Form.

Primary Commands: The following primary command is available only on the SUMMARY Report Form panel:

PROFILE
Applies only to the Transaction Profiling report. Inserts the special field PROFILE into the Form, immediately below the key fields. The PROFILE field accounts for the width of the headings (such as Report, Baseline, Delta, and Change%) that the Transaction Profiling report inserts after the key fields in the Form.

Also available from Profiling in the action bar.

For a list of other valid primary commands for the SUMMARY Report Form panel, see page LIST Report Form.


Information Information

Feedback


Timestamp icon Last updated: Thursday, 7 November 2013


http://pic.dhe.ibm.com/infocenter/cicsts/v5r1/topic//users-guide/summyfm.htm