LISTX Report Form

The LISTX Report Form can be used to tailor the format and content of the following reports and extracts:

Like the LIST Report Form, LISTX defines the fields to be included, the order of the columns, and a title for the report. LISTX can also define a sort sequence for up to three fields and, for one of the sort fields, a limit on the number of records to be processed.

The Report Form panel has two views as there are too many columns of information to display in a single screen view. Scroll Right (F11) to toggle between the views.

When you select to Edit or View a Report Form, the first view shown in Figure 1 is displayed by default.
Figure 1. LISTX Report Form (with Default Form)
   File  Edit  Confirm  Upgrade  Options  Help
 ------------------------------------------------------------------------------
                    EDIT LISTX Report Form - XMPLISTX                   More: >
 Command ===> ________________________________________________ Scroll ===> PAGE
 
 Description  . . . . List Extended Report Form_______  Version (VRM): 680
 
 Selection Criteria:
  _  Performance  *                                     Page width . . 132_ 
 
     Field
 /   Name +     S   Type      Limit     Description
 __  TRAN____   A   _______   ________  Transaction identifier
 __  STYPE___   *   _______   ________  Transaction start type
 __  USERID__   *   _______   ________  User ID
 __  RSYSID__   *   _______   ________  Remote System ID
 __  PROGRAM_   *   _______   ________  Program name
 __  TASKNO__   *   _______   ________  Transaction identification number
 __  STOP____   *   TIMET__   ________  Task stop time
 __  RESPONSE   *   _______   ________  Transaction response time
 __  DISPATCH   *   TIME___   ________  Dispatch time
 __  CPU_____   *   TIME___   ________  CPU time
 __  SUSPEND_   *   TIME___   ________  Suspend time
 __  DISPWAIT   *   TIME___   ________  Redispatch wait time
 __  FCWAIT__   *   TIME___   ________  File I/O wait time
 __  FCAMCT__   *   _______   ________  File access-method requests
 __  IRWAIT__   *   TIME___   ________  MRO link wait time
 __  EOR_____   _   _______   ________  ----------- End of Report ---------
 __  EOX_____   _   _______   ________  ----------- End of Extract --------
  F1=Help      F3=Exit      F4=Prompt    F5=Rfind     F7=Backward  F8=Forward
 F10=Actions  F11=Right    F12=Cancel                                        
   File  Edit  Confirm  Upgrade  Options  Help
 ------------------------------------------------------------------------------
                    EDIT LISTX Report Form - XMPLISTX                   More: >
 Command ===> ________________________________________________ Scroll ===> PAGE
 
 Description  . . . . List Extended Report Form_______
 
 Title  . . First half title__________________________________________________
            Second half title_________________________________________________
 
     Field
 /   Name +     S   Type      Limit      Length  Dictionary Definition
 __  TRAN____   A   _______   ________         4  TRAN     DFHTASK C001
 __  STYPE___   *   _______   ________         2  TTYPE    DFHTASK C004
 __  USERID__   *   _______   ________         8  USERID   DFHCICS C089
 __  RSYSID__   *   _______   ________         4  RSYSID   DFHCICS C130
 __  PROGRAM_   *   _______   ________         8  PGMNAME  DFHPROG C071
 __  TASKNO__   *   _______   ________         8  TRANNUM  DFHTASK P031
 __  STOP____   *   TIMET__   ________        12  STOP     DFHCICS T006
 __  RESPONSE   *   _______   ________         8  RESP     CICSPA  D901
 __  DISPATCH   *   TIME___   ________         8  USRDISPT DFHTASK S007
 __  CPU_____   *   TIME___   ________         8  USRCPUT  DFHTASK S008
 __  SUSPEND_   *   TIME___   ________         8  SUSPTIME DFHTASK S014
 __  DISPWAIT   *   TIME___   ________         8  DISPWTT  DFHTASK S102
 __  FCWAIT__   *   TIME___   ________         8  FCIOWTT  DFHFILE S063
 __  FCAMCT__   *   _______   ________         8  FCAMCT   DFHFILE A070
 __  IRWAIT__   *   TIME___   ________         8  IRIOWTT  DFHTERM S100
 __  EOR_____   _   _______   ________
 __  EOX_____   _   _______   ________
   F1=Help      F3=Exit      F4=Prompt    F5=Rfind     F7=Backward  F8=Forward
 F10=Actions  F11=Right    F12=Cancel                                        
The LISTX Report Form consists of the following:
Form Description
Up to 32 characters of text to describe the purpose of the Report Form. This description is shown on the Report Forms panel to help you identify the Forms in the list. It is initially set to List Extended Report Form.
Version (VRM)
This identifies the CICS® release that this Report Form was created for. It determines which CMF fields are available for selection in this Report Form.
Selection Criteria
Optionally, you can specify Selection Criteria to filter the data on time periods and field values to restrict the reporting to only the data that is of interest to you.

When a report specifies a Report Form and both have Selection Criteria specified, records must match both criteria to be included in the report.

Line Actions: The available line actions are:
/
Display the selection list of line actions.
S
Select (edit) the Selection Criteria. See Specifying Selection Criteria for information on specifying Selection Criteria.
A
Activate the Selection Criteria so they are included for reporting. 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 reporting.
Field rows
One row for each field. The order of the fields in the rows dictates the order of the columns in the report or extract. The fields have the following attributes: Name, Sort Sequence (only certain fields), Type (only clock and time stamp fields), Limit (only one of the sort fields), Description, Length, Dictionary Definition.
Field Name
One of the following:
  • The CICS PA field name. For CICS CMF fields, this is usually the Informal name or similar. The names for user fields are derived from the MCT. Use line action S or Prompt (F4) to select from a list of fields applicable to this Form type and CICS version.
  • The Application Group name. For details, see Application Grouping.

    Type an Application Group name in the Field Name column and APG in the Type column, and then press Enter. Otherwise, if you press Enter without APG in the Type column, the panel attempts to interpret the Application Group name as a CMF data field.

    When you add an Application Group to a Report Form, CICS PA adjusts the EOR marker to allow for the maximum width of an Application name (32 characters). However, when producing a report, CICS PA adjusts the Application Group column width to fit the longest Application name in the report.

    Application Groups are stored in a repository. Report Forms are independent of repositories, so the panel does not validate the Application Group name.

  • The special entry EOR.

    EOR is managed by CICS PA. It signals the end of the report line. The fields listed above EOR fit on the report line and are included in the report in the same order as they appear in the list. Those below EOR will not be reported and are ignored.

    CICS PA automatically sets EOR when the Report Form is created and resets it if necessary when the Form is changed to ensure that the maximum page width of 132 is not exceeded. In positioning EOR, CICS PA allows for one blank separator between each field.

    To produce a report line shorter than 132, either move EOR towards the top of the Form, delete unwanted fields, or move them below EOR.

  • The special entry EOX.

    EOX signals the end of the extract record. There are no restrictions on record length so EOX can be positioned anywhere in the list. EOX is initially positioned just below EOR. Fields above EOX are included in the extract, those below EOX are ignored. If EOX is not specified, EOR is used.

S (Sort Sequence)
Specify a sort sequence of A (ascending) or D (descending) for one to three fields listed in the order of the required sort precedence. At least one sort field must be specified. The default is TRAN ascending.

Candidate sort fields are indicated by an asterisk *. To change a candidate sort field to an active sort field, move it above EOR and overtype the asterisk with an A or D. To remove a sort field, either move it below EOR, delete it, or overtype the sort sequence with a blank or asterisk.

For one sort field only, you can specify a limit on the number of records to process at that level in the sort order.

Format Type
Either:
  • The value APG, indicating that the Field Name refers to the name of an Application Group

    or

  • The presentation format of the field.
    For numeric (A) fields, optionally specify one of the following:
    K
    Divide value by 1000, typically for count fields.
    M
    Divide value by 1000000, typically for count fields.
    KB
    Kilobytes (divide by 1024), typically for storage fields.
    MB
    Megabytes (divide by 1024x1024), typically for storage fields.
    For clock (S) fields, you must specify either:
    TIME
    Accumulation of elapsed time in seconds with requested precision of 0.0001 to 0.000001. Default: TIME with PRECISION(4).
    COUNT
    Number of occurrences of the condition.
    For time (T) fields START and STOP, you must specify one of:
    TIMET
    Time in the format hh:mm:ss.thm (default)
    TIMEM
    Time in the format hh:mm
    TIMES
    Time in the format hh:mm:ss
    TIMEP
    Time in one of the following formats, according to the requested precision:
    4 (default)
    hh:mm:ss.thmi
    5
    hh:mm:ss.thmij
    6
    hh:mm:ss.thmiju
    DATE
    Date in the format mm/dd/yyyy
    DATEISO
    Date in the format yyyy-mm-dd
    DATEM
    Date in the format mm/dd
    DATEYR
    Date in the format mm/dd/yy
Limit
For one sort field only, you can specify a limit on the number of records to process at that level in the sort order.
For example, to produce a report of the worst 10 response times for each transaction id, specify the following at the top of the Form:
Figure 2. LISTX Report Form (showing Sort Sequence and Limit)
   File  Edit  Confirm  Upgrade  Options  Help
 ------------------------------------------------------------------------------
                     EDIT LISTX Report Form - SAMPLX            Row 1 to 6 of 6
 Command ===> ________________________________________________ Scroll ===> PAGE
 
 Description  . . . . List Extended Report Form_______  Version (VRM): 680
 
 Selection Criteria:
  _  Performance  *                                     Page width . . 120_ 
 
     Field
 /   Name +     S   Type      Limit     Description
 __  TRAN____   A   _______   ________  Transaction identifier
 __  RESPONSE   D   _______   10______  Transaction response time
 __  CPU_____   *   TIME___   ________  CPU time
 __  PROGRAM_   *   _______   ________  Program name
 __  EOR_____   _   _______   ________  ----------- End of Report ---------
 __  APPLID__   *   _______   ________  CICS Generic APPLID
Field Description
This is a short description of the field. Enter line action H (Help) for a more detailed description as shown in the example in Figure 1.
Length
The length of the field in the report or extract. This is used to calculate the width of the report line.
Dictionary Definition
The description of the CMF data field in terms of the CMF informal name, CICS owner, data type, and field identifier. See LIST Report Form for further information.

Line Actions: For the list of valid line actions for the LISTX Report Form panel, see LIST Report Form.

Primary Commands: For the list of valid primary commands for the LISTX Report Form panel, see LIST Report Form.


Information Information

Feedback


Timestamp icon Last updated: Thursday, 7 November 2013


http://pic.dhe.ibm.com/infocenter/cicsts/v5r1/topic//users-guide/listxfm.htm