Reports

At any time during an Extract File or Archive File browse session or a Point-and-Shoot session, you can create a report about the contents of the display.

Use the report facility to format and print or save a report that includes some or all displayed rows. To invoke the report facility, use the REPORT command. (Note that the REPORT command is not available while browsing a Compare File.) The following panel prompts for the report specifications.

Figure: Specify Report Options

--------------------- Archive Browse: FOPDEMO.ARCHIVE.FILE --------------------
Command ===>                                                  Scroll ===> PAGE 

Cmd F == Table: FOPDEMO.ORDERS(T1) ========================= 7 OF 19 === MORE>>

+--------------------------Specify Report Options-----------------------------+
¦                                                                             ¦
¦ All rows are printed for the named table.  If 'All' is selected, one        ¦
¦ row is printed for each table before and all rows for each table after.      ¦
¦ Leave 'Table Name' blank for a selection list.  Use HELP for more           ¦
¦ information.  Press ENTER to continue, END or CANCEL to exit report.        ¦
¦                                                                             ¦
¦ Table Name, Tn, or LAST       ===> DETAILS                  >>              ¦
¦ Process All Tables or One     ===> A         A-All, N-Named Table Only      ¦
¦ Report Title                  ===> SAMPLE                                   ¦
¦ Output Type                   ===> S         D-Dataset, S-SYSOUT, J-Job     ¦
¦   If Dataset/Job: DSN         ===>                                          ¦
¦   If Sysout/Job:  Class       ===> *         A - Z, 0 - 9, *                ¦
¦                   Destination ===>                                          ¦
¦                   Hold        ===>           Y-Yes, N-No                    ¦
¦   If Job:         Review JCL  ===>           Y-Yes, N-No                    ¦
¦ Display Report Parameters     ===> N         Y-Yes, N-No                    ¦
+-----------------------------------------------------------------------------+

Panel

This panel includes:

Table Name, Tn, or LAST
The name of the table that directs the report. You can specify the name of any table in the display by explicit name, assigned Tn or Vn, or the word LAST (for the lowest-level table in the display). Leave Table Name blank or use a pattern to choose from a selection list.

This specification, combined with Process All Tables or One, determines the set of data in the report. For more information about the effect of this specification on the contents of the report, refer to Report Contents.

Process All Tables or One
Indicates whether one or all tables are included in the report. Specify:
A
All tables.
N
Only the named table.
Report Title
Specify a title (up to 40 characters) to be included in the report heading. Any characters, including uppercase and lowercase letters, are valid.
Output Type
Indicates the output type. Specify:
D
Dataset
S
SYSOUT
J
Job (a batch job that produces both dataset and SYSOUT output)
If Dataset/Job
If the Output Type is D or J, specify the name of the dataset. If the dataset does not exist, Optim™ prompts for allocation information and allocates the file before generating the report.
If Sysout/Job
If the Output Type is S or J, specify SYSOUT parameters:
Class
The output class for the printed output. Specify an alphabetic or numeric character (A – Z, 0 – 9) or an asterisk (*).
Destination
The SYSOUT destination. Specify a valid local or remote terminal, a node in the JES network, a local or remote printer or workstation, or a TSO User ID.
Hold
Specify Y or N.
If Job: Review JCL
If the Output Type is J, specify:
Y
Review JCL.
N
Do not review JCL.
Display Report Parameters
Indicates whether you want to review the prompts for report parameters. (For more information, refer to Report Format Parameters.) Specify:
Y
Review prompts.
N
Do not review prompts.

Report Contents

The Table Name and Process All Tables or One specifications determine the contents and layout of the report. For example, assume you are browsing four tables joined for display as follows:

ORDERS         
  C:DETAILS 
    P:ITEMS

P:CUSTOMERS (STACKED)

CUSTOMERS and DETAILS are joined at the same level (stacked) and ITEMS is joined to DETAILS. (For an explanation of stacked tables, refer to Multiple Table Display.)

  1. To generate a report on the rows from a single table, enter the table name and specify “N” for Process All Tables or One. For example, to include only the DETAILS rows in the report, specify:
    Table Name, Tn, or LAST                  ===> DETAILS 
    Process All Tables or One                  ===> N 
    

    All the rows from the DETAILS table, which are related to the displayed ORDERS row (the next highest table), are included in the report. No other tables are included in this report.

  2. To limit the report to a specific set of related data, specify the name of the table for which all rows on the current level are included. For reference, the related row from each higher-level table is included. The rows from lower-level tables are always included with this specification.

    For example, to generate a report on the DETAILS rows for the currently displayed ORDERS row and the related ITEMS rows for each of the DETAILS rows, specify:

    Table Name, Tn, or LAST                  ===> DETAILS  
    Process All Tables or One                  ===> A
    

    The report lists the displayed row from the ORDERS table and, one at a time, each DETAILS row with the related ITEMS rows in a control break format.

  3. To include the rows from all the tables joined in the current session, specify the name of the Start Table and “A” for the Process All Tables or One prompt. For example, assume the ORDERS table is the Start Table, specify:
    Table Name, Tn, or LAST                  ===> ORDERS 
    Process All Tables or One                  ===> A 
    

    If you want to include all information for a single ORDERS row, specify DETAILS as the table name. The ORDERS row is included with all current DETAILS rows, and related ITEMS rows.

Format

The format of rows in the report conforms to the browse or Point-and-Shoot display format. A header identifies the table, column headings are presented before the columns, and the row(s) of data are listed after the headings. You can specify the parameters for the report format.

When there are multiple lower-level tables, the report display is similar to that of the browse or Point-and-Shoot display.

  • For each table that is higher-level than the lowest-level table, only one row is displayed.
  • For the lowest-level table, all rows are displayed.
  • When multiple rows are included in the report for a higher-level table, each row is displayed in order with the related, lower-level rows.

Report Format Parameters

When you indicate Y to Display Report Parameters, prompts for the parameters are displayed. Normally, you establish these parameters once, and use them consistently for all reporting.

Figure: Report Format Parameters

--------------------- Archive Browse: FOPDEMO.ARCHIVE.FILE --------------------
Command ===>                                                  Scroll ===> PAGE 

Cmd F == Table: FOPDEMO.ORDERS(T1) ========================= 7 OF 19 === MORE>>

 +------------------------Report Format Parameters------------------------+ --+
 ¦                                                                        ¦   ¦
 ¦ Lines per Page                  ===> 57    0-No Titles, 20-999         ¦   ¦
 ¦ Maximum Report Rows per Table   ===>       blank-Editor Max Fetch Rows ¦   ¦
 ¦ Report Line Width               ===> 132   80-n, Blank-Maximum         ¦   ¦
 ¦ Oversized Lines                 ===> W     T-Truncate, W-Wrap Data     ¦   ¦
 ¦ Maximum Character Column Width  ===>       Blank-Maximum Display Width ¦   ¦
 ¦ New Page per Start Table Row    ===> N     Y-Yes, N-No                 ¦   ¦
 ¦ Blank Lines between Levels      ===> 1     0 - 3                       ¦   ¦
 ¦ Blank Lines between Rows        ===> 0     0 - 3                       ¦   ¦
 ¦ Blanks between Columns          ===> 1     0 - 20                      ¦   ¦
 ¦ Indent for Subordinate Tables   ===> 2     0 - 40                      ¦   ¦
 ¦ Omit Table Name Heading Line    ===> N     Y-Yes, N-No                 ¦   ¦
 ¦ Omit Subordinate Table Headings ===> N     Y-Yes, N-No                 ¦   ¦
 ¦ Omit Redundant Table Headings   ===> N     Y-Yes, N-No                 ¦   ¦
 ¦ Show Inactive Multi-Way Tables  ===> Y     Y-Yes, N-No                 ¦   ¦
 ¦                                                                        ¦   ¦
 ¦ Press ENTER to continue, END or CANCEL to exit report.                 ¦   ¦
 +------------------------------------------------------------------------+   ¦

Panel

The following prompts are displayed on this panel.

Lines per Page
The maximum number of lines printed on a page. Normally, this is the number of lines that physically fit on a page, excluding lines for the vertical margins. The default is 57. Specify:
0
Print the title line at the start of the report and do not insert page breaks. Use 0 to write to a dataset without inserting page breaks.
20-999
Print the indicated number of lines per page. When the number of lines have been printed, Access inserts a page break, prints the title at the start of the new page, and increments the page number by 1.
Maximum Report Rows per Table
The maximum number of rows fetched for each table in the report. The value must be from 1 through the fetch limit specified by site management. Leave blank to use the value specified for Maximum Fetch Rows in the Editor and Display Options.
Report Line Width
The maximum number of characters on a line in the report. If a row exceeds this value, it is wrapped or truncated according to the Oversized Lines specification.

The minimum value is 80. A value less than 80 is automatically reset to 80. Use 80 if the report is directed to a data set for subsequent browsing or printing. Leave blank to set the line width equal to the longest row of any table in the report.

If the report is directed to a printer, this value is normally the line length of the printer (132 for most printers), excluding the carriage control byte in the first position of the line.

Oversized Lines
Indicates the handling of lines that exceed the maximum width. Specify:
T
Data is truncated. Any columns that do not fit entirely on the line are omitted.
W
Data is wrapped. Each row occupies as many lines as needed. Line breaks occur between columns when the column width exceeds the remaining line width.
Maximum Character Column Width
The maximum number of bytes that can be included in a report column.
Note: For GRAPHIC and DBCLOB columns, the Shift Out and Shift In characters are included in the maximum width. Therefore, a report displays the specified maximum number of GRAPHIC and DBCLOB bytes minus the number of Shift Out and Shift In characters.

Leave blank to use the value specified for Columnar Max Display Width on the Editor and Display Options panel.

New Page per Start Table Row
Indicator for a new page for each Start Table row. (If the report is for a single table, this is ignored.) Specify:
Y
Print on a new page.
N
Continue printing on the current page.
Blank Lines between Levels
Indicates the number of blank lines inserted between table levels in the report. Specify a value from 0 through 3.
Blank Lines between Rows
The number of blank lines inserted between rows. This parameter applies only to the tables for which all relevant rows are included; only a single line is included for other tables. Specify a value from 0 through 3.
Blank between Columns
Indicates the number of blanks inserted between columns. Specify a value from 0 through 20.

This value is the minimum number of blanks between any two columns. The report may display more blanks between some columns, depending on the contents of the column and the justification of that data in relation to the column heading.

Indent for Subordinate Tables
The number of positions to indent data from a subordinate table at each control break to distinguish it from the immediately preceding table. Use this indentation to present a clear visual representation of the display levels.

Specify a value from 0 through 40. This value is subtracted from the Report Line Width to determine the actual number of characters in the indented table that can fit on a line.

Omit Table Name Heading Line
Indicator for including the line containing the table name and level number for each level in the report. Specify:
Y
Omit heading.
N
Include heading.
Omit Subordinate Table Headings
Indicator for including header lines for all tables other than the Start Table in the report. If the subordinate table names and column titles are not necessary, use this option to eliminate them. Specify:
Y
Omit heading.
N
Include heading.
Omit Redundant Table Headings
Indicator for including table headings more than once on a page. That is, if a table is included on a page more than once, the headings are included with the first occurrence only. Specify:
Y
Omit redundant table headings.
N
Include table headings for all occurrences of a table on a page.
Show Inactive Multi-Way Tables
Indicator for including all joined tables in a multi-way join. Although all tables cannot be currently active, all must have been displayed during the session. Specify:
Y
Include all tables in a multi-way join.
N
Include only the currently displayed table.

Additional Notes

The following notes apply to reports:

  • Excluded rows are included in the report. When you return to the browse or Point-and-Shoot display after generating a report, any excluded rows are redisplayed.
  • If you specify a table in a stack and only one table is printed, only the active table is included in the report. The hidden tables on that level are not printed, regardless of the Show Inactive Multi-way Tables option.
  • All locked column specifications are respected; locked columns are positioned as on the browse or Point-and-Shoot display.
  • The Describe Columns panel specifications for column and label handling are used to format the report lines.
  • The REPORT command is not available from a ZOOMed display.