Creating new Report Forms

You can request a new Report Form in either of the following ways:
A pop-up dialog window is displayed as shown in Figure 1. This is always displayed to allow you to initially populate your Report Form with fields for a particular CICS® System (including any user fields), Version (VRM), or fields in selected categories. Alternatively, you can model the new Report Form on an existing Report Form or HDB Template.
Figure 1. Specifying a New Report Form
   File  Systems  Options  Help
 ----------------------------------------------------------------------------
                               New Report Form                               
Command ===>                                                                 
                                                                             
Specify new Report Form options.                                             
                                                                             
Name . . . LIST2___  Version (VRM) . . . ___  +                              
                                                                             
System Selection:             Field Categories:                              
 APPLID  . . . . CICST1__  +  _  Select to specify Field Categories          
 MVS Image . . . ________                                                    
                                                                             
Form Type or Model:                                                          
_  1. List                    4. Model (Report Form)                         
   2. List Extended (Sorted)  5. Model (HDB Template)                        
   3. Summary                                                                
                                                                             
Model . . . . . . . . . . LIST1___  +                                        
Report Forms Data Set . . 'xxxx.CICSPA.FORM'____________________________  +  
HDB Register  . . . . . . 'CICSPA.HDB.REGISTER'_________________________  +  
                                                                             

This panel prompts you for details of the new Report Form.

The options are:
Name
The name of the new Report Form. A 1-8 character name in ISPF member name format. The name must be unique within the Report Forms data set.
APPLID, Image, Version (VRM)
Specify the CICS System or CICS Version (VRM) that this Report Form applies to.
  • If you specify the CICS System (APPLID, or APPLID and MVS™ Image), CICS PA can extract the associated (active) Dictionary entries for that CICS system, including any user fields. If not specified, CICS PA will assume the default Form, and user fields will not be available.

    The CICS system must be defined in System Definitions, either Personal or Shared depending on your current setting. To select one from a list, use Prompt (F4). To link directly to System Definitions or switch between Personal and Shared Systems, use Systems in the action bar.

  • Alternatively, if you specify the VRM, CICS PA uses it to populate the Form with fields applicable to that release of CICS. The supported releases are:
    640
    CICS Transaction Server for z/OS® Version 3 Release 1
    650
    CICS Transaction Server for z/OS Version 3 Release 2
    660
    CICS Transaction Server for z/OS Version 4 Release 1
    Start of change670End of change
    Start of changeCICS Transaction Server for z/OS Version 4 Release 2End of change

If a CICS System is specified and its VRM or Dictionary record is available, it overrides the VRM specification.

If you do not specify either a CICS System or a VRM, then CICS PA populates the Form with fields applicable to the latest supported release of CICS.

Field Categories
Enter / (or press F11) to display the selection list of field categories that you can use to initially populate your new Report Form. For example, you can initialize your Form with Task and Terminal Control fields by selecting DFHTASK and DFHTERM from the list. The default is all categories except CROSSYS, DBCTL, and OMCICS.

Within the selected categories, the fields added to your Report Form depend on the specified CICS APPLID or VRM. If APPLID is specified, CICS PA obtains the fields from the CMF Dictionary for that APPLID. Otherwise the VRM is used. If APPLID and VRM are not specified, the default is 670.

See Figure 1 for an example of the Field Categories selection list.

Form Type or Model
Select the type of Report Form or model which dictates how the new Form is to be initialized (such as the fields, order, sort sequence). Type is important since a Form can only be used by reports and extracts of compatible type:
1. List
Can be used for:
  • Performance List report
  • Cross-System Work report
  • Performance Data extract
  • List HDB reports
2. List Extended (Sorted)
Can be used for:
  • Performance List Extended report
  • Cross-System Work report (sort sequence and limit ignored)
  • Performance Data extract (sort sequence and limit ignored)
3. Summary
Can be used for:
  • Performance Summary report
  • Transaction Profiling report
  • Performance Data extract
  • Summary HDB reports

Alternatively, you can select Model to create a new Report Form modelled on an existing Report Form or HDB Template.

4. Model (Report Form)
If the new Report Form is to be modelled on an existing one, specify the name of the model Report Form and data set where it is stored. Prompt (F4) is available for both the Report Form data set name and the Report Form member name.
5. Model (HDB Template)
If the new Report Form is to be modelled on an existing HDB Template, specify the name of the model HDB Template and HDB Register where it is stored. Prompt (F4) is available for both the HDB Register data set name and the HDB Template name.

For HDB reporting and extract to CSV, it is useful to model a Report Form on an HDB Template. This ensures that the fields requested in the Form match the fields collected in the HDB.

When you have specified all required details, press Enter to create the Report Form.