SUMMARY - Performance Summary report

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,...),]
             [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),
             [JSON,]
             [LABELS(label-options)|NOLABELS,]
             [CODE('string'),]
             [EBCDIC|ASCII,]
             [MISSING(INCLUDE|EXCLUDE),]
             [TIMEFORMAT(ISO8601),]
             [OUTZONE(Z|+hh:mm|-hh:mm),]
             [EOL(CR|CRLF|LF|NEWLINE)|NOEOL,]
             [STREAM[,PORT(port-number)],]             
             [DELIMIT('field-delimiter'),]
             [FLOAT,]
             [EXTERNAL(ddname),]
             [INTERVAL(hh:mm:ss),]
             [ALERTDEF(alertname),]
             [SEVERITY(ELIGIBLE|ALL),]
             [FIELDS(field1[(options,...),]
             [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. DELIMIT applies for delimited text extracts only; not JSON Lines extracts. The default value is a semicolon DELIMIT(';').

FLOAT

Write numeric fields in the extract in S390 FLOAT format. This only applies to the Summary Extract when the FIELDS operand is specified.

Specify FLOAT format if you plan to import the extract into a DB2® table. When the DB2 Load Utility is used, it will interpret all numerical fields reliably and consistently in FLOAT format.

If FLOAT is not specified, the numeric fields are written in a mixture of integer, real and exponential using character digits. This is the default and is suitable when importing the extract data into a PC spreadsheet tool.

JSON, LABELS, CODE, EBCDIC, MISSING, TIMEFORMAT, OUTZONE, EOL, STREAM, PORT

These apply for extracts but not for reports. For information about these parameters, see LIST - Performance List report.

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.

NOTOTALS|TOTALS(n)

The totals level applies only to the Summary report.

Specify TOTALS(1) to TOTALS(8) to accumulate subtotals for up to 8 sort fields, print the subtotals when the sort field changes, and print a grand total at the end of the report. Default: TOTALS(8)

Specify TOTALS(0) for no subtotals, but print only the grand total.

Specify NOTOTALS for neither subtotals nor grand total.

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).

A time interval of less than one hour must fit evenly into the hour. CICS PA will round it down to the nearest interval that aligns to the hour. For example, 1.35 is reduced to 00:01:30 minutes which will produce 40 interval report lines for each hour of data.

A time interval of more than one hour must fit evenly into the day. CICS PA will round it down to the nearest interval that aligns to the day. For example, 10.30.23 is reduced to 08:00:00 hours which will produce 3 interval report lines for each day of data.

Minutes take precedence for an abbreviated entry. For example:

1: becomes 00:01:00
1.1: becomes 00:01:00 (rounded down from 00:01:01)
1.1.1: becomes 01:00:00 (rounded down from 01:01:01)

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.

LINECount

Controls the number of lines per page in the Summary report. See LINECNT 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.