List Template

A List Template defines the fields to be included in a List HDB. A List HDB contains data records for individual transactions. Typically, List HDBs are used for the detailed analysis of recent transaction events and have a short life span (retention).

The Template editor is very similar to the Report Forms editor. You can manipulate the Template to suit your needs.
Figure 1. Edit List Template (View 1 of 2)
  File  Edit  Confirm  Upgrade  Options  Help                                 
------------------------------------------------------------------------------
                      EDIT List Template – CPULST          Row 1 of 18 More: >
Command ===> _______________________________________________  Scroll ===> PAGE

Description . . Transaction CPU Analysis___________  Version (VRM): 670       
                                                     
Selection Criteria:                    
 _  Performance *                                                               

     Field                                                                      
/    Name +    K  Description                                             
__   START___  A  Transaction identifier                                  
__   TRAN____  A  Transaction identifier                                  
S_   USERID__  A  User ID                                                 
__   TASKNO__  _  Transaction identification number                       
__   STOP____  A  Task stop time                                          
__   RESPONSE  _  Transaction response time                               
M_   DISPATCH  _  Dispatch time                                           
A_   CPU_____  _  CPU time                                                
__   QRCPU___  _  CICS QR TCB CPU time                                    
__   MSCPU___  _  CICS TCBs CPU time                                      
__   ROCPU___  _  CICS RO TCB CPU time                                    
__   KY8CPU__  _  CICS Key 8 TCB CPU time                                 
__   J8CPU___  _  CICS J8 TCB CPU time                                    
__   L8CPU___  _  CICS L8 TCB CPU time                                    
__   S8CPU___  _  CICS S8 TCB CPU time                                    
__   EOD_____  _  ---------------- End of HDB ---------------------
__   TERM____  _  Terminal ID
 F1=Help      F3=Exit      F4=Prompt    F5=Rfind     F7=Backward  F8=Forward
F10=Actions  F11=Right    F12=Cancel                                        
Scroll Right (F11) to see more information.
Figure 2. Edit List Template (View 2 of 2)
  File  Edit  Confirm  Upgrade  Options  Help                                 
------------------------------------------------------------------------------
                      EDIT List Template – CPULST          Row 1 of 18 More: >
Command ===> _______________________________________________  Scroll ===> PAGE

Description . . Transaction CPU Analysis___________  Version (VRM): 670       
                                                     
Selection Criteria:                    
 _  Performance *                                                             

     Field                                       - User Field -
/    Name +    K  Length  Dictionary Definition  Offset  Length
__   START___  A      26  START    DFHCICS T005   ___     ___ 
__   TRAN____  A       4  TRAN     DFHTASK C001   ___     ___ 
__   USERID__  A       8  USERID   DFHCICS C089   ___     ___ 
__   TASKNO__  _       4  TRANNUM  DFHTASK P031   ___     ___ 
__   STOP____  A      26  STOP     DFHCICS T006   ___     ___ 
__   RESPONSE  _       8  RESP     CICSPA  D901   ___     ___ 
__   DISPATCH  _      12  USRDISPT DFHTASK S007   ___     ___ 
__   CPU_____  _      12  USRCPUT  DFHTASK S008   ___     ___ 
__   QRCPU___  _      12  QRCPUT   DFHTASK S256   ___     ___ 
__   MSCPU___  _      12  MSCPUT   DFHTASK S258   ___     ___ 
__   ROCPU___  _      12  ROCPUT   DFHTASK S270   ___     ___ 
__   KY8CPU__  _      12  KY8CPUT  DFHTASK S263   ___     ___ 
__   J8CPU___  _      12  J8CPUT   DFHTASK S260   ___     ___ 
__   L8CPU___  _      12  L8CPUT   DFHTASK S259   ___     ___ 
__   S8CPU___  _      12  S8CPUT   DFHTASK S261   ___     ___ 
__   EOD_____  _                                  ___     ___ 
__   TERM____  _       4  TERM     DFHTERM C002   ___     ___ 
 F1=Help      F3=Exit      F4=Prompt    F5=Rfind     F7=Backward  F8=Forward
F10=Actions  F11=Right    F12=Cancel                                        

When editing is complete, press Exit (F3) to save your Template.

The List Template consists of the following:
Description
Up to 32 characters of text to describe the purpose of the Template. This description is shown on the Templates panel to help you identify the Templates in the list. It is initially set to List HDB Template.
Version (VRM)
This identifies the CICS® release that this Template was created for. It determines which CMF fields are available for selection in this Template.
Selection Criteria
Optionally, you can specify Selection Criteria to filter the data on time periods and field values. Thereby you can restrict the HDB to only the data that is of interest to you.
The available line actions are:
/
Display the selection list of line actions.
S
Select (edit) the Selection Criteria. See Performance Selection Criteria for information on specifying Selection Criteria.
A
Activate the Selection Criteria so they is included for HDB processing. 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 HDB processing.
Field rows
One row for each field. The order of the fields in the Template dictates the order of the fields in the HDB records. This order is important because it determines the default sequence of fields when reporting. START or STOP must be the first field positioned at the top of the Template. The fields have the following attributes: Field Name, Key, Description, Length, Dictionary Definition, User Field Offset and Length (character user fields only).
Field Name
The CICS PA field name. To select from a list of fields applicable to this type of HDB Template and CICS version, enter line action S (see Field selection) or from the field name, press Prompt (F4) (see Select a performance field). The names for user fields are derived from the MCT of the specified CICS system.

EOD is a special entry managed by CICS PA. It signals the end of the HDB record. The fields listed above EOD are included in the record in the same order as they appear in the list. The fields below EOD are ignored.

CICS PA automatically sets EOD when the Template is created and resets it if necessary when the Template is changed to ensure it is maintained in a valid position.

K
Key field indicator for DB2® Export (see HDB Export to DB2 tables). A value of A (ascending) identifies this as a key field if it is above EOD, or a key field candidate if it is below EOD. The allowed key fields are character or time stamp fields. Any number of key fields can be specified, but at least one must be specified. Either START or STOP must be specified as the first field at the top of the Template.

The Key field indicator is used only when exporting to DB2. CICS PA generates DDL to create an index for all key fields. Blank the K field if you do not need a DB2 index for this field.

HDB Load and Report requests treat all time stamp and character fields as key fields, regardless of their Key field indicator setting.

Description
This is a short description of the field. Enter line action H (Help) to see a more detailed description. See Performance field help for an example of the help details displayed in a pop-up window.
Length
The length of the field in the HDB record.
Dictionary Definition
The description of the CMF data field in the format informalname owner xnnn where:
  • informalname is the CMF field name
  • owner is the CICS component that 'owns' the field
  • x indicates the data type:
    • A - 32- or 64-bit count
    • C - character string
    • D - CICS PA derived time
    • P - packed decimal number
    • S - clock (time-count)
    • T - STCK time stamp
    • X - CICS PA calculated count
  • nnn is the field identifier

Some special fields, such as APPLID and RESPONSE, are not defined in the CMF Dictionary and are given an owner of 'CICSPA'. They are either derived from the fixed section of the CMF record (for example, APPLID), or calculated from two or more other CMF fields (for example, RESPONSE).

User Field Offset and Length
This is used for character user fields when only part of the field is to be included in the HDB record. Offset is the position of the first character and Length is the number of characters from this position to be included. For example, if the user field contains the value ABCDEFG, then specifying offset 1 and length 4 gives the output ABCD. Both values are required for character user fields and default to the entire field (offset 1 and maximum length).

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

Line Actions: The following line actions are valid on this panel:
Display the selection list of line actions.
S
Select a field name from a list of available CMF fields. See Field selection for an example of the field selection panel.
I
Insert a blank row after this row for entry or selection of another field.
R
Repeat this row.
RR
Repeat a block of rows bounded by two RRs.
C
Copy this row.
CC
Copy a block of rows bounded by two CCs.
M
Move this row.
MM
Move a block of rows bounded by two MMs.
A
Move⁄Copy after this row.
B
Move⁄Copy before this row.
D
Delete this row.
DD
Delete a block of rows bounded by two DDs.
H
Field Help. Display a detailed explanation of the field. See Performance field help for an example of the field help panel.
Note:
  1. Line operations can span the EOD row. CICS PA will reset EOD after the operation has completed to ensure it is validly positioned. Only one EOD is retained, that closest to the top of the list. EOD cannot be deleted.
  2. Deleted user fields cannot be recovered.
  3. In a Summary Template:
    • Key fields must be together at the top of the Template.
    • TASKCNT is a required field and must be after the key fields.
Primary Commands: The following primary commands are valid for this panel:
FIND string
This command (or F) looks for the specified character string in all columns of displayed data. The string is not case sensitive. The display scrolls to the row where the string is found and positions the cursor on the matching data.

To find more occurrences, use F5 (RFIND) repeatedly.

If there is no match but the search did not begin at the top of the list, the screen does not change and the message *Bottom of data reached* is displayed. Use F5 (RFIND) to search from the top. If there is no match in the entire list, the screen does not change and a String not found message is displayed.

SAVE
This command is only available from Edit mode and saves any changes you have made. You cannot save changes made in View mode.

Also available from File in the action bar.

RESET
This command (or RES) removes all outstanding line actions and deletes any blank rows.

Also available from Edit in the action bar.

CONFIRM ON|OFF
CONFIRM ON (or CONFIRM) instructs CICS PA to prompt for confirmation when you request to Cancel from the Template panel when there have been updates.

With CONFIRM OFF, Cancel requests are actioned immediately, discarding any changes.

This command changes the setting only for the current Edit session. On exit, it reverts to the value set by Cancel Confirmation in CICS PA Settings.

Also available from Confirm in the action bar.

UPGRADE vrm
This command is used to upgrade the Template to the specified CICS version (VRM) provided it is a later release. CMF Fields for all CICS releases after the current release and up to the specified release are added to the bottom of the Template.

Also available from Upgrade in the action bar.