Report-Specification Commands

The report-specification commands specify the format and content of reports.

Only the first 72 characters of an input record are used for report-specification commands. A hyphen (-) used after text and before column 72 indicates that the following input record is a continuation of the current command.

Additional examples that demonstrate the effect of combining certain report-specification commands, are provided in “Report-Specification Command Examples” in this section.

The following report-specification commands can be used as input to LOGGER.

<report-specification command>

──┬─<break command>─────┬──────────────────────────────────────────────┤
  ├─<end command>───────┤
  ├─<exclude command>───┤
  ├─<heading command>───┤
  ├─<include command>───┤
  ├─<output command>────┤
  ├─<page size command>─┤
  ├─<report command>────┤
  ├─<reports command>───┤
  ├─<sort command>──────┤
  └─<source command>────┘

BREAK Command

Use the BREAK command to specify where to break to calculate and print the requested totals and averages.

<break command>
                   ┌◄── , ──┐
── BREAK ─┬──────┬─┴─<item>─┴─┬─────────────────┬──────────────────────┤
          └─ ON ─┘            └─<break options>─┘

<break options>

  ┌◄─/1\───────────────────────────┐
  │                     ┌◄── , ──┐ │
──┴─┬─/1\─ TOTALING ──┬─┴─<item>─┴─┴───────────────────────────────────┤
    └─/1\─ AVERAGING ─┘

The following text describes the meaning of each variable:

<item>

Indicates a valid JOBSUMMARY, STATISTICS, DRCDATA, or FILEIODATA file data item. Refer to “File Data Items” in this section for more information. When more than one file data item is specified, the items are taken in order from left to right with the rightmost item specifying the innermost break.

<break options>

The specified totals or averages or both are accumulated and printed each time the value of the break item changes.

Both totaling and averaging can be performed on the same item in the same detail report. Either totaling or averaging can be performed on an item in a SUMMARY or YTD report. If both totaling and averaging are specified for the same item in a SUMMARY or YTD report, only the totals are printed.

Examples

The following command specifies the NAME file data item as a control break:

BREAK ON NAME

The following command specifies totals for TASKS, JOBS, and HL to be printed for the DATE file data item each time the value of the item changes:

BREAK ON DATE TOTALING TASKS, JOBS, HL

The following command specifies totals for PROCESSTIME and IOTIME and averages for IOTIME be printed for the USERCODE file data item each time the value of the item changes:

BREAK ON USERCODE TOTALING PROCESSTIME, IOTIME AVERAGING IOTIME

END Command

Use the END command to indicate the end of the report-specification commands. This command must appear at the end of the report-specification commands.

<end command>

── END ────────────────────────────────────────────────────────────────┤

EXCLUDE Command

Use the EXCLUDE command to specify the records that are to be excluded from the report. As many EXCLUDE commands as desired can appear in the report specifications. Excluded items are ORed. When the EXCLUDE and INCLUDE commands are used together, the results are ANDed. Refer to “INCLUDE Command” for more information.

<exclude command>

── EXCLUDE ─┬──────────┬─┬──────┬─<item>─┬─ = ───┬─┬─<integer>───────┬─┤
            └─ RECORD ─┘ └─ IF ─┘        ├─ > ───┤ └─<quoted string>─┘
                                         ├─ < ───┤
                                         ├─ NEQ ─┤
                                         ├─ LEQ ─┤
                                         └─ GEQ ─┘

The following text describes the meaning of each variable:

<item>

Specifies a valid JOBSUMMARY, STATISTICS, DRCDATA, or FILEIODATA file data item. Refer to “File Data Items” in this section for more information.

For items of type string, the length of the comparison made to select records is the minimum of the length of the quoted string and the actual length of the item.

=

Excludes all items equal to the integer or quoted string from the report.

>

Excludes all items greater than the integer or quoted string from the report.

<

Excludes all items less than the integer or quoted string from the report.

NEQ

Excludes all items not equal to the integer or quoted string from the report.

LEQ

Excludes all items less than or equal to the integer or quoted string from the report.

GEQ

Excludes all items greater than or equal to the integer or quoted string from the report.

<integer>

Any valid real or integer number corresponding to a numeric file data item.

<quoted string>

A quoted string is data enclosed in quotation marks. The syntax is similar to an ALGOL quoted string not a WFL quoted string. The data can be null, and the data can contain quotation marks. Two successive quotation marks signify a null string, and three quotation marks signify a quotation mark within a quoted string. Quotation marks can be single (') or double (") as long as the beginning and end pair match. Embedded quotations must use quotation marks that are not the same as the delimiter quotation marks. For example, "A 'quotation' in the string" is valid. Quoted strings cannot be continued to the next input record.

Examples

The following command specifies that only records with the usercode MAVO are to be printed in the report:

EXCLUDE RECORD IF USERCODE NEQ "MAVO"

The following command specifies that all records with the chargecode SKIP are to be excluded from the report:

EXCLUDE IF CHARGECODE = "SKIP"

The following command specifies that all records with the queue number 7 are to be excluded from the report. Note that the QUEUE data item is padded with leading zeros to make its length three digits.

EXCLUDE IF QUEUE = "007"

HEADING Command

Use the HEADING command to specify the heading that appears at the top center of each page. If more than one HEADING command is present in the report specifications, only the last one is used.

<heading command>

── HEADING ─┬──────┬─ <quoted string> ─────────────────────────────────┤
            └─ IS ─┘

The following text describes the meaning of the variable:

<quoted string>

A quoted string is data enclosed in quotation marks. The syntax is similar to an ALGOL quoted string, not a WFL quoted string. The data can be null, and the data can contain quotation marks. Two successive quotation marks signify a null string, and three quotation marks signify a quotation mark within a quoted string. Quotation marks can be single (') or double (") as long as the beginning and end pair match. Embedded quotations must use quotation marks that are not the same as the delimiter quotation marks. For example, "A 'quotation' in the string" is valid. Quoted strings cannot be continued to the next input record.

Example

The following command places the heading JOB-TASK-SESSION BY USERCODE at the top center of each page of the report:

HEADING IS "JOB-TASK-SESSION BY USERCODE"

INCLUDE Command

Use the INCLUDE command to indicate what records are to be included in the report. Any item not specified in this command is excluded from the report. As many INCLUDE commands as desired can appear in the report-specification commands. Items that are included are ORed. When INCLUDE and EXCLUDE commands are used together, the results are ANDed. Refer to “EXCLUDE Command” for more information.

<include command>

── INCLUDE ─┬──────────┬─┬──────┬─<item>─┬─ = ───┬─┬─<integer>───────┬─┤
            └─ RECORD ─┘ └─ IF ─┘        ├─ > ───┤ └─<quoted string>─┘
                                         ├─ < ───┤
                                         ├─ NEQ ─┤
                                         ├─ LEQ ─┤
                                         └─ GEQ ─┘

The following text describes the meaning of each variable:

<item>

Specifies a valid JOBSUMMARY, STATISTICS, DRCDATA, or FILEIODATA file data item. Refer to “File Data Items” in this section for more information. For items of type string, the length of the comparison made to select records is the minimum of the length of the quoted string and the actual length of the item.

=

Includes the items equal to the integer or quoted string.

>

Includes the items greater than the integer or quoted string.

<

Includes the items less than the integer or quoted string.

NEQ

Includes the items not equal to the integer or quoted string.

LEQ

Includes the items less than or equal to the integer or quoted string.

GEQ

Includes the items greater than or equal to the integer or quoted string.

<integer>

Any valid real or integer number corresponding to numeric file data items.

<quoted string>

A quoted string is data enclosed in quotation marks. The syntax is similar to an ALGOL quoted string, not a WFL quoted string. The data can be null, and the data can contain quotation marks. Two successive quotation marks signify a null string, and three quotation marks signify a quotation mark within a quoted string. Quotation marks can be single (') or double (") as long as the beginning and end pair match. Embedded quotations must use quotation marks that are not the same as the delimiter quotation marks. For example, "A 'quotation' in the string" is valid. Quoted strings cannot be continued to the next input record.

Examples

The following command specifies that only records with the date 02/23/1994 are to be included in the report:

INCLUDE RECORD IF DATE = "02/23/1994"

The following command specifies that only records with the type J are to be included in the report:

INCLUDE IF TYPE = "J"

The following command specifies that only records with the queue number 7 are to be included in the report. Note that the QUEUE data item is padded with leading zeros to make its length three digits.

INCLUDE IF QUEUE = "007"

OUTPUT Command

Use the OUTPUT command to specify items that are to appear in the report.

<output command>

                                 ┌◄─── , ───┐
── OUTPUT ─┬─────────┬─┬───────┬─┴─ <item> ─┴──────────────────────────┤
           └─ ITEMS ─┘ └─ ARE ─┘

The following text describes the meaning of the variable:

<item>

Specifies a valid JOBSUMMARY, STATISTICS, DRCDATA, or FILEIODATA file data item. Refer to “File Data Items” in this section for more information.

Example

The following command specifies that the TYPE, MIXNO, JOBNO, and PROCESSTIME file data items are to appear in the report. Because these items are all valid JOBSUMMARY file data items, it is assumed that a SOURCE FILE IS JOBSUMMARY command is present in the report specifications. Refer to “SOURCE Command” for more information.

OUTPUT ITEMS ARE TYPE, MIXNO, JOBNO, PROCESSTIME

PAGE SIZE Command

Use the PAGE SIZE command to specify the number of lines per page for the report. If no PAGE SIZE command is entered, the number of lines per page is 60.

<page size command>

── PAGE ─┬────────┬─┬──────┬─<integer>─────────────────────────────────┤
         └─ SIZE ─┘ └─ IS ─┘

The following text describes the meaning of the variable:

<integer>

Indicates the number of lines on a page.

Example

The following command specifies that each page of the report will contain 72 lines:

PAGE SIZE IS 72

REPORT Command

Use the REPORT command to indicate the beginning of the report specifications. This command can only appear once in the input deck.

<report command>

── REPORT ─┬───────────┬───────────────────────────────────────────────┤
           └─<integer>─┘

The following text describes the meaning of the variable:

<integer>

Identifies the number of the report in the LOGREPORTS file. The LOGREPORTS file can contain many report specifications and is used for installation convenience. Refer to “REPORT Commands and LOGREPORTS File” in this section for more information.

Example

The following command specifies that the report specifications for the report are to be found in the LOGREPORTS file under report number 4:

REPORT 4

REPORTS Command

Use the REPORTS command to specify whether the type of report to be printed is a detailed report, summary report, or both.

If this command is not present in the report specifications, a detailed report is produced.

<reports command>

── REPORTS ─┬───────┬─┬────────────┬─┬──────────────────────────┬──────┤
            └─ ARE ─┘ └─ DETAILED ─┘ │ ┌◄─────────────────────┐ │
                                     └─┴─ SUMMARY ──<integer>─┴─┘

The following text describes the meaning of each variable:

DETAILED

Specifies one detailed report. A detailed report includes one line for each record in the file.

SUMMARY <integer>

Specifies one summary report. A summary report consists of one line for a particular group of records in the file. If summary reports are requested, the REPORTS command must be preceded by at least as many BREAK commands as there are summary reports to be printed. Refer to “BREAK Command” in this section for more information.

The integer indicates the control break item to be summarized when more than one BREAK command is specified in the report specifications.

Examples

The following command specifies a summary report with totals to be generated for the control break item specified in the second BREAK command:

REPORTS ARE DETAILED SUMMARY 2

The following command specifies a summary report to be generated for the control break items specified in the first and second BREAK commands:

REPORTS ARE DETAILED SUMMARY 1 SUMMARY 2

SORT Command

Use the SORT command to specify the sort sequence for the output items.

<sort command>

                  ┌◄──────────── , ───────────┐
── SORT ─┬──────┬─┴─ <item> ─┬──────────────┬─┴────────────────────────┤
         └─ BY ─┘            ├─ ASCENDING ──┤
                             └─ DESCENDING ─┘

The following text describes the meaning of each variable:

<item>

Specifies a valid JOBSUMMARY, STATISTICS, DRCDATA, or FILEIODATA file data item. Refer to “File Data Items” in this section for more information. If more than one item is specified, sorting begins with the first item. When the first item is equal, the sort moves to the next item and continues in order until all items are sorted.

ASCENDING

Sorts the items from the lowest to the highest order. The default order is ASCENDING.

DESCENDING

Sorts the items from the highest to the lowest order.

Examples

The following command indicates the report is to be sorted by job number in ascending order:

SORT BY JOBNO ASCENDING

The following command indicates the report is to be sorted in ascending order first by usercode, and then by mix number, within each usercode:

SORT BY USERCODE, MIXNO

SOURCE Command

Use the SOURCE command to specify whether a JOBSUMMARY, STATISTICS, DRCDATA, or FILEIODATA file is to be used to generate the report. Only one SOURCE command can appear in the input deck. This command must precede all other report-specification commands except the REPORT command.

<source command>

── SOURCE ─┬────────┬─┬──────┬─┬─ JOBSUMMARY ─┬────────────────────────┤
           └─ FILE ─┘ └─ IS ─┘ ├─ STATISTICS ─┤
                               ├─ DRCDATA ────┤
                               └─ FILEIODATA ─┘

The following text describes the meaning of each variable:

JOBSUMMARY

Indicates a JOBSUMMARY file is to be used to generate the report.

STATISTICS

Indicates a STATISTICS file is to be used to generate the report.

DRCDATA

Indicates a DRCDATA file is to be used to generate the report.

FILEIODATA

Indicates a FILEIODATA file is to be used to generate the report.

Example

The following command indicates the FILEIODATA file is to be used to generate the report. This command also enables the WRITEIODATA option. Refer to “OPTION Command” in this section for more information.

SOURCE FILE IS FILEIODATA