Statistics extract

A Statistics Extract is created as a delimited text file for the purpose of importing CICS® statistics into PC spreadsheet or database tools for further detailed analysis and reporting.

A Recap report containing processing statistics is always printed at the end of extract processing.

To request the extract, enter line action S against the Statistics Extract on the Report Set panel. If extracts have been previously specified, the list of Statistics Extracts is displayed. Otherwise, the Statistics Extract panel is displayed for you to define your first one.

Figure 1. Statistics Extracts
  File  Filter  Edit  Systems  Options  Help
 ──────────────────────────────────────────────────────────────────────────────
                         JW1 - Statistics Extracts                 Row 1 from 2 
 Command ===> ________________________________________________ Scroll ===> ____

       ──── System Selection ─────
 / Exc APPLID +  Image +  Group +    Recap      Form +     Alert +
 _     ________  ________ ________   STEX0001   ________   ________ 
       Output Data Set Prefix . .  'CICSP001.STATSSUM.CSV'                    
 ------------------------------------------------------------------------------
 _     ________  ________ ________   STEX0002   STGOVRV    MAXTASK  
       Output Data Set Prefix . .  'CICSP001.STGOVRV.CSV'                       
 ------------------------------------------------------------------------------
 ******************************* Bottom of data ********************************

This panel displays the list of Statistics Extracts in this Report Set. You can select (edit), delete, or include/exclude any extract, insert new ones, or rearrange them (move/copy).

The options and line actions are the same as on the Cross-System Work Extracts panel (see Cross-System Work extract), except that there are no selection criteria, and that, here, you specify a prefix for the output data set name, rather than the complete name.

To display the Statistics Extract panel, enter line action S against the Statistics Extract on the Report Set panel, then if the list of previously specified extracts is displayed, enter line action S against a particular extract in the list.
Figure 2. Statistics Extract
   File  Systems  Options  Help 
 ──────────────────────────────────────────────────────────────────────────────
                          JW1 - Statistics Extract
 Command ===> _________________________________________________________________

 System Selection:                       Extract Recap:
  APPLID . . ________  +                  DDname  . . . STEX0002 
  Image  . . ________  +
  Group  . . ________  +

 Output Data Set:
  Data Set Name Prefix . . 'CICSP001.EXTR1.CSV'                       
  Disposition  . . . . . . 1  1. OLD   2. MOD   (If cataloged)

 Extract Focus:
  _  Statistics Reports                   Form . . . STGOVRV   +

 Selection Criteria:                     Summary Options:
  Alert  . . MAXTASK   +                  Interval . . 03:00     
   Severity  WARNING   +
   _  Include Severity column   
  Type . . . . /  EOD  /  INT  /  USS  /  REQ  /  RRT 

 Extract Format:                         Execution Option:
  /  Include Field Labels                 /  Use External Sort
  Delimiter . . , 

 Repository  . . : CPA.V5R3M0.RSSAMP.REPOSTRY                     

Use this panel to specify extract options and interval types for the Statistics extract. The mandatory options are the prefix and disposition of the Extract data set, the DDname for the Recap report, and the selection of either a form or the statistics reports that you want to extract. You can leave the other options set to their default values.

The format of each extract depends on the statistics reports that you select.

The options are:

System Selection
Identifies the CICS APPLIDs whose data you want to select for processing.

You can specify any combination of APPLID, Image, or Group, but these must be defined in your System Definitions. If you do not specify System Selection here or in the Global Options, then you are prompted at run time to specify the System Selection. This will apply globally to all reports and extracts without their own System Selection. This is recommended as it allows you to run your Report Sets against any of your defined Systems. Press the Prompt key (F4) to select from a list of defined Systems, Images, or Groups. To modify your System Definitions, select Systems in the action bar.

Specify one of the following:
  • A CICS APPLID. An APPLID that matches a defined System's name pattern is also allowed. For example, CICSP1 can be specified if CICSP* is a defined system.
  • An APPLID and an MVS™ Image. This identifies the MVS Image where your CICS system runs.
  • An MVS Image. All CICS systems executing on this MVS Image is selected.
  • An APPLID and Image combination plus a Group. This is useful for uniquely identifying a CICS system when there are multiple CICS systems with the same name defined.
  • A Group alone. CICS PA will select all CICS APPLIDs defined to the Group. For example, for transaction grouping, or for systems that connect via IRC/MRO, ISC/APPC, or IPIC.

CICS PA uses the System Selection in JCL generation to build the APPLID(applid1,applid2,applid3,...) and INput(SMFIN001,SMFIN002,SMFIN003,...) operands, and corresponding //SMFINnnn DD statements.

System Selection can also be specified either:
  • In Global Options. The report-level specification takes precedence over the global.
  • At run time. The run-time System Selection overrides the Global Options and optionally the report-level specification.
Extract Recap
The DDname for the Recap report which prints at the end of extract processing to provide processing statistics. The DDname is mandatory.

CICS PA assigns a default DDname STEXnnnn where nnnn is a sequential number 0001-9999 to ensure each Recap report has a unique DDname.

This option generates the OUTPUT(ddname) operand.

Output Data Set:
Data Set Name Prefix
The prefix for the data set names where the extract records are written. If CICS PA is to create the data set at run time, the default allocation attributes specified on the Reporting Allocation Settings panel are used in generating the JCL. If the data set is already cataloged, then CICS PA will use DISP=OLD or DISP=MOD according to your request to overwrite or append to the existing data set. When generating the JCL:
  • CICS PA assigns the corresponding default DDname TSxxxxnn or TGxxxxnn, where nn is a 2-digit sequence number that ensures each DDname is unique.
  • CICS PA fully qualifies the extract data set name by appending an identifier to this prefix.
    • When the extract focus is a form, the identifier is the form name.
    • When the extract focus is statistics reports, the identifier is STTSxxxx for CICS Transaction Server (TS) statistics or STTGxxxx for CICS Transaction Gateway (TG) statistics, where xxxx is the statistics ID.

When specifying the data set name prefix, standard TSO conventions apply.

Disposition
The DISP value that you want the generated JCL to use for the output data set if it is already cataloged:
OLD
Overwrites the data set contents with the new extract data.
MOD
Appends the new extract data.

You must specify one of these dispositions regardless of whether the output data set is cataloged. If the output data set is not cataloged when CICS PA generates the JCL, then CICS PA generates the JCL using DISP=(NEW,CATLG) to catalog it.

Extract Focus:

In the Extract Focus section, you specify which Statistics data you want in the extract. You can use either the Statistics Reports option or the Form option.

Statistics Reports
To specify the statistics reports that you want to extract, enter S next to Statistics Reports. A list panel of CICS statistics report titles appears. Enter line action A next to the reports that you want to extract, and then press Exit (F3). An asterisk (*) appears next to Statistics Reports, which indicates that at least one report is selected.
Form
The name of a Statistics List form or Statistics Summary form that specifies the fields you want in the extract. Press Prompt (F4) to choose from a list of existing eligible forms.
Selection Criteria:
Alert
Applicable only when Extract Focus is set to a form. The alert definition containing the conditions used to select the records that you want to report. You must have already created this alert definition in the currently active repository. To select from a list of alert definitions in the repository, press Prompt (F4). To create a new alert definition, return to the primary option menu, and then select option 8.5. For details, see Statistics alert reporting.

Using statistics alert definitions to filter statistics reports is different in some respects from how selection criteria are used with other reports. For details, see Filtering Statistics List and Statistics Summary reports.

To use a different Repository, return to the primary option menu, and then select option 0.3. If you define more than one statistics extract in a report set, all the extracts must refer to alert definitions stored in the same repository; the JCL for a report set can refer to only one repository.

CICS PA JCL generation translates this option to the STALTDEF operand.

Severity
Applicable only when Extract Focus is set to a Statistics List form. Determines the minimum threshold level to evaluate which records are to be reported.
CRITICAL
Only records with Critical alerts are reported, according to the CRITICAL threshold values specified in the Statistics Alert definition.
WARNING
Only records with Critical or Warning alerts are reported, according to the CRITICAL and WARNING threshold values specified in the Statistics Alert definition.
INFO
Only records with Critical, Warning, or Informational alerts are reported, according to the CRITICAL, WARNING, and INFO threshold values specified in the Statistics Alert definition.
ELIGIBLE
Only records that are eligible for alert processing are reported. Eligible records are those that have field values that match the Resource values defined in the Statistics Alert definition. All eligible records are reported regardless of whether they generate an alert.

This option provides the means to filter out records that would never generate an alert because their resource values do not match resource values specified in the alert definition.

ALL
All records are reported regardless of whether they are eligible or whether they generate an alert.
Include Severity column
Applicable only when Extract Focus is set to a Statistics List form. This option is used to insert a Sev column in the list report, showing the highest severity encountered for each record. (No other information is shown regarding the alert such as the field or alert that caused it.) This option must be selected if Severity=ALL.
Type
To limit the types of CICS statistics intervals that CICS PA extracts, enter / next to the types you are interested in:
EOD
End-of-day
INT
Interval
USS
Unsolicited
REQ
Requested
RRT
Requested reset
Note: For more information about statistics interval types, see "Introduction to CICS Statistics" in the CICS Transaction Server for z/OS® documentation.
Summary Options:
Interval
Applicable only when Extract Focus is set to a Summary form. The time interval applies when you want to summarize statistics activity over time. It is used when you specify a summary report form that has the key field COLLECTTIME included. When reporting, CICS PA accumulates the data for each interval in the report period and writes a report line for each.

The format of the field is hh:mm|day of week|MONTH. To specify a day of the week, enter the name of the day, such as MONDAY, or WEDNESDAY.

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 is reduced to 08:00 hours which will produce 3 interval report lines for each day of data.

This option generates the INTERVAL(hh:mm|day of week|MONTH) operand.

Extract Format:
Include Field Labels
Select (⁄) to include field labels as the first record written to the extract data set. This is the default. CICS PA JCL generation translates this to the LABELS operand.

Blank out the field if you do not want field labels written. CICS PA JCL generation translates this to the NOLABELS operand.

Delimiter
The field delimiter used to separate each data field in the extract records. The default delimiter is a semicolon (;).

CICS PA JCL generation translates this to DELIMIT('delimiter'). Note that the value is enclosed in single quotation marks in this operand.

Execution Option:
Use External Sort

Select / to use an external sort utility to process records for Statistics Summary report forms. This option generates the EXTERNAL(ddname) operand, which provides the DDname of the work data set used by the external sort utility. CICS PA assigns an external work file from a pool of external work files with default DDnames in the format CPAXWnnn where nnn is a sequential number 001-999 to uniquely identify the work file.

You should use an external sort when processing records that would generate a very large number of unique key values; otherwise an internal sort is used.

Repository
Read-only. The name of the repository in use, which determines the alerts you can select. If you need to change the repository, on the primary menu select option 0.3 CICS PA Control Data Sets.