The SUMMARY operand requests the Performance Summary report
or an Extract file (see Performance Data extract).
The command format for the Performance Summary report is:
CICSPA SUMMARY(
[OUTPUT(ddname),]
[EXTERNAL(ddname),]
[NOTOTALS|TOTALS(n),]
[INTERVAL(hh:mm:ss),]
[ALERTDEF(alertname),]
[SEVERITY(ELIGIBLE|ALL),]
[FIELDS(field1[(options[,SEV(CRITICAL|WARNING|INFO,COUNT|PERCENT)])],...),]
[LINECount(nnn),]
[TITLE1('...1st 64 characters of title...'),]
[TITLE2('...2nd 64 characters of title...'),]
[SELECT(PERFORMANCE(INCLUDE|EXCLUDE(field1(values1),...),...)),]
[SELECT2(PERFORMANCE(INCLUDE|EXCLUDE(field1(values1),...),...))])
The command format for the Summary
Extract is:
CICSPA SUMMARY(
[OUTPUT(ddname),]
DDNAME(ddname),
[DELIMIT('field-delimiter'),]
[LABELS|NOLABELS,]
[FLOAT,]
[EXTERNAL(ddname),]
[INTERVAL(hh:mm:ss),]
[ALERTDEF(alertname),]
[SEVERITY(ELIGIBLE|ALL),]
[FIELDS(field1[(options[,SEV(CRITICAL|WARNING|INFO,COUNT|PERCENT)])],...),]
[TITLE1('...1st 64 characters of title.of Recap...'),]
[TITLE2('...2nd 64 characters of title of Recap...'),]
[SELECT(PERFORMANCE(INCLUDE|EXCLUDE(field1(values1),...),...)),]
[SELECT2(PERFORMANCE(INCLUDE|EXCLUDE(field1(values1),...),...))])
The options are:
- OUTPUT
- Controls the report output DDname. See OUTPUT for further information. If not
specified, CICS PA assigns
a DDname in the format xxxxnnnn where nnnn is the report sequence
number 0001-9999 to uniquely identify the output, and xxxx
is:
- SUMM for the Performance Summary report
- EXPT for the Recap report for the Summary Extract
- DDNAME
- Specifies
the DDname of the extract data set where the extracted performance
data is written. When this operand is specified, instead of producing
the Summary report, CICS PA writes
the Performance Summary data to the extract file and a Recap of the
extract process is written to the OUTPUT operand report file.
The
DDname can be up to 8 alphanumeric characters, with the first non-numeric.
The CICS PA dialog
assigns DDnames in the format CPAOEXnn where nn is the extract
sequence number 01-99. (See the sample JCL in Figure 1).
- DELIMIT
- Specifies
the field delimiter, enclosed in quotes, to be used to separate each
data field in the extract data set. The default is a semicolon DELIMIT(';').
- LABELS|NOLABELS
- LABELS indicates
that the first record to be written to the extract data set is to
be a field labels record. This is the default.
NOLABELS indicates
that CICS PA is
not to write a field labels record to the extract data set.
- FLOAT
- Write numeric fields in the extract in S390 FLOAT
format. This only applies to the Summary Extract when
the FIELDS operand is specified.
- EXTERNAL
- Specifies the DDname for the work data set used by the external
SORT facility. This is optional for the Summary report and Extract. If specified, CICS PA performs
an external sort. If not specified, CICS PA performs
an internal sort where the records are sorted in storage by CICS PA. The CICS PA dialog
always generates the EXTERNAL operand with a DDname in the format CPAXWnnn where
nnn is the sequence number 001-999. See EXTERNAL for further information.
- INTERVAL
- Specifies
a time interval when the report summarizes transaction activity over
time. The interval is in the range 1 second to 24 hours in the format hh:mm:ss for
hours, minutes, and seconds.
This operand applies
only when any of START, STOP, or OSTART is specified in the FIELDS
operand. For reporting, data is accumulated for each interval
in the report period and a report line or extract record is written
for each interval. If INTERVAL is not specified, the default is 00:01:00 (1
minute).
- ALERTDEF
- The name of a Performance Alert Definition for alert reporting.
- SEVERITY(ELIGIBLE)
- Only include alert eligible transactions.
- FIELDS
- Specifies which fields are reported, the order in which they appear
in the report or extract, and their summarization presentation. See SUMMARY(FIELDS for further information and the
complete list of fields and their options by field type.
- SEV
- Specifies the field alert column.
- CRITICAL|WARNING|INFORMATIONAL
- Alert severity level for the column.
- COUNT|PERCENT
- Specifies whether the alert data should be reported as the total
count or as a percentage of the total transactions for the summary
key.
- LINECount
- Controls the number of lines per page in the Summary report. See LINECount for further information.
- TITLE1, TITLE2
- Controls the report title (left and right half of subheading line)
for the Performance Summary report or the Extract Recap.
See TITLE1 and TITLE2 for further information.
- SELECT|SELECT2(PERFORMANCE(INCLUDE|EXCLUDE
- Specifies
what data to include or exclude from the report or extract based on
data field values. See Using SELECT statements for
an explanation and examples.