IBM CICS Performance Analyzer for z/OS

https://www.ibm.com/docs/en/cics-pa
Admin
IBM CICS Performance Analyzer for z/OS is a performance monitoring and analysis tool for CICS...
Tokens:472,296
Snippets:3,890
Trust Score:10
Update:10 months ago
Show doc for...
Tokens:
Raw
### Weekly SMF File Naming Convention

Source: https://www.ibm.com/docs/en/cics-pa/5.3_topic=files-cyclic-smf-file-data-set-name-examples

This example illustrates the data set name for SMF data covering the current week, starting from Monday. It follows a similar format to the daily naming convention.

```text
DSN: SMF.WEEK             Origin: MONDAY      Interval: WEEK    DISP: MOD
```

--------------------------------

### CICS Transaction Gateway - Activity Summary Report Example

Source: https://www.ibm.com/docs/en/cics-pa/5.3_topic=reports-ctgstatistics-examples

This is an example of the CICS Transaction Gateway - Activity Summary report. It displays statistics such as Gateway ID, start time, uptime, number of intervals and requests, peak TPS, and timeout information for a given period.

```text
 V5R3M0                                                 CICS Performance Analyzer                                                  
                                                CICS Transaction Gateway - Activity Summary                                        
                                               _____________________________________________                                       
STTG0001 Printed at 12:34:56 02/15/2015     Data from 11:35:00  6/22/2014 to 13:00:00  6/22/2014                       Page       1
                                                                                                                                   
                                                                                                                                   
Gateway ID         Start time        Up time           Number of  Number of  Peak  Peak TPS time         Connect   Worker 
                                                       Intervals   requests   TPS                       Timeouts  Timeouts
CICSTG.CAI000      2014-06-22 12.33    0days 00.22.15          6     626066   617  2014-06-22 12.55.00         0         0
                                                                                                                                   

```

--------------------------------

### Daily SMF File Naming Convention

Source: https://www.ibm.com/docs/en/cics-pa/5.3_topic=files-cyclic-smf-file-data-set-name-examples

This example shows the data set name for SMF data containing information for the current day. The format indicates the data set name, origin, interval, and disposition.

```text
DSN: SMF.TODAY            Origin: DAY         Interval: DAY     DISP: MOD
```

--------------------------------

### Sample Job to Create Dictionary Records with DFHMNDUP (JCL)

Source: https://www.ibm.com/docs/en/cics-pa/5.3_topic=data-using-dfhmndup-create-dictionary-records

This JCL job utilizes the DFHMNDUP program to generate a dictionary record for a specified APPLID. It requires the CICS SDFHLOAD library and defines output datasets for the record and system messages. Control parameters are supplied via SYSIN.

```JCL
//MNDUPJOB JOB (Job Accounting)
//MNDUP    EXEC PGM=DFHMNDUP,REGION=0M
//STEPLIB  DD  DSN=CICS.SDFHLOAD,DISP=SHR
//SYSUT4   DD  DSN=userid.applid.MNDUPREC,
//             DISP=(NEW,CATLG),UNIT=SYSDA,SPACE=(TRK,(1,1))
//SYSPRINT DD  SYSOUT=A
//SYSDUMP DD  SYSOUT=A
//SYSIN    DD  *
MCT=NO
SYSID=MVS1
GAPPLID=CICSPROD
SAPPLID=CICSPROD
/*
//
```

--------------------------------

### Filter Performance Records by Transaction ID using RECSEL

Source: https://www.ibm.com/docs/en/cics-pa/5.3_topic=extract-recsel-examples

This example demonstrates how to use the RECSEL command to extract CMF performance records where the Transaction ID starts with the character 'R'. It utilizes the SELECT and INC parameters for filtering.

```JCL
   CICSPA RECSEL(SELECT(PERFORMANCE(INC(TRAN(R*)))))
```

--------------------------------

### Sample Performance Alerts List Report Output

Source: https://www.ibm.com/docs/en/cics-pa/5.3_topic=format-example-performance-alerts-list

This is a sample of the formatted performance alerts list report generated by CICS Performance Analyzer. It displays transaction and program details along with various performance metrics and their severity levels, aiding in the identification of performance bottlenecks.

```text
 V5R3M0                                                 CICS Performance Analyzer
                                                            Performance List
 
LIST0001 Printed at 17:19:36  4/21/2010    Data from 07:51:03  3/26/2009                         APPLID XYZ299V2            
                                                                                                                            
                                                                                                                            
                            Sev               Sev               Sev               Sev                                       
Tran Program  Response Response Dispatch Dispatch User CPU User CPU  Suspend  Suspend DispWait  FC Wait   FCAMRq  IR Wait   
                  Time     Time     Time     Time     Time     Time     Time     Time     Time     Time              Time   
CESN DFHSNP      .0456 Info        .0453 Info        .0043 Info        .0003             .0003    .0000        0    .0000   
CSTE DFHTACP     .0490 Info        .0371 Info        .0032 Info        .0120             .0119    .0000        0    .0000   
CESN DFHSNP      .0066             .0036             .0021 Info        .0029             .0001    .0000        0    .0000   
CEJR DFHEJITL    .0457 Info        .0414 Info        .0357 Warning     .0043             .0000    .0000        0    .0000   
CEJR DFHEJITL    .0006             .0003             .0002             .0004             .0000    .0000        0    .0000   
CEJR DFHEJITL    .0006             .0001             .0001             .0005             .0000    .0000        0    .0000   
CEJR DFHEJITL    .0275 Info        .0233 Info        .0017 Info        .0043             .0003    .0007       10    .0000   
CRTP DFHZRTP     .0080             .0056             .0016             .0024             .0004    .0000        0    .0000   
CEDA DFHEDAP  163.3748 Critical    .5525 Warning     .3450 Critical 162.8222             .0023    .3245     9589    .0000   
CSHQ DFHSHSY  192.6462 Critical    .0922 Info        .0091 Info     192.5540             .0057    .0000        0    .0000   
CESD DFHCESD     .0037             .0008             .0007             .0028             .0001    .0000        0    .0000   
CISD DFHISCOP    .0006             .0001             .0001             .0005             .0000    .0000        0    .0000   
CSKL EZACIC02 191.6213 Critical 190.8965 Critical    .0134 Warning     .7248             .0620    .0013        1    .0000   
CKAM DFHMQMON 197.1525             .0187             .0035          197.1338             .0945    .0000        0    .0000   
CSNC DFHCRNP  205.4532 Critical    .0737 Info        .0022 Info     205.3795             .0057    .0000        0    .0000   
CSNE DFHZNAC  199.6088 Critical    .0366 Info        .0035 Info     199.5722             .0001    .0000        0    .0000   

```

--------------------------------

### Generate TOTAL Report for Specific Date

Source: https://www.ibm.com/docs/en/cics-pa/5.3_topic=report-total-examples

This example demonstrates how to use the SELECT operand with the PERFORMANCE keyword and INCLUDE to filter the TOTAL report data for a specific day, January 12, 2005. It specifies both a start and end date for the selection.

```JCL
CICSPA TOTAL(SELECT(PERFORMANCE(INCLUDE(
                    START(FROM(2005/01/12,),TO(2005/01/13,))))))
```

--------------------------------

### Monthly SMF File Naming Convention Examples

Source: https://www.ibm.com/docs/en/cics-pa/5.3_topic=files-cyclic-smf-file-data-set-name-examples

These examples demonstrate the naming convention for SMF data sets that store information for specific calendar months. Each data set corresponds to a particular month, with placeholders for the year. The format includes the data set name, origin, interval, and disposition.

```text
DSN: SMF.JAN              Origin: ****-01-01  Interval: MONTH   DISP: MOD
DSN: SMF.FEB              Origin: ****-02-01  Interval: MONTH   DISP: MOD
. . .
DSN: SMF.DEC              Origin: ****-12-01  Interval: MONTH   DISP: MOD
```

--------------------------------

### HDB Summary Report Example

Source: https://www.ibm.com/docs/en/cics-pa/5.3_topic=hdb-performance-reporting

This is an example of a CICS Performance Analyzer Historical Database Summary report. It displays performance metrics such as response time, CPU usage, and wait times for CICS transactions, aggregated over hourly intervals. The report includes data from specified start and stop times.

```text
 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      Avg      Avg      Avg      Avg      Avg      Avg      Avg      Avg     
 Start            MVS  APPLID   Tran    Tasks Response Dispatch User CPU  Suspend DispWait  FC Wait  IR Wait SC24UHWM SC31UHWM     
 Interval                                         Time     Time     Time     Time     Time     Time     Time                       
 2004/12/07 09:00 MVS1 CICSP1   ABRA        1    .2729    .0009    .0006    .2720    .0000    .0000    .2719        0        0     
 2004/12/07 09:00 MVS1 CICSP1   ASIX        2    .2184    .0009    .0006    .2175    .0000    .0000    .2175        0        0     
 2004/12/07 09:00 MVS1 CICSP1   ATRA        1   1.6067    .0008    .0005   1.6058    .0000    .0000   1.6057        0        0     

```

--------------------------------

### Platforms and Applications Summary Report Data

Source: https://www.ibm.com/docs/en/cics-pa/5.3_topic=report-summary-examples

This snippet displays sample data from a Platforms and Applications Summary report generated by CICS Performance Analyzer. It shows metrics like #Tasks, Critical Alerts, Warning Alerts, Info Alerts, and various response times and CPU usages for different CICS transactions.

```text
SUMM0001 Printed at 17:00:22  4/20/2010     Data from 07:50:50  3/26/2009 to 07:54:28  3/26/2009                               
                                                                                                                               
                                                                                                                               
                  Critical Critical  Warning     Info Critical  Warning     Info      Avg Critical  Warning     Info      Avg  
Tran       #Tasks    ALERT    ALERT    ALERT    ALERT Response Response Response Response User CPU User CPU User CPU User CPU  
                                                          Time     Time     Time     Time     Time     Time     Time     Time  
CEDA            1   100.00        1        0        0        1        0        0 163.3748        1        0        0    .3450  
CEJR            8    12.50        1        2        2        1        1        2    .4349        1        2        1    .2348  
CEMT            4    25.00        1        1        1        1        0        1   4.9471        0        1        1    .0198  
CESD            1      .00        0        0        0        0        0        0    .0037        0        0        0    .0007  
CESN            2      .00        0        0        2        0        0        1    .0261        0        0        2    .0032  
CSAC            1      .00        0        1        0        0        1        0    .5235        0        0        0    .0003  
CSFU            1      .00        0        1        0        0        1        0    .8119        0        1        0    .0415  
CSHQ            1   100.00        1        0        1        1        0        0 192.6462        0        0        1    .0091  
CSKL            1   100.00        1        1        0        1        0        0 191.6213        0        1        0    .0134  
CSNC            1   100.00        1        0        1        1        0        0 205.4532        0        0        1    .0022  
CSNE            2    50.00        1        0        1        1        0        0  99.8076        0        0        1    .0020  
CSSY           13    15.38        2        6        9        2        6        3   1.3247        1        0        8    .0457  
CSTE            1      .00        0        0        1        0        0        1    .0490        0        0        1    .0032  
CSZI            1   100.00        1        0        1        1        0        0 209.1438        0        0        1    .0077  
Total          38    26.32       10       12       19       10        9        8  31.6785        3        5       17    .0786  
```

--------------------------------

### CICS PA LOGSTREAM Filter Examples

Source: https://www.ibm.com/docs/en/cics-pa/5.3_topic=commands-logger-system-logger-report-extract

An optional filter for Logstream names, accepting exact names or patterns with wildcards '%' (single character) and '*' (multiple characters). Examples demonstrate matching specific log streams and those starting with a prefix.

```text
LOGSTREAM
    Optional filter on Logstream name. Specify a name or pattern enclosed in quotes. Masking characters **%** and ***** are allowed. For example: 

LOGSTREAM('TEST.DFHLOG')
    must match exactly 

LOGSTREAM('PROD.*')
    can match PROD.DFHLOG 

LOGSTREAM('PROD.MVSA%')
    can match PROD.MVSA1, but not PROD.MVSA1LOG
```

--------------------------------

### Example: CICS PA SMF Filtering by Specific Date to End of File

Source: https://www.ibm.com/docs/en/cics-pa/5.3_topic=operands-smfstart-smfstop

This example shows how to use SMFSTART to begin processing from a specific date and relies on the default behavior of SMFSTOP to process until the end of the file. Data before the specified date will be ignored.

```CICSPA
CICSPA SMFSTART(2005/02/19,),
       SMFSTOP(,)
```

--------------------------------

### HDB List Report Example Output

Source: https://www.ibm.com/docs/en/cics-pa/5.3_topic=reporting-hdb-list-report

An example of the HDB List report output, showing transaction details such as start time, application ID, response time, CPU time, and wait times. The fields displayed are based on the default List Template and can be altered with custom Report Forms.

```text
 V5R3M0                                                  CICS Performance Analyzer
                                                         Historical Database List
 
HDBR0001 Printed at 12:03:45 8/15/2010    Data from 15:41:28  8/07/2010                                                          
                                                                                                                                   
 Start        MVS  APPLID   Tran Userid   Program    TaskNo Response Dispatch User CPU  Suspend DispWait  FC Wait   FCAMRq  IR Wait
 Time                                                         Time     Time     Time     Time     Time     Time              Time  
 15:41:28.649 P390 CICS53A1 CPLT CICSUSER DFHSIPLT        6    .5196    .1771    .0316    .3425    .3422    .0000        0    .0000
 15:41:29.598 P390 CICS53A1 CSSY CICSUSER DFHAPATT       15    .4595    .0036    .0033    .4558    .0000    .0000        0    .0000
 15:41:29.604 P390 CICS53A1 CSSY CICSUSER DFHAPATT       16    .9663    .0069    .0088    .9594    .0795    .0000        0    .0000
 15:41:29.610 P390 CICS53A1 CSSY CICSUSER DFHAPATT       17   4.0131    .1379    .0311   3.8752   1.7449    .0000        0    .0000
 15:41:29.570 P390 CICS53A1 CSSY CICSUSER DFHAPATT       12   4.2133    .1621    .0494   4.0511   2.5906    .0000        0    .0000
 15:41:29.191 P390 CICS53A1 CGRP CICSUSER DFHZCGRP       11   5.1156    .1956    .0603   4.9199   1.9401    .0000        0    .0000
 15:41:29.591 P390 CICS53A1 CSSY CICSUSER DFHAPATT       14   4.7978    .1880    .0652   4.6098   2.3487    .0000        0    .0000
 15:41:29.178 P390 CICS53A1 CSSY CICSUSER DFHAPATT       10   5.2738   1.4746    .2259   3.7992    .6720    .0000        0    .0000
 15:41:29.177 P390 CICS53A1 CSSY CICSUSER DFHAPATT        9   5.3366    .7647    .1494   4.5719   1.6657    .0000        0    .0000
 15:41:29.590 P390 CICS53A1 CSSY CICSUSER DFHAPATT       13   5.2787    .7009    .1740   4.5778   2.0694    .0000        0    .0000
 15:42:24.011 P390 CICS53A1 CLQ2 CICSUSER DFHLUP         19   7.2473    .2907    .0416   6.9566   1.9555    .0000        0   3.7840
 15:41:29.172 P390 CICS53A1 CSSY CICSUSER DFHAPATT      III  74.6388  48.6230  18.0249  26.0158   7.7521    .6756     1506    .0000
 15:42:43.395 P390 CICS53A1 CLR2 CICSUSER DFHLUP         20    .4513    .0130    .0128    .4383    .0215    .0000        0   .4363
```

--------------------------------

### Execute CICS PA REXX Script (TSO Command)

Source: https://www.ibm.com/docs/en/cics-pa/5.3_topic=dialog-dynamic-setup

This command executes the CPAOREXX REXX exec from the SCPAEXEC library to dynamically set up CICS PA. It requires specifying the high-level qualifier and language for your CICS PA installation. Ensure the path and qualifier match your installation.

```CLIST
EX 'qual.SCPAEXEC(CPAOREXX)' 'qual lang'
```

```CLIST
EX 'CICSPA.V5R3M0.SCPAEXEC(CPAOREXX)' 'CICSPA.V5R3M0 E'
```

--------------------------------

### Requesting reports using batch commands

Source: https://www.ibm.com/docs/en/cics-pa/5.3_topic=operands-tailoring-using-fields

This section details how to request reports and extracts using batch commands with CICS PA. It covers JCL setup, command syntax, and various report operands.

```APIDOC
## Using the CICS PA commands

### Description
This section describes how to use the CICS PA commands for requesting reports and extracts in batch mode. It covers the general command format and specific operands for various reports.

### Method
Batch Command Execution

### Endpoint
N/A (Batch process)

### Parameters
#### CICS PA Commands
- **CICSPA report operands**: Used to specify the type of report and its parameters.
  - **Common options**: General options applicable to multiple reports.
  - **Filtering using SELECT and SELECT2**: Options for filtering data based on specific criteria.
  - **Tailoring using FIELDS**: Options for selecting and formatting specific data fields.
    - **Suboperand APG for Application Groups**: Filters or groups by application groups.
    - **Suboperands for Clock type fields**: Filters or groups by clock type fields.
    - **Suboperands for Time Stamp fields**: Filters or groups by time stamp fields.
    - **Suboperands for User fields**: Filters or groups by user-defined fields.
- **CICSPA control operands**: Control operands for managing the batch job execution.

### Report Types
- **LIST - Performance List report**
- **LISTX - Performance List Extended report**
- **SUMMARY - Performance Summary report**
- **TOTAL - Performance Totals report**
- **WAITANALYSIS - Wait Analysis report**
- **PROFILING - Transaction Profiling report**
- **CROSSsystem - Cross-System Work report and extract**
- **TRANGROUP - Transaction Group report**
- **BTS - BTS report**
- **WORKLOAD - Workload Activity report**
- **TRACKINGLIST - Transaction Tracking List report**
- **TRACKINGSUMMARY - Transaction Tracking Summary report**
- **LISTEXC - Exception List report**
- **SUMEXC - Exception Summary report**
- **RESUSAGE - Transaction Resource Usage reports**
- **STATISTICSLIST - Statistics List reports and extracts**
- **STATISTICSSUMMARY - Statistics Summary reports and extracts**
- **STATSALERT - Statistics Alert reports**
- **CTGSTATISTICS - CICS TG Statistics reports**
- **DB2 - DB2 report**
- **MQ - WebSphere MQ report**
- **OMEGAMON - OMEGAMON reports**
- **LOGGER - System Logger report and extract**
- **EXTRACTPERFORMANCE - Performance data extract**
- **RECSEL - Record Selection extract**
- **HDB(LOAD) - HDB Load**
- **EXTRACTSTATISTICS - Statistics extract**

### Additional Instructions
- **Using SELECT statements**: Details on constructing SELECT statements for data filtering.
- **COPY instruction**: Information on using the COPY instruction for data manipulation.
- **Sample library**: Reference to sample JCL and commands.
```

--------------------------------

### Example: CICS PA SMF Filtering by Relative and Absolute Time

Source: https://www.ibm.com/docs/en/cics-pa/5.3_topic=operands-smfstart-smfstop

This example demonstrates filtering SMF records using SMFSTART and SMFSTOP. It specifies a start time relative to the current date and an absolute stop date and time. CICS PA will process data only within this defined period.

```CICSPA
CICSPA SMFSTART(-1,08:30:00.00),
       SMFSTOP(0,17:30:00.00)
```

--------------------------------

### CICS TG Usage and Capacity Report Example

Source: https://www.ibm.com/docs/en/cics-pa/5.3_topic=ctgr-report-content

An example of the CICS Transaction Gateway Usage and Capacity report, displaying statistics such as Gateway ID, region size, Java heap usage, client connections, and more over a collection period.

```text
                                               CICS Transaction Gateway - Usage and Capacity                                       
                                               _____________________________________________                                       
STTG0002 Printed at 12:34:56 02/15/2015     Data from 11:35:00  6/22/2014 to 11:35:00  6/22/2014                       Page       1
                                                                                                                                   

Gateway ID : GBIBMIYA.CTGA22   Jobname : CTGA22   VRM : 910 Start Time : 2014-06-22 11.09                                          
                                                                                         
Collection time       Region      Java heap   Clients   Web Services Workers   EXCI pipes IPIC sessions Client Connections         
                      Size/Max    Size/Max    Peak/Max    Peak/Max   Peak/Max   Num/Max     Num/Avail   Established/New            
2014-06-22 11.10.00   549M/700M    59M/375M      0/1         0/100      0/100     0/250       0/0                 0/100            
2014-06-22 11.15.00   548M/700M    59M/375M      0/1         0/100      0/100     0/250       0/0                 0/0              
2014-06-22 11.20.00   548M/700M    59M/375M      0/1         0/100      0/100     0/250       0/0                 0/0              
2014-06-22 11.25.00   548M/700M    59M/375M      0/1         0/100      0/100     0/250       0/0                 0/0              
2014-06-22 11.30.00   561M/700M   315M/375M      0/1         3/100      3/100     0/250       0/999               0/0              
2014-06-22 11.35.00   564M/700M   313M/375M      0/1         2/100      2/100     0/250       0/999               0/0     

```

--------------------------------

### Generate WAITANALYSIS Report for a Specific Interval (CICSPA)

Source: https://www.ibm.com/docs/en/cics-pa/5.3_topic=report-waitanalysis-examples

Generates a WAITANALYSIS report filtered by a specific date range using the SELECT operand. This example restricts the analysis to data from January 12, 2005, to January 13, 2005. The input requires the WAITANAL command with the nested SELECT, PERFORMANCE, INCLUDE, START, and TO parameters.

```CICSPA
CICSPA WAITANAL(SELECT(PERFORMANCE(INCLUDE(
                       START(FROM(2005/01/12,),TO(2005/01/13,))))))
```

--------------------------------

### HDB Summary Extract Record Format

Source: https://www.ibm.com/docs/en/cics-pa/5.3_topic=dialog-hdb-extract-csv

This example illustrates the format of records within the HDB Summary Extract data set. The records are delimited by semicolons and contain fields such as start date, start time, MVS identifier, APPLID, transaction ID, number of tasks, and various performance metrics like response time, dispatch time, CPU time, and suspend time.

```csv
Start Date;Start Time;MVS;APPLID;Tran;#Tasks;Response Time Avg;Dispatch Time Avg;User CPU Time Avg;Suspend Time
2004/12/15 15:00:00;MV2C    ;IYK3ZAC1;CSHQ    ;       1;55155.62;   .2103;   .0212;55155.41;   .0331;   .0001; 
2004/12/15 15:00:00;MV2C    ;IYK3ZAC1;CSNC    ;       1;55159.06;   .3379;   .0041;55158.72;   .0356;   .0001; 
2004/12/15 15:00:00;MV2C    ;IYK3ZAC1;CSNE    ;       1;55153.97;   .0881;   .0060;55153.88;   .0042;   .0001; 
2004/12/15 18:00:00;MV2C    ;IYK2ZFV1;CEX2    ;       1;50237.83;   .5030;   .2717;50237.33;   .1800;   .0001; 

```
Tokens:
Raw