REPORT primary command — process IPCS output streams

Use the REPORT primary command when viewing an IPCS output stream to initiate processing of report text. REPORT initiates a line mode session similar to that initiated by the IPCS primary command except that the list of subcommand accepted differs.

Syntax
VERB OPERANDS

REPORT { subcommand }

RPT { clist }

{ rexx-exec }

VERB	OPERANDS
REPORT	{ subcommand }
RPT	{ clist }
	{ rexx-exec }

Usage notes

This session is run with ISPF application ID ISR in effect. This activates any personalized program function key definitions and other defaults that you have defined during normal use of BROWSE and VIEW services.
IPCS adds lines of output to an output stream incrementally, based on the last line that you have viewed. When the REPORT primary command is used, IPCS makes the current output stream available to it. In the following discussion of the REPORT primary command, the term entire report refers to all lines in the output stream at the time the primary command is requested. If you want to have the primary command run against a completed report, you must first use primary command DOWN MAX or its equivalent.

The following subcommands are available during a REPORT session:

BROWSE (alias B) — Use the BROWSE subcommand of REPORT to display some or all lines of a report using ISPF BROWSE. BROWSE processing will be performed with the application ISR command table and program function key definitions in effect.

Syntax of BROWSE

VERB	OPERANDS
BROWSE B	[ line-number[:line-number] ] [ relative-report-number \| 1 ]
------ SETDEF-Defined Parameter -------------- Note: You can override the following SETDEF parameter. See the SETDEF Subcommand in z/OS MVS IPCS Commands. [ TEST \| NOTEST ]

line-number[:line-number]: This option explicitly specifies the range of lines to be browsed. The default is the entire report being referenced. The end of the range may be overstated to request all lines beginning with the first to be browsed. The initial line in a report is always line 1.
relative-report-number: This operand specifies the report number. Report 0 is reserved for terminal output produced by the REPORT command itself. Report 1, the default, is the report being viewed at the time that the REPORT primary command was entered. Reports nested, if any, under the current ISPF logical screen are numbered from 2 onward.

CLOSE
END
EVALRPT
Use EVALRPT to copy information about one line in a report to a command procedure variable. The intended use for EVALRPT is where the common actions anticipated by IPCS are not appropriate or require embellishment.

For example, if you combine NOTE with some command procedure logic, a report copied to IPCSPRNT can have one or more IPCSTOC entries added to identify pages where significant data starts.

EVALRPT will be rejected if an attempt is made to invoke it directly using the REPORT primary command.
- Syntax of EVALRPT
  VERB OPERANDS
  
  EVALRPT
  [ line-number | 1 ]
  [ relative-report-number | 1 ]]
  { CLIST(variable-list) }
  { DIALOG(variable-list) }
  { REXX(variable-list) )
  
  line-number
  
  This operand specifies the line being referenced. Lines are numbered sequentially beginning with 1.
  
  relative-report-number
  
  This operand specifies the report number. Report 0 is reserved for terminal output produced by the REPORT command itself. Report 1, the default, is the report being viewed at the time that the REPORT primary command was entered. Reports nested, if any, under the current ISPF logical screen are numbered from 2 onward.
  
  CLIST(variable-list)
  
  DIALOG(variable-list)
  
  REXX(variable-list)
  
  This operand specifies the data to be accessed and used to update command procedure variables.
- Syntax of EVALRPT variable-list
```
LINEMAX(variable-name)
REPORTMAX(variable-name)
TEXT(variable-name)
VISIBILITY(variable-name)
```
  LINEMAX(variable-name)
  
  This option returns the number of lines in the referenced report. Partially-viewed reports may not be extended during processing of the REPORT primary command. Only those lines already written are accessible.
  
  REPORTMAX(variable-name)
  
  This option returns the number of reports nested under the logical screen when the REPORT primary command was entered.
  
  TEXT(variable-name)
  
  This option returns the text of the referenced line in the report. Note: CLIST(variable-name) is supported but not recommended for processing of a REPORT primary command. Processing free-form text in a CLIST is feasible but requires considerable expertise.
  
  VISIBILITY(variable-name)
  
  This option returns VISIBLE or EXCLUDED.
HELP (alias H)

VERB	OPERANDS
EVALRPT	[ line-number \| 1 ] [ relative-report-number \| 1 ]] { CLIST(variable-list) } { DIALOG(variable-list) } { REXX(variable-list) )

IPCSPRNT– Use the IPCSPRNT subcommand of REPORT to copy some or all lines of a report to the IPCS print file. If any lines are longer than the print file line size, they are truncated.

Syntax of IPCSPRNT

VERB	OPERANDS
IPCSPRNT	[ line-number[:line-number] ]
	[ relative-report-number \| 1 ]
	[ EXCLUDE( SUMMARIZE \| DISPLAY \| OMIT ) ]
------ SETDEF-Defined Parameter -------------- Note: You can override the following SETDEF parameter. See the SETDEF Subcommand in z/OS MVS IPCS Commands.

line-number[:line-number]

This option explicitly specifies the range of lines to be browsed. The default is the entire report being referenced. The end of the range may be overstated to request for all lines beginning with the first to be browsed. The initial line in a report is always line 1.

relative-report-number

This operand specifies the report number. Report 0 is reserved for terminal output produced by the REPORT command itself. Report 1, the default, is the report being viewed at the time that the REPORT primary command was entered. Reports nested, if any, under the current ISPF logical screen are numbered from 2 onward.

EXCLUDE(SUMMARIZE)

EXCLUDE(DISPLAY)

EXCLUDE(OMIT)

The EXCLUDE option specifies the treatment of lines within the selected range that have been excluded from display on the screen.

EXCLUDE(SUMMARIZE), the default, places one line into the print file for each group of excluded lines encountered. The line indicates the number of excluded lines within the selected range of lines that were in exclude.
EXCLUDE(DISPLAY) prints the excluded lines/
EXCLUDE(OMIT) neither shows nor summarizes excluded lines, printing only those lines visible.

Visible lines within the selected range are always printed as shown.

ISPEXEC
NOTE (alias N)
OPEN

VIEW (alias V) — Use the VIEW subcommand of REPORT to display some or all lines of a report using ISPF VIEW. VIEW processing will be performed with the application ISR command table and program function key definitions in effect. Both visible and excluded lines within the selected range are initially made visible in VIEW.

Syntax of VIEW

VERB	OPERANDS
VIEW V	[ line-number[:line-number] ] [ relative-report-number \| 1 ]
------ SETDEF-Defined Parameter -------------- Note: You can override the following SETDEF parameter. See the SETDEF Subcommand in z/OS MVS IPCS Commands. [ TEST \| NOTEST ]

line-number[:line-number]: This option explicitly specifies the range of lines to be browsed. The default is the entire report being referenced. The end of the range may be overstated to request for all lines beginning with the first to be browsed. The initial line in a report is always line 1.
relative-report-number: This operand specifies the report number. Report 0 is reserved for terminal output produced by the REPORT command itself. Report 1, the default, is the report being viewed at the time that the REPORT primary command was entered. Reports nested, if any, under the current ISPF logical screen are numbered from 2 onward.

END, ISPEXEC, and NOTE subcommands act the same way they do in a line mode IPCS session. You should rarely need to enter END.

Example: REPORT VIEW will display the entire current report using ISPF VIEW and return to the original context when that viewing has been completed.