OUTput Parameter

OUTPUT parameters describe the physical characteristics of output reports or files, such as the number of characters per line, number of lines per page, and output file type. Also, the user can specify either a details-only or totals-only report.
idmscu19
OUTPUT parameters describe the physical characteristics of output reports or files, such as the number of characters per line, number of lines per page, and output file type. Also, the user can specify either a details-only or totals-only report.
This article describes the following information:
2
2
Syntax
Col 2 ▼ ►►───
nn
OUTput ─┬───────────────────────────────┬──┬─────┬────────────────────► └─
record-size
─┬──────────────┬┘ ├─ T ─┤ └─
block-size
─┘ └─ D ─┘ ►─┬──────────────────────────────────────────────┬───────────────────────────► ├─ PS ─┬───────────────────┬───────────────────┤ │ └─ (
device-type
) ─┘ │ ├─ IS ─┬───────────────────┬───────────────────┤ │ └─ (
device-type
) ─┘ │ ├─ CARD ───────────────────────────────────────┤ ├─ NS ─┬────────────────┬──────────────────────┤ │ └─ (
forms-id
) ─┘ │ └─ UM (
module-name
─┬──────────────────┬─ ) ──┘ └─ ,
special-value
─┘ ►─┬─────────────────────────────────────┬───┬───────────────────────┬────────► └─ DD = ─┬─
ddname
─────────────────┬─┘ └─ LP =
lines-per-page
─┘ ├─
file-name logical-unit
─┤ └─
linkname
───────────────┘ ►─┬──────────────────┬───────────────────────────────────────────────────────►◄ └─ LT = ─┬─ S ◄ ─┬─┘ └─ N ───┘
Syntax Rules
  • nn
    Identifies the report that is associated with the OUTPUT parameter.
    The identifier is a two-digit number in the range 00 through 99 and must be coded starting in column 2.
  • OUTput
    Specifies the parameter type. The type must be coded starting in column 4.
  • record-size
    Specifies the output record size for the report. The size is coded in any column after OUT or OUTPUT. The default value for
    record-size
    is 132 bytes or the value specified on the PROFILE parameter for the run.
    For printed and card output, CA Culprit adds an extra byte to the value of
    record-size
    to accommodate a carriage control character or stacker select character, respectively. The extra byte precedes the data in the output record.
    Depending on the operating system and file type, the following rules apply:
    • The maximum record size is 32,760 bytes.
    • For CARD output, record-size is 80 bytes.
    • For tape or disk output, record-size is the size of the longest record to a maximum of 32,760 bytes. For variable-length output, the record size must include the 4-byte record descriptor word (RDW).
    • Ensure that the record length and block size of the SYS006 and SYS008 files can accommodate a record as large as the output record.
  • block-size
    Specifies the size of a physical block of output records. In a z/VSE environment, this parameter must be specified for file types PS and IS (definitions follow). The following rules apply to
    block-size
    :
    • The maximum block size that may be coded is 32,760 bytes.
    • Under z/OS and z/VM block size serves for documentation purposes only.
    • Under z/OS LBI - Large Block Interface is supported.  BLKSIZE= must be coded on the output DD card (default SYS020).
  • T/D
    Specifies a totals-only (T) report or a details-only (D) report. If this parameter is not specified, CA Culprit prints both total and detail lines.
  • PS/IS/CARD/NS/UM
    Specifies the file type or organization of the output file; if this parameter is not specified, the output is a printed report.
    Valid specifications follow:
  • PS (
    device-type
    )
    Specifies sequential file output.
    Device-type
    is an optional qualifier that must be enclosed in parentheses. Possible values for
    device-type
    are TAPE, 2311, 2314, 3310, 3330, 3340, 3350, 3370, 3375, 3380, or FBA.
    In z/OS and z/VM environments, users can specify
    device-type
    for documentation purposes. In a z/VSE environment, CA Culprit determines the device type if the file is assigned to a particular device in execution JCL. CA Culprit requires
    device-type
    to be specified in either execution JCL or on the OUTPUT parameter. This rule applies even with a tape or disk management system (for example, TFAST, DFAST) that may ignore the assignment.
    z/OS, z/VSE, and z/VM users can create variable-length output by using a PS output file type. Execution JCL for the output file must specify RECFM=V OR VB. The output lines contain the record descriptor word (RDW) in the first 4 bytes of the file. Bytes 1-2 hold the record length and bytes 3-4 hold binary zeros. If the output records are the same as the input records, CA Culprit rewrites the input RDW as the output RDW. If a new RDW is required for output, CULLUS33 (numeric field conversion), a CA-supplied procedure module, can be used to convert the calculated output field length into a binary number at run time.
    For more information about using this module, see CA Culprit User Modules .
  • IS (
    device-type
    )
    Specifies indexed sequential (ISAM) file output.
    Device-type
    is an optional qualifier that must be enclosed in parentheses. Possible values for
    device-type
    are 2311, 2314, 3310, 3330, 3340, 3350, 3370, 3375, 3380, or FBA.
    When IS is specified, a SORT parameter is required, and the primary sort field must appear on a type 5 edit parameter (see SORT Parameters and Edit Parameters). A details-only report (D) should be specified on the OUTPUT parameter to prevent automatic totaling; otherwise, a CA Culprit ISAM error may occur.
    Under z/OS and z/VM users can specify
    device-type
    for documentation purposes. Under z/VSE, CA Culprit determines the device type if the file is assigned to a particular device in execution JCL. CA Culprit requires
    device-type
    to be specified in either execution JCL or on the OUTPUT parameter; this rule applies even with a tape or disk management system (for example, TFAST, DFAST) that may ignore the assignment.
  • CARD
    Specifies an output card file. If CARD is specified, record size and block size specifications can be omitted.
    (z/OS and z/VM only) Users must specify RECFM=FA or FBA and LRECL=81 in execution JCL for SYSPCH because the output record for CARD output includes a stacker-select character. Alternatively, a PS output file type can be specified; CA Culprit directs output to the default or specified ddname. Execution JCL provides a list of default ddnames for output files.
  • NS (
    forms-id
    )
    Specifies output on special forms.
    Forms-id
    specifies the type of special form. It is a 1- to 10-character identifier that must be enclosed in parentheses. Identifiers that contain special characters (that is, anything other than letters, numbers, or hyphens) must be enclosed in single quotation marks within parentheses.
    The effect of
    forms-id
    depends on the SF= keyword that is coded on the PROFILE parameter.
    Operating system information is as follows:
    • In z/OS and z/VSE environments, special forms are controlled through execution JCL;
      forms-id
      can be specified for documentation purposes. In a z/VSE environment, forms can also be controlled through CULLPOWR (VSE/POWER segmentation), a CA-supplied output module.
      For details on using this module, see the "CA Culprit User Modules" section.
    • In a non-VS z/VSE environment, SF=EXTRA can be specified on the PROFILE parameter; this specification causes
      forms-id
      to appear on the console to prompt the operator to mount the appropriate form. Also, the first page of special-forms output is reprinted to allow the forms to be properly aligned; the operator can request reprints of the first page as needed.
    • In a z/VM environment, special forms are controlled through the SPOOL command.
  • UM (
    module-name,special-value
    )
    Specifies that edited output lines are passed to an output module for special handling. Operating system conditions follow:
    • Under z/VSE,
      module-name
      must be the name that was specified on the linkage editor PHASE statement when the module was linked.
    • Under z/OS,
      module-name
      must be the name or alias of the load module.
    • Under z/VM,
      module-name
      must be the name of the load module.
  • special-value
    Specifies a 2-byte value that is optionally passed to an output module. The value of
    special-value
    and the type of data that is contained in this specification vary, depending upon the needs of the output module.
    For more information about coding special values with CA-supplied output modules, see CA Culprit User Modules.
  • DD =
    Specifies the name of the output file.
    Execution JCL
    contains a list of default ddnames and filenames. When the DD= keyword expression is specified for a tape or disk report in a CA Culprit run, it must be specified on the OUTPUT parameter for all tape or disk reports in the run.
  • DD =
    ddname
    Specifies the name of the DD statement in z/OS execution JCL or FILEDEF statement in z/VM JCL that describes the output file. This keyword expression is not valid if the file type is omitted (that is, output is a printed report).
  • DD =
    file-name logical-unit
    Specifies the file name of the output file in a z/VSE environment and the logical unit number of the device that receives the output file.
    If DD =
    file-name
    is specified,
    logical-unit
    must also be specified.
    Logical-unit
    is a number in the range 0 through 255.
    In a z/VSE environment, a DD= specification is invalid when either the file type is omitted (that is, output is a printed report) or the file type is CARD.
  • LP =
    lines-per-page
    Specifies the maximum number of printed lines for each report page. This specification applies only to printed reports and output modules as follows:
    • For printed output, the default value for
      lines-per-page
      is 55 or the value that is specified of the PROFILE parameter.
    • For output to an output module, a default value for
      lines-per-page
      does not exist. The LP= keyword expression must be specified to write title and header lines at regular intervals.
    The following rules apply to
    lines-per-page
    :
    • CA Culprit counts detail and total lines, and their associated spacing requirements.
    • CA Culprit does not count header or title lines, or their associated spacing requirements.
    • Special channel skips count for one line each.
    When the specified number of lines is reached, CA Culprit prints title and header lines (if any) at the top of a new page, followed by detail and total lines. The line count is reset to zero.
  • LT = S/N
    Specifies the label type for tape file output as follows:
    • S (default) indicates that standard labels are to be created.
    • N indicates that no labels are to be created.
Examples
Sample OUTPUT parameters follow.
Example 1
25OUT 120 LP=40
Report 25 is a printed report that contains 120 characters on each line. Each page of the report contains up to 40 lines that are classified as detail lines, total lines, and break lines that are associated with these edit lines. Also, header lines and a title line are printed if they were specified for Report 25.
Example 2
99OUTPUT T CARD
Report 99 is output to a card file. The report contains only total lines.
Example 3
02OUT 140 700 D PS(TAPE) DD=SYS036,36 LT=N
In a z/VSE environment, a sequential output file is written to an unlabeled tape; the file, described on DD statement SYS036, is assigned to logical unit SYS036. The file contains 140-byte fixed-length records; each block contains five records. The records contain details-only information.
Example 4
01OUTPUT 70 NS(INVOICE) LP=28 DD=SYS018
Report 01 is printed on special forms. Each page of Report 01 contains 28 lines of 70 characters. CA Culprit writes this report to the file described on DD statement SYS018. DD= is a valid specification for special forms output, although it is not valid for standard printed output.
Under z/OS and z/VM, the special forms specification serves for documentation purposes only, because execution JCL handles forms control. CA Culprit does not reprint the first page and does not prompt the operator in a z/OS environment.
Example 5
44OUTPUT D UM(DTAILREP) LP=55
Detail lines for Report 44 pass to a user-written output module, DTAILREP. CA Culprit inserts a page eject after every 55 lines.